Deploy Container Plugin

The Deploy container plugin allows you to start a deployment of an application on Deploy.

important

You must set up a connection to the Deploy server before adding Deploy tasks. For more information, see Set up Connection to Deploy Server.

note

In the release flow editor, Container tasks have a blue border.

Deploy plugin provides the following features:

• Control Task (Container)
• Create Directory (Container)
• Deploy (Container)
• Get All Versions (Container)
• Get Last Deployed Version (Container)
• Get Latest Version (Container)
• Import package (Container)
• Migrate package (Container)
• Undeploy (Container)

Prerequisites

For Deploy integration, you need the following:

• Deploy server running and accessible via HTTP(s)
• Digital.ai Release Runner setup to run the container tasks

Set up Connection to Deploy Server

1. From the navigation pane, under CONFIGURATION, click Connections.
2. Under HTTP Server connections, next to Digital.ai Deploy Server, click . The New Digital.ai Deploy Server page opens.
3. In the Title field, enter a name for the configuration.
4. In the Authentication Method field, select your relevant authentication type from the drop-down list.

• PAT
• Basic
• Ntlm
• Bearer

6. For Basic, you can enter Username and Password.
7. For others, you can enter the proxy details.
8. To test the connection, click Test.
9. To save the configuration, click Save.

Control Task (Container)

This task is used to manage and control the execution of other tasks. It is typically employed for task orchestration and workflow management.

Create Directory (Container)

This task creates a directory in the specified location. It is used to set up necessary folder structures in a deployment environment.

Deploy (Container)

The Deploy (Container) task allows you to deploy an application.

1. In the release flow tab of a Release template, add a task of type Digital.ai Deploy > Deploy (Container).
2. Click the added task to open it.
3. In the Capabilities field, enter a value that matches the capability set for your Runner. This will help you to route jobs to that particular Runner.
4. In the Server field, select the configured Deploy server.
5. In the Application field, enter the ID of the application to deploy.
6. In the Version field, enter the version of the application to deploy.
7. In the Package field, enter the package name of the application to be deployed.
8. In the Environment field, enter the name of the environment where the application must be deployed.
9. If you select the Continue If Step Fails toggle, you can retry the task even if the step fails. This is not selected by default.
10. In the Number Of Continue Retrials field, enter a value to define the number of times you can retry the task if the step fails.
11. In the Polling Interval field, enter the polling interval in seconds to check the task status.
12. In the Polling Retry Count field, enter a value to define the number of times you can retry to check the task status.
13. In the Connection Retries field, enter a value to define the number of times you can retry the task in case of a connection failure/timeout.
14. The following toggles are enabled by default:

• Display Step Logs
• Rollback on Failure
• Rollback on Abort
• Cancel If Not Rolling Back
• Fail On Pause

15. If you select the Reuse previous output properties toggle, when you retry you can use the same Deploy task ID. This is not selected by default.

Get All Versions (Container)

The Get All Versions (Container) task allows you to get all the version of the deployed application.

1. In the release flow tab of a Release template, add a task of type Digital.ai Deploy > Get All Versions (Container).
2. Click the added task to open it.
3. In the Capabilities field, enter a value that matches the capability set for your Runner. This will help you to route jobs to that particular Runner.
4. In the Server field, select the configured Deploy server.
5. In the Application ID field, enter the ID of the application to deploy.
6. If you select the Throw on Fail toggle, the task will fail if the configuration item does not exist. This is not selected by default.

Get Last Deployed Version (Container)

This task retrieves the last deployed version of a package in Digital.ai Deploy. It is used to identify the most recent version that has been deployed.

Get Latest Version (Container)

This task fetches the latest deployment package version for an application in Digital.ai Deploy. It is used to determine the most current version available for deployment.

Import Package (Container)

This task imports a package from a remote URL. It is used to bring a package into Digital.ai Deploy from an external source.

Migrate Package (Container)

This task migrates a package from one Digital.ai Deploy server to another. It is used to transfer deployment packages between different environments or servers.

Undeploy (Container)

This task executes an undeployment in Digital.ai Deploy. It is used to remove a previously deployed package from the environment.