系列目录html
下面咱们经过一个完整的示例来学习如何使用 Helm 建立、打包、分发、安装、升级及回退Kubernetes应用。node
建立一个名为 mychart 的 Chartnginx
$ helm create mychart
该命令建立了一个 mychart 目录,该目录结构以下所示。这里咱们主要关注目录中的 Chart.yaml、values.yaml、NOTES.txt 和 Templates 目录。json
[centos@k8s-master helm]$ tree mychart mychart ├── charts ├── Chart.yaml ├── templates │ ├── deployment.yaml │ ├── _helpers.tpl │ ├── ingress.yaml │ ├── NOTES.txt │ ├── service.yaml │ └── tests │ └── test-connection.yaml └── values.yaml
仅仅是一些简单的文本描述centos
values.yaml 用于存储 templates 目录中模板文件中用到变量的值。api
NOTES.txt 用于介绍 Chart 部署后的一些信息,例如:如何使用这个 Chart、列出缺省的设置等。bash
Templates 目录下是 YAML 文件的模板,该模板文件遵循 Go template 语法。网络
Templates 目录下 YAML 文件模板的值默认都是在 values.yaml 里定义的,好比在 deployment.yaml 中定义的容器镜像。并发
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"app
其中的 .Values.image.repository
的值就是在 values.yaml
里定义的 nginx
,.Values.image.tag
的值就是 stable
。
以上两个变量值是在 create chart 的时候就自动生成的默认值,你能够根据实际状况进行修改。实际上都是静态文本,只在是执行的时候才被解析.
若是你须要了解更多关于 Go 模板的相关信息,能够查看 Hugo 的一个关于 Go 模板 的介绍
打开 Chart.yaml,能够看到内容以下
$ cat mychart/Chart.yaml apiVersion: v1 appVersion: "1.0" description: A Helm chart for Kubernetes name: mychart version: 0.1.0
编辑 values.yaml,它默认会在 Kubernetes 部署一个 Nginx。下面是 mychart 应用的 values.yaml 文件的内容:
$ cat mychart/values.yaml # Default values for mychart. # This is a YAML-formatted file. # Declare variables to be passed into your templates. replicaCount: 1 image: repository: nginx tag: stable pullPolicy: IfNotPresent service: type: ClusterIP port: 80 ingress: enabled: false annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" path: / hosts: - chart-example.local tls: [] # - secretName: chart-example-tls # hosts: # - chart-example.local resources: {} # We usually recommend not to specify default resources and to leave this as a conscious # choice for the user. This also increases chances charts run on environments with little # resources, such as Minikube. If you do want to specify resources, uncomment the following # lines, adjust them as necessary, and remove the curly braces after 'resources:'. # limits: # cpu: 100m # memory: 128Mi # requests: # cpu: 100m # memory: 128Mi nodeSelector: {} tolerations: [] affinity: {}
检查依赖和模板配置是否正确
$ helm lint mychart/ ==> Linting . [INFO] Chart.yaml: icon is recommended 1 chart(s) linted, no failures
若是文件格式错误,能够根据提示进行修改。
$ helm package mychart Successfully packaged chart and saved it to: /home/k8s/mychart-0.1.0.tgz
mychart 目录会被打包为一个 mychart-0.1.0.tgz 格式的压缩包,该压缩包会被放到当前目录下,并同时被保存到了 Helm 的本地缺省仓库目录中。
若是你想看到更详细的输出,能够加上 --debug 参数来查看打包的输出,输出内容应该相似以下:
$ helm package mychart --debug Successfully packaged chart and saved it to: /home/k8s/mychart-0.1.0.tgz [debug] Successfully saved /home/k8s/mychart-0.1.0.tgz to /home/k8s/.helm/repository/local
虽然咱们已经打包了 Chart 并发布到了 Helm 的本地目录中,但经过 helm search 命令查找,并不能找不到刚才生成的 mychart包。
$ helm search mychart No results found
这是由于 Repository 目录中的 Chart 包尚未被 Helm 管理。经过 helm repo list 命令能够看到目前 Helm 中已配置的 Repository 的信息。
注:新版本中执行 helm init 命令后默认会配置一个名为 local 的本地仓库。若是你们经过helm repo list 能够看到local选项,则为默认添加了,下面的有配置不用管,固然若是你不太明白仍然按照下面的操做执行了,也是没有问题的
咱们能够在本地启动一个 Repository Server,并将其加入到 Helm Repo 列表中。Helm Repository 必须以 Web 服务的方式提供,这里咱们就使用 helm serve 命令启动一个 Repository Server,该 Server 缺省使用 $HOME/.helm/repository/local
目录做为 Chart 存储,并在 8879 端口上提供服务。
$ helm serve & Now serving you on 127.0.0.1:8879
默认状况下该服务只监听 127.0.0.1,若是你要绑定到其它网络接口,可以使用如下命令:
helm serve --address 192.168.100.211:8879 &
若是你想使用指定目录来作为 Helm Repository 的存储目录,能够加上 --repo-path 参数
helm serve --address 192.168.124.59:8879 --repo-path /data/helm/repository/ --url http://192.168.124.59:8879/charts/
经过 helm repo index 命令将 Chart 的 Metadata 记录更新在 index.yaml 文件中:
更新 Helm Repository 的索引文件 $ cd /home/k8s/.helm/repository/local $ helm repo index --url=http://192.168.100.211:8879 .
完成启动本地 Helm Repository Server 后,就能够将本地 Repository 加入 Helm 的 Repo 列表
$ helm repo add local http://127.0.0.1:8879 "local" has been added to your repositories
如今再次查找 mychart 包,就能够搜索到了。
$ helm repo update $ helm search mychart NAME CHART VERSION APP VERSION DESCRIPTION local/mychart 0.1.0 1.0 A Helm chart for Kubernetes
Chart 被发布到仓储后,就能够经过 helm install 命令部署该 Chart。
当使用 helm install
命令部署应用时,实际上就是将 templates 目录下的模板文件渲染成 Kubernetes 可以识别的 YAML 格式。
在部署前咱们可使用 helm install --dry-run --debug
$ helm install --dry-run --debug local/mychart --name mike-test [debug] Created tunnel using local port: '46649' [debug] SERVER: "127.0.0.1:46649" [debug] Original chart version: "" [debug] Fetched local/mychart to /home/k8s/.helm/cache/archive/mychart-0.1.0.tgz [debug] CHART PATH: /home/k8s/.helm/cache/archive/mychart-0.1.0.tgz NAME: tylertest REVISION: 1 RELEASED: Mon Jul 23 10:39:49 2018 CHART: mychart-0.1.0 USER-SUPPLIED VALUES: {} COMPUTED VALUES: affinity: {} image: pullPolicy: IfNotPresent repository: nginx tag: stable ingress: annotations: {} enabled: false hosts: - chart-example.local path: / tls: [] nodeSelector: {} replicaCount: 1 resources: {} service: port: 80 type: ClusterIP tolerations: [] HOOKS: MANIFEST: --- # Source: mychart/templates/service.yaml apiVersion: v1 kind: Service metadata: name: tylertest-mychart labels: app: mychart chart: mychart-0.1.0 release: tyler-test heritage: Tiller spec: type: ClusterIP ports: - port: 80 targetPort: http protocol: TCP name: http selector: app: mychart release: mike-test --- # Source: mychart/templates/deployment.yaml apiVersion: apps/v1beta2 kind: Deployment metadata: name: tylertest-mychart labels: app: mychart chart: mychart-0.1.0 release: tyler-test heritage: Tiller spec: replicas: 1 selector: matchLabels: app: mychart release: tyler-test template: metadata: labels: app: mychart release: tyler-test spec: containers: - name: mychart image: "nginx:stable" imagePullPolicy: IfNotPresent ports: - name: http containerPort: 80 protocol: TCP livenessProbe: httpGet: path: / port: http readinessProbe: httpGet: path: / port: http resources: {}
验证完成没有问题后,咱们就可使用如下命令将其部署到 Kubernetes 上了。
# 部署时需指定 Chart 名及 Release(部署的实例)名。 $ helm install local/mychart --name mike-test NAME: mike-test LAST DEPLOYED: Mon Jul 23 10:41:20 2018 NAMESPACE: default STATUS: DEPLOYED RESOURCES: ==> v1/Service NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE mike-test-mychart ClusterIP 10.254.120.177 <none> 80/TCP 1s ==> v1beta2/Deployment NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE mike-test-mychart 1 0 0 0 0s ==> v1/Pod(related) NAME READY STATUS RESTARTS AGE mike-test-mychart-6d56f8c8c9-d685v 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=mychart,release=mike-test" -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
注:helm install 默认会用到 socat,须要在全部节点上安装 socat 软件包。
关于访问的部分这里就再也不介绍了,后面会讲解一个完整项目对外暴露访问
使用下面的命令列出的全部已部署的 Release 以及其对应的 Chart。
$ helm list NAME REVISION UPDATED STATUS CHART NAMESPACE tylertest 1 Mon Jul 23 10:41:20 2018 DEPLOYED mychart-0.1.0 default
你还可使用 helm status
查询一个特定的 Release 的状态。
$ helm status tylertest LAST DEPLOYED: Mon Jul 23 10:41:20 2018 NAMESPACE: default STATUS: DEPLOYED RESOURCES: ==> v1/Pod(related) NAME READY STATUS RESTARTS AGE tylertest-mychart-6d56f8c8c9-d685v 1/1 Running 0 1m ==> v1/Service NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE tylertest-mychart ClusterIP 10.254.120.177 <none> 80/TCP 1m ==> v1beta2/Deployment NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE tylertest-mychart 1 1 1 1 1m NOTES: 1. Get the application URL by running these commands: export POD_NAME=$(kubectl get pods --namespace default -l "app=mychart,release=tyler-test" -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
从上面 helm list 输出的结果中咱们能够看到有一个 Revision(更改历史)字段,该字段用于表示某一个 Release 被更新的次数,咱们能够用该特性对已部署的 Release 进行回滚。
将版本号从 0.1.0 修改成 0.2.0, 而后使用 helm package
命令打包并发布到本地仓库。
$ cat mychart/Chart.yaml apiVersion: v1 appVersion: "1.0" description: A Helm chart for Kubernetes name: mychart version: 0.2.0 $ helm package mychart Successfully packaged chart and saved it to: /home/k8s/mychart-0.2.0.tgz
查询本地仓库中的 Chart 信息
咱们能够看到在本地仓库中 mychart 有两个版本
[centos@k8s-master helm]$ helm search mychart -l NAME CHART VERSION APP VERSION DESCRIPTION local/mychart 0.2.0 1.0 A Helm chart for Kubernetes local/mychart 0.1.0 1.0 A Helm chart for Kubernetes
如今用 helm upgrade 命令将已部署的 tylertest 升级到新版本。你能够经过 --version 参数指定须要升级的版本号,若是没有指定版本号,则缺省使用最新版本。
[centos@k8s-master helm]$ helm upgrade tylertest mychart Release "tylertest" has been upgraded. Happy Helming! LAST DEPLOYED: Thu Apr 25 09:19:53 2019 NAMESPACE: default STATUS: DEPLOYED RESOURCES: ==> v1/Deployment NAME READY UP-TO-DATE AVAILABLE AGE tylertest-mychart 1/1 1 1 25m ==> v1/Pod(related) NAME READY STATUS RESTARTS AGE tylertest-mychart-545479dd4b-hj9ml 1/1 Running 0 25m ==> v1/Service NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE tylertest-mychart ClusterIP 10.103.51.57 <none> 80/TCP 25m NOTES: 1. Get the application URL by running these commands: export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=mychart,app.kubernetes.io/instance=tylertest" -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
完成后,能够看到已部署的 tylertest 被升级到 0.2.0 版本。
NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE kubernetes-dashboard 1 Thu Mar 14 09:06:25 2019 DEPLOYED kubernetes-dashboard-1.2.0 1.10.1 kube-system tylertest 2 Thu Apr 25 09:19:53 2019 DEPLOYED mychart-0.2.0 1.0 default
若是更新后的程序因为某些缘由运行有问题,须要回退到旧版本的应用。首先咱们可使用 helm history
命令查看一个 Release 的全部变动记录。
[centos@k8s-master helm]$ helm list tylertest NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE tylertest 2 Thu Apr 25 09:19:53 2019 DEPLOYED mychart-0.2.0 1.0 default
其次,咱们可使用下面的命令对指定的应用进行回退。
[centos@k8s-master helm]$ helm rollback tylertest 1 Rollback was a success! Happy Helming!
注:其中的参数 1 是 helm history 查看到 Release 的历史记录中 REVISION 对应的值。
[centos@k8s-master helm]$ helm list NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE kubernetes-dashboard 1 Thu Mar 14 09:06:25 2019 DEPLOYED kubernetes-dashboard-1.2.0 1.10.1 kube-system tylertest 3 Thu Apr 25 09:22:19 2019 DEPLOYED mychart-0.1.0 1.0 default [centos@k8s-master helm]$ helm history tylertest REVISION UPDATED STATUS CHART DESCRIPTION 1 Thu Apr 25 08:54:49 2019 SUPERSEDED mychart-0.1.0 Install complete 2 Thu Apr 25 09:19:53 2019 SUPERSEDED mychart-0.2.0 Upgrade complete 3 Thu Apr 25 09:22:19 2019 DEPLOYED mychart-0.1.0 Rollback to 1
若是须要删除一个已部署的 Release,能够利用 helm delete 命令来完成删除。
[centos@k8s-master helm]$ helm delete tylertest release "tylertest" deleted
确认应用是否删除,该应用已被标记为 DELETED 状态
[centos@k8s-master helm]$ helm ls --deleted NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE intentional-chinchilla 1 Wed Apr 24 18:37:29 2019 DELETED mychart-0.1.0 1.0 default invisible-turkey 1 Mon Apr 22 17:39:14 2019 DELETED nginx-ingress-0.21.1 0.14.0 jx punk-condor 1 Wed Apr 24 18:38:09 2019 DELETED mychart-0.1.0 1.0 default tylerchart 1 Wed Apr 24 18:40:01 2019 DELETED mychart-0.1.0 1.0 default tylertest 3 Thu Apr 25 09:22:19 2019 DELETED mychart-0.1.0 1.0 default vigilant-bat 1 Wed Apr 24 17:40:02 2019 DELETED xray-0.4.2 2.3.0 default
从上面的结果也能够看出,默认状况下已经删除的 Release 只是将状态标识为 DELETED 了 ,但该 Release 的历史信息仍是继续被保存的。
[centos@k8s-master helm]$ helm history tylertest REVISION UPDATED STATUS CHART DESCRIPTION 1 Thu Apr 25 08:54:49 2019 SUPERSEDED mychart-0.1.0 Install complete 2 Thu Apr 25 09:19:53 2019 SUPERSEDED mychart-0.2.0 Upgrade complete 3 Thu Apr 25 09:22:19 2019 DELETED mychart-0.1.0 Deletion complete
若是要移除指定 Release 全部相关的 Kubernetes 资源和 Release 的历史记录,能够用以下命令:
[centos@k8s-master helm]$ helm delete --purge tylertest release "tylertest" deleted
再次查看已删除的 Release,已经没法找到相关信息。
$ helm hist tylertest Error: release: "tyertest" not found # helm ls 命令也已均无查询记录。 $ helm ls --deleted $ helm ls -a tylertest