【笔记】Helm-5 Chart模板指南-1 从这里开始吧

从这里开始吧

指南的该部分，我们会创建一个chart并添加第一个模板。创建的chart会在后续指南中用到。

接下来，让我们简单看一下Helm chart。

Charts

如 Charts指南 所述，Helm chart的结构如下： 

Helm | Chart

mychart/

  Chart.yaml

  values.yaml

  charts/

  templates/

  ...

mychart/
  Chart.yaml
  values.yaml
  charts/
  templates/
  ...

templates/目录包括了模板文件。当Helm评估chart时，会通过模板渲染引擎将所有文件发送到templates/目录中。然后收集模板的结果并发送给Kubernetes。

values.yaml文件也导入了模板。这个文件包含了chart的默认值。这些值会在用户执行helm install或helm upgrade时被覆盖。

Chart.yaml文件包含了该chart的描述。您可以从模板中访问它。charts/目录可以包含其他的chart（称之为子chart）。指南稍后我们会看到当涉及模板渲染时这些是如何工作的。

入门Chart

在本指南中我们会创建一个名为mychart的Chart，然后会在chart中创建一些模板。

$ helm create mychart

Creating mychart

$ helm create mychart
Creating mychart

快速查看mychart/templates/

如果您查看mychart/templates/目录，会注意到一些文件已经存在了：

1、NOTES.txt

chart的“帮助文本”。这会在您的用户执行helm install时展示给他们。

2、deployment.yaml

创建Kubernetes 工作负载 的基本清单。

https://kubernetes.io/docs/user-guide/deployments/

3、service.yaml

为您的工作负载创建一个 service终端 基本清单。

https://kubernetes.io/docs/user-guide/services/

4、_helpers.tpl

放置可以通过chart复用的模板辅助对象。

然后我们要做的是。。。把它们全部删掉！这样我们就可以从头开始学习我们的教程。我们在开始时会创造自己的NOTES.txt和_helpers.tlp。

