为什么需要Helm
K8S上的应用对象,都是由特定的资源描述组成,包括deployment、service等。都保存各自文件中或者集中写到一个配置文件,然后kubectl apply –f 部署。
如果应用只由一个或几个这样的服务组成,上面部署方式足够了。
而对于一个复杂的应用,会有很多类似上面的资源描述文件,例如微服务架构应用,组成应用的服务可能多达十个,几十个。如果有更新或回滚应用的需求,可能要修改和维护所涉及的大量资源文件,而这种组织和管理应用的方式就显得力不从心了。
且由于缺少对发布过的应用版本管理和控制,使Kubernetes上的应用维护和更新等面临诸多的挑战,主要面临以下问题:
- 如何将这些服务作为一个整体管理
- 这些资源文件如何高效复用
- 不支持应用级别的版本管理
什么是Helm
Helm是一个Kubernetes的包管理工具,就像Linux下的包管理器,如yum/apt等,可以很方便的将之前打包好的yaml文件部署到kubernetes上。
Helm有几个重要概念:
- helm:一个命令行客户端工具,主要用于Kubernetes应用chart的创建、打包、发布和管理。
- Chart:应用描述,一系列用于描述 k8s 资源相关文件的集合。
- Release:基于Chart的部署实体,一个 chart 被 Helm 运行后将会生成对应的一个 release;将在k8s中创建出真实运行的资源对象。
Helm客户端
1、部署Helm客户端
Helm客户端下载地址:Releases · helm/helm · GitHub
解压移动到/usr/bin/目录即可
2、Helm常用命令
命令 | 描述 |
---|---|
create | 创建一个chart并指定名字 |
dependency | 管理chart依赖 |
get | 下载一个release。可用子命令:all、hooks、manifest、notes、values |
history | 获取release历史 |
install | 安装一个chart |
list | 列出release |
package | 将chart目录打包到chart存档文件中 |
pull | 从远程仓库中下载chart并解压到本地 # helm pull stable/mysql --untar |
repo | 添加,列出,移除,更新和索引chart仓库。可用子命令:add、index、list、remove、update |
rollback | 从之前版本回滚 |
search | 根据关键字搜索chart。可用子命令:hub、repo |
show | 查看chart详细信息。可用子命令:all、chart、readme、values |
status | 显示已命名版本的状态 |
template | 本地呈现模板 |
uninstall | 卸载一个release |
upgrade | 更新一个release |
version | 查看helm客户端版本 |
需要自定义chart配置选项,安装过程中有两种方法可以传递配置数据:
- --values(或-f):指定带有覆盖的YAML文件。这可以多次指定,最右边的文件优先
- --set:在命令行上指定替代。如果两者都用,--set优先级高
values yaml与set使用:
helm install命令可以从多个来源安装:
- chart存储库
- 本地chart存档(helm install foo-0.1.1.tgz)
- chart目录(helm install path/to/foo)
- 完整的URL(helm install https://example.com/charts/foo-1.2.3.tgz)
Helm基本使用
构建一个Helm Chart
# helm create mychart
Creating mychart
# tree mychart/
mychart/
├── charts
├── Chart.yaml
├── templates
│ ├── deployment.yaml
│ ├── _helpers.tpl
│ ├── ingress.yaml
│ ├── NOTES.txt
│ └── service.yaml
└── values.yaml
- Chart.yaml:用于描述这个 Chart的基本信息,包括名字、描述信息以及版本等。
- values.yaml :用于存储 templates 目录中模板文件中用到变量的值。
- Templates: 目录里面存放所有yaml模板文件。
- charts:目录里存放这个chart依赖的所有子chart。
- NOTES.txt :用于介绍Chart帮助信息, helm install 部署后展示给用户。例如:如何使用这个 Chart、列出缺省的设置等。
- _helpers.tpl:放置模板助手的地方,可以在整个 chart 中重复使用
Chart模板
Helm最核心的就是模板,即模板化的K8S manifests文件。
它本质上就是一个Go的template模板。Helm在Go template模板的基础上,还会增加很多东西。如一些自定义的元数据信息、扩展的库以及一些类似于编程形式的工作流,例如条件语句、管道等等。这些东西都会使得我们的模板变得更加丰富。
[root@master demo-nginx]# tree
.
├── charts
├── Chart.yaml
├── templates
│ ├── deployment.yaml
│ └── service.yaml
└── values.yaml
2 directories, 4 files
[root@master demo-nginx]# cat templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: myapp
spec:
selector:
matchLabels:
app: myapp
template:
metadata:
labels:
app: myapp
spec:
containers:
- name: myapp
image: nginx
resources:
limits:
memory: "128Mi"
cpu: "500m"
ports:
- containerPort: 80
[root@master demo-nginx]# cat templates/service.yaml
apiVersion: v1
kind: Service
metadata:
name: myapp
spec:
selector:
app: myapp
ports:
- port: 80
targetPort: 80
[root@master demo-nginx]#
实际上,这已经是一个可安装的Chart包了,通过 helm install
命令来进行安装:
[root@master chart]# helm install demo-nginx demo-nginx/
NAME: demo-nginx
LAST DEPLOYED: Tue Mar 21 11:44:34 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
[root@master chart]#
但是这样部署,其实与直接apply没什么两样。
内置对象
常用的内置对象:
Release.Name | release 名称 |
---|---|
Release.Time | release 的时间 |
Release.Namespace | release 的 namespace(如果清单未覆盖) |
Release.Service | release 服务的名称 |
Release.Revision | 此 release 的修订版本号,从1开始累加 |
Release.IsUpgrade | 如果当前操作是升级或回滚,则将其设置为 true。 |
Release.IsInstall | 如果当前操作是安装,则设置为 true。 |
Values
Values对象是为Chart模板提供值,这个对象的值有4个来源:
- chart 包中的 values.yaml 文件
- 父 chart 包的 values.yaml 文件
- 通过 helm install 或者 helm upgrade 的
-f
或者--values
参数传入的自定义的 yaml 文件 - 通过
--set
参数传入的值
chart 的 values.yaml 提供的值可以被用户提供的 values 文件覆盖,而该文件同样可以被 --set
提供的参数所覆盖。
[root@master demo-nginx]# cat values.yaml
replicaCount: 2
image:
repository: nginx
tag: 1.17
[root@master demo-nginx]# cat templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .Release.Name }}
spec:
replicas: {{ .Values.replicaCount }}
selector:
matchLabels:
app: {{ .Release.Name }}
template:
metadata:
labels:
app: {{ .Release.Name }}
spec:
containers:
- name: {{ .Release.Name }}
image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
resources:
limits:
memory: "128Mi"
cpu: "500m"
[root@master demo-nginx]#
管道与函数
模板引擎还支持对数据进行二次处理。
例如从Values中读取的值变成字符串,可以使用quote
函数实现:
app: {{ quote .Values.label.app }}
quote .Values.label.app 将后面的值作为参数传递给quote函数。
模板函数调用语法为:functionName arg1 arg2...
另外还会经常使用一个default函数,该函数允许在模板中指定默认值,以防止该值被忽略掉。
例如忘记定义,执行helm install 会因为缺少字段无法创建资源,这时就可以定义一个默认值。
spec:
replicas: {{ .Values.replicas | default 2 }}
其他函数:
缩进:{{ .Values.resources | indent 12 }}
大写:{{ upper .Values.resources }}
首字母大写:{{ title .Values.resources }}
流程控制
流程控制是为模板提供了一种能力,满足更复杂的数据逻辑处理。
Helm模板语言提供以下流程控制语句:
if/else
条件块with
指定范围range
循环块
if
if/else
块是用于在模板中有条件地包含文本块的方法,条件块的基本结构如下:
{{ if PIPELINE }}
# Do something
{{ else if OTHER PIPELINE }}
# Do something else
{{ else }}
# Default case
{{ end }}
条件判断就是判断条件是否为真,如果值为以下几种情况则为false:
- 一个布尔类型的
假
- 一个数字
零
- 一个
空
的字符串 - 一个
nil
(空或null
) - 一个空的集合(
map
、slice
、tuple
、dict
、array
)
除了上面的这些情况外,其他所有条件都为 真
。
例如,如果.Values.env.hello值为world,则值为hello: true
# cat values.yaml
replicas: 2
label:
project: ms
app: product
env:
hello: "world"
# cat templates/deploymemt.yaml
env:
{{ if eq .Values.env.hello "world" }}
- name: hello
value: 123
{{ end }}
其中运算符 eq
是判断是否相等的操作,除此之外,还有 ne
、 lt
、 gt
、 and
、 or
等运算符。
通过模板引擎来渲染一下,会得到如下结果:
# helm install --dry-run web ../mychart/
...
env:
- name: hello
value: 123
可以看到渲染出来会有多余的空行,这是因为当模板引擎运行时,会将控制指令删除,所有之前占的位置也就空白了,需要使用{{- if ...}} 的方式消除此空行:
# cat templates/deploymemt.yaml
...
env:
{{- if eq .Values.env.hello "world" }}
- name: hello
value: 123
{{- end }}
现在是不是没有多余的空格了,如果使用-}}
需谨慎,比如上面模板文件中:
# cat templates/deploymemt.yaml
...
env:
{{- if eq .Values.env.hello "world" -}}
- hello: true
{{- end }}
这会渲染成:
env:- hello: true
因为-}}
它删除了双方的换行符。
with
with :控制变量作用域。
其语法和一个简单的 if
语句比较类似:
{{ with PIPELINE }}
# restricted scope
{{ end }}
with
语句可以允许将当前范围 .
设置为特定的对象,比如我们前面一直使用的 .Values.label
,我们可以使用 with
来将 .
范围指向 .Values.label
:
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .Values.name | default "web" }}
spec:
replicas: {{ .Values.replicas }}
selector:
matchLabels:
project: {{ .Values.label.project }}
app: {{ .Values.label.app }}
template:
metadata:
labels:
project: {{ .Values.label.project }}
app: {{ .Values.label.app }}
{{- with .Values.label }}
project: {{ .project }}
app: {{ .app }}
{{- end }}
上面增加了一个{{- with .Values.label }} xxx {{- end }}的一个块,这样的话就可以在当前的块里面直接引用 .project
和 .app
了。
需要注意的在 with
声明的范围内,将无法从父范围访问到其他对象了,比如:
{{- with .Values.label }}
project: {{ .project }}
app: {{ .app }}
{{ .Release.Name }}
{{- end }}
range
在 Helm 模板语言中,使用 range
关键字来进行循环操作。
# cat values.yaml
replicas: 2
label:
project: ms
app: product
env:
hello: "world"
test: "yes"
循环打印该列表:
env:
{{- range .Values.env }}
{{ . }}
{{- end }}
循环内部我们使用的是一个 .
,这是因为当前的作用域就在当前循环内,这个 .
引用的当前读取的元素。
但结果并不是我们所期望的:
env:
- name: world
value: world
变量
在模板中,使用变量的场合不多,但我们将看到如何使用它来简化代码,并更好地利用with和range。
1、获取列表键值
# cat ../values.yaml
env:
NAME: "gateway"
JAVA_OPTS: "-Xmx1G"
# cat deployment.yaml
...
env:
{{- range $k, $v := .Values.env }}
- name: {{ $k }}
value: {{ $v | quote }}
{{- end }}
结果如下:
env:
- name: JAVA_OPTS
value: "-Xmx1G"
- name: NAME
value: "gateway"
range
循环中使用 $key
和 $value
两个变量来接收后面列表循环的键和值。
2、with中不能使用内置对象
with
语句块内不能再 .Release.Name
对象,否则报错。
我们可以将该对象赋值给一个变量可以来解决这个问题:
{{- $releaseName := .Release.Name -}}
{{- with .Values.label }}
project: {{ .project }}
app: {{ .app }}
release: {{ $releaseName }}
# 或者可以使用$符号,引入全局命名空间
release: {{ $.Release.Name }}
{{- end }}
可以看到在 with
语句上面增加了一句 {{-$releaseName:=.Release.Name-}}
,其中 $releaseName
就是后面的对象的一个引用变量,它的形式就是 $name
,赋值操作使用 :=
,这样 with
语句块内部的 $releaseName
变量仍然指向的是 .Release.Name
命名模板
命名模板:使用define定义,template引入,在templates目录中默认下划线_开头的文件为公共模板 _helpers.tpl
# cat _helpers.tpl
{{- define "demo.fullname" -}}
{{- .Chart.Name -}}-{{ .Release.Name }}
{{- end -}}
# cat deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ template "demo.fullname" . }}
...
template指令是将一个模板包含在另一个模板中的方法。但是,template函数不能用于Go模板管道。为了解决该问题,增加include功能。
# cat _helpers.tpl
{{- define "demo.labels" -}}
app: {{ template "demo.fullname" . }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
release: "{{ .Release.Name }}"
{{- end -}}
# cat deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ include "demo.fullname" . }}
labels:
{{- include "demo.labels" . | nindent 4 }}
...
上面包含一个名为 demo.labels
的模板,然后将值 .
传递给模板,最后将该模板的输出传递给 nindent
函数。