使用Helm包管理器

前面已经安装了Helm,本文讲解使用 Helm(和 Tiller)来管理 Kubernetes 群集。

如果只是想运行一些简单命令,可以从 快速入门指南 开始。本章将介绍 Helm 命令的具体内容,并解释如何使用 Helm。


三大概念


什么是Chart

一个 Chart 是一个 Helm 包。它包含在 Kubernetes 集群内部运行应用程序,工具或服务所需的所有资源定义。例如一个网站项目,由前端,后端和数据库组成,可以把这几部分组装陈一个Chart包,这样不用单独运维配置,一键即可启动这个网站了,是不是很完美呢?


什么是Repository

Repository是仓库的意思 Repository 是 Charts 存放的地方,供helm调用。


什么是Release

一个 Release 是处于 Kubernetes 集群中运行的 Chart 的一个实例。一个 chart 通常可以多次安装到同一个群集中。每次安装时,都会创建一个新 release 。比如像一个 MySQL chart。如果希望在群集中运行两个数据库,则可以安装该 chart 两次。每个都有自己的 release,每个 release 都有自己的 release name

有了这些概念,我们现在可以这样解释 Helm:

Helm 将 charts 安装到 Kubernetes 中,每个安装创建一个新 release 。要找到新的 chart,可以搜索 Helm charts 存储库 repositories

直白点说,repositories是仓库的意思。例如mvn repositories就是一个仓库。charts是一个软件包,release是这个软件包安装的一个软件。


'helm search': 查找 Charts

首次安装 Helm 时,它已预配置为使用官方 Kubernetes chart 存储库 repo。该 repo 包含许多精心设计和维护的 charts。此 charts repo 默认以 stable 命名。

可以通过运行 helm search 查看有哪些 charts 可用:

$ helm search
NAME                 	VERSION 	DESCRIPTION
stable/drupal   	0.3.2   	One of the most versatile open source content m...
stable/jenkins  	0.1.0   	A Jenkins Helm chart for Kubernetes.
stable/mariadb  	0.5.1   	Chart for MariaDB
stable/mysql    	0.1.0   	Chart for MySQL
...

如果没有使用过滤条件,helm search 显示所有可用的 charts。可以通过使用过滤条件进行搜索来缩小搜索的结果范围:

$ helm search mysql
NAME               	VERSION	DESCRIPTION
stable/mysql  	0.1.0  	Chart for MySQL
stable/mariadb	0.5.1  	Chart for MariaDB

现在只会看到与过滤条件匹配的结果。上面没有把所有的mysql查询出来,在你的电脑上可能会查出10来个mysql软件包 。

为什么 mariadb 在列表中?因为它的包描述中包含了MySQL关键词。我们可以使用 helm inspect chart 看到描述中的关键词:

$ helm inspect stable/mariadb
Fetched stable/mariadb to mariadb-0.5.1.tgz
description: Chart for MariaDB
engine: gotpl
home: https://mariadb.org
keywords:
- mariadb
- mysql
- database
- sql
...

搜索是找到可用软件包的好方法。一旦找到想要安装的软件包,可以使用 helm install 它来安装它。


'helm install':安装一个软件包

要安装新的软件包,请使用该 helm install 命令。最简单的方法,它只需要一个参数:chart 的名称。

$ helm install stable/mariadb
Fetched stable/mariadb-0.3.0 to /Users/mattbutcher/Code/Go/src/k8s.io/helm/mariadb-0.3.0.tgz
NAME: happy-panda
LAST DEPLOYED: Wed Sep 28 12:32:28 2016
NAMESPACE: default
STATUS: DEPLOYED

Resources:
==> extensions/Deployment
NAME                     DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
happy-panda-mariadb   1         0         0            0           1s

==> v1/Secret
NAME                     TYPE      DATA      AGE
happy-panda-mariadb   Opaque    2         1s

==> v1/Service
NAME                     CLUSTER-IP   EXTERNAL-IP   PORT(S)    AGE
happy-panda-mariadb   10.0.0.70    <none>        3306/TCP   1s


Notes:
MariaDB can be accessed via port 3306 on the following DNS name from within your cluster:
happy-panda-mariadb.default.svc.cluster.local

To connect to your database run the following command:

   kubectl run happy-panda-mariadb-client --rm --tty -i --image bitnami/mariadb --command -- mysql -h happy-panda-mariadb

