Skip to content
PDF

Deploy Menu#

Workloads that have been provisioned in the Management System are ready to be deployed to nodes. However, before tackling how to deploy workloads to nodes, let's take a look at the Deploy menu. It offers three sub-menus:

!Deploy Menu

Item Description
Deploy This is the landing page of the deploy menu. You can deploy workloads to nodes from here.
Log This is the history of deployments and dry runs.
Dry run Structurally the same as the deployment process for workloads, you can simulate the deployment of a workload from this menu.

Log#

The log is the history of deployments and dry runs. This includes:

  • deployments in progress
  • dry runs in progress
  • failed deployments
  • failed dry runs
  • successful deployments
  • successful dry runs

It is displayed in reverse chronological order and can be filtered according to search criteria. It also offers some control functionality for active and failed deployments.

!Log

Item Description
Search by name (1) Enter text here to filter the list by deployment name.
Deployment Type (2) Select an option from the drop-down menu to filter the list for Deploys or Dry runs.
Workload Type (3) Select an option from the drop-down menu to filter the list for a specific workload type: VM, Docker or CODESYS.
DEPLOYMENT NAME (4) This is the name of the deployment you have defined in the deployment process. Please note that this is not the name of the workload.
ACTION (5) Here the deployment type is displayed: Deploy or Dry run.
PROGRESS (6) The progress bar is an indicator for both progress and status. Depending on the status of the workload it changes its color:
  • Green
    If a workload was deployed successfully, the bar will be green at a 100%.
  • Blue
    If a workload is currently being deployed, the bar will be blue, fill up gradually and display the progress of the deployment in percent.
  • Red
    If the deployment of a workload has failed, the bar will be red at a 100%.
STARTED (7) This is the date and time the workload deployment was started. The date format is DD/MM/YYYY.
FINISHED (8) This is the date and time the workload deployment was completed. The date format is DD/MM/YYYY.
This field also shows if a workload is in progress of being deployed. In that case it will show In progress.
Ellipsis menu (9) Select the ellipsis menu to trigger an overlay with the DELETE option. Selecting DELETE will remove the entry from the log. When a workload is in progress, this symbol is grayed out.
Rows per page (10) Specify how many log entries are displayed on one page. You can select 5, 10 or 15 workloads per page.
Page navigation (11) Use the arrows to switch between pages. Clicking the number in the middle opens a list of all page numbers. Selecting a number jumps to that page.

Deployment Details#

Clicking an entry in the log will show you the details of the deployment.

!Deployment Details

Item Description
Back button (1) Click here to return to the log.
Header (2) The header states the name of the deployment. Details of deployment <deploymentname>.
Search (3) Enter text here to filter the Operation task list by device name. The search function can be combined with the status checkboxes to the right of the search bar.
Status checkboxes (4) The checkboxes to the right of the search bar filter the Operation task list by status:
  • Success
    Deployments that were completed successfully are shown in the list if this checkbox is ticked.
  • In progress
    Deployments that are currently in progress are shown in the list if this checkbox is ticked.
  • Failed
    Deployments that could not be completed are shown if this checkbox is ticked.
  • Canceled
    Deployments that have been aborted by the user are shown in the list if this checkbox is ticked. However, it is not possible to cancel deployments in this version.
If a checkbox is ticked, tasks with the corresponding status will be displayed in the operation task list. All checkboxes are ticked by default.
Deployment information (5) This is information about the deployment.
  • Workload name
    The name of the workload that has been defined in the provisioning process.
  • Workload version
    The name of the workload version.
  • Operation start time
    This is the date and time the workload deployment was started. The date format is DD/MM/YYYY.
  • Operation finish time
    This is the date and time the workload deployment finished. The date format is DD/MM/YYYY.
  • Release name
    This is the release name of the workload version.
  • Type
    This is the type of the workload that has been deployed: codesys, vm or docker.
  • Status
    This is the status of the deployment. Possible statuses are Created, In progress, Completed, Error, Canceled.
  • Progress
    The progress of the deployment in percent.
Operation task list (6) The operation task list displays every deployment that is part of the deployment. The list displays information in six columns:
  • DEVICE
    This is the serial number of the node that is the target of the deployment.
  • STATUS
    This is the status of the deployment. The information in this column here corresponds with the checkboxes to the right of the search bar: Success, In progress, Failed and Canceled
  • PROGRESS
    This is the progress bar. It displays a different color and gradually fills up according to the progress and status of the deployment.
    • Success
      If a workload was deployed successfully, the bar will be green at a 100%.
    • In progress
      If a workload is currently being deployed, the bar will be blue and display the progress of the deployment in percent.
    • Failed
      If the deployment of a workload has failed, the bar will be red at a 100%.
  • RETRY COUNTER/MAX
    In case of failure, the Management System will attempt the deployment of a workload up to three times automatically. The left number of the counter shows the number of the current attempt. The right number is the maximum number of attempts.
  • STARTED
    This is the date and time the workload deployment was started. The date format is DD/MM/YYYY.
  • FINISHED
    This is the date and time the workload deployment was finished. The date format is DD/MM/YYYY.
Rows per page (7) Specify how many deployments are displayed on one page. You can select 5, 10 or 15 deployments per page.
Page navigation (8) Use the arrows to switch between pages. Clicking the number in the middle opens a list of all page numbers. Selecting a number jumps to that page.

Restarting a Failed Deployment#

In case a deployment fails, the Management System will attempt the deployment of a workload up to three times automatically. After that, the deployment can be restarted manually through the ellipsis menu in the operation task list.

  1. Select Deploy > Log from the menu on the left.
  2. Select the failed deployment from the log.

    !Failed Deployment

  3. Choose the failed deployment from the operation task list.

  4. Select the ellipsis menu to the right of the deployment entry.
  5. Select RESET in the overlay that appeared.

    !Reset Deployment

The deployment is restarted immediately. If you want to see error information of the deployment, select FEEDBACK in the overlay of the ellipsis menu instead.

!Feedback to Deployment

This opens a window giving information on the type of error in a message, a short troubleshooting hint and the time the error occurred. Please note that troubleshooting hints are not available for every feedback message.

!Feedback to Deployment

Note

If you would like to restart all deployments at once, click the ellipsis menu next to the status checkboxes and select RESET ALL TASKS from the overlay that appears.

!Restart All Tasks

Deploying Workloads and Dry Runs#

Deployment of workloads and dry runs are covered in a separate chapter: Deploying a Workload.