Build Your Environments

How to Add Environments for Deployments

Intro to Environments

Environments represent where you execute your Application and Components such as a Kubernetes Cluster for Dev, Test or Production. An Environment could be a virtual cloud or physical datacenter. Applications run in many Environments to support your Pipeline states.

Note: First define Endpoints to be assigned before you can define an Environment.

Environments and Domains

Environments are associated to a Domain. You can assign Environments to any level of Domain including the Global Domain. However, Environments are most commonly associated to a Project Domain used for Applications. A Project Domain is used to manage an Application and may be defined to include Life Cycle Subdomains for managing your Application’s progression from development through release.

Use the Environment List View to Add and Delete

The Environment menu is on the left of the main panel. Select the Environment menu, to view a list of all Environments to which you have access. The Search bar, represented by a funnel icon, allows you to reorder Environments based on Name or Domain.

The Environments List View has the following Tabs.

Tab Description
Refresh Refreshes the browser.
Add Allows you to Add a new Environment.
Delete Deletes the selected item.
Reports Success or Failed Report: This report shows an ongoing list of all deployments to all Environments, regardless of Domain or Application with success or fail status. This report can be sorted based on the column for easy viewing. It can also be exported.

Double click on an item in the list to see the Dashboard view.

Use the Environment Dashboard to View and Edit

The Dashboard view displays all information related to a specific Environment. The Dashboard view has one additional tab option - Calendars. Below are the Details for an Environment.

Environment Details

Field Description
Full Domain The fully qualified name of the Domain, including all parent Domains.
Name The name of the Environment. Note: Duplicate Names are restricted. It is recommended that Environments be named in a specific manner, such as ‘DevEnv-HipsterStore.’
Owner Type User or Group
Owner The owner defaults to the User or Group who created it.
Summary A short text description of the Environment.
Availability (DeployHub Pro feature) This field interacts with the Environment calendar making the Environment open for deployments at anytime, or closed for all deployments unless scheduled. The default value, “Always Available Unless Denied by Calendar”, allows the User to deploy Applications into the Environment unless there is an entry in the Calendar that prevents stops it. The other value, “Always Unavailable Unless Denied by Calendar”, doesn’t allow deployments unless a specific entry in the Calendar is approved.
Created Auto generated date and time the Environment was created.
Modified Auto generated date and time the Environment was last modified.

Endpoint Access Control

The Access Section allows Users within designated Groups to update the Environment. To add a Group to one of the access lists, drag and drop the Group from the Available Groups list onto desired access list. All Users who belong to a Group that appear in one of the Access lists will be granted access to the Environment in the following ways:

Access Description
View Allows the User to see the Environment. If the User does not belong to a Group in the View Access list, the Environment will not appear in the List View.
Change Allows the User to change the Environment’s characteristics i.e. Name, Summary, etc.
Create Calendar Entries Allows Users to control the Calendar for the selected Environment. NOTE: Securing Environment Calendars is only available in DeployHub Pro.
Deploy Allows Users to deploy Applications into the selected Environment.

Audit Trail

The Audit Trail displays audit entries for any changes or deployments that impact this object. It includes all changes in the object including User date and time, and deployments with unique numbers.

For deployment audits, select a deployment number to see the details including:

Access Description
Log The output of the deployment.
Files Any files or objects deployed.
Step Duration Deployment Steps with time required to execute.
Feedback Loop Shows what was updated starting from Component.

You can also Subscribe or Comment to an Audit Entry.

  • Subscribe: Allows you to receive information about the selected deployment.

  • Comment: Click on ‘Comment’ to add information. There is a field above the list labeled “Say something about this Application” that can have comments placed into it, and files can be attached to the comment as well. Entering text into this field activates the Add Message button. Click to save the comment as a line in the list.

  • Add Files to Comments: Click on the paperclip icon to add a file to the message. Once done, click on the “Add Message” button. These attachments can later be retrieved by clicking on the paperclip icon which then displays the name of the file within a list. Choose the file to download it into the your default Download directory on your local computer.

Key Value Configurations

Key Value Configurations are Value Pairs for managing associative arrays assigned to the Object.

Key Value Pairs can be assigned at multiple levels, from the Global Domain down to an individual Component and have a “scope.” Lower level Objects can override a higher level Object. Below is the order in which Key Value Pairs can be overridden:

Object Description
Global Contains all Environment variables and any “additional Key Value Pairs” set by the user when running that task.
Environment Overrides any Global Key Value Pairs during a deployment.
Application Overrides the Environment Key Value Pairsduring a deployment.
Endpoint Overrides the Application Key Value Pairs during a deployment.
Component Overrides the Application Key Value Pairs during a deployed.

Key Value Pairs can be given any Name and a Value. Use +Add to add Key Value Pairs to the table. Use Save to confirm. Use the checkbox to Delete or Edit a Key Value Pair.

Assigned Endpoints

Note: You will need to have pre-defined your Endpoints. See the Define Your Endpoints chapter for more information.

Environments are a collection of Endpoints. Use this section to assign the Endpoints that will make up this Environment. Use +Add to create a new row in the Endpoints table. Use Save to commit the row. Select the row and use Edit or Delete to update or remove an Endpoint. When you add a new Endpoint the Hostname will be displayed. The Hostname is the actual network name or IP address. It is assigned when the Endpoint is defined, but is not a required field. If it is defined, it will be displayed in the row.

This section shows the success/failure rate and time required for the last 10 deployments to this Environment.

Assigned Applications

View all the Application Base Versions assigned to this Environment. This is read only. Applications Base Versions are associated to Environments when created using the Application Dashboard.

Deployed Components to Environment Map

This map shows you all of the current Component Versions, with Application Versions, that have been deployed to this Environment.

Environment Calendars Tab

DeployHub Team Calendar only shows you a history of what has already been deployed.

DeployHub Pro users have access to “Smart” Calendars. For more information see DeployHub Pro Smart Calendars.

Last modified July 9, 2020: small cleanup (b45ee8f)