Subcharts and Global Values

To this point we have been working only with one chart. But charts can have dependencies, called subcharts, that also have their own values and templates. In this section we will create a subchart and see the different ways we can access values from within templates.

Before we dive into the code, there are a few important details to learn about subcharts.

  • A subchart is considered “stand-alone”, which means a subchart can never explicitly depend on its parent chart.
  • For that reason, a subchart cannot access the values of its parent.
  • A parent chart can override values for subcharts.
  • Helm has a concept of global values that can be accessed by all charts.

As we walk through the examples in this section, many of these concepts will become clearer.

Creating a Subchart

For these exercises, we’ll start with the mychart/ chart we created at the beginning of this guide, and we’ll add a new chart inside of it.

  1. $ cd mychart/charts
  2. $ helm create mysubchart
  3. Creating mysubchart
  4. $ rm -rf mysubchart/templates/*.*

Notice that just as before, we deleted all of the base templates so that we can start from scratch. In this guide, we are focused on how templates work, not on managing dependencies. But the Charts Guide has more information on how subcharts work.

Adding Values and a Template to the Subchart

Next, let’s create a simple template and values file for our mysubchart chart. There should already be a values.yaml in mychart/charts/mysubchart. We’ll set it up like this:

  1. dessert: cake

Next, we’ll create a new ConfigMap template in mychart/charts/mysubchart/templates/configmap.yaml:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   name: {{ .Release.Name }}-cfgmap2
  5. data:
  6.   dessert: {{ .Values.dessert }}

Because every subchart is a stand-alone chart, we can test mysubchart on its own:

  1. $ helm install --dry-run --debug mychart/charts/mysubchart
  2. SERVER: "localhost:44134"
  3. CHART PATH: /Users/mattbutcher/Code/Go/src/k8s.io/helm/_scratch/mychart/charts/mysubchart
  4. NAME:   newbie-elk
  5. TARGET NAMESPACE:   default
  6. CHART:  mysubchart 0.1.0
  7. MANIFEST:
  8. ---
  9. # Source: mysubchart/templates/configmap.yaml
  10. apiVersion: v1
  11. kind: ConfigMap
  12. metadata:
  13.   name: newbie-elk-cfgmap2
  14. data:
  15.   dessert: cake

Overriding Values of a Child Chart

Our original chart, mychart is now the parent chart of mysubchart. This relationship is based entirely on the fact that mysubchart is within mychart/charts.

Because mychart is a parent, we can specify configuration in mychart and have that configuration pushed into mysubchart. For example, we can modify mychart/values.yaml like this:

  1. favorite:
  2.   drink: coffee
  3.   food: pizza
  4. pizzaToppings:
  5.   - mushrooms
  6.   - cheese
  7.   - peppers
  8.   - onions
  10. mysubchart:
  11.   dessert: ice cream

Note the last two lines. Any directives inside of the mysubchart section will be sent to the mysubchart chart. So if we run helm install —dry-run —debug mychart, one of the things we will see is the mysubchart ConfigMap:

  1. # Source: mychart/charts/mysubchart/templates/configmap.yaml
  2. apiVersion: v1
  3. kind: ConfigMap
  4. metadata:
  5.   name: unhinged-bee-cfgmap2
  6. data:
  7.   dessert: ice cream

The value at the top level has now overridden the value of the subchart.

There’s an important detail to notice here. We didn’t change the template of mychart/charts/mysubchart/templates/configmap.yaml to point to .Values.mysubchart.dessert. From that template’s perspective, the value is still located at .Values.dessert. As the template engine passes values along, it sets the scope. So for the mysubchart templates, only values specifically for mysubchart will be available in .Values.

Sometimes, though, you do want certain values to be available to all of the templates. This is accomplished using global chart values.

Global Chart Values

Global values are values that can be accessed from any chart or subchart by exactly the same name. Globals require explicit declaration. You can’t use an existing non-global as if it were a global.

The Values data type has a reserved section called Values.global where global values can be set. Let’s set one in our mychart/values.yaml file.

  1. favorite:
  2.   drink: coffee
  3.   food: pizza
  4. pizzaToppings:
  5.   - mushrooms
  6.   - cheese
  7.   - peppers
  8.   - onions
  10. mysubchart:
  11.   dessert: ice cream
  13. global:
  14.   salad: caesar

Because of the way globals work, both mychart/templates/configmap.yaml and mychart/charts/mysubchart/templates/configmap.yaml should be able to access that value as {{ .Values.global.salad}}.

mychart/templates/configmap.yaml:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   name: {{ .Release.Name }}-configmap
  5. data:
  6.   salad: {{ .Values.global.salad }}

mychart/charts/mysubchart/templates/configmap.yaml:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   name: {{ .Release.Name }}-cfgmap2
  5. data:
  6.   dessert: {{ .Values.dessert }}
  7.   salad: {{ .Values.global.salad }}

Now if we run a dry run install, we’ll see the same value in both outputs:

  1. # Source: mychart/templates/configmap.yaml
  2. apiVersion: v1
  3. kind: ConfigMap
  4. metadata:
  5.   name: silly-snake-configmap
  6. data:
  7.   salad: caesar
  9. ---
  10. # Source: mychart/charts/mysubchart/templates/configmap.yaml
  11. apiVersion: v1
  12. kind: ConfigMap
  13. metadata:
  14.   name: silly-snake-cfgmap2
  15. data:
  16.   dessert: ice cream
  17.   salad: caesar

Globals are useful for passing information like this, though it does take some planning to make sure the right templates are configured to use globals.

Sharing Templates with Subcharts

Parent charts and subcharts can share templates. Any defined block in any chart isavailable to other charts.

For example, we can define a simple template like this:

  1. {{- define "labels" }}from: mychart{{ end }}

Recall how the labels on templates are globally shared. Thus, the labels chartcan be included from any other chart.

While chart developers have a choice between include and template, one advantageof using include is that include can dynamically reference templates:

  1. {{ include $mytemplate }}

The above will dereference $mytemplate. The template function, in contrast,will only accept a string literal.

Avoid Using Blocks

The Go template language provides a block keyword that allows developers to providea default implementation which is overridden later. In Helm charts, blocks are notthe best tool for overriding because if multiple implementations of the same blockare provided, the one selected is unpredictable.

The suggestion is to instead use include.

The .helmignore file

The .helmignore file is used to specify files you don’t want to include in your helm chart.

If this file exists, the helm package command will ignore all the files that match the pattern specified in the .helmignore file while packaging your application.

This can help in avoiding unnecessary or sensitive files or directories from being added in your helm chart.

The .helmignore file supports Unix shell glob matching, relative path matching, and negation (prefixed with !). Only one pattern per line is considered.

Here is an example .helmignore file:

  1. # comment
  2. .git
  3. */temp*
  4. */*/temp*
  5. temp?

We’d love your help making this document better. To add, correct, or removeinformation, file an issue orsend us a pull request.