HelmDeploy

Overview

TheHelmDeploystep deploys a Docker image to aKubernetescluster using a Helm chart.

The Helm chart used to deploy the image through this native step can be either:

AHelmChartresource that identifies a Helm chart stored in an Artifactory repository byHelmPublish.
A Helm chart in a source code repository identified by aGitReporesource.

When properly configured, the HelmDeploy step also performs areplace_envsoperation on all files specified under thevalueFilePathstag 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 anImage, and use it to perform the deployment.

The HelmDeploy step uses thehelm upgradecommand to perform the deployment.

Tags derived from Bash

本机所有步骤来自theBashstep. 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 theBashstep definition, since it's the core of the definition of all other steps.

Page Contents

YAML Schema

The YAML schema for HelmDeploy native step is as follows:

HelmDeploy

pipelines: - name:  steps: - name:  type: HelmDeploy configuration: #inherits all the tags from bash; //www.si-fil.com/confluence/display/JFROG/Bash helmVersion: <2 | 3> # optional, defaults to 2 namespace:  # optional, namespace to which to deploy flags:  # optional valueFilePaths: # optional -  releaseName:  chartPath:  # optional, may be required for certain input resources chartName:  # optional, may be required for certain input resources chartVersion:  # optional, may be required for certain input resources dryRun:  # optional, only deploys if the dryrun is success lint:  # lints chart before upgrade, default false lintFlags: “--strict” test:  # runs helm test after upgrade, default false testFlags: “--parallel” integrations: - name:  # required inputResources: - name:  # 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

Analphanumericstring (underscores are permitted) that identifies the step.

type

Must beHelmDeployfor this step type.

configuration

Specifies all configuration selections for the step's execution environment.This step inherits theBash/PowerShellstep configuration tags, including these pertinenttags:

Tag

Description of usage

Required/Optional

integrations

Must specify aKubernetes Integration.

or

Must specify anArtifactory IntegrationwhenReleaseBundleis theinputResourceto the step.

Required

May be required

inputResources

Must specifyHelmChart,GitRepo,FileSpec,BuildInfoorReleaseBundleresource that contains a Helm chart.
Can also specify a second input resource of typeGitRepocontainingHelm values files, ifHelmChartwas provided as the other input resource.

Required

Tags derived from Bash

本机所有步骤来自theBashstep. 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 theBashstep definition, since it's the core of the definition of all other steps.

In addition, these tags can be defined to support the step's native operation:

Tag	Description of usage	Required/Optional
`helmVersion`	A number representing the major version of Helm to use. Can be 2 or 3. Defaults to 2.	Optional
`namespace`	The namespace to which to deploy. This will be added to the deploy command as a`--namespace`parameter.	Optional
`flags`	A flag string to be included in the Helm command. For example: "--set key=’value’ -f myTestValues.yaml"	Optional
`valueFilePaths`	Specifies values YAML file(s) for use with a--values (-f) option of thehelm installcommand. All environment variable referenced in the specified file(s) are automatically replaced with values of matching runtime environment variables.	Optional
`releaseName`	The release name. Equivalent to the --name (-n) option of thehelm installcommand.	Required
`chartPath`	The path to the Helm chart in the`GitRepo/FileSpec/BuildInfo/ReleaseBundle`resource specified in`inputResources`. Do not use when a HelmChart resource is specified.	May be required
`chartName`	The name of the Helm chart in the`FileSpec/BuildInfo/ReleaseBundle`resource specified in`inputResources`. Do not use when a HelmChart/GitRepo resource is specified or when your input resource is not an Artifactory Helm repository.	May be required
`chartVersion`	The name of the Helm chart in the`FileSpec/BuildInfo/ReleaseBundle`resource specified in`inputResources`. Do not use when a HelmChart/GitRepo resource is specified or when your input resource is not an Artifactory Helm repository.	May be required
`dryRun`	Whentrue, only deploys if the --dry-run install simulation is successful. Defaults to`false`.	Optional
`lint`	When set totrue, performs alintto examine a chart for possible issues. Defaults to`false`.	Optional
`lintFlags`	Flag string to pass to the`helm lint`command.	Optional
`test`	When set totrue, performs atestto run the tests for release. Defaults to`false`.	Optional
`testFlags`	Flag string to pass to the`helm test`command.	Optional

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag	Description of usage	Required/Optional
`onStart`	Commands to execute in advance of the native operation	Optional
`onSuccess`	Commands to execute on successful completion	Optional
`onFailure`	Commands to execute on failed completion	Optional
`onComplete`	Commands to execute on any completion	Optional

The actions performed for theonExecutephase are inherent to this step type and may not be overridden.

Reserved Keywords

onExecute,onStart,onSuccess,onFailure, andonCompleteare reserved keywords. Using these keywords in any other context in your execution scripts can cause unexpected behavior.

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

管道:名称:helmDeployPipeline步骤:-南e: 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

管道:名称:helmDeployPipeline步骤:-南e: 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

管道:名称:helmDeployPipeline步骤:-南e: 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 thechartPathproperty 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

管道:名称:helmDeployPipeline步骤:-南e: 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 thechartNameandchartVersionconfiguration properties:

HelmDeploy

管道:名称:helmDeployPipeline步骤:-南e: 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 thechartPathproperty 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

管道:名称:helmDeployPipeline步骤:-南e: 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 thechartNameandchartVersionconfiguration properties:

HelmDeploy

管道:名称:helmDeployPipeline步骤:-南e: 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输入

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 thechartPathproperty.

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 anArtifactory IntegrationwhenReleaseBundleis theinputResourcetoHelmDeploystep. This integration will point to the Artifacoty that will be the source to download the ReleaseBundle that will be used in this step.

HelmDeploy

管道:名称:helmDeployPipeline步骤:-南e: 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 specifychartNameandchartVersionconfiguration properties:

HelmDeploy

管道:名称:helmDeployPipeline步骤:-南e: 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

管道:名称:helmDeployPipeline步骤:-南e: helmDeployStep type: HelmDeploy configuration: helmVersion: 2 namespace: my-namespace releaseName: myHelmRelease integrations: - name: kubernetes_integration inputResources: - name: helmChartResource

How it Works

When you use theHelmDeploynative 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)

Content

Space Tools

HelmDeploy

Overview

YAML Schema

Tags

name

type

configuration

execution

Examples

Helm 3 and HelmChart Resource Input

Dry Run

GitRepo Input

FileSpec Input

BuildInfo Input

ReleaseBundle输入

Helm 2

How it Works