1. 程式人生 > 程式設計 >從入門到實踐:創作一個自己的 Helm Chart

從入門到實踐:創作一個自己的 Helm Chart

前言

我們平時在日常生活中會經常在不同的平臺上與各種各樣的應用打交道,比如從蘋果的 App Store 裡下載的淘寶、高德、支付寶等應用,或者是在 PC 端安裝的 Word、Photoshop、Steam。這些各類平臺上的應用程式,對使用者而言,大多隻需要點選安裝就可使用。

file

然而,在雲 (Kubernetes)上,部署一個應用往往卻不是那麼簡單。如果想要部署一個應用程式到雲上,首先要準備好它所需要的環境,打包成 Docker 映象,進而把映象放在部署檔案 (Deployment) 中、配置服務 (Service)、應用所需的賬戶 (ServiceAccount) 及許可權 (Role)、名稱空間 (Namespace)、金鑰資訊 (Secret)、可持久化儲存 (PersistentVolumes) 等資源。也就是編寫一系列互相相關的 YAML 配置檔案,將它們部署在 Kubernetes 叢集上。

但是即便應用的開發者可以把這些 Docker 映象存放在公共倉庫中,並且將所需的 YAML 資原始檔提供給使用者,使用者仍然需要自己去尋找這些資原始檔,並把它們一一部署。倘若使用者希望修改開發者提供的預設資源,比如使用更多的副本 (Replicas) 或是修改服務埠 (Port),他還需要自己去查需要在這些資原始檔的哪些地方修改,更不用提版本變更與維護會給開發者和使用者造成多少麻煩了。

可見最原始的 Kubernetes 應用形態並不便利。

Helm 與 Helm Chart

file

在這樣的大環境下,有一系列基於 Kubernetes 的應用包管理工具橫空出世。而我們今天的主角 Helm,就是這其中最受歡迎的選擇之一。

file

開發者按照 Helm Chart 的格式,將應用所需的資原始檔包裝起來,通過模版化 (Templating) 的方式將一些可變欄位(比如我們之前提到的暴露哪個埠、使用多少副本)暴露給使用者,最後將封裝好的應用包,也就是 Helm Chart,集中存放在統一的倉庫中供使用者瀏覽下載。

站在使用者角度,使用者只需要一行簡單的命令就可以完成應用的安裝、解除安裝與升級。對於安裝之後狀態,也可以通過 helm list 或者是原生的 kubectl 進行查詢。

$ helm install redis stable/redis
$ kubectl get pods
NAME                  READY       STATUS     RESTARTS           AGE
redis-master-0        1/1         Running    0                  63s
redis-slave-0-0       1/1         Running    0                  63s
redis-slave-1-0       1/1         Running    0                  13s
$ helm delete redis複製程式碼

創作 Helm Chart

那麼站在開發者的角度上,我們應該如何去創作一個 Helm 應用包呢?

file

準備工作

首先我們需要一個準備部署的映象。這個映象可以是一個 Java 程式、一個 Python 指令碼、甚至是一個空的 linux 映象跑幾條命令。

file

這裡我們使用一個簡單的基於 golang 的 hello world HTTP 服務。該服務通過讀取環境變數 USERNAME 獲得使用者自己定義的名稱,然後監聽 80 埠。對於任意 HTTP 請求,返回 Hello ${USERNAME}。比如如果設定 USERNAME=world(預設場景),該服務會返回 Hello world

然後我們使用 Dockerfile 對映象進行打包。先對 Golang 程式碼進行編譯,然後將編譯後的程式放在基於 alpine 的映象中,以縮小映象體積。file

在 Docker 構建好映象之後,我們把映象上傳到倉庫中,比如 Docker Hub 或是阿里雲容器映象倉庫。準備工作做好之後,我們就可以開始創作 Helm Chart 了。

開始創作

執行 helm create my-hello-world,會得到一個 helm 自動生成的空 chart。這個 chart 裡的名稱是 my-hello-world需要注意的是,Chart 裡面的 my-hello-world 名稱需要和生成的 Chart 資料夾名稱一致。如果修改 my-hello-world,則需要做一致的修改。 現在,我們看到 Chart 的資料夾目錄如下:

my-hello-world
├── charts
├── Chart.yaml
├── templates
│   ├── deployment.yaml
│   ├── _helpers.tpl
│   ├── ingress.yaml
│   ├── NOTES.txt
│   └── service.yaml
└── values.yaml複製程式碼

