chart文件结构
chart是一个组织在文件目录中的集合。目录名称就是chart名称(没有版本信息)
chartname/
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 # 可选: 包含简要使用说明的纯文本文件
Chart.yaml 文件
apiVersion: chart API 版本 (必需)
name: chart名称 (必需)
version: chart的版本(必需)
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: 按名称输入的批注列表 (可选)
- apiVersion:v2至少需要helm3,但helm3也支持v1。v1和v2的区别:a)依赖charts的定义,v1是requirements.yaml,v2是chart.yaml中的dependencies字段。b)
v2支持type字段 - type:application 和 library,后者不能被安装
- dependencies:依赖charts,例如
dependencies:
- name: apache
version: 1.2.3
repository: https://example.com/charts
- name: mysql
version: 3.2.1
repository: https://another.example.com/charts
一旦你定义好了依赖,运行 helm dependency update 就会使用你的依赖文件下载所有你指定的chart到你的charts/目录
注意:当Helm安装/升级chart时,chart中所有的Kubernetes对象以及依赖会
聚合成一个单一的集合;然后
按照类型和名称排序;然后
按这个顺序创建/升级。
依赖charts更多详细内容参见官网:https://helm.sh/zh/docs/topics/charts/
Templates and Values
Helm Chart 模板是按照 Go模板语言书写, 增加了50个左右的附加模板函数(来自 Sprig库)和一些其他 指定的函数。
模板的Value通过两种方式提供:
Chart开发者:可以在chart中提供一个命名为 values.yaml 的文件。这个文件包含了默认值。
Chart用户:可以提供一个包含了value的YAML文件。可以在命令行使用 helm install命令时提供。
value的定义比较简单,关于全局value、子chart的value等可以参考官网。https://helm.sh/zh/docs/topics/charts/
用户自定义资源(CRD)
CRD YAML文件应被放置在chart的crds/目录中。 多个CRD(用YAML的开始和结束符分隔)可以被放置在同一个文件中。Helm会尝试加载CRD目录中 所有的 文件到Kubernetes。
CRD 文件 无法模板化,必须是普通的YAML文档。
当Helm安装新chart时,会先上传CRD,直到CRD可以被API server使用,然后启动模板引擎, 渲染chart其他部分。
注意:
- CRD从不重新安装。 如果Helm确定crds/目录中的CRD已经存在(忽略版本),Helm不会安装或升级。
- CRD从不会在升级或回滚时安装。Helm只会在安装时创建CRD。
- CRD从不会被删除。自动删除CRD会删除集群中所有命名空间中的所有CRD内容。因此Helm不会删除CRD。