Skip to main content
Version: Release 24.3

Helm Container Plugin

The Helm container plugin allows you simplify the deployment and management of applications on Kubernetes clusters. It allows you to define, install, upgrade, and rollback the Kubernetes applications.

important

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

note

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

Helm provides the following features:

  • Command (Container)
  • Install/Upgrade (Container)
  • Rollback (Container)
  • Uninstall (Container)

Prerequisites​

For Helm integration, you need the following:

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

Set up Connection to Helm Server​

  1. From the navigation pane, under CONFIGURATION, click Connections.
  2. Under HTTP Server connections, next to Helm: Configuration (Container), click add button. The New Helm: Configuration (Container) page opens.
  3. In the Title field, enter the name of the configuration. This name will display in Helm tasks.
  4. In the Server URL field, enter the URL of the Kubernetes API server.
  5. In the Certificate Authority field, enter the trusted root certificate for server in base64 format. Alternatively, you can create a variable and use it here.
  6. If you select the Chart Insecure Connection checkbox, it will skip the TLS certification check when you download the helm chart.
  7. Two authentication methods available, do one of the following:
    • Token
    • ConfigFile
  8. To test the connection, click Test.
  9. To save the configuration, click Save.

Create Helm Configuration

Command (Container)​

The Command (Container) task is used to run the helm commands to manage your helm charts.

  1. In the release flow tab of a Release template, add a task of type Helm > Command (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 Helm Config field, select the Helm configuration.
  5. In the Command field, enter the helm command that you want to run to manage your helm charts.
  6. Switch on the Output Json toggle, if your helm command supports the --output flag.

Command Container

Install/Upgrade (Container)​

The Install/Upgrade (Container) task is used to install or upgrade your helm charts.

  1. In the release flow tab of a Release template, add a task of type Helm > Install/Upgrade (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 Helm Config field, select the Helm configuration.
  5. In the Release Name field, enter the name of the Helm release.
  6. In the Chart Name field, enter the name of the Helm chart.
  7. In the Chart Version field, enter the version of the Helm chart.
  8. In the Namespace field, enter the Kubernetes namespace where you will install or upgrade the Helm chart.
  9. In the Repository URL field, enter the URL of the Helm chart repository.
  10. In the Username field, enter the username to access your Helm chart repository.
  11. In the Password field, enter the password to access your Helm chart repository.
  12. You can switch on the Dry Run with Client toggle to simulate an installation with the client.
  13. You can switch on the Dry Run with Server toggle to simulate an installation with the server.
  14. In the Command Flags field, you can add some additional commands that you want to add in your Helm command.
  15. You can use the Input variables table to create some key-value pairs as input variables to be used in the Helm configuration.

Install/Upgrade Container

Rollback (Container)​

The Rollback (Container) task is used to roll back your helm charts.

  1. In the release flow tab of a Release template, add a task of type Helm > Command (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 Helm Config field, select the Helm configuration.
  5. In the Release Name field, enter the name of the Helm release that you want to roll back.
  6. In the Revision field, enter the revision number of the Helm chart that you want to roll back.
  7. In the Namespace field, enter the Kubernetes namespace from where the Helm chart will be rolled back.
  8. In the Command Flags field, you can add some additional commands that you want to add in your Helm command.

Rollback Container

Uninstall (Container)​

The Uninstall (Container) task is used to uninstall your helm charts.

  1. In the release flow tab of a Release template, add a task of type Helm > Command (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 Helm Config field, select the Helm configuration.
  5. In the Release Name field, enter the name of the Helm release that you want to uninstall.
  6. In the Namespace field, enter the Kubernetes namespace from where the Helm chart will be uninstalled.

Uninstall Container