HelmBlueGreenDeploy - Tags

JFrog Pipelines Documentation
Products
JFrog Pipelines
Content Type
User Guide
ft:sourceType
Paligo

This topic lists tags that can be used with HelmBlueGreeDeploy Pipeline steps. For more information on HelmBlueGreenDeploy Pipeline steps, see HelmBlueGreenDeploy.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be HelmBlueGreenDeploy 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 pertinent tags:

Tag

Description of usage

Required/Optional

integrations

Must specify a Kubernetes Integration.

and

Must specify an Artifactory Integration when ReleaseBundle is the inputResourcefor the step.

Required

May be required

inputResources

Must specify HelmChart, GitRepo, FileSpec, BuildInfo, or ReleaseBundle resource that contains a Helm chart.

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 either 2 or 3. Defaults to 3.

Optional

namespace

Target kubernetes namespace for the deployment.

Required

blueReleaseName

The release name for the blue environment. Equivalent to the --name (-n) option of the helm install command.

Required

blueFlags

A flag string to be included in the Helm command when deploying the blue release. For example: --set key=’value’ -f myTestValues.yaml

Optional

blueValueFilePaths

Specifies values YAML file(s) for use with a --values (-f) option of the helm install command when deploying the blue release.

All environment variables referenced in the specified file(s) are automatically replaced with the values of matching runtime environment variables.

Optional

greenReleaseName

The release name for the green environment. Equivalent to the --name (-n) option of the helm install command.

Required

greenFlags

A flag string to be included in the Helm command when deploying the green release. For example: --set key=’value’ -f myTestValues.yaml

Optional

greenValueFilePaths

Specifies values YAML file(s) for use with a --values (-f) option of the helm install command when deploying the green release.

All environment variable referenced in the specified file(s) are automatically replaced with values of matching runtime environment variables.

Optional

roleServices

List of services that should be created by Pipelines to assign Idle and Live roles to the releases.

Tag

Description of usage

Required/Optional

liveName

Name of the Service that points to the environment playing Live role.

Required

liveCustomProperties

jq expression to be executed on the Live Service after the content is copied from the reference Service and before applying it to the kubernetes cluster. Can be used to customize the Live Service content. For instance, to assign a custom label use the following expression: ".metadata.labels.my-label = my-value".

Optional

idleName

Name of the Service that points to the environment playing Idle role.

Required

idleCustomProperties

jq expression to be executed on this Idle Service after the content is copied from the reference Service and before applying it to the kubernetes cluster. Can be used to customize the Idle Service content. For instance, to assign a custom label use the following expression: ". metadata.labels.my-label = my-value".

Optional

blueReferenceName

Name of the Service deployed by the blue release that will be used as reference when creating or updating this role Service. When blue is playing Live role, liveName will be a copy of this Service. If blue is playing Idle role, idleName will be a copy of this Service.

Required

greenReferenceName

Name of the Service deployed by the green release that will be used as reference when creating or updating this role Service. When green is playing Live role, liveName will be a copy of this Service. If green is playing Idle role, idleName will be a copy of this Service.

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.