Skip to main content
Version: Early Access

Argo Rollouts Plugin

This topic describes the tasks that are available with the Argo Rollouts plugin.

About Argo Rollouts

Argo Rollouts is a Kubernetes controller and set of CRDs, which provide advanced deployment capabilities such as Blue-Green, Canary, Canary analysis, experimentation, and progressive delivery features to Kubernetes. It (optionally) integrates with Ingress controllers and service meshes, leveraging their traffic shaping abilities to gradually shift traffic to the new version during an update. The Digital.ai Release Argo Rollouts integration lets you automate Argo Rollout tasks and provides out of the box templates for Blue-Green and Canary deployments. With this plugin, you can Orchestrate Releases, and run your applications at scale.

Prerequisites

  1. Digital.ai Release 22.2.x or later
  2. Kubernetes cluster with Argo Rollouts installed

Install the Digital.ai Argo Rollouts Plugin

  1. From the left navigation bar, click the Admin menu.
  2. Select Manage Plugins.
  3. Search for Argo Rollouts and click Install now.

    Note: If the plugin JAR file is not available in the Plugin Manager, then contact Digital.ai Support.

Connect to your Kubectl Unix host with Digital.ai Release

  1. Log on to Digital.ai Release as an Administrator.

  2. Select Connections from the sidebar navigation menu.

  3. Click the + icon next to Unix Host.

  4. Enter the title, Connection Type, Address, Port, and Auth Details.

    argo-rollouts

  5. Click Test to verify your connection to the Unix Host.

  6. Click Save if the connection is successful.

Connect to your Argo Rollouts Setup with Digital.ai Release

  1. Log on to Digital.ai Release as an Administrator.

  2. Select Connections from the sidebar navigation menu.

  3. Click the + icon next to Argo Rollouts.

  4. Enter the title, Kubectl Path, and other optional parameters.

    argo-rollouts

  5. Click Save if the connection is successful.

Argo Rollout Tasks

The following tasks are available with the Argo Rollout plugin

  • Execute Command
  • Wait For Status

Execute Command

This task lets you run any Argo Rollout command using kubectl.

  1. The task takes in parameters like the Rollouts Configuration, Host, Command and a number of optional parameters. execute command
  2. On a successful run, it returns the output of the command run.

Wait For Status

This task lets you wait for a specified Rollout status.

  1. The task takes in parameters like the Rollouts Configuration, Host, Rollout Name, Expected Status and a number of optional parameters. wait for status

  2. The tasks wait for the rollout to reach the specified status.

Blue/Green | Canary Deployment Templates

The templates let you configure and perform out of the box Blue-Green | Canary deployments with a few user inputs.

  1. The template asks user to create global variables which it uses to maintain the state of the deployments.

    1. global.blue-green.live-rollout of type Text that contains the Argo Rollout name.
    2. global.blue-green.live-imageof type Text that contains the current running image.
    3. global.blue-green.live-container of type Text that contains the container name.
    4. global.blue-green.prev-failed-image of type Text that initially is empty but later saves the failed image from previous run. or for Canary Deployment,
    5. global.canary.live-rollout of type Text that contains the Argo Rollout name.
    6. global.canary.live-imageof type Text that contains the current running image.
    7. global.canary.live-container of type Text that contains the container name.
    8. global.canary.prev-failed-image of type Text that initially is empty but later saves the failed image from previous run.
  2. The template when run asks for the New image to deploy.

  3. The template has to be run with Run automated tasks as user set to a user who has access to modify global variables.

  4. When run, the template first asks user to confirm the new image in the first phase.

  5. The second phase of the template makes a partial deployment or a review service and asks for the users confirmation to promote the deployment. The user can also chose to abort the promotion of the new version as well. blue-green-canary-deployment

  6. On successful promotion, the new applicaiton version is rolled out using the intended strategy. If the user aborts the promotion, the partial|revision deployment is rollbacked to the previous version.

Create a ArgoRollouts Canary details tile

The ArgoRollouts Canary details tile type creates a dashboard tile that displays the summary, revision, pods, and strategy details of the canary rollout.

To configure a ArgoRollouts Canary details tile:

  1. Add custom dashboard from the Dashboards menu.

  2. Click Configure > Add tile > ArgoRollouts Canary details.

  3. Click the gear icon to configure the added tile.

  4. In the Title field, enter the name for the tile.

  5. In the Rollouts Config field, select an existing argo rollout configuration.

  6. In the Namespace field, enter the name of the namespace.

  7. In the Rollout Name field, enter the name of the rollout.

    argo-rollout-canary-dashboard

Create a ArgoRollouts Blue Green details tile

The ArgoRollouts Blue Green details tile type creates a dashboard tile that displays the summary, revision, pods, and strategy details of the blue green rollout.

To configure a ArgoRollouts Blue Green details tile:

  1. Add custom dashboard from the Dashboards menu.

  2. Click Configure > Add tile > ArgoRollouts Blue Green details.

  3. Click the gear icon to configure the added tile.

  4. In the Title field, enter the name for the tile.

  5. In the Rollouts Config field, select an existing argo rollout configuration.

  6. In the Namespace field, enter the name of the namespace.

  7. In the Rollout Name field, enter the name of the rollout.

    argo-rollout-bluegreen-dashboard