Helm - Chart 模板函数和流水线

• 原文地址: 模板函数和流水线

模板函数和流水线

到目前为止，我们已经知道了如何将信息放入模板中。但是这些信息未被修改就放入了模板中。有时候我们希望以一种更有用的方式来转换所提供的数据。

1. 让我们从一个最佳实践开始: 将 .Values 对象中的字符串注入模板中，应该引用这些字符串。可以通过调用模板指令中的 quote 函数来实现:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: {{ .Release.Name }}-configmap
   data:
     myvalue: "Hello World"
     drink: {{ quote .Values.favorite.drink }}
     food: {{ quote .Values.favorite.food }}

   quote 函数会自动给值加上引号，将值转换为字符串.

模板函数遵循的语法是 functionName arg1 arg2 ...。在上面的代码片段中，quote .Values.favorite.drink 调用了 quote 函数并只传递了一个参数。

Helm 有超过 60 个可用函数。其中有些通过 Go 模板语言 本身定义。其他大部分都是 Sprig 模板库。

使用 管道符

模板语言其中一个强大功能就是管道概念。借鉴 UNIX 的概念，管道符就是将一系列的模板语言紧凑地表示为一系列转换的工具。换句话说，管道符是按顺序完成一系列任务的有效方式。

1. 现在用管道符重写上述的示例：

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: {{ .Release.Name }}-configmap
   data:
     myvalue: "Hello World"
     drink: {{ .Values.favorite.drink | quote }}
     food: {{ .Values.favorite.food | quote }}

   在这个示例中，并不是调用 quote ARGUMENT，而是倒置了命令。使用管道符 (|) 将参数发送给函数 .Values.favorite.drink | quote。

2. 使用管道符可以将很多函数连接在一起，如下:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: {{ .Release.Name }}-configmap
   data:
     myvalue: "Hello World"
     drink: {{ .Values.favorite.drink | quote }}
     food: {{ .Values.favorite.food | upper | quote }}

   倒置命令是模板中的常见做法。可以经常看到 .val | quote 而不是 quote .val。这两种操作都是可以的。

3. 修改 values.yaml 文件，在其中加入以下内容

   favorite:
     drink: "coffee" 
     food: "pizza"

4. 使用 helm install --dry-run --debug helm-test . 命令测试，以上模板会生成以下内容

   ---
   # Source: helm-test/templates/configmap.yaml
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: helm-test-configmap
   data:
     myvalue: "Hello World"
     drink: "coffee"
     food: "PIZZA"
   ---

   注意: 原有的 pizza 现在已经被转换成了 “PIZZA”。

5. 可以修改上述示例，用一个函数带两个参数说明，如: repeat COUNT STRING，使用管道符时如下所示

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: {{ .Release.Name }}-configmap
   data:
     myvalue: "Hello World"
     drink: {{ .Values.favorite.drink | repeat 5 | quote }}
     food: {{ .Values.favorite.food | upper | quote }}

   repeat 函数会返回给定参数特定的次数，则可以得到以下结果

   # Source: helm-test/templates/configmap.yaml
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: helm-test-configmap
   data:
     myvalue: "Hello World"
     drink: "coffeecoffeecoffeecoffeecoffee"
     food: "PIZZA"

使用 default 函数

模板中频繁使用的一个函数是 default: default DEFAULT_VALUE GIVEN_VALUE。这个函数允许你在模板中指定一个默认值，以防这个值被忽略。

1. 现在使用它修改上述示例，如下

   drink: {{ .Values.favorite.drink | default "tea" | quote }}

2. 如果正常运行，会得到 coffee

   # Source: helm-test/templates/configmap.yaml
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: helm-test-configmap
   data:
     myvalue: "Hello World"
     drink: "coffee"
     food: "PIZZA"

3. 现在，从 values.yaml 文件中移除最爱的饮料设置

   favorite:
     #drink: coffee
     food: pizza

4. 重新运行 helm install --dry-run helm-test . 命令，会生成以下内容

   # Source: helm-test/templates/configmap.yaml
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: helm-test-configmap
   data:
     myvalue: "Hello World"
     drink: "tea"
     food: "PIZZA"

在实际的 chart 中，所有的静态默认值应该设置在 values.yaml 文件中，且不应该重复使用 default 命令 (否则会出现冗余)。然而这个default 命令很适合计算值，其不能声明在 values.yaml 文件中，比如：

drink: {{ .Values.favorite.drink | default (printf "%s-tea" (include "fullname" .)) }}

模板函数和管道符是转换信息强有力的方式，然后将其插入到YAML中。但有时需要插入一些模板逻辑，比仅插入一个字符串要复杂一些。下一部分，我们会看到模板语言提供的控制结构。

使用 lookup 函数

lookup 函数可以用于在运行的集群中查找资源。lookup 函数简称为 查找 apiVersion，Kind，namespace，name --> 资源或者资源列表

parameter	type
apiVersion	string
kind	string
namespace	string
name	string

name 和 namespace 都是可选的，且可以作为空字符串(“”)传递。

以下是可能的参数组合:

命令	Lookup 函数
kubectl get pods mypod -n mynamespace	lookup “v1” “Pod” “mynamespace” “mypod”
kubectl get pods -n mynamespace	lookup “v1” “Pod” “mynamespace” “”
kubectl get pods –all-namespaces	lookup “v1” “Pod” “” “”
kubectl get namespace mynamespace	lookup “v1” “Namespace” “” “mynamespace”
kubectl get namespaces	lookup “v1” “Namespace” “” “”

当 lookup 返回一个对象，它会返回一个字典。这个字典可以进一步被引导以获取特定值。

1. 下面的例子将返回 mynamespace 对象的注释：

   (lookup "v1" "Namespace" "" "mynamespace").metadata.annotations

2. 当 lookup 回一个对象列表时，可以通过 items 字段访问对象列表：

   {{ range $index, $service := (lookup "v1" "Service" "mynamespace" "").items }}
       {{/* do something with each service */}}
   {{ end }}

当对象未找到时，会返回空值。这可以用来检测对象是否存在。

lookup 函数使用 Helm 已有的 Kubernetes 连接配置查询 Kubernetes。当与调用API服务交互时返回了错误 （比如缺少资源访问的权限），helm 的模板操作会失败。

请记住，Helm 在 helm template 或者 helm install|update|delete|rollback --dry-run 时，不应该请求 Kubernetes API 服务。由此，lookup 函数在该案例中会返回空列表（即字典）。

运算符

对于模板来说，运算符( eq, ne, lt, gt, and, or 等等) 都是作为函数来实现的。 在管道符中，操作可以按照圆括号分组。