The HelmDeploy step deploys a Docker image to a Kubernetes cluster using a Helm chart.
The Helm chart used to deploy the image through this native step can be either:
A HelmChart resource that identifies a Helm chart stored in an Artifactory repository by HelmPublish.
A Helm chart in a source code repository identified by a GitRepo resource.
When properly configured, the HelmDeploy step also performs a replace_envs operation on all files specified under the valueFilePaths
tag to replace all environment variables in those files with their values. This enables the step to derive information from a resource, such as the image name and tag from an Image, and use it to perform the deployment.
The HelmDeploy step uses the helm upgrade
command to perform the deployment.
YAML Schema
The YAML schema for HelmDeploy native step is as follows:
HelmDeploy
pipelines: - name: <string> steps: - name: <string> type: HelmDeploy configuration: #inherits all the tags from bash helmVersion: <2 | 3> # optional, defaults to 2 namespace: <string> # optional, namespace to which to deploy flags: <string> # optional valueFilePaths: # optional - <path and filename> releaseName: <string> chartPath: <path string> # optional, may be required for certain input resources chartName: <path string> # optional, may be required for certain input resources chartVersion: <path string> # optional, may be required for certain input resources dryRun: <true | false> # optional, only deploys if the dryrun is success lint: <true | false> # lints chart before upgrade, default false lintFlags: “--strict” test: <true | false> # runs helm test after upgrade, default false testFlags: “--parallel” integrations: - name: <kubernetes integration> # required inputResources: - name: <HelmChart, GitRepo, FileSpec, BuildInfo or ReleaseBundle resource> # required, one input resource from this list is required # HelmChart and GitRepo input resources are allowed together execution: onStart: - echo "Preparing for work..." onSuccess: - echo "Job well done!" onFailure: - echo "uh oh, something went wrong" onComplete: #always - echo "Cleaning up some stuff"
Tags
name
An alphanumeric string (underscores are permitted) that identifies the step.
type
Must be HelmDeploy
for this step type.
configuration
Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinenttags:
Tag | Description of usage | Required/Optional |
---|---|---|
| Must specify a Kubernetes Integration. or Must specify an Artifactory Integration when | Required May be required |
| Must specify HelmChart, GitRepo, FileSpec , BuildInfo or ReleaseBundle resource that contains a Helm chart. Can also specify a second input resource of type GitRepo containing Helm values files, if HelmChart was provided as the other input resource. | Required |
In addition, these tags can be defined to support the step's native operation:
Tags derived from Bash
All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.
Tag | Description of usage | Required/Optional |
---|---|---|
| A number representing the major version of Helm to use. Can be 2 or 3. Defaults to 2. | Optional |
| The namespace to which to deploy. This will be added to the deploy command as a | Optional |
| A flag string to be included in the Helm command. For example: "--set key=’value’ -f myTestValues.yaml" | Optional |
| Specifies values YAML file(s) for use with a--values (-f) option of the helm install command. All environment variable referenced in the specified file(s) are automatically replaced with values of matching runtime environment variables. | Optional |
| The release name. Equivalent to the --name (-n) option of the helm install command. | Required |
| The path to the Helm chart in the NoteDo not use when a HelmChart resource is specified. | May be required |
| The name of the Helm chart in the NoteDo not use when a HelmChart/GitRepo resource is specified or when your input resource is not an Artifactory Helm repository. | May be required |
| The name of the Helm chart in the NoteDo not use when a HelmChart/GitRepo resource is specified or when your input resource is not an Artifactory Helm repository. | May be required |
| When true, only deploys if the --dry-run install simulation is successful. Defaults to | Optional |
| When set to true, performs a lint to examine a chart for possible issues. Defaults to | Optional |
| Flag string to pass to the | Optional |
| When set to true, performs a test to run the tests for release. Defaults to | Optional |
| Flag string to pass to the | Optional |
execution
Declares collections of shell command sequences to perform for pre- and post-execution phases:
Tag | Description of usage | Required/Optional |
---|---|---|
| Commands to execute in advance of the native operation | Optional |
| Commands to execute on successful completion | Optional |
| Commands to execute on failed completion | Optional |
| Commands to execute on any completion | Optional |
The actions performed for the onExecute
phase are inherent to this step type and may not be overridden.
Examples
The following examples show how to configure a HelmDeploy step.
Helm 3 and HelmChart Resource Input
A HelmDeploy step using Helm 3 and a HelmChart resource input.
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace releaseName: myHelmRelease integrations: - name: kubernetes_integration inputResources: - name: helmChartResource
Dry Run
A HelmDeploy step using Helm 3 and a HelmChart resource input with values files and a dry run before the deployment.
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace releaseName: myHelmRelease dryRun: true valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration inputResources: - name: helmChartResource
GitRepo Input
A HelmDeploy step with a GitRepo input instead of a HelmChart and lint and test commands.
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace chartPath: "./myChart" releaseName: myHelmRelease lint: true lintFlags: "--strict" test: true testFlags: "--parallel" valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration inputResources: - name: gitRepoResource
FileSpec Input
A HelmDeploy step with a FileSpec input resource. When using the FileSpec input resource, use the chartPath
property to specify where the Helm chart file is in the FileSpec resource. If the FileSpec represents a Generic repository in Artifactory that contains the Helm chart, use the following configuration as a reference:
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace chartPath: "./myChart" releaseName: myHelmRelease lint: true lintFlags: "--strict" test: true testFlags: "--parallel" valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration inputResources: - name: fileSpecResource
If the FileSpec input resource represents a Helm repository in Artifactory, you will also need toprovide the chartName
andchartVersion
configuration properties:
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace chartPath: "./myChart" chartName: "myChartName" chartVersion: 0.0.1 releaseName: myHelmRelease lint: true lintFlags: "--strict" test: true testFlags: "--parallel" valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration inputResources: - name: fileSpecResource
BuildInfo Input
A HelmDeploy step with a BuildInfo input resource. When using the BuildInfo input resource, use the chartPath
property to specify where the Helm chart file is in the BuildInfo resource. If the BuildInfo represents a Generic repository in Artifactory that contains the Helm chart, use the following configuration as a reference:
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace chartPath: "./myChart" releaseName: myHelmRelease lint: true lintFlags: "--strict" test: true testFlags: "--parallel" valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration inputResources: - name: buildInfoResource
If the BuildInfo input resource represents a Helm repository in Artifactory, you will also need toprovide the chartName
and chartVersion
configuration properties:
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace chartPath: "./myChart" chartName: "myChartName" chartVersion: 0.0.1 releaseName: myHelmRelease lint: true lintFlags: "--strict" test: true testFlags: "--parallel" valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration inputResources: - name: buildInfoResource
ReleaseBundle Input
A HelmDeploy step with a ReleaseBundle input resource. When using the ReleaseBundle input resource you will need to specify where the Helm chart file is in the ReleaseBundle resource using the chartPath property.
If the ReleaseBundle represents a Generic repository in Artifactory that contains the Helm chart, please use the following configuration as a reference:
Artifactory integration is required
You must specify an Artifactory Integration when ReleaseBundle
is the inputResource
to HelmDeploy
step. This integration will point to the Artifacoty that will be the source to download the ReleaseBundle that will be used in this step.
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace chartPath: "./myChart" releaseName: myHelmRelease lint: true lintFlags: "--strict" test: true testFlags: "--parallel" valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration - name: artifactory_integration inputResources: - name: releaseBundleResource
If the ReleaseBundle input resource represents a Helm repository in Artifactory, you will also have to specify chartName and chartVersion configuration properties:
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 3 namespace: my-namespace chartPath: "./myChart" chartName: "myChartName" chartVersion: 0.0.1 releaseName: myHelmRelease lint: true lintFlags: "--strict" test: true testFlags: "--parallel" valueFilePaths: - values/values1.yaml - values/values2.yaml integrations: - name: kubernetes_integration - name: artifactory_integration inputResources: - name: releaseBundleResource
Helm 2
A HelmDeploy step using Helm 2.
HelmDeploy
pipelines: - name: helmDeployPipeline steps: - name: helmDeployStep type: HelmDeploy configuration: helmVersion: 2 namespace: my-namespace releaseName: myHelmRelease integrations: - name: kubernetes_integration inputResources: - name: helmChartResource
How it Works
When you use the HelmDeploy native step in a pipeline, it performs the following functions in the background:
helm init --client-only (if the Helm version is 2)
jfrog rt config (if there is a HelmChart resource input, to configure the JFrog CLI with the Artifactory credentials)
jfrog rt use (if there is a HelmChart resource input, to set the current default Artifactory configuration)
helm fetch (if there is a HelmChart resource input and the Helm version is 2, to fetch the chart)
helm pull (if there is a HelmChart resource input and the Helm version is 3, to fetch the chart)
replace_envs (if there are valueFilePaths, to replace variable placeholders)
helm lint (if lint is true)
helm --dry-run (if dryRun is true)
helm (deploy)
helm test (if test is true)