HelmDeploy - Tags

JFrog Pipelines Documentation

ft:sourceType
Paligo

This topic lists tags that can be used with HelmDeploy Pipeline steps. For more information about HelmDeploy, seeHelmDeploy.

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

integrations

Must specify a Kubernetes Integration.

or

Must specify an Artifactory Integration when ReleaseBundle is the inputResource to the step.

Required

May be required

inputResources

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

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 the helm install 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 helm install command.

Required

chartPath

The path to the Helm chart in the GitRepo/FileSpec/BuildInfo/ReleaseBundle resource specified in inputResources.

Note

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.

Note

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.

Note

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

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

Defaults to false.

Optional

lint

When set to true, performs a lint to examine a chart for possible issues.

Defaults to false.

Optional

lintFlags

Flag string to pass to the helm lint command.

Optional

test

When set to true, performs a test to 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 the onExecute phase are inherent to this step type and may not be overridden.