Deploy Helm Charts

Use Spinnaker to create Helm charts for your applications.

Spinnaker surfaces a “Bake (Manifest)” stage to turn templates into manifests with the help of a templating engine. Helm relies on the helm template command. For more details, see helm template --help.

Note: This stage is intended to help you package and deploy applications that you own, and are actively developing and redeploying frequently. It is not intended to serve as a one-time installation method for third-party packages. If that is your goal, it’s arguably better to call helm install once when bootstrapping your Kubernetes cluster.

Note: Make sure that you have configured artifact support in Spinnaker first. All Helm charts are fetched/stored as artifacts in Spinnaker. Read more in the reference pages .

Configure the “Bake (Manifest)” stage

When configuring the “Bake (Manifest)” stage using a Helm (Helm2 or Helm3) render engine, you can specify the following:

  • The release name (required)

    The Helm release name for this chart. This determines the name of the artifact produced by this stage.

Note: this name will override any changes you make to the name in the Produces Artifacts section.

  • The template artifact (required)

    The Helm chart that you will be deploying, stored remotely as a .tar.gz archive. You can produce this by running helm package /path/to/chart. For more details, helm package --help.

  • The release namespace (optional)

    The Kubernetes namespace to install release into. If parameter is not specified default namespace will be used.

Note: Not all Helm charts contain namespace definitions in their manifests. Make sure that your manifests contain the following code:

  1. metadata:
  2.   namespace: {{ .Release.Namespace }}

  • Helm chart file path (optional)

    Helm chart file path is only relevant (and visible) when the template artifact is a git/repo artifact. It specifies the directory path to Chart.yaml in the git repo. If absent, spinnaker looks for Chart.yaml in the root directory of the git repo.

    Given: A git repo where your Chart.yaml is in: sub/folder/Chart.yml
    Then: helmChartFilePath: "sub/folder/"

Note: Leading slashes will not work in helmChartFilePath.

  • Zero or more override artifacts (optional)

    The files passed to --values parameter in the helm template command. Each is a remotely stored artifact representing a Helm Value File .

  • Statically specified overrides

    The set of static key/value pairs that are passed as --set parameters to the helm template command.

As an example, we have a fully configured Bake (Manifest) stage below:

Deploy Helm Charts - 图1

Notice that in the “Produces Artifacts” section, Spinnaker has automatically created an embedded/base64 artifact that is bound when the stage completes, representing the fully baked manifest set to be deployed downstream.

Deploy Helm Charts - 图2

If you are programatically generating stages, here is the JSON representation of the same stage from above:

  1. {
  2.   "type": "bakeManifest",
  3.   "templateRenderer": "HELM2",
  4.   "name": "Bake nginx helm template",
  5.   "outputName": "nginx",
  6.   "inputArtifacts": [
  7.     {
  8.       "account": "gcs",
  9.       "id": "template-id"
  10.     },
  11.     {
  12.       "account": "gcs",
  13.       "id": "value-id"
  14.     }
  15.   ],
  16.   "overrides": {
  17.     "replicas": "3"
  18.   },
  19.   "expectedArtifacts": [
  20.     {
  21.       "defaultArtifact": {},
  22.       "id": "baked-template",
  23.       "matchArtifact": {
  24.         "kind": "base64",
  25.         "name": "nginx",
  26.         "type": "embedded/base64"
  27.       },
  28.       "useDefaultArtifact": false
  29.     }
  30.   ]
  31. }

Configure a downstream deployment

Now that your manifest set has been baked by Helm, configure a downstream stage (in the same pipeline or in one triggered by this pipeline) your “Deploy (Manifest)” stage to deploy the artifact produced by the “Bake (Manifest)” stage as shown here:

Deploy Helm Charts - 图3

Note: Make sure to select “embedded-artifact” as the artifact account for your base64 manifest set. This is required to translate the manifest set into the format required by the deploy stage.

When this stage runs, you can see every resource in your Helm chart get deployed at once:

Deploy Helm Charts - 图4

Other Templating Engines

In addition to Helm, Spinnaker also supports Kustomize as a templating engine. For more information, see Using Kustomize for Manifests .

Last modified June 30, 2021: update docs clarifying how the chartpath should be used when the gitr… (#101) (d53f3c8)