Managing an Environment

Users can manage an environment on the environment settings page.

To get there:

Environments from the main, left-hand navigation.
Choose the environemnt from the list of environments in the first column.
Use the settings tab from the horizontal navigation.

Updating the Environment

Editable fields for environment:

Field	Description
Name	Human readable name that is shown for the environment.
Identifier	The environment resource identifier.
Description	A description for the environment.

Users can also set access controls during the create process.

Monitoring Config

The monitoring configuration section currently configures log drain but will be expanded as more monitoring tooling and systems are released!

External Logging

Enable external logging at the environment level and set a log drain endpoint for all container logs (including service containers).

The drain URL must be a public endpoint as the execution of the request will originate from the agent on the server.

The user will also define the format of the outbound request. There are two options:

NDJSON - Headers
NDJSON - Raw

In both options the format for the content type is NDJSON. Interval for post is always 60 seconds.

NDJSON - Headers

With this format, the logs will be sent with the following headers:

X-Cycle-Container-Id
X-Cycle-Instance-Id
X-Cycle-Server-Id.
X-Cycle-Environment-Id
X-Cycle-Container-Identifier
X-Cycle-Container-Deployment (if container is in a deployment)

NDJSON - Raw

With this format, the logs will be sent with the information in the return.

{
	"time": "2025-01-23T17:10:40.471661706Z",
	"source": "stdout",
	"message": "fd00::95c9:9d3b:1:1 - - [23/Jan/2025 17:10:40] \"GET / HTTP/1.1\" 200 -\r\n",
	"instance_id": "678a81408597c5a1c2378dfe",
	"environment_id": "67881ba14181c237c6fb63a0",
	"container_id": "678a8140517bbec678cddb3f",
	"container_identifier": "demo-log-drain",
	"server_id": "653850e1845d6d9e4c4ce380"
}

Access Controls

To enable access controls, use the toggle next to the field and a form will expand.

If the access controls section is enabled, the Roles portion of the form must include at least 1 role or the platform will return an error to the user. After Selecting the roles, the user will need to add the appropriate access controls using the checkboxes.

Virtual Machine SSH Keys

Users can add environment level SSH keys here that can be used with the virtual machines deployed to the environment.

To remove keys, add them to the form and then submit the delete button.

Requires Restart

After adding or removing an SSH key from any virtual machine, the virtual machine must be restarted for the effects to take place. It is possible to remove the keys manually through the virtual machine, if that workflow is preferred.

Deleting an Environment

There are no safeguards preventing the deleting of an environment and when an environment is deleted all containers, services, and scoped variables are deleted as well.

As environments can be targeted for deployments through pipelines, make sure to double check usage before deleting.

Use the delete form on the environment settings page to delete this resource.