iT邦幫忙

2022 iThome 鐵人賽
DAY 27
0
DevOps

前端轉生～到了實驗室就要養幾隻可愛鯨魚：自架 Kubernetes 迷航日記系列 第 27 篇

Day 27 — 做點小小模板：製作 helm chart

14th鐵人賽 kubernetes helm harbor devops
2358 瀏覽

  • 分享至 

  • xImage
    •  

可愛鯨魚

貨櫃這麼多要怎麼設定？來製造模板快速部署貨櫃吧～

圖片來源：Docker (@Docker) / Twitter

上一篇安排了要部署的 Kubernetes resource，今天繼續轉換成 helm chart～

helm chart

來製作自己的模板吧！

create chart

先建立一個 chart

helm create test-web

之後就會長出基本的 chart 結構

$ tree test-web
test-web
├── charts
├── Chart.yaml
├── templates
│   ├── deployment.yaml
│   ├── _helpers.tpl
│   ├── hpa.yaml
│   ├── ingress.yaml
│   ├── NOTES.txt
│   ├── serviceaccount.yaml
│   ├── service.yaml
│   └── tests
│       └── test-connection.yaml
└── values.yaml

3 directories, 10 files
  • charts/: 放其他依賴的 chart
  • templates/: 放套件的模板
  • Chart.yaml: chart 基本資訊
  • values.yaml: chart 設定檔

接下來會依照前端、後端製作模板

完整檔案可以到 github Day 27 - test-web/ 查看

後端

後端的 resource 有 PersistentVolumeClaim, Deployment, Service

前置作業

先在 _helper.tpl 加入定義，test-web.backend 代表名稱 chart-fullname + backend

templates/_helper.tpl

{{- define "test-web.backend" -}}
  {{- printf "%s-backend" (include "test-web.fullname" .) -}}
{{- end -}}

在 templates 目錄下新增 backend 目錄，用來存放後端的模板

mkdir ./templates/backend

PersistentVolumeClaim

原本的設定： Day 27 - backend.yaml#L1

接著根據設定建立 pvc.yaml 模板～

  1. 先定義 pvc 建立條件:

    • 需要在設定檔 enabled 啟用
    • 如果有 existingClaim 就不需要再建立

    templates/backend/pvc.yaml

    {{- if and .Values.persistence.backend.enabled (not .Values.persistence.backend.existingClaim) }}
...
...
...
{{- end }}

    values.yaml

    persistence:
  backend:
    enabled: true
    existingClaim: ""

  2. 設定變數 $backend_pvc 放便接下來使用

    templates/backend/pvc.yaml

    {{- $backend_pvc := .Values.persistence.backend -}}

  3. 基本 pvc 設定

    templates/backend/pvc.yaml

    apiVersion: v1
kind: PersistentVolumeClaim

  4. metadata.name: 使用 _helper.tpl 定義的後端名稱

    templates/backend/pvc.yaml

    metadata:
  name: {{ template "test-web.backend" . }}

  5. metadata.labels: 套用 helm chart 內部的 label

    templates/backend/pvc.yaml

    metadata:
  labels: {{- include "test-web.labels" . | nindent 4 }}

  6. metadata.annotations: 設定解除安裝時會保留 resource pvc

    templates/backend/pvc.yaml

    metadata:
  annotations:
  {{- if eq $backend_pvc.resourcePolicy "keep" }}
    helm.sh/resource-policy: keep
  {{- end }}

    values.yaml

    persistence:
  backend:
    resourcePolicy: keep

  7. spec.storageClassName: 如果有設定 storageClss 就套用設定

    templates/backend/pvc.yaml

    spec:
  {{- if eq "-" $backend_pvc.storageClass }}
  storageClassName: ""
  {{- else }}
  storageClassName: {{ $backend_pvc.storageClass }}
  {{- end }}

    values.yaml

    persistence:
  backend:
    storageClass: "nfs-client"

  8. spec.accessMode: 設定 pvc accessMode

    templates/backend/pvc.yaml

    spec:
  accessModes:
    - {{ $backend_pvc.accessMode }}

    values.yaml

    persistence:
  backend:
    accessMode: ReadWriteMany

  9. spec.resources: 設定 pvc 請求的資源

    templates/backend/pvc.yaml

    spec:
  resources:
    requests:
      storage: {{ $backend_pvc.size }}

    values.yaml

    persistence:
  backend:
    size: 1Gi

