Dashboards is an exciting feature that allows you to graphically visualize your entire software release workflow.
You can visualize your deployment workflow from applications on the left to the associated environment stages on the right. You can also promote an application release from the application or from one stage to the next in a stack or rollback to a previous release anywhere along the flow.
Your First Dashboard
Before you can create a dashboard you must first have at least one application with at least two environments.
- Click the Dashboard link at the top of the Pipelines web UI.
- In the Dashboard Overview page, click the New Dashboard button.
- Give your dashboard a Dashboard Name.
- Click the Create Dashboard button.
Next you will find yourself in the dashboard page for your newly create dashboard. You will also see a prompt for you to create the first column for applications on the left.
- Click the Create column for Applications link.
The default name for this first column is Applications. You can change it now or edit it later. For this document I will refer to it as the Application Column.
- Click the Save button.
You can close the helpful dialog box with the X
In the next steps you will be adding columns for deployment stages. These stages represent your deployment process during your software development lifecycle.
Here is an example when code is checked in it is automatically built and on successful build is automatically deployed to our "beta" stage. This means the deploy can be validated in beta and, as necessary, promote the release to gamma and/or production.
Dashboard Deployment Stages
To continue creating the dashboard you will now add deployment stage columns. For this example exercise let’s add three columns for the following stages:
- To begin, click the New column for Stage link.
- Name the column Test.
- Click Save to save the column.
- Create two more columns for Staging and Production.
Dashboards Apps and Environments
- In the Applications column click the Add App link.
- From the Add Application list chose one of your applications that has at least two environments.
- Click the Add button.
Take a moment to look at the information shown on this application card.
The application card provides links to:
- The application.
- The repository commit information page.
- The build logs.
- The most recent release.
- Rebuild the latest code.
- Delete this application card.
Let's add the first environment to the Test stage column.
Click the Add Env link in the Test stage column.
In the dialog drop down, select the application from step 2 above.
Now select an application environment that you would consider a Test environment.
Click the Add button.
I chose my -beta
The environment card provides useful information, including:
- How many servers are in the environment.
- What release is currently active in the environment.
- When the release was deployed to the environment.
The environment card also provides links to:
- The environment.
- A dialog that allows you to:
- Add servers.
- Remove servers.
- Set Environment Variables.
- Deployment details.
- Release details.
- Deploy, Restart, Terminate, or Promote the release.
- Delete the environment card.
Connecting Apps and Envs
Next you will connect the application to the environment to visually denote and allow promotions of releases from the application to the environment stage.
- Hover your mouse over the black dot (connector) on the right of the Applications card.
- Click and hold while dragging the dot (connector) to the right to the corresponding dot (connector) on the left of the environment in the Test stage column.
Notice the environment cards left bar turns from purple to green. This identifies a qualified connection.
- Let go of your mouse button when you have the appropriate line connecting the two cards.
Great. You have created your first line connecting an application to an environment in the Test stage.
If this application has at least one release, you will see a new command in the Application card. Let's look at the application card in more details.
Commands you can perform include:
- Promoting the current release to the connected environment(s).
- Kicking off a build of the current repository branch commit.
> **Note:** Deleting an application card does not delete the application.
> **Note:** Deleting an environment card does not delete the environment.
Building out the Dashboard
- To continue, add an environment to the Production stage column.
- In the Staging column click the Add Pass Through link.
- Now connect the environment in the Test column to the Staging column pass through.
- And finally, connect the Staging pass through to the Production column.
You can now promote a release from the Test column environment through to the Production column environment.
Also note that you can rearrange cards from one column to another. You can not move applications to a stage column nor can you move environments to the application column.
The above design was created to illustrate the features of dashboards.
Dashboards allow you to visualize your deployment workflow and strategies.
Some information you can ascertain.
You can see in the Beta stage at the bottom environment hugo-docs-beta
that release v93 is currently successfully deployed. Follow the pipeline forward through the pass through and on to the final environment in the Prod stage hugo-docs-prod
and release v89 is currently deployed.
Also interesting to note. For all three applications, the production stage environments each have 3 servers. All three applications coexist and run on the same servers.