$ rm -f mychart/templates/*

编制生产环境级别的chart时，有这些chart的基础版本会很有用。因此在日常编写中，您可能不想删除它们。

第一个模板

第一个创建的模板是ConfigMap。Kubernetes中，配置映射只是用于存储配置数据的对象。其他组件，比如pod，可以访问配置映射中的数据。

因为配置映射是基础资源，对我们来说是很好的起点。

让我们以创建一个名为 mychart/templates/configmap.yaml 的文件开始：

apiVersion: v1

kind: ConfigMap

metadata:

  name: mychart-configmap

data:

  myvalue: "Hello World"

apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
data:
  myvalue: "Hello World"

提示：模板名称不遵循严格的命名模式。但是建议以.yaml作为YAML文件的后缀，以 tpl 作为helper文件的后缀。

上述YAML文件是一个简单的配置映射，构成了最小的必须字段。因为文件在mychart/templates/目录中，它会通过模板引擎传递。

像这样一个普通的YAML文件放在mychart/templates/目录中是没问题的。当Heml读取这个模板时会按照原样传递给Kubernetes。

有了这个简单的模板，现在有一个可安装的chart了。现在安装如下：

$ helm install full-coral ./mychart

$ helm install full-coral ./mychart
NAME: full-coral
LAST DEPLOYED: Tue Nov  1 17:36:01 2016
NAMESPACE: default
STATUS: DEPLOYED
REVISION: 1
TEST SUITE: None

我们可以用Helm检索版本并查看实际加载的模板。

$ helm get manifest full-coral

___

# Source: mychart/templates/configmap.yaml

$ helm get manifest full-coral

---
# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
data:
  myvalue: "Hello World"

helm get manifest 命令后跟一个发布名称（full-coral）然后打印出了所有已经上传到server的Kubernetes资源。每个文件以--开头表示YAML文件的开头，然后是自动生成的注释行，表示哪个模板文件生成了这个YAML文档。

从这个地方开始，我们看到的YAML数据确实是configmap.yaml文件中的内容。

现在卸载发布：helm uninstall full-coral。

添加一个简单的模板调用

将name: 硬编码到一个资源中不是很好的方式。名称应该是唯一的。因此我们可能希望通过插入发布名称来生成名称字段。

提示：由于DNS系统的限制，name: 字段长度限制为63个字符。因此发布名称限制为53个字符。Kubernetes 1.3及更早版本限制为24个字符（名称成都是14个字符）。

对应改变一下configmap.yaml:

apiVersion: v1

kind: configmap

metadata:

  name: {{ .Release.Name }}-configmap

data:

  myvalue: "Hello World"

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"

大的变化是name: 字段的值，现在是{{ .Release.Name }}-configmap。

模板命令要括在 {{和}}之间。

模板命令{{ .Release.Name }}将发布名称注入了模板。值作为一个命名空间对象传给了模板，用点(.)分隔每个命名空间的元素。

Release前面的点表示从作用域最顶层的命名空间开始（稍后会谈作用域）。这样.Release.Name就可以解读为“从顶层命令空间开始查找Release对象，然后在其中找Name对象”。

Release是一个Helm的内置对象。稍后会更深入地讨论。但现在足够说明它可以显示从库中赋值的发布名称。

现在安装资源，可以立即看到模板命令的结果：

$ helm install clunky-serval ./mychart

$ helm install clunky-serval ./mychart
NAME: clunky-serval
LAST DEPLOYED: Tue Nov  1 17:45:37 2016
NAMESPACE: default
STATUS: DEPLOYED
REVISION: 1
TEST SUITE: None

可以运行helm get manifest clunky-serval查看生成的完整的YAML。

注意在kubernetes内的配置映射名称是clunky-serval-configmap，而不是之前的mychart-configmap。

由此我们已经看到了最基本的模板：YAML文件有嵌入在{{ 和 }}之间的模板命令。下一部分，会深入了解模板，但在这之前，有个快捷技巧可以加快模板的构建速度：当您想测试模板渲染的内容但有不想安装任何实际应用时，可以使用helm install --debug --dry-run goodly-guppy ./mychart。这样不会安装应用（chart）到您的kubernetes集群中，只会渲染模板内容到控制台（用于测试）。渲染后的模板如下：

$ helm install --debug --dry-run goodly-guppy ./mychart

$ helm install --debug --dry-run goodly-guppy ./mychart
install.go:149: [debug] Original chart version: ""
install.go:166: [debug] CHART PATH: /Users/ninja/mychart

NAME: goodly-guppy
LAST DEPLOYED: Thu Dec 26 17:24:13 2019
NAMESPACE: default
STATUS: pending-install
REVISION: 1
TEST SUITE: None
USER-SUPPLIED VALUES:
{}

COMPUTED VALUES:
affinity: {}
fullnameOverride: ""
image:
  pullPolicy: IfNotPresent
  repository: nginx
imagePullSecrets: []
ingress:
  annotations: {}
  enabled: false
  hosts:
  - host: chart-example.local
    paths: []
  tls: []
nameOverride: ""
nodeSelector: {}
podSecurityContext: {}
replicaCount: 1
resources: {}
securityContext: {}
service:
  port: 80
  type: ClusterIP
serviceAccount:
  create: true
  name: null
tolerations: []

HOOKS:
MANIFEST:
---
# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: goodly-guppy-configmap
data:
  myvalue: "Hello World"

使用--dry-run会让您变得更容易测试，但不能保证Kubernetes会接受您生成的模板。最好不要仅仅因为--dry-run可以正常运行就觉得chart可以安装。

在 Chart模板指南 中，我们以这里定义的chart基本模板为例详细讨论Heml模板语言。然后开始讨论内置对象。

Helm | Docs

————————————

仅用于本人学习

来源：Helm | Docs