Environments and Tags

Environments

CloudTruth Environments allow us to model an organization's hierarchy and define parameter values specific to the current environment context.

Each CloudTruth Organization starts with the following environment tree:

  • default (the root environment, cannot be deleted or renamed)

    • development

    • production

    • staging

Parameters inherit values from branches in the Environment tree allowing you to have a common default value throughout the Organization while also granting fine grain control over those values where required.

Creating an Environment

  1. Select Create Environment from the global Project and Environment action menu at the top of the page to open the CREATE NEW ENVIRONMENT dialog:

  • ENVIRONMENT NAME - Typically a name representing a real world environment (required)

  • PARENT ENVIRONMENT - Existing environment to nest the new environment under (required, defaults to the current globally selected environment)

  • DESCRIPTION - Further describe the environment's purpose (optional)

  1. Fill out the form with the appropriate information:

  1. Submit the form to create the dev1 environment as a child of the development environment.

Environment Hierarchy

In the example above, we have created a single child environment under the development environment:

This process can be repeated for complex models allowing very distinct parameter customization at multiple levels of your organization:

Copying an Environment

  1. On the Environments page, select the source environment to copy in either the global environment selector at the top or in the environment tree, then select the Copy option from the selected environment's action menu:

  • ENVIRONMENT NAME - Typically a name representing a real world environment (required)

  • DESCRIPTION - Further describe the environment's purpose (optional)

  • COPY DEPENDENTS - This option is only available if there are dependent environments to the environment being copied.

  1. Enter the appropriate information and click Next:

  1. After reviewing, click Copy Environment

  2. This will copy the environment as a top-level environment under the default environment, along with any dependent environments (with the COPY DEPENDENTS option checked):

All copied environments will be placed under the default environment.

Deleting an Environment

  1. On the Environments page, select the environment to delete in either the global environment selector at the top or in the environment tree, then select the Delete option from the selected environment's action menu:

  1. Click Yes, delete on the confirmation dialog to complete the environment deletion process.

You will not be allowed to delete the default environment or any parent environment containing children.

Tags

Tagging allows you to create a snapshot of parameters and values in a selected environment to a specific point in time. You can then use the tag to retrieve values for your applications. Tags are applied for the chosen environment across all projects in your organization. To see a tag's parameters and values use the history feature or the via CLI.

Creating a Tag

Select Environments in the left-hand navigation menu:

Click the + Create Tag button to open the CREATE NEW TAG dialog:

  • TAG NAME - Use a descriptive name to reference the tag, i.e. (stable, current, nightly)

  • IMMUTABLE - Prevents the tag's properties from being edited or updated, the tag will always reflect the data state of the selected timestamp when the tag was created

  • ENVIRONMENT - Choose the Environment to which the new tag will be applied

  • DESCRIPTION - Further describe the tag's purpose

  • TIMESTAMP - Choose a date and time for the parameter values the tag will represent (defaults to current date and time).

Editing a Tag

You can edit the timestamp, description, or make a tag immutable by selecting Edit Tag from the environment tag's ACTIONS menu:

Editing the timestamp of a tag will allow you to set the time and date to the last known good configuration in a tag e.g. stable:

Updating a tag will automatically initiate any associated push actions.

Setting the IMMUTABLE option is useful when you need to take a snapshot of parameter and parameter values in a known good state before making any updates to those parameters. Once a tag has been set to immutable, the timestamp can no longer be updated. This guarantees the parameter and parameter values from that date and time will always be available to fall back to if needed. Immutable tags can only be deleted.

Deleting a Tag

The environment tag's ACTIONS menu also allows you to delete your tags.

Last updated

CopyrightΒ© 2023 CloudTruth