☰
Conductor Documentation

Deployments View

Presents information about deployments in a single view. Contains:

Deployments View widget

Table

The table shows deployments that match the current filter. See Filtering deployments for more details on filtering.

The columns shown in the table can be shown and hidden using the widget’s configuration.

Clicking a deployment row in the table will select it and affect the contents of the Details pane and the selected marker in the map.

At the bottom of the table are controls that allow changing the number of deployments shown in a single table page, as well as moving to other pages in case there are more deployments that fit a single page.

If there is a workflow in progress for a given environment, there is a progress bar right under the row in the table.

Deployments View table progress bar

Columns

The columns can show:

  1. The deployment status represented as an icon

    • No icon - Good
    • Yellow spinner In progress icon - In progress
    • Red exclamation mark Requires attention icon - Requires attention

    See the Environments and Services section for more information on deployment statuses.

  2. ID - the deployment ID

    You can see the exact ID by hovering over the ID button. From the popup you can also copy the ID directly to your clipboard.

  3. Name - the deployment display name

  4. Blueprint Name - the name of the blueprint that this deployment is using

  5. Environment Type - the value of the csys-env-type label for that deployment

    Useful for differentiating deployments that use the same blueprint.

  6. Location - the name of the site the deployment is assigned to

  7. The counts and statuses of child deployments depending on their type (environments or services)

    See the Environments and Services section for more information on child deployments.

    The counts and statuses in those columns are based on all child deployments (it does not matter whether they are directly or indirectly attached to the main deployment).

  8. Deployment labels' values for selected label key (you can select labels' keys in widget configuration - “List of labels' keys to show in the table as columns” parameter)

Sorting deployments

Deployments in the table can be sorted by clicking a column’s header.

Clicking the column again will cycle between ascending and descending sort order.

Details pane

The right side of the widget contains details about the currently selected deployment.

In the header of the right side are:

What follows are different deployment-related widgets divided into 3 tabs:

  1. Last Execution - information about the last workflow execution for that deployment
  2. Deployment Info - general information about the deployment
  3. History - a list of workflow executions for that deployment and a list of logs

Environments and Services

For clarity and better organization, deployments can form a hierarchical structure and be marked as:

Marking the deployments happens by adding the following labels to the deployment:

  1. csys-obj-parent - the ID of the parent of the current deployment
  2. csys-obj-type - either service or environment If there is no such label, the deployment is a service by default.

Forming a hierarchical structure allows drilling down into deployments that are directly attached to a parent environment, as well as aggregating and propagating statuses of deployments for better problem discovery.

Deployment status

A single deployment’s status is:

Propagating deployment statuses

If a deployment has child deployments, then their statuses are propagated so that:

  1. If there is at least one nested deployment that requires attention, the parent’s status will be Requires attention too.
  2. Otherwise, if there is at least one nested deployment that is in progress, the parent’s status will be In progress too (unless the parent deployment itself Requires attention).

Drilling down to child deployments

If a deployment has child deployments, the drill-down buttons in the top part of the right pane become visible. Clicking them will navigate to a nested page that present the deployments (only environments or services, depending on the button clicked) from the next level in the hierarchy.

The nested page has only a single Deployments View widget, but it can be customized using the Edit Mode.

Drilling down can happen multiple times if there are more levels in the deployments hierarchy.

To go back to the parent page, use “Parent” button in the Details pane header or the breadcrumbs in top part of the page.

Drilled-down Deployments View

Features

Filtering deployments

Deployments visible in the table can be filtered in 3 ways:

  1. Typing in the search bar above the table

  2. Setting a default filter in the widget’s configuration

    This filter will be persisted and used when viewing the widget again.

  3. Applying a local filter

    By clicking the “Filter” button in the top-right corner of the widget, one can select a local filter. It will override the default filter picked in the widget’s configuration. The local filter will be reset when viewing the widget again.

Deployments Map

Clicking the Map button in the top part of the widget will open an additional map section in the top part of the widget. The map presents deployments in the sites that are attached to them.

Deployments View map

The height of the map section, as well as whether it should be open by default can be changed using the widget’s configuration.

The color of the marker representing a deployment depends on the deployment’s state:

  1. Blue - Good
  2. Yellow - In progress
  3. Red - Requires attention

The map supports zooming (when scrolling using the mouse or when using the zoom buttons in the top-left part of the map) and panning (when dragging using the mouse).

Deployments that are close together are grouped into a cluster that displays the number of deployments in that clustered group. The color of the cluster icon depends on the worst state of deployments inside of it. Clicking the marker will expand the cluster (either by zooming in or by breaking the cluster apart into individual markers).

The currently selected deployment is marked by an additonal circle underneath the marker. Such a deployment is not clustered, meaning it will appear outside of any cluster, even if it is close to other deployments.

Clicking a deployment marker will select it in the table and affect the contents of the Details pane and the selected marker in the map.

Hovering over a deployment marker will show a tooltip with additonal information:

Deployments Map tooltip

Bulk Actions

The Deployments View widget also has a Bulk Actions button in the top-right corner of the widget. It allows invoking actions over all deployments that match the current filter criteria.

Deploy On

The Deploy On bulk action will show a modal that guides the user through deploying additional services on the environments that are matched by the current filter.

The “Deployment group” field is an optional configuration to specify a name for the deployment group that will be created in order to perform the bulk action, if not specified, a template name will be generated. After indicating the Deployment group (if required), select the base blueprint for the new deployments, providing a name suffix and additional labels. A new child deployment will be created for each deployment matched by the current filter. Each generated deployment will be labeled with the Environment ID of the environment on which it is deployed as a parent label, and the capabilities of that parent environment can be retrieved using the get-environment-capability intrinsic function.

The newly created child deployments will be automatically installed.

Deploy On modal

Run Workflow

The “Run Workflow” bulk action will show a modal that allows selecting a deployment group which is optional and a workflow that will be executed on each deployment that matches the current filter and deployment group.

Run Workflow modal

Run Workflow modal

Settings