Helm介绍
preview image

前言


Helm 是 Kubernetes 生态系统中的一个软件包管理工具。本文将介绍为何要使用 Helm 进行 Kubernetes 软件包管理,澄清 Helm 中使用到的相关概念,并通过一个具体的示例学习如何使用 Helm 打包,分发,安装,升级及回退 Kubernetes 应用。

Kubernetes 应用部署的挑战


让我们首先来看看 Kubernetes,kubernetes 提供了基于容器的应用集群管理,为容器化应用提供了部署运行、资源调度、服务发现和动态伸缩等一系列完整功能。

kubernetes 的核心设计理念是: 用户定义应用程序的规格,而 kubernetes 则负责按照定义的规则部署并运行应用程序,如果应用系统出现问题导致偏离了定义的规格,kubernetes 负责对其进行自动修正。例如应用规格要求部署两个实例,其中一个实例异常终止了,kubernetes 会检查到并重新启动一个新的实例。

用户通过使用 kubernetes API 对象来描述应用程序规格,包括 Pod,Service,Volume,Namespace,ReplicaSet,Deployment,Job 等等。一般这些对象需要写入一系列的 yaml 文件中,然后通过 kubernetes 命令行工具 kubectl 进行部署。

以下面的 wordpress 应用程序为例,涉及到多个 kubernetes API 对象,这些 kubernetes API 对象分散在多个 yaml 文件中。

Wordpress 应用程序中涉及到的 kubernetes API 对象
图 1: Wordpress 应用程序中涉及到的 kubernetes API 对象

可以看到,在进行 kubernetes 软件部署时,我们面临下述问题:

  • 如何管理,编辑和更新这些这些分散的 kubernetes 应用配置文件?
  • 如何把一套的相关配置文件作为一个应用进行管理?
  • 如何分发和重用 kubernetes 的应用配置?

Helm 的引入很好地解决上面这些问题。

Helm 是什么?


很多人都使用过 Ubuntu 下的 ap-get 或者 CentOS 下的 yum, 这两者都是 Linux 系统下的包管理工具。采用 apt-get/yum,应用开发者可以管理应用包之间的依赖关系,发布应用;用户则可以以简单的方式查找、安装、升级、卸载应用程序。

