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





You are viewing an old version of this page. View thecurrent version.

Compare with CurrentView Page History

« PreviousVersion 9下一个”

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:

  • AHelmChart资源urce that identifies a Helm chart stored in an Artifactory repository byHelmPublish.
  • A Helm chart in a source code repository identified by aGitRepo资源urce.

When properly configured, the HelmDeploy step will also perform 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 an图像) and use it to perform the deployment.

The HelmDeploy step uses thehelm upgradecommand to perform the deployment.

Usage


HelmDeploy
pipelines: - name:  steps: - name:  type: HelmDeploy configuration: #inherits from bash flags:  # optional valueFilePaths: # optional -  releaseName:  chartPath:  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 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"
Page Contents

Tags

name

Analphanumericstring (underscores are permitted) that identifies the step.

类型

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 必须指定aKubernetes Integration. Required
inputResources

必须指定eitheraHelmChart资源urce or aGitRepo资源urce that contains a Helm chart.

Required


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

Tag

Description of usage

Required/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 references in the specified file(s) will be 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 HelmChart in the GitRepo resource specified ininputResources. Do not use when a HelmChart resource is specified. May be required
dryRun

Whentrue, only deploys if the --dry-run install simulation is successful.

Defaults to false.

Optional
lint

When set totrueperforms alintto examine a chart for possible issues.

Defaults to false.

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

When set totrueperforms atestto run the tests for release.

Defaults to false.

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.

  • 没有标签
Copyright © 2023 JFrog Ltd.