Deployment

原本的設定： Day27 - backend.yaml#L17

接著根據設定建立 deployment.yaml 模板～

  1. 定義設定檔參數路徑

    templates/backend/deployment.yaml

    {{- $backend := .Values.backend -}}
{{- $backend_pvc := .Values.persistence.backend -}}

  2. Deployment 基本設定

    • name: 使用 _helper.tpl 定義的名稱
    • labels: 套用 helm chart 的 labels，再加上自定義的 app: backend

    templates/backend/deployment.yaml

    apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ include "test-web.backend" . }}
  labels:
    {{- include "test-web.labels" . | nindent 4 }}
    app: backend

  3. spec.selector, spec.template.metadata: 設定 helm chart 的 labels 再加上自定的 app: backend

    templates/backend/deployment.yaml

    spec:
  selector:
    matchLabels:
      {{- include "test-web.selectorLabels" . | nindent 6 }}
      app: backend
  template:
    metadata:
      labels:
        {{- include "test-web.selectorLabels" . | nindent 8 }}
        app: backend

  4. spec.strategy: 設定部署策略

    templates/backend/deployment.yaml

    spec:
  replicas: 1
  strategy:
    type: {{ $backend.updateStrategy.type }}
    {{- if eq $backend.updateStrategy.type "RollingUpdate"  }}
    rollingUpdate:
      maxSurge: {{ $backend.updateStrategy.rollingUpdate.maxSurge }}
      maxUnavailable: {{ $backend.updateStrategy.rollingUpdate.maxUnavailable }}
    {{- else }}
    rollingUpdate: null
    {{- end }}

    values.yaml

    backend:
  updateStrategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate

  5. imagePullSecrets: 設定 pull image 使用的 secret

    templates/backend/deployment.yaml

    spec:
  template:
    spec:
      {{- with .Values.imagePullSecrets }}
      imagePullSecrets:
        {{- toYaml . | nindent 8 }}
      {{- end }}

    values.yaml

    imagePullSecrets:
  - test-web-robot

  6. initContainers: 設定 initial container，volume 會套用 subPath 設定

    templates/backend/deployment.yaml

    spec:
  template:
    spec:
      initContainers:
        - name: init-backend
          image: {{ $backend.init.image.repository }}:{{ $backend.init.image.tag }}
          command: ["/bin/sh"]
          args:
            - "-c"
            - "[ ! -e /app/data/todos.json ] && echo [] > /app/data/todos.json || true"
          volumeMounts:
            - name: data
              mountPath: /app/data
              subPath: {{ $backend_pvc.subPath }}

    values.yaml

    backend:
  init:
    image:
      repository: alpine
      tag: "3.16.2"

