Add An Environment

One of the concerns for the Cascade system is the marshalling of application layer code, assets, databases and links. In order to accomplish moving these items around a bespoke hosting solution, there are a few main concepts to understand: Deployment Environment and Deployment Group.

This guide assumes some knowledge of Cascade terminology, before proceeding read more about Deployment Targets, Deployment Groups, and Deployment Environments in our FAQ on this subject.

Prerequisites

You will need to log into Cascade as a special kind of administrator to add Environments. In order to check your permissions, please navigate to the Environments tab in the administration section of Cascade, you should see a display similar to below.

Environments Dashboard

Take note of the + icon next to the Environments header. If you do not see the + icon, your account does not have permission to add Environments.

Add a New Environment

  1. Navigate to to the Environments Tab in the Administration dashboard by clicking the Administration header and then the Environments tab.
  2. Ensure you have the appropriate permissions to create environments by looking for the + symbol next to the Environments header as shown above.
  3. Click the + icon to open the add new environment dialogue. Note that entry box will show you the names of existing environments, you may still type the name of your new one.
  4. After filling in your chosen name, click the resulting pop-up option displayed as ” Create [your name]”.
  5. Click the create button at the bottom right of the form.

New Environment Form

Attach Deployment Targets to Environment

After your environment is created, you must decide which Deployment Targets and Deployment Groups are associated with it. For guidance on how to add deployment groups, see the Add A Deployment Group guide

  1. Click on the gear icon next to each deployment group and decide what targets are enabled by clicking a check-box.
  2. Click the save button.
  3. Repeat for each Deployment Group you wish to associate.
  4. Optional: You may also decide to disassociate a Deployment Group by clicking the trash can icon for that group.

Environments Target Form

Update an Existing Environment

  1. Navigate to to the Environments Tab in the Administration dashboard.
  2. Select the Environment Tab that is going to edited.
  3. Click the Gear in the desired Deployment Group.
  4. The new Deployment Target should be listed. If not, ensure that the Deployment Target exists again.
  5. Select the desired Deployment Target in the drop down. Search in the search box if needed.
  6. Click the Save button.

The selected Deployment Target should show up in the Deployment Group area.

Add an Environment to a Project

  1. Navigate back to the project you would like to modify via the list page.
  2. Click the project title or, on the right side of the row, click on the vertical ellipsis and then Edit.
  3. Click on the Environments tab at the left side project display.
  4. While on the Environments tab, the new Environment name will be available down at the bottom of the list, click the + to add it and then drag and drop to order.
  5. Click the Code tab at the side of the left side project display.
  6. While on the code tab, ensure the newly added Environment is set to track the branch you would expect. For example, if you’re adding an Environment called Feature and the project has a feature branch, then the branch name should be feature.
  7. Click Save at the top of the page to finish.