现在 mariadb chart 已安装,请注意,安装 chart 会创建一个新 release 对象。上面的 release 被命名 为 happy-panda。(如果你想使用你自己的 release 名称,只需使用 --name 参数 配合 helm install。)

在安装过程中,helm 客户端将打印有关创建哪些资源的有用信息,release 的状态以及是否可以或应该采取其他的配置步骤。

Helm 不会一直等到所有资源都运行才退出。许多 charts 需要大小超过 600M 的 Docker 镜像,因此可能需要很长时间才能安装到群集中。

要跟踪 release 状态或重新读取配置信息,可以使用 helm status

$ helm status happy-panda
Last Deployed: Wed Sep 28 12:32:28 2016
Namespace: default
Status: DEPLOYED

Resources:
==> v1/Service
NAME                     CLUSTER-IP   EXTERNAL-IP   PORT(S)    AGE
happy-panda-mariadb   10.0.0.70    <none>        3306/TCP   4m

==> extensions/Deployment
NAME                     DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
happy-panda-mariadb   1         1         1            1           4m

==> v1/Secret
NAME                     TYPE      DATA      AGE
happy-panda-mariadb   Opaque    2         4m


Notes:
MariaDB can be accessed via port 3306 on the following DNS name from within your cluster:
happy-panda-mariadb.default.svc.cluster.local

To connect to your database run the following command:

   kubectl run happy-panda-mariadb-client --rm --tty -i --image bitnami/mariadb --command -- mysql -h happy-panda-mariadb

以上显示了集群内 release 的当前状态。


在安装前自定义 chart

上面的安装方式使用 chart 的默认配置选项。很多时候,我们需要自定义 chart 以使用自定义配置。

要查看 chart 上可配置的选项,请使用 helm inspect values + chart

helm inspect values stable/mariadb
Fetched stable/mariadb-0.3.0.tgz to /Users/mattbutcher/Code/Go/src/k8s.io/helm/mariadb-0.3.0.tgz
## Bitnami MariaDB image version
## ref: https://hub.docker.com/r/bitnami/mariadb/tags/
##
## Default: none
imageTag: 10.1.14-r3

## Specify a imagePullPolicy
## Default to 'Always' if imageTag is 'latest', else set to 'IfNotPresent'
## ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images
##
# imagePullPolicy:

## Specify password for root user
## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#setting-the-root-password-on-first-run
##
# mariadbRootPassword:

## Create a database user
## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-user-on-first-run
##
# mariadbUser:
# mariadbPassword:

## Create a database
## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-on-first-run
##
# mariadbDatabase:

然后,可以在 YAML 格式的文件中覆盖任何这些设置,然后在安装过程中使用该文件。

$ cat <<EOF>  config.yaml
mariadbUser: user0
mariadbDatabase: user0db
EOF
$ helm install -f config.yaml stable/mariadb

以上将创建一个名称为 MariaDB 的默认用户 user0,并授予此用户对新创建 user0db 数据库的访问权限,其他使用这个 chart 的默认值。

在安装过程中有两种方式传递自定义配置数据:

  • --values(或 - f):指定一个 overrides 的 YAML 文件。可以指定多次,最右边的文件将优先使用
  • --set (也包括 --set-string--set-file): :在命令行上指定 overrides。

如果两者都使用,则将 --set 值合并到 --values 更高的优先级中。指定的 override --set 将保存在 configmap 中。--set 可以通过使用特定的版本查看已经存在的值 helm get values <release-name>,--set 设置的值可以通过运行 helm upgrade 带有 --reset-values 参数重置。


--set 格式和限制

--set 选项使用零个或多个 name/value 对。最简单的用法:--set name=value。YAML 的表示是:

name: value

多个值由, 字符分隔。因此 --set a=b,c=d 变成:

a: b
c: d

支持更复杂的表达式。例如,--set outer.inner=value 变成这样:

outer:
  inner: value

列表可以通过在 {和} 中包含值来表示。例如, --set name={a, b, c} 转化为:

name:
  - a
  - b
  - c

从 Helm 2.5.0 开始,可以使用数组索引语法访问列表项。例如,--set servers[0].port=80 变成:

servers:
  - port: 80

可以通过这种方式设置多个值。该行 --set servers[0].port=80,servers[0].host=example 变成:

servers:
  - port: 80
    host: example

有时候你需要在 --set 行中使用特殊字符。可以使用反斜杠来转义字符; --set name="value1\,value2" 会变成:

