子chart和全局值
到目前为止,我们只使用了一个chart。但chart可以使用依赖,称为 子chart,且有自己的值和模板。 该章节我们会创建一个子chart并能看到访问模板中的值的不同方式。
在深入研究代码之前,需要了解一些应用的子chart的重要细节:
- 子chart被认为是“独立的”,意味着子chart从来不会显示依赖它的父chart。
- 因此,子chart无法访问父chart的值。
- 父chart可以覆盖子chart的值。
- Helm有一个 全局值 的概念,所有的chart都可以访问。
这些限制不一定都适用于提供标准化辅助功能的 library charts。
浏览本节的示例之后,这些概念会变得更加清晰。
创建子chart
为了做这些练习,我们可以从本指南开始时创建的mychart/
开始,并在其中添加一个新的chart。
$ cd mychart/charts
$ helm create mysubchart
Creating mysubchart
$ rm -rf mysubchart/templates/*
注意,和以前一样,我们删除了所有的基本模板,然后从头开始,在这个指南中,我们聚焦于模板如何工作,而不是管理依赖。 但 Chart指南提供了更多子chart运行的信息。
在子chart中添加值和模板
下一步,为mysubchart
创建一个简单的模板和values文件。mychart/charts/mysubchart
应该已经有一个values.yaml
。
设置如下:
dessert: cake
下一步,在mychart/charts/mysubchart/templates/configmap.yaml
中创建一个新的配置映射模板:
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ .Release.Name }}-cfgmap2
data:
dessert: {{ .Values.dessert }}
因为每个子chart都是 独立的chart,可以单独测试mysubchart
:
$ helm install --generate-name --dry-run --debug mychart/charts/mysubchart
SERVER: "localhost:44134"
CHART PATH: /Users/mattbutcher/Code/Go/src/helm.sh/helm/_scratch/mychart/charts/mysubchart
NAME: newbie-elk
TARGET NAMESPACE: default
CHART: mysubchart 0.1.0
MANIFEST:
---
# Source: mysubchart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: newbie-elk-cfgmap2
data:
dessert: cake
用父chart的值来覆盖
原始chart,mychart
现在是mysubchart
的 父。这种关系是基于mysubchart
在mychart/charts
中这一事实。
因为mychart
是父级,可以在mychart
指定配置并将配置推送到mysubchart
。比如可以修改mychart/values.yaml
如下:
favorite:
drink: coffee
food: pizza
pizzaToppings:
- mushrooms
- cheese
- peppers
- onions
mysubchart:
dessert: ice cream
注意最后两行,在mysubchart
中的所有指令会被发送到mysubchart
chart中。因此如果运行helm install --dry-run --debug mychart
,会看到一项mysubchart
的配置:
# Source: mychart/charts/mysubchart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: unhinged-bee-cfgmap2
data:
dessert: ice cream
现在,子chart的值已经被顶层的值覆盖了。
这里需要注意个重要细节。我们不会改变mychart/charts/mysubchart/templates/configmap.yaml
模板到
.Values.mysubchart.dessert
的指向。从模板的角度来看,值依然是在.Values.dessert
。当模板引擎传递值时,会设置范围。
因此对于mysubchart
模板,.Values
中只提供专门用于mysubchart
的值。
但是有时确实希望某些值对所有模板都可用。这是使用全局chart值完成的。
全局Chart值
全局值是使用完全一样的名字在所有的chart及子chart中都能访问的值。全局变量需要显式声明。不能将现有的非全局值作为全局值使用。
这些值数据类型有个保留部分叫Values.global
,可以用来设置全局值。在mychart/values.yaml
文件中设置一个值如下:
favorite:
drink: coffee
food: pizza
pizzaToppings:
- mushrooms
- cheese
- peppers
- onions
mysubchart:
dessert: ice cream
global:
salad: caesar
因为全局的工作方式,mychart/templates/configmap.yaml
和mysubchart/templates/configmap.yaml
应该都能以{{ .Values.global.salad }}
进行访问。
mychart/templates/configmap.yaml
:
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ .Release.Name }}-configmap
data:
salad: {{ .Values.global.salad }}
mysubchart/templates/configmap.yaml
:
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ .Release.Name }}-cfgmap2
data:
dessert: {{ .Values.dessert }}
salad: {{ .Values.global.salad }}
现在如果预安装,两个输出会看到相同的值:
# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: silly-snake-configmap
data:
salad: caesar
---
# Source: mychart/charts/mysubchart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: silly-snake-cfgmap2
data:
dessert: ice cream
salad: caesar
全局值在类似这样传递信息时很有用,不过要确保使用全局值配置正确的模板,确实需要一些计划。
与子chart共享模板
父chart和子chart可以共享模板。在任意chart中定义的块在其他chart中也是可用的。
比如,我们可以这样定义一个简单的模板:
{{- define "labels" }}from: mychart{{ end }}
回想一下模板标签时如何 全局共享的。因此,标签
chart可以包含在任何其他chart中。
当chart开发者在include
和 template
之间选择时,使用include
的一个优势是include
可以动态引用模板:
{{ include $mytemplate }}
上述会取消对$mytemplate
的引用,相反,template
函数只接受字符串字符。
避免使用块
Go 模板语言提供了一个 block
关键字允许开发者提供一个稍后会被重写的默认实现。在Helm chart中,
块并不是用于覆盖的最好工具,因为如果提供了同一个块的多个实现,无法预测哪个会被选定。
建议改为使用include
。