在根目錄下的 Chart.yaml 檔案內,宣告瞭當前 Chart 的名稱、版本等基本資訊,這些資訊會在該 Chart 被放入倉庫後,供使用者瀏覽檢索。比如我們可以把 Chart 的 Description 改成 "My first hello world helm chart"。在 Chart.yaml 裡有兩個跟版本相關的欄位,其中 version 指明的是 Chart 的版本,也就是我們應用包的版本;而 appVersion 指明的是內部實際使用的應用版本。

在 templates 資料夾記憶體放了各類應用部署所需要使用的 YAML 檔案,比如 Deployment 和 Service。在我們當前的應用內,我們只需要一個 deployment,而有的應用可能包含不同元件,需要多個 deployments,那麼我們就可以在 templates 資料夾下放置 deploymentA、deploymentB 等。同樣的,如果我們需要配置 serviceaccount,secret,volumes 等內容,也可以在裡面新增相應的配置檔案。

apiVersion: apps/v1beta2
kind: Deployment
metadata:
 name: {{ template "my-hello-world.fullname" . }}
 labels:
{{ include "my-hello-world.labels" . | indent 4 }}
spec:
 replicas: {{ .Values.replicaCount }}
 selector:
   matchLabels:
     app.kubernetes.io/name: {{ include "my-hello-world.name" . }}
     app.kubernetes.io/instance: {{ .Release.Name }}
 template:
   metadata:
     labels:
       app.kubernetes.io/name: {{ include "my-hello-world.name" . }}
       app.kubernetes.io/instance: {{ .Release.Name }}
   spec:
     containers:
       - name: {{ .Chart.Name }}
         image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}"
         imagePullPolicy: {{ .Values.image.pullPolicy }}
         env:
           - name: USERNAME
             value: {{ .Values.Username }}
......複製程式碼

Helm Chart 對於應用的打包,不僅僅是將 Deployment 和 Service 以及其它資源整合在一起。我們看到 deployment.yaml 和 service.yaml 檔案被放在 templates/ 資料夾下,相較於原生的 Kubernetes 配置,多了很多渲染所用的可注入欄位。比如在 deployment.yaml 的 spec.replicas 中,使用的是 .Values.replicaCount 而不是 Kubernetes 本身的靜態數值。這個用來控制應用在 Kubernetes 上應該有多少執行副本的欄位,在不同的應用部署環境下可以有不同的數值,而這個數值便是由注入的 Values 提供。

replicaCount: 1
image:
 repository: somefive/hello-world
 pullPolicy: IfNotPresent
nameOverride: ""
fullnameOverride: ""
service:
 type: ClusterIP
 port: 80
......
Username: AppHub複製程式碼

在根目錄下我們看到有一個 values.yaml 檔案,這個檔案提供了應用在安裝時的預設引數。在預設的 Values 中,我們看到 replicaCount: 1,說明該應用在預設部署的狀態下只有一個副本。

為了使用我們要部署應用的映象,我們看到 deployment.yaml 中,在 spec.template.spec.containers 裡, image 和 imagePullPolicy 都使用了 Values 中的值。其中 image 欄位由 .Values.image.repository 和 .Chart.AppVersion 組成。

看到這裡,同學們應該就知道需要變更的欄位了:一個是位於 values.yaml 內的 image.repository,另一個是位於 Chart.yaml 裡的 AppVersion。將它們與我們需要部署應用的 docker 映象匹配起來,這裡我們把 values.yaml 裡的 image.repository 設定成 somefive/hello-world,把 Chart.yaml 裡的 AppVersion 設定成 1.0.0 即可。

類似的,我們可以檢視 service.yaml 內要部署的服務,其中的主要配置也在 values.yaml 中。預設生成的服務將 80 埠暴露在 Kubernetes 叢集內部。我們暫時不需要對這一部分進行修改。

由於部署的 hello-world 服務會從環境變數中讀取 USERNAME 環境變數,所以將這個配置加入 deployment.yaml。

- name: {{ .Chart.Name }}
  image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}"
  imagePullPolicy: {{ .Values.image.pullPolicy }}
  env:
  - name: USERNAME
    value: {{ .Values.Username }}複製程式碼

現在我們的 deployment.yaml 模版會從 values.yaml 中載入 Username 欄位,因此相應的,我們也在 values.yaml 中新增 Username: AppHub。這樣,我們的應用就會從 values.yaml 中讀取 Username,把它放入映象的環境變數中啟動了。

校驗打包

在準備好我們的應用後,我們可以使用 Helm lint 來粗略地檢查一下製作的 Chart 有沒有什麼語法上的錯誤。如果沒有問題的話,就可以使用 helm package 命令對我們的 Chart 資料夾進行打包,打包後我們可以得到一個 my-hello-world-0.1.0.tgz 的應用包。這個便是我們完成的應用了。