name: "value1,value2"

同样,也可以转义点序列,这可能在 chart 中使用 toYaml 函数解析注释,标签和节点选择器时派上用场 。--set nodeSelector."kubernetes.io/role"=master 的语法变为:

nodeSelector:
  kubernetes.io/role: master

使用深层嵌套的数据结构可能很难用 --set 表达。鼓励 chart 设计师在设计 values.yaml 文件格式时考虑 --set 使用情况。

Helm 会使用 --set 将指定的某些值转换为整数。例如,--set foo = trueHelm 会将 true 强制转换为 int64 值。如果你想要一个字符串,请使用 --set 的变体名为 --set-string--set-string foo = true 会设置字符串值为 "true"

--set-file key = filepath--set 的另一种变体。 它读取文件并将其内容用作值。 它的一个示例用例是将多行文本注入值而不处理 YAML 中的缩进。 假设您要创建一个 brigade 项目,其中包含包含 5 行 JavaScript 代码的特定值,您可以编写一个 values.yaml,如:

defaultScript: |
  const {events, Job} = require("brigadier")
  function run(e, project) {
    console.log("hello default script")
  }
  events.on("run", run)

嵌入在 YAML 中,这使你更难以使用支持编写代码的 IDE 功能和测试框架等。 因此,你可以使用 -set-file defaultScript = brigade.js 替代,brigade.js 包含:

const {events, Job} = require("brigadier")
function run(e, project) {
  console.log("hello default script")
}
events.on("run", run)

更多的安装方法

helm install 命令可以从多个来源安装:

  • 一个 chart repository (像上面看到的)
  • 一个本地 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 upgrade' and 'helm rollback':升级版本和失败时恢复

当新版本的 chart 发布时,或者当你想要更改 release 配置时,可以使用 helm upgrade 命令。

升级需要已有的 release 并根据提供的信息进行升级。由于 Kubernetes chart 可能很大而且很复杂,因此 Helm 会尝试执行最小侵入式升级。它只会更新自上次发布以来发生更改的内容。

$ helm upgrade -f panda.yaml happy-panda stable/mariadb
Fetched stable/mariadb-0.3.0.tgz to /Users/mattbutcher/Code/Go/src/k8s.io/helm/mariadb-0.3.0.tgz
happy-panda has been upgraded. Happy Helming!
Last Deployed: Wed Sep 28 12:47:54 2016
Namespace: default
Status: DEPLOYED
...

在上面的例子中,happy-panda release 使用相同的 chart 进行升级,但使用新的 YAML 文件:

mariadbUser: user1

我们可以使用 helm get values 看看这个新设置是否生效。

$ helm get values happy-panda
mariadbUser: user1

该 helm get 命令是查看集群中的 release 的有用工具。正如我们上面所看到的,它表明我们的新值 panda.yaml 已被部署到群集中。

现在,如果在发布过程中某些事情没有按计划进行,那么使用回滚到以前的版本很容易 helm rollback [RELEASE] [REVISION]

$ helm rollback happy-panda 1

上述回滚我们的 “happy-panda” 到它的第一个 release 版本。release 版本是增量修订。每次安装,升级或回滚时,修订版本号都会增加 1. 第一个修订版本号始终为 1. 我们可以使用 helm history [RELEASE] 查看特定版本的修订版号。


安装 / 升级 / 回滚的有用选项

在安装 / 升级 / 回滚期间,可以指定几个其他有用的选项来定制 Helm 的行为。请注意,这不是 cli 参数的完整列表。要查看所有参数的说明,请运行 helm --help。

  • --timeout:等待 Kubernetes 命令完成的超时时间值(秒),默认值为 300(5 分钟)
  • --wait:等待所有 Pod 都处于就绪状态,PVC 绑定完,将 release 标记为成功之前,Deployments 有最小(Desired-maxUnavailable)Pod 处于就绪状态,并且服务具有 IP 地址(如果是 LoadBalancer,则为 Ingress )。它会等待 --timeout 的值。如果达到超时,release 将被标记为 FAILED。注意:在部署 replicas 设置为 1 maxUnavailable 且未设置为 0,作为滚动更新策略的一部分的情况下, --wait 它将返回就绪状态,因为它已满足就绪状态下的最小 Pod。
  • --no-hooks:这会跳过命令的运行钩子
  • --recreate-pods(仅适用于 upgrade 和 rollback):此参数将导致重新创建所有 pod(属于 deployment 的 pod 除外)

