Helm Charts 範本技術：引數化與流程控制詳解

Helm Charts 使用 Go 範本技術來生成 Kubernetes YAML 資源，讓開發者能以引數化和流程控制的方式管理佈署組態。values.yaml 檔案定義預設值，供範本參照，並可透過 --set 或 --values 標誌覆寫。範本使用 {{ .Values.key }} 的語法參照這些值。流程控制方面，if 條件句可根據 values.yaml 中的值動態生成資源，例如根據 probeType.httpGet 值決定使用 HTTP 或 TCP 型別的健康檢查。values.schema.json 檔案則用於驗證值的格式和型別，確保佈署一致性。例如，可以限制 replicas 值必須為非負整數。此外，Helm 範本也支援範圍修改、重複操作、變數、函式與管道的應用，可以更靈活地操作資料和控制流程。with 動作能簡化對巢狀值的參照，range 動作能迭代列表元素，變數能儲存中間結果，函式和管道則能執行更複雜的轉換和操作。這些技術共同提升了 Helm Charts 的靈活性和可維護性。

Go 範本技術：深入解析 Helm Charts 的引數化與流程控制

Go 語言是由 Google 在 2009 年開發的，並在 Kubernetes、Helm 及許多其他容器技術工具中廣泛應用。Go 語言的核心元件之一是範本（Templates），這些範本可以用來生成各種格式的檔案。在 Helm 中，Go 範本被用來生成 Kubernetes YAML 資源，這些資源位於 Helm Charts 的 templates/ 目錄下。

Go 範本的基本結構

Go 範本的控制結構和處理始於兩個開放大括號 ({{)，結束於兩個閉合大括號 (}})。這些符號可能會出現在 templates/ 目錄下的本地檔案中，但在安裝或升級過程中的處理中會被移除。

引數化：將值注入到範本中

Helm Charts 的目錄中包含一個 values.yaml 檔案，這個檔案宣告瞭所有的預設值。這些值會被 Go 範本參照，並由 Helm 動態生成 Kubernetes 資源。

以下是一個 values.yaml 檔案的範例：


## chapterNumber 是當前章節的編號
chapterNumber: 4

## chapterName 是當前章節的描述
chapterName: Understanding Helm Charts

以 # 開頭的行是註解，在執行時會被忽略。這些註解應該提供有關值的詳細資訊，讓使用者理解如何應用它們。其他行則代表鍵值對。

Go 範本以 .Values 開頭來參照 values.yaml 檔案中的值，或是使用 --set 或 --values 標誌在安裝或升級時傳遞進來。

以下是一個未處理的範本範例：

env:
- name: CHAPTER_NUMBER
  value: {{ .Values.chapterNumber }}
- name: CHAPTER_NAME
  values: {{ .Values.chapterName }}

處理後，這段 YAML 資源會被渲染成：

env:
- name: CHAPTER_NUMBER
  value: 4
- name: CHAPTER_NAME
  values: Understanding Helm Charts

流程控制：精細化範本處理

除了引數化，Go 標板還允許在 YAML 檔案中提供條件邏輯。以下是一個使用條件邏輯的佈署範本片段：

readinessProbe:
{{- if .Values.probeType.httpGet }}
httpGet:
  path: /healthz
  port: 8080
  scheme: HTTP
{{- else }}
tcpSocket:
  port: 8080
{{- end }}
initialDelaySeconds: 30
periodSeconds: 10

這段程式碼中的 if 塊用於條件性地設定 readinessProbe 段落。如果 probeType.httpGet 值評估為真或非空，則會範本化 HTTP GET 的 readinessProbe。否則，建立的是 TCP Socket 型別的 readinessProbe。大括號中的連字號用於在處理後移除空白。

內容解密：

以上程式碼片段展示瞭如何使用 Go 標板進行條件判斷來動態生成 Kubernetes 資源。具體來說：

.Values.probeType.httpGet: 參照 values.yaml 中定義的 probeType.httpGet 值。
{{- if ... }}: 用於條件判斷，如果條件為真則執行內部程式碼。
{{- else }}: 用於條件判斷的 else 條件。
大括號中的連字號 -: 用於在處理後移除空白字元，使生成的 YAML 資源更為整潔。
httpGet 和 tcpSocket: 分別表示不同型別的健康檢查方式。
initialDelaySeconds 和 periodSeconds: 組態健康檢查的初始延遲和間隔時間。

此範例顯示瞭如何在 Helm Chart 中靈活地組態和控制 Kubernetes 資源的生成過程。

值模式檔案：確保值的一致性

在討論值和引數化時，我們可以簡單介紹一下 values.schema.json 檔案。這個檔案可以強制執行特定模式以驗證在安裝或升級過程中提供的值。以下是一個簡單的模式範例：

