Helm Chart

Deploys a Helm chart to an existing Kubernetes cluster.

Object Representation (YAML)

id: String
name: String
tool_version: String
type: String
depends: [String]
tags: [String]
condition: Boolean
each: Array
verbosity: String
ignore_errors: Boolean
properties:
  credential: String
  api_url: String
  name: String
  chart_path: String
  chart_url: String
  chart_repo: String
  chart_name: String
  upgrade: Boolean
  values: String
  namespace: String
  args: String
  kubeconfig_content: String
  kubeconfig_path: String
  cwd: String
  skip_cert_validation: Boolean
  env:
    - name: String
      value: String

Fields

PropertyDetails
id *

String

A unique identifier for the step.

Can contain hyphens and underscores, but not spaces.

name *

String

A friendly name for the step. This name will appear in the pipeline designer and run output.

tool_version

String

The version to use. This version is only installed for the subprocess run by the step, and will not propagate to other operating system sessions.

type *

String

The type of the step. Can be pipeline or a step module type.

depends[]

[String]

A list of dependencies of this step.

This step will not be executed until all steps with ids in this list are finished executing.

tags[]

[String]

Tags are used to group related steps. Steps with the same tag can be retrieved using the findStepsByTag() helper function.

Can contain hyphens and underscores, but not spaces.

condition

Boolean

An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The step.result.status field will be "Skipped".

each

Array

An array of elements to execute the step once for each of them.

verbosity

String

Step event verbosity. Determines how much information about step execution is sent back to the application.

ignore_errors

Boolean

If true, errors in the step module will not halt pipeline execution, and subsequent steps will still be executed. The step.result.status field will be "Failed" if the step encounters an error.

properties.credential

String

A Username/Password or API Token credential to use for authentication with the Kubernetes API server.

properties.api_url

String

URL of the Kubernetes API server.

properties.name

String

Name of the release.

properties.chart_path

String

Path to an existing Helm chart.

properties.chart_url

String

The absolute URL of a chart, e.g. a .tgz file download URL.

properties.chart_repo

String

The URL of a remote chart repository.

properties.chart_name

String

The name of the chart in the repository. Required if chart_repo is specified.

properties.upgrade

Boolean

Upgrade the release if it already exists.

properties.values

String

A values file to provide to Helm. Should be YAML or JSON format.

properties.namespace

String

Kubernetes namespace to use.

properties.args

String

Additional command line arguments.

properties.kubeconfig_content

String

Path to an existing kubeconfig file.

properties.kubeconfig_path

String

Inline kubeconfig content.

properties.cwd

String

Working directory to use for script execution.

properties.skip_cert_validation

Boolean

Skip TLS certificate validation when communicating with the Kubernetes API server and when pulling charts.

properties.env[]

[Object]

A list of environment variables that will be set for script execution.

properties.env[].name *

String

Environment variable name.

properties.env[].value *

String

Environment variable value.

Result Fields

The following are the step execution result fields available at steps.<step id>.result after a step executes.

KeyDetails
result.status

String

A string indicating the step execution status. Can be Succeeded, Failed, or Skipped.

result.exit_code

Number

Exit code of the helm process.

result.stdout

String

Stdout of the helm process.

result.stderr

String

Stderr of the helm process.