[Helm入門] Templateで使える関数の実行例～文字列分割編～

この記事は公開されてから半年以上経過しています。情報が古い可能性がありますので、ご注意ください。

Helmのテンプレートで文字列分割の関数を使っていますか？

HelmはKubernetes用のパッケージ管理ソフトウェアです。HelmはChartと呼ばれる設計図をもとに、Kubernetesのマニフェストを作成し、パッケージをインストールします。ChartはGoのテンプレートを利用していて、Sprigの関数を利用することができます。本記事ではHelmテンプレートでのSprig関数のうち、文字列分割操作の使用例を紹介します。

分割以外の文字列操作については、別の記事で紹介をしています。

TL;DR

Sprigの文字列分割操作関数ドキュメント
helm install --dry-run --debug <chart>コマンドを使うことで、Kubernetesにインストールしないで関数の結果を知ることができます。

検証環境

実行例のhelmバージョンは、以下の通りです。

$ helm version --short
Client: v2.13.1+g618447c
Server: v2.13.1+g618447c

$ helm version --short

Client: v2.13.1+g618447c

Server: v2.13.1+g618447c

事前準備

検証用のHelmチャートを作成します。

helm createコマンドでチャートのひな形を作成します。
rmコマンドで不要なファイルを削除します。
検証のYAMLファイルを作成します。今回はConfigMapを作成するYAMLを作成しています。
helm install --dry-run --debugコマンドで実行確認をします。--dry-run オプションを利用することで、Kuernetes上にConfigMapのリソースをインストールしないで、実行結果の確認を行うことができます。

