Add and Override Values YAML Files

Updated 1 month ago by Michael Cretzman

You can use values files for Kubernetes and Helm deployments in Harness.

For Kubernetes manifests, the values file uses Go templating to template manifest files. See Example Kubernetes Manifests using Go Templating.

For Helm charts, the values file defines the default values for parsing the Kubernetes templates (manifests) when deploying the Helm chart. See Deploy Helm Charts.

Harness supports Kubernetes and Helm charts without requiring Helm or Tiller and Kubernetes and Helm have equal support for all Harness deployment strategies.

You can overlay and override multiple values files in a stage's Service in a few ways. For example, by overlaying multiple files and by replacing file paths dynamically at runtime.

This topic describes how to add values files, how to override them at the Service and Environment, and how to override them at Pipeline runtime.

In this topic:

Before You Begin

Limitations

  • For Kubernetes deployments, the values.yaml file used in Harness doesn't support Helm templating, only Go templating.
  • Helm templating is fully supported in the remote Helm charts you add to your Harness Service. If you add a Helm chart and a values.yaml, the values.yaml can use Helm templating.

Review: Propagate and Override between Stages

This topic covers adding and overriding the values.yaml files you add to a Harness Service, but you can also propagate and override entire Services.

See Propagate and Override CD Services.

Review: Values Files with Kubernetes and Helm Charts

Let's take a quick look at how values files are used with Kubernetes and Helm charts in Harness.

Kubernetes

You can use values.yaml files with your Kubernetes manifests in Harness. This allows you to define several Kubernetes resources as a set.

files/
|-values.yaml
|-templates/
|-deployment.yaml
|-namespace.yaml
|-service.yaml

Harness evaluates the values.yaml files you add just like Helm does with its values file. Values.yaml files added to Harness don't use Helm templating, but instead use Go templating and Harness built-in variable expressions. This removes the need for Helm or Tiller to be installed.

Helm Charts

The typical Helm chart uses the following files:

chart/              # Helm chart folder
|-Chart.yaml # chart definition
|-requirements.yaml # optional charts to deploy with your chart
|-values.yaml # values for the template variables
|-templates/ # directory containing the template files (Kubernetes manifests)

Harness support Helm charts using Helm templating. Harness will evaluate the Helm chart just like Helm. You do not need to install Helm on the Harness Delegate pod/host. Harness manages Helm for you.

Review: Artifacts with Manifests and Charts

You can hardcode the deployment artifact in your values.yaml file just as you might in a typical Helm deployment.

Or you can add a path to the artifact in Harness and use a Harness expression in your values.yaml to refer to that path.

When Harness executes the Pipeline, the Harness Delegate resolves the expression and pulls the artifact onto the target pods.

Adding artifacts to Harness is covered in Add Container Images as Artifacts for Kubernetes Deployments.

Once you've added the artifact to Harness, you add the Harness expression <+artifact.image> in your values.yaml using the image label: image: <+artifact.image>.

For example:

name: myapp
replicas: 2

image: <+artifact.image>
dockercfg: <+artifact.imagePullSecret>
...

Artifacts and manifests are discussed in detail in Add Kubernetes Manifests.

Step: Add Values YAML

In your CD stage, click Service.

In Service Definition, select Kubernetes.

In Manifests, click Add Manifest.

In Specify Manifest Type, select Values YAML, and click Continue.

In Specify Values YAML Store, select the Git repo provider you're using and then create or select a Connector to that repo. The different Connectors are covered in Connect to a Git Repo.

If you haven't set up a Harness Delegate, you can add one as part of the Connector setup. This process is described in Kubernetes CD QuickstartHelm CD Quickstart and Install a Kubernetes Delegate.

Once you've selected a Connector, click Continue.

In Manifest Details, you tell Harness where the values.yaml is located.

In Manifest Identifier, enter a name that identifies the file, like values.

In Git Fetch Type, select a branch or commit Id for the manifest, and then enter the Id or branch.

For Specific Commit ID, you can also use a Git commit tag.

In File Path, enter the path to the values.yaml file in the repo.

You can enter multiple values file paths by clicking Add File. At runtime, Harness will compile the files into one values file.

If you use multiple files, the highest priority is given from the last file, and the lowest priority to the first file. For example, if you have 3 files and the second and third files contain the same key:value as the first file, the third file's key:value overrides the second and first files.

Click Submit.

The values file(s) are added to the Service.

Option: Override Values in an Environment

You can override the values YAML file for a stage's Environment by mapping the Environment name to the values file or folder. Next, you use the <+env.name> Harness expression in the values YAML path.

Let's look at an example.

Here is a repo with three values files, dev.yaml, qa.yaml. prod.yaml. In the File Path for the values file, you use the <+env.name> expression. Next, in the Environment setting, you add three Environments, one for each YAML file name.

When you select an Environment, such as qa, the name of the Environment is used in File Path and resolves to qa.yaml. At runtime, the qa.yaml values file is used.

Instead of selecting the Environment in the Infrastructure each time, you can set the Environment as a Runtime Input and then enter devqa, or prod at runtime. See Runtime Inputs.

Option: Override Values at Runtime

You can make the values file path a Runtime Input and simply enter the name of the values file when you run the Pipeline. See Runtime Inputs.

In Manifest Details for the values file, in File Path, select Runtime Input. At runtime, you simply enter the name of the values file to use.

See Also


Please Provide Feedback