{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "properties": {
    "replicas": {
      "description": "要佈署的應用程式例項數量",
      "minimum": 0,
      "type": "integer"
    },
    ...
    "title": "values",
    "type": "object"
}

這個模式檔案確保了 replicas 值至少設定為零。新增更多值到這個檔案中可以進一步限制可以提供給範本中的引數。

最佳化與改進

要最佳化和改進 Helm Chart 的設計，可以考慮以下幾點：

範本重用：將常見的範本片段提取出來，並透過子範本（subtemplates）進行重用。
錯誤處理：增加錯誤處理機制，確保在渲染過程中能夠捕捉並處理潛在錯誤。
檔案與註解：保持範本和值檔案中的註解詳細且清晰，以便其他開發者能夠輕鬆理解和維護。

未來趨勢

隨著 Kubernetes 和容器技術的不斷演進，Go 標板在 Helm 中的應用也將變得更加靈活和強大。未來可能會看到更多內建函式和更高效的流程控制機制，以滿足複雜應用場景的需求。

深入理解 Helm Charts 範本

在開發 Helm Charts 的過程中，範本是其中最重要的部分之一。透過範本，我們可以動態生成 Kubernetes 資源，並根據不同的情境進行調整。這些範本不僅能夠簡化佈署流程，還能提升系統的靈活性與可維護性。以下將詳細探討 Helm 範本的核心技術，包括範圍修改、重複操作、變數使用以及函式與管道的應用。

使用 with 操作修改範圍

開發者可以使用 with 操作來修改值的範圍，這在處理巢狀深度較高的值時特別有用。透過 with 操作，我們可以減少參照深度巢狀值所需的字元數量，從而提升範本檔案的可讀性和維護性。

假設我們有一個 values 檔案，內容如下：

application:
  resources:
    limits:
      cpu: 100m
      memory: 512Mi

在沒有使用 with 操作的情況下，我們會這樣參照這些值：

cpu: {{ .Values.application.resources.limits.cpu }}
memory: {{ .Values.application.resources.limits.memory }}

使用 with 操作後，我們可以簡化這些參照：

{{- with .Values.application.resources.limits }}
cpu: {{ .cpu }}
memory: {{ .memory }}
{{- end }}

內容解密：

在上述範例中，with 操作將範圍修改為 .Values.application.resources.limits，因此在 with 塊內部可以直接使用 .cpu 和 .memory 來參照對應的值。這樣不僅減少了字元數量，也使得範本更加簡潔易讀。

使用 range 操作進行重複操作

除了 with 操作之外，Helm 範本還提供了 range 操作來處理列表中的重複操作。假設我們有一個包含多個服務埠的列表：

servicePorts:
  - name: http
    port: 8080
  - name: https
    port: 8443
  - name: jolokia
    port: 8778

我們可以使用 range 操作來遍歷這個列表：

spec:
  ports:
    {{- range .Values.servicePorts }}
    - name: {{ .name }}
      port: {{ .port }}
    {{- end }}

內容解密：

在上述範例中，range 操作會遍歷 .Values.servicePorts 中的每個元素，並在每次迭代中使用 .name 和 .port 來參照對應的值。這樣我們就可以動態生成包含多個埠組態的 Kubernetes 資源。

此外，如果我們需要在 range 塊內部參照全域性範圍內的值，可以使用 $ 字首：

{{- range .Values.servicePorts }}
- name: {{ $.Release.Name }}-{{ .name }}
  port: {{ .port }}
{{- end }}

內容解密：

在上述範例中，.Release.Name 是一個全域性範圍內的值，因此我們需要使用 $ 字首來參照它。這樣可以確保在 range 塊內部仍然能夠正確參照全域性範圍內的值。

範本變數

除了範圍和重複操作之外，Helm 範本還支援定義和使用變數。這些變數可以幫助我們進行額外的處理操作，例如流程控制等。

定義一個變數非常簡單：

{{ $myvar := 'Hello World!' }}

內容解密：

上述範例中，$myvar 被設定為字串 ‘Hello World!’。變數可以被賦予任何型別的值，包括物件和列表。

接著我們可以在範本中參照這個變數：

data:
  greeting.txt: |
    {{ $myvar }}

內容解密：

上述範例中，$myvar 被參照並插入到 greeting.txt 資源中。

變數特別適用於遍歷列表或對映時捕捉索引和值：

data:
  greetings.txt: |
    {{- range $index, $value := .Values.greetings }}
    Greeting {{ $index }}: {{ $value }}
    {{- end }}

內容解密：

上述範例中，$index 和 $value 分別捕捉了列表中的索引和值，$index 和 $value 被插入到 greetings.txt 資源中。

函式與管道

Helm 範本支援使用 Go 範本語言中的函式和管道來進行複雜處理。函式類別似於其他程式語言中的函式，能夠接受輸入並傳回結果。例如常見的 indent 函式可以用來縮排字串：

data:
  application-config: |-
    {{ indent 4 .Values.config }}

內容解密：

上述範例中，indent 函式將 .Values.config 中的字串縮排四個空格。YAML 是一種對空白敏感的標記語言，因此縮排對於正確格式化 YAML 資源非常重要。

管道則是將一個命令的輸出作為另一個命令的輸入。例如：

data:
  application-config: |-
    {{ .Values.config | indent 4 | quote }}

內容解密：

上述範例中，$config 值經過 indent 函式縮排後再經由 quote 函式加上雙引號。管道使得多個命令連續執行變得更加自然和易讀。

總結來說，Helm 範本透過提供多種操作和功能來增強其靈活性與可維護性。開發者可以利用範圍修改、重複操作、變數、函式與管道等技術來動態生成 Kubernetes 資源。這些技術不僅能夠簡化佈署流程，還能提升系統的靈活性與可擴充套件性。

mermaid
graph TD;
    A[Values] --> B[With Action];
    A --> C[Range Action];
    A --> D[Variables];
    A --> E[Functions and Pipelines];
    B --> F[Simplified Reference];
    C --> G[Loop Over List];
    D --> H[Additional Processing];
    E --> I[Complex Data Handling];

此圖示展示了 Helm Charts 範本中的各種操作和功能之間的關係。從 Values 出發，我們可以透過 With Action、Range Action、Variables 和 Functions and Pipelines 等技術來實作更靈活且動態地生成 Kubernetes 資源。

內容解密：

在此圖示中，

With Action 用於簡化深度巢狀值的參照。
Range Action 用於遍歷列表並進行重複操作。
Variables 用於進行額外處理操作。
Functions and Pipelines 用於複雜資料處理。透過這些技術手段，我們能夠更高效地管理和調整 Kubernetes 資源。

玄貓

技術愛好者，專注於分享程式開發、雲端技術與 AI 應用的心得體會。