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.
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 of the give environment.
To remove keys, add them to the form and then submit the delete button.
Requires Restart
After 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.