$ helm lint --strict my-hello-world
1 chart(s) linted,0 chart(s) failed
    [INFO] Chart.yaml: icon is recommended
$ helm package my-hello-world複製程式碼

我們可以使用 helm install 命令嘗試安裝一下剛剛做好的應用包,然後用 kubectl 檢視一下執行 pod 的狀態。通過 port-forward 命令將該 pod 的埠對映到本地埠上,這個時候就可以通過訪問 localhost 來訪問部署好的應用了。

$ helm install my-hello-world-chart-test my-hello-world-0.1.0.tgz
$ kubectl get pods
NAME                                          READY    STATUS     RESTARTS    AGE
my-hello-world-chart-test-65d6c7b4b6-ptk4x-0  1/1      Running    0           4m3s
$ kubectl port-forward my-hello-world-chart-test-65d6c7b4b6-ptk4x 8080:80
$ curl localhost:8080
Hello AppHub複製程式碼

引數過載

有的同學可能會有疑惑,雖然我們應用開發者把可配置的資訊暴露在 values.yaml 中,使用者使用應用的時候想要修改該怎麼辦呢?答案很簡單,使用者只需要在 install 時使用 set 引數,設定想要覆蓋的引數即可。

應用開發者在 Chart 的 values 配置中只是提供了預設的安裝引數,使用者也可以在安裝時指定自己的配置。類似的,如果使用者可以用 upgrade 命令替代 install,實現在原有部署好的應用的基礎上變更配置。

$ helm install my-app my-hello-world-0.1.0.tgz --set Username="Cloud Native"
$ helm install my-super-app my-hello-world-0.1.0.tgz -f my-values.yaml
$ helm upgrade my-super-app my-hello-world-0.1.0.tgz -f my-new-values.yaml複製程式碼

修改提示資訊

我們注意到在安裝 Chart 指令執行後,螢幕的輸出會出現:

NOTES:
1. Get the application URL by running these commands:
  export POD_NAME=$(kubectl get pods -l "app=my-hello-world,release=my-hello-world-chart-test2" -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複製程式碼

這裡的註釋是由 Chart 中的 templates/NOTES.txt 提供的。

我們注意到原始的 NOTES 中,所寫的 "app={{ template "my-hello-world.name" . }},release={{ .Release.Name }}" 和 deployment.yaml 中所寫的配置不太一樣,可以把它改成 "app.kubernetes.io/name={{ template "my-hello-world.name" . }},app.kubernetes.io/instance={{ .Release.Name }}",將 values.yaml 中的 version 更新成 0.1.1。然後重新打包 Chart(執行 helm package),得到新的 my-hello-world-0.1.1.tgz 之後,升級原有 Chart(執行 helm upgrade my-hello-world-chart-test2 my-hello-world-0.1.1.tgz --set Username="New Chart"),就能看到更新過後的 NOTES 了。

NOTES:
1. Get the application URL by running these commands:
  export POD_NAME=$(kubectl get pods -l "app.kubernetes.io/name=my-hello-world,app.kubernetes.io/instance=my-hello-world-chart-test2" -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複製程式碼

應用分享

file那麼製作完成的應用如何和其他人分享呢?Helm 官方推出的 ChartMuseum 提供了 Chart 倉庫的構建方法,使用它可以建立自己的 Chart 倉庫。然而自行維護一個倉庫本身成本不小,而且對於使用者而言如果每一個開發者都是自己的倉庫,他就需要將所需應用對應的倉庫都加入自己的檢索列表中,很不利於應用的傳播與分享。file我們團隊近期推出了開放雲原生應用中心,Cloud Native App Hub,同步了各類應用,同時還提供了開發者上傳應用的渠道。

在我們的開放雲原生應用中心中,應用來自兩個渠道:

  • 一方面,我們定期從一些國外的知名 Helm 倉庫同步 Chart 資源,在同步的過程中,會對 Chart 內部使用的一部分 Docker 映象進行同步替換(例如 gcr.io 或者 quay.io 的映象),方便國內使用者訪問使用;
  • 另一方面,我們和 Helm 官方庫一樣在 Github 上接受開發者通過 Pull Request 的形式提交自己的應用。提交成功的應用會在短期內同步至雲原生應用中心,和其他官方應用展示在一起供其他使用者使用。

file

雲原生應用開發大賽

參賽點選:developer.aliyun.com/special/app…file

參考

  1. Helm Chart 創作指南 cloudnativeapp.gitbook.io/handbook/he…
  2. 開放雲原生應用中心 - Cloud Native App Hub developer.aliyun.com/hub
  3. 開放雲原生應用中心 Github 倉庫 github.com/cloudnative…