Helm-Chart入门

1,649次阅读
没有评论

Chart

Helm 使用的包格式称为  chart。chart 就是一个描述 Kubernetes 相关资源的文件集合。单个 chart 可以用来部署一些简单的,类似于 memcache pod,或者某些复杂的 HTTP 服务器以及 web 全栈应用、数据库、缓存等等。

Chart 是作为特定目录布局的文件被创建的。它们可以打包到要部署的版本存档中。

如果你想下载和查看一个发布的 chart,但不安装它,你可以用这个命令: helm pull chartrepo/chartname。

该文档解释说明了 chart 格式,并提供了用 Helm 构建 chart 的基本指导。

Chart 文件结构

chart 是一个组织在文件目录中的集合。目录名称就是 chart 名称(没有版本信息)。因而描述 WordPress 的 chart 可以存储在 wordpress/ 目录中。

在这个目录中,Helm 期望可以匹配以下结构:

wordpress/
  Chart.yaml          # 包含了 chart 信息的 YAML 文件
  LICENSE             # 可选: 包含 chart 许可证的纯文本文件
  README.md           # 可选: 可读的 README 文件
  values.yaml         # chart 默认的配置值
  values.schema.json  # 可选: 一个使用 JSON 结构的 values.yaml 文件
  charts/             # 包含 chart 依赖的其他 chart
  crds/               # 自定义资源的定义
  templates/          # 模板目录,当和 values 结合时,可生成有效的 Kubernetes manifest 文件
  templates/NOTES.txt # 可选: 包含简要使用说明的纯文本文件

Helm 保留使用  charts/crds/, templates/目录,以及列举出的文件名。其他文件保持原样。

Chart.yaml 文件

Chart.yaml文件是 chart 必需的。包含了以下字段:

具体必需字段的含义,参考https://helm.sh/zh/docs/topics/charts/

apiVersion: chart API 版本(必需)name: chart 名称(必需)version: 语义化 2 版本(必需)kubeVersion: 兼容 Kubernetes 版本的语义化版本(可选)description: 一句话对这个项目的描述(可选)type: chart 类型(可选)keywords:
  - 关于项目的一组关键字(可选)home: 项目 home 页面的 URL(可选)sources:
  - 项目源码的 URL 列表(可选)dependencies: # chart 必要条件列表(可选)- name: chart 名称 (nginx)
    version: chart 版本 ("1.2.3")
    repository:(可选)仓库 URL ("https://example.com/charts") 或别名 ("@repo-name")
    condition:(可选)解析为布尔值的 yaml 路径,用于启用 / 禁用 chart (e.g. subchart1.enabled)
    tags: #(可选)- 用于一次启用 / 禁用 一组 chart 的 tag
    import-values: #(可选)- ImportValue 保存源值到导入父键的映射。每项可以是字符串或者一对子 / 父列表项
    alias:(可选)chart 中使用的别名。当你要多次添加相同的 chart 时会很有用
maintainers: #(可选)- name: 维护者名字(每个维护者都需要)email: 维护者邮箱(每个维护者可选)url: 维护者 URL(每个维护者可选)icon: 用做 icon 的 SVG 或 PNG 图片 URL(可选)appVersion: 包含的应用版本(可选)。不需要是语义化,建议使用引号
deprecated: 不被推荐的 chart(可选,布尔值)annotations:
  example: 按名称输入的批注列表(可选).

Chart 和版本控制

每个 chart 都必须有个版本号。版本必须遵循  语义化版本 2  标准。不像经典 Helm,Helm v2 以及后续版本会使用版本号作为发布标记。仓库中的包通过名称加版本号标识。

比如  nginx chart 的版本字段 version: 1.2.3 按照名称被设置为:

nginx-1.2.3.tgz

helm chart 模版

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

查看 mychart/templates/ 目录

  • NOTES.txt: chart 的 ” 帮助文本 ”。这会在你的用户执行 helm install 时展示给他们。
  • deployment.yaml: 创建 Kubernetes 工作负载 的基本清单
  • service.yaml: 为你的工作负载创建一个  service 终端 基本清单。
  • _helpers.tpl: 放置可以通过 chart 复用的模板辅助对象

第一个模版

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

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

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

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

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

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

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

安装 chart

$ 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
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

正文完
 
评论(没有评论)