Deploy a Helm chart

step

Deploys a Helm chart to a Kubernetes cluster.

Specification

name

Required

string
The name of the deployment
values

Required

object
Use the `values` mapping to override specific values in the chart. For example, the example below overrides some of the chart's API values.
repository
Optional
string
The URL to the chart repository to use if not using Git or the legacy Helm chart repository.
chart

Required

string
The chart to use. If the `git` map is set, then the chart is referenced from that repository instead of a remote chart repo.
namespace
Optional
string
The Kubernetes namespace to deploy the chart into.
recreatePods
Optional
boolean
If `true`, all pods managed by this chart will be destroyed and recreated after the deployment completes.
cluster

Required

object
Information about the Kubernetes cluster to deploy to
cluster.name

Required

string
An alias to use for the cluster within this step
cluster.connection

Required

The Kubernetes cluster connection to use for this stepConnection docs
!Connection {type: kubernetes, name: my-kubernetes-connection}
git
Optional
object
A git repository containing helm charts
git.connection
Optional
A Relay SSH connection to useConnection docs
!Connection {type: ssh, name: my-ssh-connection}
git.name

Required

string
A directory name for the git clone.
git.branch
Optional
string
The Git branch to clone.
git.repository

Required

string
The git repository URL.
credentials
Optional
object
A map of cert credentials to use for accessing the tiller controller in the cluster.
credentials.ca.pem

Required

string
The Tiller CA file contents
credentials.key.pem

Required

string
The tiller key file contents
credentials.cert.pem

Required

string
The tiller cert file contents

Join our community

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.