persistence:
  backend:
    subPath: ""

  7. containers: 設定 container，volume 會套用 subPath 設定、內部 app 會套用外部設定的 container port

    templates/backend/deployment.yaml

    spec:
  template:
    spec:
      containers:
        - name: backend
          image: "{{ $backend.container.image.repository }}:{{ $backend.container.image.tag | default .Chart.AppVersion }}"
          resources:
            {{- toYaml $backend.container.resources | nindent 12 }}
          livenessProbe:
            tcpSocket:
              port: {{ $backend.container.port }}
            initialDelaySeconds: 5
            timeoutSeconds: 5
            successThreshold: 1
            failureThreshold: 3
            periodSeconds: 10
          readinessProbe:
            httpGet:
              path: /
              port: {{ $backend.container.port }}
            initialDelaySeconds: 5
            timeoutSeconds: 2
            successThreshold: 1
            failureThreshold: 3
            periodSeconds: 10
          env:
            - name: HOST_PORT
              value: {{ $backend.container.port | quote }}
          ports:
            - containerPort: {{ $backend.container.port }}
              name: backend
          volumeMounts:
            - name: data
              mountPath: /app/data
              subPath: {{ $backend_pvc.subPath }}

    values.yaml

    backend:
  container:
    port: 80

  8. volumes: 設定套用前面定義的 pvc

    templates/backend/deployment.yaml

    spec:
  template:
    spec:
      volumes:
        - name: data
        {{- if and $backend_pvc.enabled }}
          persistentVolumeClaim:
            claimName: {{ $backend_pvc.existingClaim | default (include "test-web.backend" .) }}
        {{- else }}
          emptyDir: {}
        {{- end }}

    values.yaml

    persistence:
  backend:
    enabled: true
    existingClaim: ""

  9. restartPolicy: 設定重新啟動的策略

    templates/backend/deployment.yaml

    spec:
  template:
    spec:
      restartPolicy: Always

Service

原本的設定： Day27 - backend.yaml#L94

接著根據設定建立 service.yaml 模板～

  1. 定義設定檔參數路徑

templates/backend/service.yaml

{{- $backend := .Values.backend -}}
{{- $backend_svc := .Values.service.backend -}}

  1. Service 基本設定

    templates/backend/service.yaml

    apiVersion: v1
kind: Service
metadata:
  name: {{ include "test-web.backend" . }}
  labels:
    {{- include "test-web.labels" . | nindent 4 }}

  2. selector: 篩選 helm chart 的 labels 再加上自定的 app: backend

    templates/backend/service.yaml

    spec:
  selector:
    {{- include "test-web.selectorLabels" . | nindent 4 }}
    app: backend

  3. type, ports

    templates/backend/service.yaml

    spec:
  type: {{ $backend_svc.type }}
  ports:
    - name: http
      protocol: TCP
      port: {{ $backend.container.port }}
      targetPort: {{ $backend_svc.port }}
      {{- if eq $backend_svc.type "nodePort" }}
      nodePort: {{ $backend_svc.nodePort }}
      {{- end }}

    values.yaml

    service:
  backend:
    type: ClusterIP
    port: 80
    # nodePort: 30081

  4. 其他設定

    templates/backend/service.yaml

    spec:
  sessionAffinity: None
  sessionAffinityConfig:
    clientIP:
      timeoutSeconds: 10800

前端

前端的 resource 有 Deployment, Service, Ingress

前置作業

先在 _helper.tpl 加入定義，test-web.frontend 代表名稱 chart-fullname + frontend

templates/_helper.tpl

{{- define "test-web.frontend" -}}
  {{- printf "%s-frontend" (include "test-web.fullname" .) -}}
{{- end -}}

在 templates 目錄下新增 frontend 目錄，用來存放後端的模板

mkdir ./templates/frontend

Deployment

原本的設定： Day27 - frontend.yaml#L1

接著根據設定建立 deployment.yaml 模板～

  1. 定義設定檔參數路徑

    templates/frontend/deployment.yaml

    {{- $frontend := .Values.frontend -}}
{{- $frontend_pvc := .Values.persistence.frontend -}}

  2. Deployment 基本上和後端的雷同，部分省略～

    templates/frontend/deployment.yaml

    apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ include "test-web.frontend" . }}
  labels:
    {{- include "test-web.labels" . | nindent 4 }}
    app: frontend