$ helm create sprig
$ rm -rf sprig/templates/*
$ rm -rf sprig/values.yaml
$ cat &lt;&lt; EOF &gt; sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue: {{ .Values.myvalue }}</span>
EOF
$ cat &lt;&lt; EOF &gt; sprig/values.yaml
<span style="color: #ffff00">myvalue: Hello World!</span>
EOF
$ helm install --dry-run --debug ./sprig
...省略...
---
# Source: sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue: Hello World!</span>

$ helm create sprig

$ rm -rf sprig/templates/*

$ rm -rf sprig/values.yaml

$ cat << EOF > sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue: {{ .Values.myvalue }}

EOF

$ cat << EOF > sprig/values.yaml

myvalue: Hello World!

EOF

$ helm install --dry-run --debug ./sprig

...省略...

---

# Source: sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue: Hello World!

String Slice Functions

join

joinは、文字列のリストを指定したセパレータで結合します。パラメータとして、セパレータを指定します。

$ cat &lt;&lt; EOF &gt; sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: {{ .Values.myvalue }}
  myvalue2: {{ join "-" .Values.myvalue }}</span>
EOF
$ cat &lt;&lt; EOF &gt; sprig/values.yaml
<span style="color: #ffff00">myvalue: 
- Hello
- World!</span>
EOF
$ helm install --dry-run --debug ./sprig
...省略...
---
# Source: sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: [Hello World!]
  myvalue2: Hello-World!</span>

$ cat << EOF > sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: {{ .Values.myvalue }}

myvalue2: {{ join "-" .Values.myvalue }}

EOF

$ cat << EOF > sprig/values.yaml

myvalue:

- Hello

- World!

EOF

$ helm install --dry-run --debug ./sprig

...省略...

---

# Source: sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: [Hello World!]

myvalue2: Hello-World!

splitList

splitListは、文字列を指定したセパレータで分割したリストを返します。パラメータとして、セパレータを指定します。

$ cat &lt;&lt; EOF &gt; sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: {{ .Values.myvalue }}
  myvalue2: {{ splitList "-" .Values.myvalue }}</span>
EOF
$ cat &lt;&lt; EOF &gt; sprig/values.yaml
<span style="color: #ffff00">myvalue: Hello-Wor-ld!</span>
EOF
$ helm install --dry-run --debug ./sprig
...省略...
---
# Source: sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: Hello-Wor-ld!
  myvalue2: [Hello Wor ld!]</span>

$ cat << EOF > sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: {{ .Values.myvalue }}

myvalue2: {{ splitList "-" .Values.myvalue }}

EOF

$ cat << EOF > sprig/values.yaml

myvalue: Hello-Wor-ld!

EOF

$ helm install --dry-run --debug ./sprig

...省略...

---

# Source: sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: Hello-Wor-ld!

myvalue2: [Hello Wor ld!]

split

splitは、文字列を指定したセパレータで分割した文字列を辞書型で返します。パラメータとして、セパレータを指定します。

$ cat &lt;&lt; EOF &gt; sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: {{ .Values.myvalue }}
  myvalue2: {{ split "-" .Values.myvalue }}</span>
EOF
$ cat &lt;&lt; EOF &gt; sprig/values.yaml
<span style="color: #ffff00">myvalue: Hello-Wor-ld!</span>
EOF
$ helm install --dry-run --debug ./sprig
...省略...
---
# Source: sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: Hello-Wor-ld!
  myvalue2: map[_0:Hello _1:Wor _2:ld!]</span>

$ cat << EOF > sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: {{ .Values.myvalue }}

myvalue2: {{ split "-" .Values.myvalue }}

EOF

$ cat << EOF > sprig/values.yaml

myvalue: Hello-Wor-ld!

EOF

$ helm install --dry-run --debug ./sprig

...省略...

---

# Source: sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: Hello-Wor-ld!

myvalue2: map[_0:Hello _1:Wor _2:ld!]

splitn

splitnは、文字列を指定したセパレータで分割した文字列を辞書型で返します。パラメータとして、セパレータと分割数を指定します。

splitは、すべてのセパレータで分割されますが、splitnは、指定した数だけ分割されます。分割されなかった文字列は、最後のデータにまとめて表示されます。

$ cat &lt;&lt; EOF &gt; sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: {{ .Values.myvalue }}
  myvalue2: {{ splitn "-" 2 .Values.myvalue }}</span>
EOF
$ cat &lt;&lt; EOF &gt; sprig/values.yaml
<span style="color: #ffff00">myvalue: Hello-Wor-ld!</span>
EOF
$ helm install --dry-run --debug ./sprig
...省略...
---
# Source: sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: Hello-Wor-ld!
  myvalue2: map[_0:Hello _1:Wor-ld!]</span>

$ cat << EOF > sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: {{ .Values.myvalue }}

myvalue2: {{ splitn "-" 2 .Values.myvalue }}

EOF

$ cat << EOF > sprig/values.yaml

myvalue: Hello-Wor-ld!

EOF

$ helm install --dry-run --debug ./sprig

...省略...

---

# Source: sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: Hello-Wor-ld!

myvalue2: map[_0:Hello _1:Wor-ld!]

sortAlpha

sortAlphaは文字列のリストをアルファベットの昇順に並び替えます。

$ cat &lt;&lt; EOF &gt; sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
<span style="color: #ffff00">data:
  myvalue1: {{ .Values.myvalue }}
  myvalue2: {{ sortAlpha .Values.myvalue }}</span>
EOF
$ cat &lt;&lt; EOF &gt; sprig/values.yaml
<span style="color: #ffff00">myvalue:
- Hello
- Alphabet
- 123
- alphabet
- hello
- おめでとう
- あけまして</span>
EOF
$ helm install --dry-run --debug ./sprig
...省略...
---
# Source: sprig/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
data:
  <span style="color: #ffff00">myvalue1: [Hello Alphabet 123 alphabet hello おめでとう あけまして]
  myvalue2: [123 Alphabet Hello alphabet hello あけまして おめでとう]</span>

$ cat << EOF > sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: {{ .Values.myvalue }}

myvalue2: {{ sortAlpha .Values.myvalue }}

EOF

$ cat << EOF > sprig/values.yaml

myvalue:

- Hello

- Alphabet

- 123

- alphabet

- hello

- おめでとう

- あけまして

EOF

$ helm install --dry-run --debug ./sprig

...省略...

---

# Source: sprig/templates/configmap.yaml

apiVersion: v1

kind: ConfigMap

metadata:

data:

myvalue1: [Hello Alphabet 123 alphabet hello おめでとうあけまして]

myvalue2: [123 Alphabet Hello alphabet hello あけましておめでとう]

おわりに

本記事ではHelmテンプレートでのSprig関数のうち、文字列分割操作の使用例を紹介しました。公開されているチャートでも、リリース名やラベル名を変換するのにjoinやsplitが使われていたりします。文字列分割操作の関数を上手につかってリリース名やラベル名を見やすくし、わかりやすいDevOpsを目指していきましょう。