我们可以将 Helm 看作 Kubernetes 下的 apt-get/yum。Helm 是 Deis ( https://deis.com/ ) 开发的一个用于 kubernetes 的包管理器。

对于应用发布者而言,可以通过 Helm 打包应用,管理应用依赖关系,管理应用版本并发布应用到软件仓库。

对于使用者而言,使用 Helm 后不用需要了解 Kubernetes 的 Yaml 语法并编写应用部署文件,可以通过 Helm 下载并在 kubernetes 上安装需要的应用。

除此以外,Helm 还提供了 kubernetes 上的软件部署,删除,升级,回滚应用的强大功能。

Helm 组件及相关术语


开始接触 Helm 时遇到的一个常见问题就是 Helm 中的一些概念和术语非常让人迷惑,我开始学习 Helm 就遇到这个问题。

因此我们先了解一下 Helm 的这些相关概念和术语。

  • Helm

    Kubernetes 的应用打包工具,也是命令行工具的名称。

  • Tiller

    Helm 的服务端,部署在 Kubernetes 集群中,用于处理 Helm 的相关命令。

  • Chart

    Helm 的打包格式,内部包含了一组相关的 kubernetes 资源。

  • Repoistory

    Helm 的软件仓库,repository 本质上是一个 web 服务器,该服务器保存了 chart 软件包以供下载,并有提供一个该 repository 的 chart 包的清单文件以供查询。在使用时,Helm 可以对接多个不同的 Repository。

  • Release

    使用 Helm install 命令在 Kubernetes 集群中安装的 Chart 称为 Release。

需要特别注意的是, Helm 中提到的 Release 和我们通常概念中的版本有所不同,这里的 Release 可以理解为 Helm 使用 Chart 包部署的一个应用实例。

其实 Helm 中的 Release 叫做 Deployment 更合适。估计因为 Deployment 这个概念已经被 Kubernetes 使用了,因此 Helm 才采用了 Release 这个术语。

下面这张图描述了 Helm 的几个关键组件 Helm(客户端),Tiller(服务器),Repository(Chart 软件仓库),Chart(软件包)之前的关系。

Helm 软件架构
图 2: Helm 软件架构

安装 Helm


下面我们通过一个完整的示例来介绍 Helm 的相关概念,并学习如何使用 Helm 打包,分发,安装,升级及回退 kubernetes 应用。

可以参考 Helm 的帮助文档https://docs.helm.sh/using_helm/#installing-helm 安装 Helm

采用二进制的方式安装 Helm

  1. 下载 Helm https://github.com/kubernetes/helm/releases
  2. 解压 tar -zxvf helm-v2.0.0-linux-amd64.tgz
  3. 拷贝到 bin 目录 mv linux-amd64/helm /usr/local/bin/helm

然后使用下面的命令安装服务器端组件 Tiller

Helm init

构建一个 Helm chart


让我们在实践中来了解 Helm。这里将使用一个 Go 测试小程序,让我们先为这个小程序创建一个 Helm chart。

git clone https://github.com/zhaohuabing/testapi.git;
cd testapi

首先创建一个 chart 的骨架

helm create testapi-chart

该命令创建一个 testapi-chart 目录,该目录结构如下所示,我们主要关注目录中的这三个文件即可: Chart.yaml,values.yaml 和 NOTES.txt。

testapi-chart
├── charts
├── Chart.yaml
├── templates
│   ├── deployment.yaml
│   ├── _helpers.tpl
│   ├── NOTES.txt
│   └── service.yaml
└── values.yaml
  • Chart.yaml 用于描述这个 chart,包括名字,描述信息以及版本。
  • values.yaml 用于存储 templates 目录中模板文件中用到的变量。 模板文件一般是 Go 模板。如果你需要了解更多关于 Go 模板的相关信息,可以查看 Hugo ( https://gohugo.io ) 的一个关于 Go 模板的介绍 ( https://gohugo.io/templates/go-templates/ )。
  • NOTES.txt 用于向部署该 chart 的用于介绍 chart 部署后的一些信息。例如介绍如何使用这个 chart,列出缺省的设置等。

打开 Chart.yaml, 填写你部署的应用的详细信息,以 testapi 为例:

apiVersion: v1
description: A simple api for testing and debugging
name: testapi-chart
version: 0.0.1

然后打开并根据需要编辑 values.yaml。下面是 testapi 应用的 values.yaml 文件内容。

replicaCount: 2
image:
  repository: daemonza/testapi
  tag: latest
  pullPolicy: IfNotPresent
service:
  name: testapi
  type: ClusterIP
  externalPort: 80
  internalPort: 80
resources:
  limits:
    cpu: 100m
    memory: 128Mi
  requests:
    cpu: 100m
    memory: 128Mi

在 testapi_chart 目录下运行下面命令以对 chart 进行校验。

helm lint
==> Linting .
[INFO] Chart.yaml: icon is recommended

1 chart(s) linted, no failures

如果文件格式错误,可以根据提示进行修改;如果一切正常,可以使用下面的命令对 chart 进行打包:

helm package testapi-chart --debug

这里添加了 –debug 参数来查看打包的输出,输出应该类似于:

Saved /Users/daemonza/testapi/testapi-chart/testapi-chart-0.0.1.tgz to current directory
Saved /Users/daemonza/testapi/testapi-chart/testapi-chart-0.0.1.tgz to /Users/daemonza/.helm/repository/local

chart 被打包为一个压缩包 testapi-chart-0.0.1.tgz,该压缩包被放到了当前目录下,并同时被保存到了 helm 的本地缺省仓库目录中。

Helm Repository


虽然我们已经打包了 chart 并发布到了 helm 的本地目录中,但通过 Helm search 命令查找,并不能找不到刚才生成的 chart 包。

helm search testapi
No results found

这是因为 repository 目录中的 chart 还没有被 Helm 管理。我们可以在本地启动一个 Repository Server,并将其加入到 Helm repo 列表中。

通过 helm repo list 命令可以看到目前 helm 中只配置了一个名为 stable 的 repo,该 repo 指向了 google 的一个服务器。

helm repo list
NAME    URL
stable  https://kubernetes-charts.storage.googleapis.com

使用 helm serve 命令启动一个 repo server,该 server 缺省使用’$HELM_HOME/repository/local’目录作为 chart 存储,并在 8879 端口上提供服务。

helm serve&
Now serving you on 127.0.0.1:8879

启动本地 repo server 后,将其加入 helm 的 repo 列表。

helm repo add local http://127.0.0.1:8879
"local" has been added to your repositories

现在再查找 testapi chart 包,就可以找到了。

helm search testapi

NAME                    CHART VERSION   APP VERSION     DESCRIPTION
local/testapi-chart     0.0.1                           A Helm chart for Kubernetes

在 kubernetes 中部署 Chart


chart 被发布到仓储后,可以通过 Helm instal 命令部署 chart,部署时指定 chart 名及 Release(部署的实例)名:

 helm install local/testapi-chart --name testapi

该命令的输出应类似:

NAME:   testapi
LAST DEPLOYED: Mon Apr 16 10:21:44 2018
NAMESPACE: default
STATUS: DEPLOYED

RESOURCES:
==> v1/Service
NAME                   TYPE       CLUSTER-IP    EXTERNAL-IP  PORT(S)  AGE
testapi-testapi-chart  ClusterIP  10.43.121.84  <none>       80/TCP   0s

==> v1beta1/Deployment
NAME                   DESIRED  CURRENT  UP-TO-DATE  AVAILABLE  AGE
testapi-testapi-chart  1        1        1           0          0s

==> v1/Pod(related)
NAME                                   READY  STATUS   RESTARTS  AGE
testapi-testapi-chart-9897d9f8c-nn6wd  0/1    Pending  0         0s


NOTES:
1. Get the application URL by running these commands:
  export POD_NAME=$(kubectl get pods --namespace default -l "app=testapi-testapi-chart" -o jsonpath="{.items[0].metadata.name}")
  echo "Visit http://127.0.0.1:8080 to use your application"
  kubectl port-forward $POD_NAME 8080:80

使用下面的命令列出所有已部署的 Release 以及其对应的 Chart。

helm ls

该命令的输出应类似:

NAME    REVISION        UPDATED                         STATUS          CHART                   NAMESPACE
testapi 1               Mon Apr 16 10:21:44 2018        DEPLOYED        testapi-chart-0.0.1     default

可以看到在输出中有一个 Revision(更改历史)字段,该字段用于表示某一 Release 被更新的次数,可以用该特性对已部署的 Release 进行回滚。

升级和回退


修改 Chart.yaml,将版本号从 0.0.1 修改为 1.0.0, 然后使用 Helm package 命令打包并发布到本地仓库。

查看本地库中的 Chart 信息,可以看到在本地仓库中 testapi-chart 有两个版本

helm search testapi -l
NAME                    CHART VERSION   APP VERSION     DESCRIPTION
local/testapi-chart     0.0.1                           A Helm chart for Kubernetes
local/testapi-chart     1.0.0                           A Helm chart for Kubernetes

现在用 helm upgrade 将已部署的 testapi 升级到新版本。可以通过参数指定需要升级的版本号,如果没有指定版本号,则缺省使用最新版本。

helm upgrade testapi local/testapi-chart

已部署的 testapi release 被升级到 1.0.0 版本

helm list
NAME    REVISION        UPDATED                         STATUS          CHART                   NAMESPACE
testapi 2               Mon Apr 16 10:43:10 2018        DEPLOYED        testapi-chart-1.0.0     default

可以通过 Helm history 查看一个 Release 的多次更改。

helm history testapi
REVISION        UPDATED                         STATUS          CHART                   DESCRIPTION
1               Mon Apr 16 10:21:44 2018        SUPERSEDED      testapi-chart-0.0.1     Install complete
2               Mon Apr 16 10:43:10 2018        DEPLOYED        testapi-chart-1.0.0     Upgrade complete

如果更新后的程序由于某些原因运行有问题,我们则需要回退到旧版本的应用,可以采用下面的命令进行回退。其中的参数 1 是前面 Helm history 中查看到的 Release 的更改历史。

helm rollback testapi 1

使用 Helm list 命令查看,部署的 testapi 的版本已经回退到 0.0.1

helm list
NAME    REVISION        UPDATED                         STATUS          CHART                   NAMESPACE
testapi 3               Mon Apr 16 10:48:20 2018        DEPLOYED        testapi-chart-0.0.1     default

总结


Helm 作为 kubernetes 应用的包管理以及部署工具,提供了应用打包,发布,版本管理以及部署,升级,回退等功能。Helm 以 Chart 软件包的形式简化 Kubernetes 的应用管理,提高了对用户的友好性。

Q&A


昨天在 Docker.io 技术微信群里面进行了 Helm 的分享,下面是分享过程中得到的一些有意思的反馈,进一步启发了我自己的一些思考。

Q: Helm 结合 CD 有什么好的建议吗? A: 采用 Helm 可以把零散的 Kubernetes 应用配置文件作为一个 chart 管理,chart 源码可以和源代码一起放到 git 库中管理。Helm 还简了在 CI/CD pipeline 的软件部署流程。通过把 chart 参数化,可以在测试环境和生产环境可以采用不同的 chart 参数配置。

下图是采用了 Helm 的一个 CI/CD 流程 Helm 的一个 CI/CD 流程

Q: 感谢分享,请问下多环境(test,staging,production)的业务配置如何管理呢?通过 heml 打包 configmap 吗,比如配置文件更新,也要重新打 chats 包吗?谢谢,这块我比较乱 A:Chart 是支持参数替换的,可以把业务配置相关的参数设置为模板变量。使用 Helm install Chart 的时候可以指定一个参数值文件,这样就可以把业务参数从 Chart 中剥离了。例子: helm install –values=myvals.yaml wordpress

Q: helm 能解决服务依赖吗? A:可以的,在 chart 可以通过 requirements.yaml 声明对其他 chart 的依赖关系。如下面声明表明 chart 依赖 apache 和 mysql 这两个第三方 chart。

dependencies:
  - name: apache
    version: 1.2.3
    repository: http://example.com/charts
  - name: mysql
    version: 3.2.1
    repository: http://another.example.com/charts

Q: chart 的 reversion 可以自定义吗?比如跟 git 的 tag A: 这位朋友应该是把 chart 的 version 和 Release 的 reversion 搞混了,呵呵。 Chart 是没有 reversion 的,Chart 部署的一个实例(Release)才有 Reversion,Reversion 是 Release 被更新后自动生成的。

Q: 没有看到 helm 指向 k8s 的配置,怎么确认在哪个 K8s 集群运行的? A: 使用和 kubectl 相同的配置,在 ~/.kube/config 中。

Q: 这个简单例子并没有看出 Helm 相比 kubectl 有哪些优势,可以简要说一下吗? A: Helm 将 kubernetes 应用作为一个软件包整体管理,例如一个应用可能有前端服务器,后端服务器,数据库,这样会涉及多个 Kubernetes 部署配置文件,Helm 就整体管理了。另外 Helm 还提供了软件包版本,一键安装,升级,回退。Kubectl 和 Helm 就好比你手工下载安装一个应用 和 使用 apt-get 安装一个应用的区别。

Q: 如何在 helm install 时指定命名空间? A: helm install local/testapi-chart –name testapi –namespace mynamespace

参考



TAGS
On this page