spec:
  selector:
    matchLabels:
      {{- include "test-web.selectorLabels" . | nindent 6 }}
      app: frontend
  replicas: 1
  strategy:
    type: {{ $frontend.updateStrategy.type }}
    {{- if eq $frontend.updateStrategy.type "RollingUpdate"  }}
    rollingUpdate:
      maxSurge: {{ $frontend.updateStrategy.rollingUpdate.maxSurge }}
      maxUnavailable: {{ $frontend.updateStrategy.rollingUpdate.maxUnavailable }}
    {{- else }}
    rollingUpdate: null
    {{- end }}
  template:
    metadata:
      labels:
        {{- include "test-web.selectorLabels" . | nindent 8 }}
        app: frontend
    spec:
      {{- with .Values.imagePullSecrets }}
      imagePullSecrets:
        {{- toYaml . | nindent 8 }}
      {{- end }}
      restartPolicy: Always

    values.yaml

    frontend:
  updateStrategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate

  3. containers: 設定 container，env 會自動帶入後端 Service 的名稱

    spec:
  template:
    spec:
      containers:
        - name: frontend
          image: "{{ $frontend.container.image.repository }}:{{ $frontend.container.image.tag | default .Chart.AppVersion }}"
          resources:
            {{- toYaml $frontend.container.resources | nindent 12 }}
          livenessProbe:
            tcpSocket:
              port: {{ $frontend.container.port }}
            initialDelaySeconds: 5
            timeoutSeconds: 5
            successThreshold: 1
            failureThreshold: 3
            periodSeconds: 10
          readinessProbe:
            httpGet:
              path: /
              port: {{ $frontend.container.port }}
            initialDelaySeconds: 5
            timeoutSeconds: 2
            successThreshold: 1
            failureThreshold: 3
            periodSeconds: 10
          env:
            - name: BACKEND_URL
              value: "{{ include "test-web.backend" . }}"
          ports:
            - containerPort: {{ $frontend.container.port }}
              name: frontend

    values.yaml

    frontend:
  container:
    image:
      repository: harbor.example.domain.com/test-web/test-frontend
      tag: "dev"
    port: 80
    resources:
      requests:
        cpu: 100m
        memory: 100Mi
      limits:
        cpu: 100m
        memory: 100Mi

Service

原本的設定： Day27 - frontend.yaml#L61

接著根據設定建立 service.yaml 模板～

  1. 定義設定檔參數路徑

    templates/backend/service.yaml

    {{- $backend := .Values.backend -}}
{{- $backend_svc := .Values.service.backend -}}

  2. Service 基本上和後端的雷同，只有將 selector 替換成 app: frontend

    templates/backend/service.yaml

    apiVersion: v1
kind: Service
metadata:
  name: {{ include "test-web.frontend" . }}
  labels:
    {{- include "test-web.labels" . | nindent 4 }}
spec:
  selector:
    {{- include "test-web.selectorLabels" . | nindent 4 }}
    app: frontend
  type: {{ $frontend_svc.type }}
  sessionAffinity: None
  sessionAffinityConfig:
    clientIP:
      timeoutSeconds: 10800
  ports:
    - name: http
      protocol: TCP
      port: {{ $frontend.container.port }}
      targetPort: {{ $frontend_svc.port }}
      {{- if eq $frontend_svc.type "nodePort" }}
      nodePort: {{ $frontend_svc.nodePort }}
      {{- end }}

    values.yaml

    service:
  frontend:
    type: ClusterIP
    port: 80
    # nodePort: 30080

Ingress

原本的設定： Day27 - frontend.yaml#L81

接著根據設定建立 ingress.yaml 模板～

  1. 先定義 ingress 建立條件:

    • 需要在設定檔 enabled 啟用

    templates/backend/ingress.yaml

    {{- if .Values.ingress.enabled -}}
