Environments
Environments are used to organise changes and assets within a project.
Accessing the environments table screen
To view all environments within a project:
- Log in to the GUI.
- Click on projects in the navigation bar.
- Navigate to your desired project.
- Click on the environments tab to display the list of environments.
Just as with projects, if you don't see any environment in the list, it is possible that either no environment has been created for this project or you have not been granted access to any environment within it.
Environment table columns
| Column | Description |
|---|---|
| Name | Displays the name of each environment. |
| Code | Shows a unique identifier for the environment. |
| Description | Provides a short summary or purpose of the environment. |
| Archived | Indicates the archival status of the environment. |
Buttons & links
| Buttons & links | Function |
|---|---|
| Bulk actions | Perform operations on multiple environments, such as archiving, restoring or permanently deleting them. |
| Search | Filter the contents of the table by the text you type. |
| Include archived | List archived environments alongside active ones. |
| Columns | Hide or display columns in the table. |
| CSV | Download the environments as a CSV file. Archived environments are included only when Include archived is ticked; the search is not applied. |
| Create environment | Add a new environment to the project in MintPress. |
Managing environments in the table
- Use checkboxes to select multiple environments for bulk operations (archiving, restoring or deleting).
- Click on a column heading to sort the contents of the table.
- Click on an environment's row to navigate to its detailed view.
Archiving an environment
Archive an environment by selecting it from the environments table and choosing Archive environments from the Bulk actions menu.
Archiving an environment:
- archives every asset that belongs to the environment
- disables every scheduled activity defined on the environment (and on its child assets) - they will not run until the environment is restored
- prevents new changes, workflow runs and scheduled activities from being created in the environment (or its assets)
An environment cannot be archived if it contains a queued or running activity. Wait for those activities to complete (or cancel them) before archiving.
Deleting an environment
Delete an environment from its actions menu, or delete several at once by selecting them in the environments table and choosing Delete environments from the Bulk actions menu.
Deleting an environment is permanent and irreversible, and removes the environment along with the assets it owns. An environment that has changes recorded against it cannot be deleted - archive it instead.
Creating a new environment
To create a new environment, follow these steps:
- Click on the create environment button.
- Fill in the mandatory fields in the dialog, including name and code.
- (Optional) Add a description to clarify the purpose of the environment for other users.
- Click the create environment button to finalise the creation of your environment. You stay on the current screen, and a notification links to the new environment.
The values entered for name and code must be unique within a project. i.e. there cannot be more than one environment with the same code or name in the same project.
Cloning an environment
Clone an environment to copy it, its properties and settings, and its assets, to a new environment or onto an existing one in the same project. Open the environment, select the menu (⋮) in its header and choose Clone environment…:
- Under Clone to, choose A new environment and enter its name, code and description, or An existing environment and pick it.
- Under Assets, untick any asset you do not want to clone. Filter assets narrows the list.
- Choose what to copy:
- For a new environment, tick Properties, Settings or both under Clone.
- For an existing environment, Advanced sets how Environment properties, Environment settings, Asset properties and Asset settings are each handled: Skip leaves the target's as they are, Merge merges the source's into them, and Replace overwrites them. Assets that already exist sets what happens to an asset whose code the target already has: Skip (the default), Update or Fail, which stops the whole clone.
- Select Preview. Nothing is changed yet: the preview lists each environment and asset the clone will create, update or skip, and the properties and settings it will change. It lists the key paths of any secrets being copied, which are cloned as they are. Use compare afterwards to see what changed.
- Select Clone.
The clone is made in one go: if any part of it fails, nothing is changed. New assets have their actions refreshed in the background. Clone environment… is offered only where you can update a target environment, and is disabled on an archived environment, which must be unarchived first. To clone a single asset, see cloning an asset.
Viewing the environment details
You can view the details of an environment by clicking on its row.
Environment details screen
This screen displays the changes, scheduled activities, assets, artifacts, audit history, properties and settings specific to this particular environment and its child assets.
Activity tab
Lists the changes that have been deployed in this environment. Refer to the activities list for a detailed description of this table's contents.
Scheduled activity tab
This tab lists the scheduled activities defined for this environment. Refer to the scheduled activity details for a detailed description of this table's contents.
Assets tab
This tab lists the assets available for this environment. Refer to the assets page for a detailed description of this table's contents.
Artifacts tab
This tab lists the latest version of each artifact stored against this environment, and is where you upload one by hand or open an artifact's version history. It works as it does for an asset - see artifacts for the columns, filters, upload dialog and versions page.
Audit history tab
This tab lists the most recent audit events for this environment. Refer to node & agent audit history for a description of this table's contents.
Properties tab
A set of properties can be specified against an environment. The properties are then available to the actions that are executed within the environment and its child assets. This allows the action to query the value and then influence the change. This tab lists the properties available for this environment. Refer to the properties page for a detailed description of this table's contents.
Settings tab
The settings tab allows you to specify configuration options that apply to the environment and its children. Refer to the settings page for a detailed description of this table's contents.