JFrog

    Cloud customer?
    Start for Free>
    Upgrade in MyJFrog >
    What's New in Cloud >





    Versions Compared

    Old Version25

    changes.mady.by.userRajesh G

    Saved on

    compared with

    New Version26

    changes.mady.by.userRajesh G

    Saved on

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.

    Overview

    Excerpt

    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.

    Info
    title 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.
    Panel
    title Page Contents

    Table of Contents
    maxLevel 3

    YAML Schema

    The YAML schema for HelmDeploy native step is as follows:

    Code Block
    language yml
    title 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
    In addition, these tags can be defined to support the step's native operation:
    Info
    title 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--namespaceparameter. 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 the

    Newtablink
    Text helm install
    URL https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing
    command.

    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 the

    Newtablink
    Text helm install
    URL https://v2.helm.sh/docs/helm/#helm-install
    command.

    		 Required
    chartPath

    The path to the Helm chart in theGitRepo/FileSpec/BuildInfo/ReleaseBundleresource specified ininputResources.

    Info

    Do not use when a HelmChart resource is specified.
    		May be required
    chartName

    The name of the Helm chart in theFileSpec/BuildInfo/ReleaseBundleresource specified ininputResources.

    Info
    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 theFileSpec/BuildInfo/ReleaseBundleresource specified ininputResources.

    Info
    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 tofalse.

    		 Optional
    lint

    When set totrue, performs a

    Newtablink
    Text lint
    URL https://v2.helm.sh/docs/helm/#helm-lint
    to examine a chart for possible issues.

    Defaults tofalse.

    		 Optional
    lintFlags Flag string to pass to thehelm lintcommand. Optional
    test

    When set totrue, performs a

    Newtablink
    Text test
    URL https://v2.helm.sh/docs/helm/#helm-test
    to run the tests for release.

    Defaults tofalse.

    		 Optional
    testFlags Flag string to pass to thehelm testcommand. 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.

    Examples

    下面的例子展示了如何配置一个冥界mDeploy step.

    Helm 3 and HelmChart Resource Input

    A HelmDeploy step using Helm 3 and a HelmChart resource input.

    Code Block
    language yml
    title 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.

    Code Block
    language yml
    title 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.

    Code Block
    language yml
    title 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:

    Code Block
    language yml
    title 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:

    Code Block
    language yml
    title 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:

    Code Block
    language yml
    title 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:

    Code Block
    language yml
    title 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:

    Info
    title 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.
    Code Block
    language yml
    title 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:

    Code Block
    language yml
    title 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.

    Code Block
    language yml
    title 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)
    Copyright © 2023 JFrog Ltd.