...
...
...
{{- end }}

    values.yaml

    ingress:
  enabled: true

  2. 調用 _helper.tpl 參數 char 名稱、前端名稱

    templates/backend/ingress.yaml

    {{- $fullName := include "test-web.fullname" . -}}
{{- $frontendName := include "test-web.frontend" . -}}

  3. 定義設定檔參數路徑

    templates/backend/ingress.yaml

    {{- $ingress := .Values.ingress -}}
{{- $frontend_svc := .Values.service.frontend -}}

  4. 依據 kubernetes 版本設定 apiVersion

    templates/backend/ingress.yaml

    {{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
apiVersion: networking.k8s.io/v1
{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
apiVersion: networking.k8s.io/v1beta1
{{- else -}}
apiVersion: extensions/v1beta1
{{- end }}

  5. Ingress 基本設定

    templates/backend/ingress.yaml

    kind: Ingress
metadata:
  name: {{ $fullName }}
  labels:
    {{- include "test-web.labels" . | nindent 4 }}{{ toYaml $ingress.labels | nindent 4 }}

  6. rules: 取用設定檔 hosts array，paths bacekend 自動對應到前端 Service 名稱、port

    templates/backend/ingress.yaml

    spec:
  rules:
    {{- range $ingress.hosts }}
    - host: {{ .host | quote }}
      http:
        paths:
          {{- range .paths }}
          - path: {{ .path }}
            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
            pathType: {{ .pathType }}
            {{- end }}
            backend:
              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
              service:
                name: {{ $frontendName }}
                port:
                  number: {{ $frontend_svc.port }}
              {{- else }}
              serviceName: {{ $frontendName }}
              servicePort: {{ $frontend_svc.port }}
              {{- end }}
          {{- end }}
    {{- end }}

    values.yaml

    ingress:
  labels:
    environment: production
    method: traefik
  hosts:
    - host: test-web.example.domain.com
      paths:
        - path: /
          pathType: Prefix

helm 指令

測試

可以使用指令 --debug, --dry-run 測試

$ helm install --debug --dry-run --namespace test-web test-web ./test-web

安裝

確認無誤後安裝～

$ helm install --namespace test-web test-web ./test-web

NAME: test-web
LAST DEPLOYED: Tue Oct 11 19:51:58 2022
NAMESPACE: test-web-helm
STATUS: deployed
REVISION: 1
TEST SUITE: None

Day 27 - test-web/

最後目錄結構如下

$ tree test-web/
test-web/
├── charts
├── Chart.yaml
├── templates
│   ├── backend
│   │   ├── deployment.yaml
│   │   ├── pvc.yaml
│   │   └── service.yaml
│   ├── frontend
│   │   ├── deployment.yaml
│   │   ├── ingress.yaml
│   │   └── service.yaml
│   └── _helpers.tpl
└── values.yaml

4 directories, 9 files

Harbor

最後來打包推上 Harbor 吧～

  1. 安裝 plugin
helm plugin install https://github.com/chartmuseum/helm-push
  1. 新增 helm repo
$ helm repo add --username admin test-web https://harbor.example.domain.com/chartrepo/test-web
Password: 
"test-web " has been added to your repositories
  1. 使用 cm-push 把整個資料夾推上去～
$ helm cm-push test-web/ test-web

成功後會在 Helm Chart 頁面看到剛剛推送的 chart

Ref

終於弄完 helm chart...
一開始看到 template 根本像亂碼... /images/emoticon/emoticon13.gif


上一篇
Day 26 — 安排小小貨櫃：建立 kubernetes resource
下一篇
Day 28 — 測試部署作業：gitlab ci
系列文
前端轉生～到了實驗室就要養幾隻可愛鯨魚：自架 Kubernetes 迷航日記 共 30 篇
  1. 26
    Day 26 — 安排小小貨櫃：建立 kubernetes resource
  2. 27
    Day 27 — 做點小小模板：製作 helm chart
  3. 28
    Day 28 — 測試部署作業：gitlab ci
  4. 29
    Day 29 — 打包及部署：撰寫 .gitlab-ci.yml
  5. 30
    Day 30 — 希望 bug 也能一起 End：統整總結
完整目錄
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言
iThome鐵人賽
參賽組數
1064 組
團體組數
40 組
累計文章數
22195 篇
完賽人數
600 人
iT+看影片追技術 看影片追技術 看更多
熱門tag 看更多
15th鐵人賽 16th鐵人賽 13th鐵人賽 14th鐵人賽 12th鐵人賽 11th鐵人賽 鐵人賽 2019鐵人賽 javascript 2018鐵人賽 python 2017鐵人賽 windows php c# windows server linux css react vue.js
熱門問題
熱門回答
熱門文章
IT邦幫忙