五. Helm Chart 变量/命名模板

最新推荐文章于 2024-07-13 22:57:11 发布

小伙计~

最新推荐文章于 2024-07-13 22:57:11 发布

阅读量1.8k

点赞数

分类专栏： Helm Kubernetes 文章标签： kubernetes k8s

本文链接：https://blog.csdn.net/weixin_44814672/article/details/117384719

版权

Helm 同时被 2 个专栏收录

5 篇文章 0 订阅

订阅专栏

Kubernetes

5 篇文章 0 订阅

订阅专栏

文章目录

变量
命名模板

变量

1. 概念

函数、管道符、对象和控制结构都可以控制，我们转向很多编程语言中更基本的思想之一：变量。在模板中，很少被使用。但是我们可以使用变量简化代码，并更好地使用 with 和 range。

在例子中，我们看到下面的代码会失败：

{{- with .Values.favorite }}
drink: {{ .drink | default "tea" | quote }}
food: {{ .food | upper | quote }}
release: {{ .Release.Name }}
{{- end }}

Release.Name 不在 with 块的限制范围内。解决作用域问题的一种方法是将对象分配给可以不考虑当前作用域而访问的变量。

2. 语法格式

Helm模板中，变量是对另一个对象的命名引用。遵循 $name 变量的格式且指定了一个特殊的赋值运算符：:=。我们可以使用针对 Release.Name 的变量重写上述内容。

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- $relname := .Release.Name -}}
  {{- with .Values.favorite }}
  drink: {{ .drink | default "tea" | quote }}
  food: {{ .food | upper | quote }}
  release: {{ $relname }}
  {{- end }}

说明： 在 with 块开始之前，赋值 $relname := .Release.Name。现在在 with 块中，$relname 变量仍会执行版本名称

# 运行结果
apiVersion: v1
kind: ConfigMap
metadata:
  name: viable-badger-configmap
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "PIZZA"
  release: viable-badger

3. 示例

数据结构为单一数据

value.yaml

# values.yaml
pizzaToppings:
  - mushrooms
  - cheese
  - peppers
  - onions

定义模板
$变量在$ range $循环中特别有用。可以用于类似列表的对象，以捕获索引和值$

toppings: |-
  {{- range $index, $topping := .Values.pizzaToppings }}
    {{ $index }}: {{ $topping }}
  {{- end }}

输出结果
$注意先是$ range $，然后是变量，然后是赋值运算符，然后是列表。会将整型索引（从 0 开始）赋值给$ $index $并将值赋值给$ $topping

toppings: |-
    0: mushrooms
    1: cheese
    2: peppers
    3: onions

数据结构有key和value

values.yaml

favorite: 
  drink: coffee
  food: pizza

定义模板
$对于数据结构有$ key $和$ value $，可以使用$ range $获取$ key $和$ value $。比如，可以通过$ .Values.favorite $进行循环$

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- range $key, $val := .Values.favorite }}
  {{ $key }}: {{ $val | quote }}
  {{- end }}

输出结果
$第一次迭代，$ $key $会是$ drink $且$ $val $会是$ coffee $，第二次迭代$ $key $会是$ food $且$ $val $会是$ pizza

apiVersion: v1
kind: ConfigMap
metadata:
  name: eager-rabbit-configmap
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "pizza"

4. 补充说明

变量一般不是"全局的"。作用域是其声明所在的块。上面我们在模板的顶层赋值了 $relname。变量的作用域会是整个模板。但在最后一个例子中 $key 和 $val 作用域会在{{ range... }}{{ end }}块内。

但有个变量一直是全局的 - $ - 这个变量一直是指向根的上下文。当在一个范围内循环时会很有用，同时你要知道chart的版本名称。

{{- range .Values.tlsSecrets }}
apiVersion: v1
kind: Secret
metadata:
  name: {{ .name }}
  labels:
    # Many helm templates would use `.` below, but that will not work,
    # however `$` will work here
    app.kubernetes.io/name: {{ template "fullname" $ }}
    # I cannot reference .Chart.Name, but I can do $.Chart.Name
    helm.sh/chart: "{{ $.Chart.Name }}-{{ $.Chart.Version }}"
    app.kubernetes.io/instance: "{{ $.Release.Name }}"
    # Value from appVersion in Chart.yaml
    app.kubernetes.io/version: "{{ $.Chart.AppVersion }}"
    app.kubernetes.io/managed-by: "{{ $.Release.Service }}"
type: kubernetes.io/tls
data:
  tls.crt: {{ .certificate }}
  tls.key: {{ .key }}
---
{{- end }}

命名模板

1. 概念

命名模板 (有时称作一个 部分 或一个 子模板) 仅仅是在文件内部定义的模板，并使用了一个名字。有两种创建方式和几种不同的使用方法。

三种声明和管理模板的方法

define 在模板中声明一个新的命名模板
template 导入一个命名模板
block 声明一种特殊的可填充的模板块

注意：

