Blueprint deployments
Displays the list of the deployments in the current tenant, according to the user’s permissions. The data can be displayed as a table or list.
Features
Deployment basic information
The Deployments widget displays a list of deployments in the current tenant. The displayed information is: Deployment name, the blueprint which the deployment is derived from, the deployments creation and last update dates, the name of the user who created the deployment, and the number of node instances per state.
Last execution status
You can also quickly check status and logs of the last workflow executed on the deployment by hovering over the status icon in the top left corner of deployment. Depending on the type of the execution there are additional action buttons there.
The last execution status is indicated as follows:
- - Failed - execution has failed
- - In Progress - execution is in progress (meaning that it is in one of the following states: pending, started, cancelling, force_cancelling, kill_cancelling)
- - Cancelled - execution has been cancelled
- - Waiting - execution has been either scheduled or queued and it is waiting
- - Completed - execution has been completed
Node instances status
The status of the deployments’ node instances is indicated as follows:
- Blue - the number of node instances that are not initialized
- Yellow - the number of node instances that are in active state (one of: initializing, creating, created, configuring, configured, starting, stopping, stopped and deleting)
- Green - the number of node instances that are started
- Black - the number of node instances that are deleted
Deployment actions
The hamburger menu on the right of every deployment allows performing the following operations:
- Execute workflow on deployment
- Install/Uninstall deployment
- Update deployment
- Set site for deployment
- Delete deployment
Executing a Workflow
- Go to Execute workflow section in the menu and click the workflow you want to execute.
- Provide values for workflow parameters.
- Click Execute.
You can also use Install or Uninstall menu options to execute those specific workflows. For these two workflows you will also be able to track the progress of the execution as at the bottom of the deployment row there will be thin line visible. Progress is calculated based on number of node instances installed (in case of install workflow) or deleted (in case of uninstall workflow).
The color of the line indicates the status of the execution:
- Green - succeeded
- Yellow - in progress
- Red - failed
Each of the default workflows are described in detail here.
Updating a Deployment
- Click Update in the action menu.
- Select the blueprint for the updated deployment.
- Select the inputs file for the blueprint or provide values for the inputs.
- Set actions to be performed during the update or use defaults.
- Click Update.
For more information about updating a deployment, click here.
For more information about creating custom workflows, click here.
Setting a Site
- Click Set Site in the action menu.
- Select a new site for the deployment. The selected site must be in the same visibility context as the deployment or in a higher visibility context. (i.e. both site and deployment are in the same tenant or the site is defined as global)
- Click Update.
For detaching the current site, leave the Site name
input empty and toggle the Detach
button.
Deleting a Deployment
- Click Delete or Force Delete in the action menu.
- When prompted for deployment removal confirmation, click Yes.
Deployments details
Clicking on a deployment’s name will bring us to deployment’s drill-down page, which provides additional data about the deployment.
By default, that page displays the following:
- Deployment Info widget
- Deployment Action Buttons widget
- 3 tabs with deployment details:
- Last Execution tab with the following widgets:
- Executions (configured to display only task graph of the last execution)
- Deployment Events/Logs filter
- Deployment Events/Logs
- Deployment Info tab with the following widgets:
- History tab with the following widgets:
- Executions (configured to display list of executions)
- Deployment Events/Logs filter
- Deployment Events/Logs
- Last Execution tab with the following widgets:
Settings
Refresh time interval
- The time interval in which the widget’s data will be refreshed, in seconds. Default: 10 secondsEnable click to drill down
- This option enables redirecting to the deployment’s drill down page upon clicking on a specific deployments. Default: OnShow execution status label
- Allows showing last execution workflow ID and status near last execution status icon. Default: OffBlueprint ID to filter by
- Allows filtering the deployments in this list to those derived from a specific blueprint, by providing its ID (the blueprint ID is its name). Default: emptyDisplay style
- Can be either list or table. The deployments status column is only available in list mode. Default: List