Setting up dashboards

Sections

Dashboards allow you to graphically visualize your entire software release workflow.

With dashboards you graphically lay out your deployment strategy. Dashboards give you insight into what is currently deployed and what is available for deployment.

Dashboard Example

Dashboards can represent a single application with multiple environments, as above. And a dashboard can visualize multiple applications all at the same time, as below.

Dashboard Example

Create a dashboard

To create a dashboard in the Pipelines web UI:

  1. Click Dashboards at the top of the web UI.
  2. Click the New Dashboard button.
  3. Give your dashboard a Dashboard Name and Dashboard Description.
  4. Click the Create Dashboard button.
  5. You have created a dashboard.

    By default an initial Application column will be created on the left. This will need a name before you can continue.

  6. Click on the column header. There is a dialog box "Add an Application" pointing at the column header.
  7. Add application column
  8. Enter a name for the column. Note that "Applications" is the default recommended name.
  9. Click the Save button.

Add application column

Working with the application column

The leftmost column in a dashboard is the application column.

Rename the application column

The application column is created by default but needs to be named on creation

  1. Navigate to the dashboard whose application column name you wish to change.
  2. Click the edit icon.
  3. dashboard
  4. Edit the column name.
  5. Press Enter to save your changes.

Add an application card

You add applications in the form of cards to the application column.

  1. Navigate to the dashboard where you wish to add an application card.
  2. At the bottom of the application column click the Add App link.
  3. add application card
  4. Select the application you wish to add to your dashboard.
  5. If this application has a connected repository, you will be prompted to choose a branch. Choose a branch.
  6. Click the Add button to add the application card.

Working with environment stage columns

All columns in a dashboard besides the leftmost application column are environment stage columns.

Add an environment stage column

You can create as many stages as necessary.

  1. Navigate to the dashboard where you wish to add an environment column.
  2. Find the rightmost empty column and click New column for Stage.
  3. dashboard stage
  4. Give the stage column a name.
  5. Click the Save button to save your changes.

Rename the environment column

  1. Navigate to the dashboard whose environment stage column name you wish to change.
  2. Click the edit icon on that column header.
  3. dashboard
  4. Edit the column name.
  5. Press Enter to save your changes.

Add an environment card

All columns besides the Application column on the far left of the dashboard are Environment stage columns.

  1. Navigate to the dashboard where you wish to add an environment card.
  2. At the bottom of the environment stage column, click the Add Env link.
  3. add environment card
  4. In the dialog select the application that contains the environment you wish to add.
  5. Select the environment that you wish to add.
  6. Click the Add button to add the environment card.

Connect cards in a dashboard

Connecting application cards to environment cards and environment cards to the subsequent environment provides a visual workflow your your release deployment strategy.

  1. Navigate to the dashboard where you wish connect cards.
  2. Find the card on the left that you wish to connect to a card on the right and with your mouse grab the black dot connector and drag it right.
  3. Note, when you have a valid connection, the receiving connector will hightlight in green.

    add connection
  4. Drop the pipe connector on top of the receiving end black dot connector to complete the connection.

Add a column pass-through card

Connecting application cards to environment cards and environment cards to the subsequent environment provides a visual workflow your your release deployment strategy.

To skip a stage column you must use a pass-through card.

When making dashboard connections you cannot drag across a stage.

bad environment example

You must instead add a pass through card to pass through the stage.

passthrough

  1. Navigate to the dashboard where you wish connect cards.
  2. Find the stage you wish to traverse through and click the Add Pass Through link.

Move a card

When working with dashboard cards you can drag application cards up and down in the application column. You can drag environment cards up and down, and between stage columns. This includes dragging pass-through cards too.

  1. Navigate to the dashboard where you wish to move cards.
  2. Find the card you wish to move and "click and hold" your mouse on the card as you drag it to its destination.
  3. Let the mouse button go to drop the card.

Delete a card

Deleting application and environment cards in a dashboard will not delete the application or environment. You delete application, environment, and pass-through cards the same way.

  1. To delete a card in a dashboard click the X on the bottom right of the card.
  2. You will be prompted for confirmation.

  3. Click Yes in the confirmation dialog.
How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.