'helm delete':删除 Release

在需要从群集中卸载或删除 release 时,请使用以下 helm delete 命令:

$ helm delete happy-panda

这将从集群中删除该 release。可以使用以下 helm list 命令查看当前部署的所有 release:

$ helm list
NAME           	VERSION	UPDATED                        	STATUS         	CHART
inky-cat       	1      	Wed Sep 28 12:59:46 2016       	DEPLOYED       	alpine-0.1.0

从上面的输出中,我们可以看到该 happy-panda release 已被删除。

尽快如此,Helm 总是保留记录发生了什么。需要查看已删除的版本?helm list --deleted 可显示这些内容,并 helm list --all 显示了所有 release(已删除和当前部署的,以及失败的版本):

⇒  helm list --all
NAME           	VERSION	UPDATED                        	STATUS         	CHART
happy-panda   	2      	Wed Sep 28 12:47:54 2016       	DELETED        	mariadb-0.3.0
inky-cat       	1      	Wed Sep 28 12:59:46 2016       	DEPLOYED       	alpine-0.1.0
kindred-angelf 	2      	Tue Sep 27 16:16:10 2016       	DELETED        	alpine-0.1.0

由于 Helm 保留已删除 release 的记录,因此不能重新使用 release 名称。(如果 确实 需要重新使用此 release 名称,则可以使用此 --replace 参数,但它只会重用现有 release 并替换其资源。)

请注意,因为 release 以这种方式保存,所以可以回滚已删除的资源并重新激活它。


'helm repo':使用存储库

到目前为止,我们一直只从 stable 存储库 repo 安装 chart。但是可以配置 helm 使用其他 repo。Helm 在该 helm repo 命令下提供了多个 repo 工具。

可以使用 helm repo list 以下命令查看配置了哪些 repo:

$ helm repo list
NAME           	URL
stable         	https://kubernetes-charts.storage.googleapis.com
local          	http://localhost:8879/charts
mumoshu        	https://mumoshu.github.io/charts

新的 repo 可以通过 helm repo add 添加:

$ helm repo add dev https://example.com/dev-charts

由于 chart repo 经常更改,因此可以随时通过运行 helm repo update 确保 Helm 客户端处于最新状态。


创建你自己的 charts

该 chart 开发指南 Chart Development Guide 介绍了如何开发自己的 charts。也可以通过使用以下 helm create 命令快速入门:

$ helm create deis-workflow
Creating deis-workflow

现在有一个 chart./deis-workflow。可以编辑它并创建自己的模板。

在编辑 chart 时,可以通过 helm lint 验证它是否格式正确。

当将 chart 打包分发时,可以运行以下 helm package 命令:

$ helm package deis-workflow
deis-workflow-0.1.0.tgz

现在可以通过 helm install 以下方式轻松安装该 chart:

$ helm install ./deis-workflow-0.1.0.tgz
...

可以将已归档的 chart 加载到 chart repo 中。请参阅 chart repo 服务器的文档以了解如何上传。

注意:stable repo 在 Helm Charts GitHub 存储库 Helm Charts GitHub repository 上进行管理。该项目接受 chart 源代码,并且(在审计后)自动打包。


Tiller,Namespaces 和 RBAC

在某些情况下,可能希望将 Tiller 的范围或将多个 Tillers 部署到单个群集。以下是在这些情况下操作的一些最佳做法。

  1. Tiller 可以安装到任何 namespace。默认情况下,它安装在 kube-system 中。可以运行多个 Tillers,只要它们各自在自己的 namespace 中运行。
  2. 限制 Tiller 只能安装到特定的 namespace 和 / 或资源类型由 Kubernetes RBAC 角色和角色绑定控制。可以通过在配置 Helm 时通过 helm init --service-account <NAME> 向 Tiller 添加服务帐户。你可以在这里 here. 找到更多的信息。
  3. Release 名称在每个 Tiller 实例中是唯一的。
  4. chart 应该只包含存在于单个命名空间中的资源。
  5. 不建议将多个 Tillers 配置为在相同的命名空间中管理资源。


    总结

本章介绍了 helm 客户端的基本使用模式,包括搜索,安装,升级和删除。它也涵盖了有用的工具命令类似如 helm statushelm gethelm repo

有关这些命令的更多信息,请查看 Helm 的内置帮助:helm help

在下一章中,我们将看看开发chart的过程。