elm官方文档摘录

Chart 代表着 Helm 包。它包含在 Kubernetes 集群内部运行应用程序，工具或服务所需的所有资源定义。你可以把它看作是 Homebrew formula，Apt dpkg，或 Yum RPM 在Kubernetes 中的等价物。

Repository（仓库） 是用来存放和共享 charts 的地方。它就像 Perl 的 CPAN 档案库网络 或是 Fedora 的 软件包仓库，只不过它是供 Kubernetes 包所使用的。

Release 是运行在 Kubernetes 集群中的 chart 的实例。一个 chart 通常可以在同一个集群中安装多次。每一次安装都会创建一个新的 release。以 MySQL chart为例，如果你想在你的集群中运行两个数据库，你可以安装该chart两次。每一个数据库都会拥有它自己的 release 和 release name。

在了解了上述这些概念以后，我们就可以这样来解释 Helm：Helm 安装 charts 到 Kubernetes 集群中，每次安装都会创建一个新的 release。你可以在 Helm 的 chart repositories 中寻找新的 chart。

Helm按照以下顺序安装资源：

本节只简单说明几个概念和语法。

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

模板中横线的作用：

Helm模板中，变量是对另一个对象的命名引用。

变量的作用域一般不是全局的，而是其声明所在的块。所谓块，是指if/else、with、range、define、template、block定义的范围。

.代表对当前作用域的引用，.Values表示在当前作用域查找Values对象。每个模板中，默认可以访问到的内置对象有Release、Values、Chart、Files、Capabilities和Template。如果定义了块，那么在块中不可以通过.Values找到Values对象。

$代表对根作用域的引用，$.Values表示在根作用域查找Values对象。如果定义了块，那么在块中可以通过$.Values找到Values对象。

Helm 模板语言是用强类型Go编程语言实现的。 因此，模板中的变量是 有类型的。大多数情况下，变量将作为以下类型之一显示：

Go里面有很多其他类型，有时你需要在模板里转换。调试对象类型最简便的方式是在模板中传递给printf “%t”，这样会打印类型。 也可以使用 typeOf 和 kindOf 函数。

命名模板（也被称作一个 部分 或一个 子模板）名称是全局的。一个常见的命名惯例是用chart名称作为模板前缀。使用特定chart名称作为前缀可以避免可能因为 两个不同chart使用了相同名称的模板而引起的冲突。

template渲染时，一般传入.作为命名模板可以访问的范围。include是template的替代，只是为了更好地处理YAML文档的输出格式，方便缩进。

.helmignore 文件用来指定你不想包含在你的helm chart中的文件。如果该文件存在，helm package 命令会在打包应用时忽略所有在 .helmignore 文件中匹配的文件。

一些值得注意的和.gitignore不同之处：

include方法允许你引入另一个模板，并将结果传递给其他模板方法。比如，这个模板片段包含了一个叫mytpl的模板，然后将其转成小写，并使用双引号括起来。

tpl方法允许开发者在模板中使用字符串作为模板。将模板字符串作为值传给chart或渲染额外的配置文件时会很有用。语法： {{ tpl TEMPLATE_STRING VALUES }}

有时你想在chart中创建可以重复利用的部分，不管是块还是局部模板。通常将这些文件保存在自己的文件中会更干净。

3、模板中使用辅助模板

根据YAML规范，YAML是JSON的超集。这意味着任意的合法JSON结构在YAML中应该是合法的。

这有个优势：有时候模板开发者会发现使用类JSON语法更容易表达数据结构而不是处理YAML的空白敏感度。

作为最佳实践，模板应遵循类YAML语法 除非 JSON语法大大降低了格式问题的风险。

在CNCF的 Artifact Hub 中的很多chart是创建更先进应用的“组成部分”。但是chart可能被用于创建大规模应用实例。 在这种场景中，一个总的chart会有很多子chart，每一个是整体功能的一部分。

当前从离散组件组成一个复杂应用的最佳实践是创建一个顶层总体chart构建全局配置，然后使用charts子目录嵌入每个组件。

chart名称必须是小写字母和数字。单词之间可以使用横杠分隔(-)。

当SemVer版本存储在Kubernetes标签中时，我们通常把+字符改成_，因为标签不允许使用+作为值进行签名。

YAML 文件应该按照 双空格 缩进(绝不要使用tab键)。

以下是几个 Helm 和 helm 的惯用方法。

若有疑问，使用 Helm (‘H’大写)。

变量名称以小写字母开头，单词按驼峰区分

YAML是一种灵活格式，值可以嵌套得很深，也可以是扁平的。大多数场景中，扁平的优于嵌套的。因为对模板开发者和用户来说更加简单。

YAML的类型强制规则有时候是很反常的。比如，foo: false 和 foo: “false” 是不一样的。大整型数如：foo: 12345678 有时会被转换成科学计数法。

避免类型强制规则错误最简单的方式是字符串明确定义，其他都是不明确的。或者，简单来讲， 给所有字符串打引号。

通常，为了避免整数转换问题，将整型存储为字符串更好，并用 {{ int $value }} 在模板中将字符串转回整型。

在大多数场景中，显式的类型标记更好，所以 foo: !!string 1234 会将1234作为字符串对待。 但是，YAML解析器会消耗标记，因此类型数据在一次解析后会丢失。

templates/目录结构应该如下：

定义的模板(在{{ define }}命令中定义的模板)是可全局访问的。这就意味着chart和所有的子chart都可以访问用{{ define }}创建的所有模板。

因此， 所有定义的模板名称应该被命名空间化。

正确的：

不正确的：

强烈建议通过helm create命令创建新chart，因为模板名称是根据此最佳实践自动定义的。

模板应该使用两个 空格 缩进（永远不要用tab）。模板命令的大括号前后应该使用空格。正确的：

不正确的：

最好在生成的模板中将空格量保持在最小值。尤其是大量的空行不应该相邻出现。但偶尔有空行（尤其在逻辑块之间）是没问题的。

YAML和Helm模板都有注释标记符。YAML注释：

模板注释：

YAML是JSON的超集。在某些情况下，使用JSON语法比其他YAML表示更具可读性。

比如，这个YAML更接近表示列表的普通YAML方法：

但是折叠成JSON列表样式时会更易阅读:

使用JSON可以很好地提高易读性。然而，JSON语法不应用于表示更复杂的结构。

如果元数据项不是用于查询，就应该设置为注释。

Pod指的是Pod，Pod模板指的是Deployment、ReplicationController、ReplicaSet、DaemonSet、StatefulSet等。

容器镜像应该使用固定的tag或镜像SHA。不应该使用latest, head, canary等标签或其他被设计为“浮动的”标签。

所有的Pod模板部分应该指定一个selector。比如：

RBAC 资源有：

RBAC和服务账户配置应该使用独立的key。它们是独立的内容。在YAML中将这两个概念分开可以消除歧义使其更加清晰。