模板名称是全局的。如果您想声明两个相同名称的模板，哪个最后加载就使用哪个。因为在子 chart 中的模板和顶层模板一起编译，命名时要注意 chart 特定名称。
一个常见的命名惯例是用 chart 名称作为模板前缀：{{ define "mychart.labels" }}。使用特定 chart 名称作为前缀可以避免可能因为两个不同 chart 使用了相同名称的模板而引起的冲突。

2. 局部的和 _文件

单个文件中包含了单个模板。但Helm的模板语言允许你创建命名的嵌入式模板，这样就可以在其他位置按名称访问。

templates/中的大多数文件被视为包含 Kubernetes 清单
NOTES.txt是个例外
命名以下划线(_)开始的文件则假定没有包含清单内容。这些文件不会渲染为 Kubernetes 对象定义，但在其他 chart 模板中都可用

这些文件用来存储局部和辅助对象，实际上当我们第一次创建mychart时，会看到一个名为_helpers.tpl的文件，这个文件时模板局部的默认位置

3. define 和 template 声明和使用模板

define 操作允许我们在模板文件中创建一个命名模板

{{ define "MY.NAME" }}
  # body of template here
{{ end }}

定义一个模板封装 Kubernetes 的标签: default

{{- define "mychart.labels" }}
  labels:
    generator: helm
    date: {{ now | htmlDate }}
{{- end }}

将模板嵌入到了已有的配置映射中: template

{{- define "mychart.labels" }}
  labels:
    generator: helm
    date: {{ now | htmlDate }}
{{- end }}
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  {{- template "mychart.labels" }}
data:
  myvalue: "Hello World"
  {{- range $key, $val := .Values.favorite }}
  {{ $key }}: {{ $val | quote }}
  {{- end }}

渲染结果
$当模板引擎读取该文件时，它会存储$ mychart.labels $的引用直到$ template "mychart.labels" $被调用。然后会按行渲染模板$

apiVersion: v1
kind: ConfigMap
metadata:
  name: running-panda-configmap
  labels:
    generator: helm
    date: 2021-05-16
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "pizza"

注意：define 不会有输出，除非像本示例一样用模板调用它。

4. _helpers.tpl 文件

Helm chart 将这些模板放置在局部文件中，一般是 _helpers.tpl

定义模板

# _helpers.tpl
{{/* Generate basic labels */}}
{{- define "mychart.labels" }}
  labels:
    generator: helm
    date: {{ now | htmlDate }}
{{- end }}

说明：define 方法会有个简单的文档块{{/* ... */}}来描述要做的事

调用模板
$尽管这个定义是在$ _helpers.tpl $中，但它仍能访问$ configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  {{- template "mychart.labels" }}
data:
  myvalue: "Hello World"
  {{- range $key, $val := .Values.favorite }}
  {{ $key }}: {{ $val | quote }}
  {{- end }}

5. include方法

假设定义了一个简单模板如下:

{{- define "mychart.app" -}}
app_name: {{ .Chart.Name }}
app_version: "{{ .Chart.Version }}"
{{- end -}}

需求：我想把这个插入到模板的 labels: 部分和 data: 部分：

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  labels:
    {{ template "mychart.app" . }}
data:
  myvalue: "Hello World"
  {{- range $key, $val := .Values.favorite }}
  {{ $key }}: {{ $val | quote }}
  {{- end }}
{{ template "mychart.app" . }}

输出错误信息

$ helm install --dry-run measly-whippet ./mychart
Error: unable to build kubernetes objects from release manifest: error validating "": error validating data: [ValidationError(ConfigMap): unknown field "app_name" in io.k8s.api.core.v1.ConfigMap, ValidationError(ConfigMap): unknown field "app_version" in io.k8s.api.core.v1.ConfigMap]

要查看渲染了什么，可以用--disable-openapi-validation参数重新执行： helm install --dry-run --disable-openapi-validation measly-whippet ./mychart

apiVersion: v1
kind: ConfigMap
metadata:
  name: measly-whippet-configmap
  labels:
    app_name: mychart
app_version: "0.1.0"
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "pizza"
app_name: mychart
app_version: "0.1.0"

注意： 两处的 app_version 缩进都不对，为啥？因为被替换的模板中文本是左对齐的。由于 template 是一个行为，不是方法，无法将 template 调用的输出传给其他方法，数据只是简单地按行插入

修改模板
Helm $提供了一个$ template $的可选项，可以将模板内容导入当前管道，然后传递给管道中的其他方法，使用$ indent $正确地缩进$ mychart.app $模板$

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  labels:
{{ include "mychart.app" . | indent 4 }}
data:
  myvalue: "Hello World"
  {{- range $key, $val := .Values.favorite }}
  {{ $key }}: {{ $val | quote }}
  {{- end }}
{{ include "mychart.app" . | indent 2 }}

输出信息

apiVersion: v1
kind: ConfigMap
metadata:
  name: edgy-mole-configmap
  labels:
    app_name: mychart
    app_version: "0.1.0"
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "pizza"
  app_name: mychart
  app_version: "0.1.0"