1
2
3
4
5

操作			版本号
install		release 1
upgrade		release 2
upgrade		release 3
rollback 1	release 4 (但使用release 1的配置)

1
2
3
4
5

wget https://get.helm.sh/helm-v3.3.3-linux-amd64.tar.gz

tar -zxvf helm-v3.3.3-linux-amd64.tar.gz

mv helm /usr/local/bin/helm

1
2
3

curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh

1
2
3

git clone https://github.com/helm/helm.git
cd helm
make

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# 添加Helm官方仓库
helm repo add stable https://kubernetes-charts.storage.googleapis.com/


# 查看安装的charts列表
helm search repo stable
NAME                                    CHART VERSION   APP VERSION                     DESCRIPTION
stable/acs-engine-autoscaler            2.2.2           2.1.1                           DEPRECATED Scales worker nodes within agent pools
stable/aerospike                        0.2.8           v4.5.0.5                        A Helm chart for Aerospike in Kubernetes
stable/airflow                          4.1.0           1.10.4                          Airflow is a platform to programmatically autho...
stable/ambassador                       4.1.0           0.81.0                          A Helm chart for Datawire Ambassador

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

helm repo update

# helm install，都会创建一个新的release
# 所以一个chart在同一个集群里面可以被安装多次，每一个都可以被独立的管理和升级
helm install stable/mysql --generate-name
NAME: mysql-1600679719
LAST DEPLOYED: Mon Sep 21 17:15:23 2020
NAMESPACE: default
STATUS: deployed
REVISION: 1
NOTES:
MySQL can be accessed via port 3306 on the following DNS name from within your cluster:
mysql-1600679719.default.svc.cluster.local

To get your root password run:

    MYSQL_ROOT_PASSWORD=$(kubectl get secret --namespace default mysql-1600679719 -o jsonpath="{.data.mysql-root-password}" | base64 --decode; echo)

To connect to your database:

1. Run an Ubuntu pod that you can use as a client:

    kubectl run -i --tty ubuntu --image=ubuntu:16.04 --restart=Never -- bash -il

2. Install the mysql client:

    $ apt-get update && apt-get install mysql-client -y

3. Connect using the mysql cli, then provide your password:
    $ mysql -h mysql-1600679719 -p

To connect to your database directly from outside the K8s cluster:
    MYSQL_HOST=127.0.0.1
    MYSQL_PORT=3306

    # Execute the following command to route the connection:
    kubectl port-forward svc/mysql-1600679719 3306

    mysql -h ${MYSQL_HOST} -P${MYSQL_PORT} -u root -p${MYSQL_ROOT_PASSWORD}

#查看此chart的基本信息
helm show chart stable/mysql
helm show all stable/mysql

1
2
3
4
5
6
7
8

# 查看chart发行版
helm ls
NAME                    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART           APP VERSION
mysql-1600679719        default         1               2020-09-21 17:15:23.169811348 +0800 CST deployed        mysql-1.6.7     5.7.30


# 列出所有部署的发行
helm list

1
2

helm uninstall mysql-1600679719
release "mysql-1600679719" uninstalled

1
2

# 下载一个chart，但不安装
helm pull xxx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

wordpress/
  Chart.yaml          # 包含了chart信息的YAML文件
  LICENSE             # 可选: 包含chart许可证的纯文本文件
  README.md           # 可选: 可读的README文件
  values.yaml         # chart 默认的配置值
  values.schema.json  # 可选: 一个使用JSON结构的values.yaml文件
  charts/             # 包含chart依赖的其他chart
  crds/               # 自定义资源的定义
  templates/          # 模板目录， 当和values 结合时，可生成有效的Kubernetes manifest文件
  templates/NOTES.txt # 可选: 包含简要使用说明的纯文本文件

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

apiVersion: chart API 版本 （必需）
name: chart名称 （必需）
version: 语义化2 版本（必需）
kubeVersion: 兼容Kubernetes版本的语义化版本（可选）
description: 一句话对这个项目的描述（可选）
type: chart类型 （可选）
keywords:
  - 关于项目的一组关键字（可选）
home: 项目home页面的URL （可选）
sources:
  - 项目源码的URL列表（可选）
dependencies: # chart 必要条件列表 （可选）
  - name: chart名称 (nginx)
    version: chart版本 ("1.2.3")
    repository: 仓库URL ("https://example.com/charts") 或别名 ("@repo-name")
    condition: （可选） 解析为布尔值的yaml路径，用于启用、禁用chart (e.g. subchart1.enabled )
    tags: # （可选）
      - 用于一次启用/禁用 一组chart的tag
    enabled: （可选） 决定是否加载chart的布尔值
    import-values: # （可选）
      - ImportValue 保存源值到导入父键的映射。每项可以是字符串或者一对子/父列表项
    alias: （可选） chart中使用的别名。当你要多次添加相同的chart时会很有用
maintainers: # （可选）
  - name: 维护者名字 （每个维护者都需要）
    email: 维护者邮箱 （每个维护者可选）
    url: 维护者URL （每个维护者可选）
icon: 用做icon的SVG或PNG图片URL （可选）
appVersion: 包含的应用版本（可选）。不需要是语义化的
deprecated: 不被推荐的chart （可选，布尔值）
annotations:
  example: 按名称输入的批注列表 （可选）.

1
2
3

# nginx chart的版本字段version: 1.2.3
# 按照名称设置为
nginx-1.2.3.tgz

1
2
3
4
5

>= 1.13.0 < 1.15.0

>= 1.13.0 < 1.14.0 || >= 1.14.1 < 1.15.0

1.1 - 2.3.4

1
2
3
4
5
6
7

dependencies:
  - name: apache
    version: 1.2.3
    repository: https://example.com/charts
  - name: mysql
    version: 3.2.1
    repository: https://another.example.com/charts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

dependencies:
  - name: subchart
    repository: http://localhost:10191
    version: 0.1.0
    alias: new-subchart-1
  - name: subchart
    repository: http://localhost:10191
    version: 0.1.0
    alias: new-subchart-2
  - name: subchart
    repository: http://localhost:10191
    version: 0.1.0

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

dependencies:
  - name: subchart1
    repository: http://localhost:10191
    version: 0.1.0
    condition: subchart1.enabled, global.subchart1.enabled
    tags:
      - front-end
      - subchart1
  - name: subchart2
    repository: http://localhost:10191
    version: 0.1.0
    condition: subchart2.enabled,global.subchart2.enabled
    tags:
      - back-end
      - subchart2

1
2
3
4
5
6

#values.yaml
subchart1:
  enabled: true
tags:
  front-end: false
  back-end: true

1
2

# 可以在CLI使用--set参数来设置标签和条件值
helm install --set tags.front-end=true --set subchart2.enabled=false

1
2
3
4
5
6
7
8

# parent's Chart.yaml file

dependencies:
  - name: subchart
    repository: http://localhost:10191
    version: 0.1.0
    import-values:
      - data

1
2
3
4
5

# child's values.yaml file

exports:
  data:
    myint: 99

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

apiVersion: v1
kind: ReplicationController
metadata:
  name: deis-database
  namespace: deis
  labels:
    app.kubernetes.io/managed-by: deis
spec:
  replicas: 1
  selector:
    app.kubernetes.io/name: deis-database
  template:
    metadata:
      labels:
        app.kubernetes.io/name: deis-database
    spec:
      serviceAccount: deis-database
      containers:
        - name: deis-database
          image: {{ .Values.imageRegistry }}/postgres:{{ .Values.dockerTag }}
          imagePullPolicy: {{ .Values.pullPolicy }}
          ports:
            - containerPort: 5432
          env:
            - name: DATABASE_STORAGE
              value: {{ default "minio" .Values.storage }}

1
2

global:
  app: MyWordPress

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "properties": {
    "image": {
      "description": "Container Image",
      "properties": {
        "repo": {
          "type": "string"
        },
        "tag": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "description": "Service name",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "minimum": 0,
      "type": "integer"
    },
    "protocol": {
      "type": "string"
    }
  },
  "required": [
    "protocol",
    "port"
  ],
  "title": "Values",
  "type": "object"
}

1
2
3
4
5
6
7
8

# 创建新chart
helm create mychart

# 打包
helm package mychart

# 格式信息
helm lint mychart

1
2

annotations:
  "helm.sh/hook": post-install

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

helm repo add bitnami https://charts.bitnami.com/bitnami
helm pull bitnami/wordpress --untar

wordpress/
  Chart.yaml
  README.md
  values.yaml
  charts/
  templates/
  templates/tests/test-mariadb-connection.yaml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

{{- if .Values.mariadb.enabled }}
apiVersion: v1
kind: Pod
metadata:
  name: "{{ .Release.Name }}-credentials-test"
  annotations:
    "helm.sh/hook": test
spec:
  containers:
    - name: {{ .Release.Name }}-credentials-test
      image: {{ template "wordpress.image" . }}
      imagePullPolicy: {{ .Values.image.pullPolicy | quote }}
      {{- if .Values.securityContext.enabled }}
      securityContext:
        runAsUser: {{ .Values.securityContext.runAsUser }}
      {{- end }}
      env:
        - name: MARIADB_HOST
          value: {{ template "mariadb.fullname" . }}
        - name: MARIADB_PORT
          value: "3306"
        - name: WORDPRESS_DATABASE_NAME
          value: {{ default "" .Values.mariadb.db.name | quote }}
        - name: WORDPRESS_DATABASE_USER
          value: {{ default "" .Values.mariadb.db.user | quote }}
        - name: WORDPRESS_DATABASE_PASSWORD
          valueFrom:
            secretKeyRef:
              name: {{ template "mariadb.fullname" . }}
              key: mariadb-password
      command:
        - /bin/bash
        - -ec
        - |
                    mysql --host=$MARIADB_HOST --port=$MARIADB_PORT --user=$WORDPRESS_DATABASE_USER --password=$WORDPRESS_DATABASE_PASSWORD
  restartPolicy: Never
{{- end }}

1
2
3

helm install quirky-walrus wordpress --namespace default

helm test quirky-walrus

1
2
3
4
5
6
7
8

# 生成
helm package --sign ...
helm package --sign --key 'John Smith' --keyring path/to/keyring.secret mychart

# 校验
helm install --verify
helm verify mychart-0.1.0.tgz
helm install --generate-name --verify mychart-0.1.0.tgz

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# 激活对OCI的支持
export HELM_EXPERIMENTAL_OCI=1


# 运行一个注册中心
docker run -dp 5000:5000 --restart=always --name registry registry


# 认证
htpasswd -cB -b auth.htpasswd myuser mypass
docker run -dp 5000:5000 --restart=always --name registry \
  -v $(pwd)/auth.htpasswd:/etc/docker/registry/auth.htpasswd \
  -e REGISTRY_AUTH="{htpasswd: {realm: localhost, path: /etc/docker/registry/auth.htpasswd}}" \
  registry


# 登录
helm registry login -u myuser localhost:5000


# 注销
helm registry logout localhost:5000


# 保存
helm chart save mychart/ localhost:5000/myrepo/mychart:2.7.0

# 查看
helm chart list

# 导出
helm chart export localhost:5000/myrepo/mychart:2.7.0

# 推送到远程
helm chart push localhost:5000/myrepo/mychart:2.7.0

# 从缓存中移除
helm chart remove localhost:5000/myrepo/mychart:2.7.0

# 从远程拉取
helm chart pull localhost:5000/myrepo/mychart:2.7.0

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

tree ~/Library/Caches/helm/
└── registry
    ├── cache
    │   ├── blobs
    │   │   └── sha256
    │   │       ├── 1b251d38cfe948dfc0a5745b7af5ca574ecb61e52aed10b19039db39af6e1617
    │   │       ├── 31fb454efb3c69fafe53672598006790122269a1b3b458607dbe106aba7059ef
    │   │       └── 8ec7c0f2f6860037c19b54c3cfbab48d9b4b21b485a93d87b64690fdb68c2111
    │   ├── index.json
    │   ├── ingest
    │   └── oci-layout
    └── config.json

1
2
3
4
5
6
7
8

# 创建ns
kubectl create namespace foo

#创建RoleBinding
kubectl create rolebinding sam-edit
    --clusterrole edit \
    --user sam \
    --namespace foo

1
2
3
4
5
6
7
8

kubectl create clusterrolebinding sam-view
    --clusterrole view \
    --user sam


kubectl create clusterrolebinding sam-secret-reader
    --clusterrole secret-reader \
    --user sam

1
2
3
4
5
6
7
8
9

# cluster-role-secret-reader.yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: secret-reader
rules:
- apiGroups: [""]
  resources: ["secrets"]
  verbs: ["get", "watch", "list"]

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

kubectl create -f clusterrole-secret-reader.yaml

kubectl create namespace foo

kubectl create rolebinding sam-view
    --clusterrole view \
    --user sam \
    --namespace foo


kubectl create rolebinding sam-secret-reader
    --clusterrole secret-reader \
    --user sam \
    --namespace foo

1
2
3
4
5
6
7

kubectl create clusterrolebinding sam-view
    --clusterrole view \
    --user sam

kubectl create clusterrolebinding sam-secret-reader
    --clusterrole secret-reader \
    --user sam

1
2
3
4
5
6
7

# 示例
drupal
nginx-lego
aws-cluster-autoscaler

nginx-lego
nginx-lego/

1
2

chicken: true
chickenNoodleSoup: true

1
2

.Release.Name
.Capabilities.KubeVersion

1
2
3

server:
  name: nginx
  port: 80

1
2
3

{{ if .Values.server }}
  {{ default "none" .Values.server.name }}
{{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# YAM的类型强制规则有时是反直觉的。例如一下两者是不同的
foo: false
foo: "false"

# 避免类型转化错误的最简单的方法是要明确字符串和隐含的一切。使用引号引用字符串
# 要避免整数转换错误，将整数存储为字符串，使用以下方法来获取整数值
{{ int $value }}

# 在大多数情况下，显式类型标签被尊重。如以下1234被当作字符串
foo: !!string 1234

1
2
3
4
5

servers:
  foo:
    port: 80
  bar:
    port: 81

1
2
3
4

# serverHost is the host name for the webserver
serverHost: example
# serverPort is the HTTP listener port for the webserver
serverPort: 9191

1
2
3

{{- define "nginx.fullname" }}
{{/* ... */}}
{{ end -}}

1
2
3
4
5
6
7

{{ .foo }}
{{ print "foo" }}
{{- print "bar" -}}

{{ if $foo -}}
  {{- with .Bar }}Hello{{ end -}}
{{- end -}}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

# This is best
apiVersion: batch/v1
kind: Job
metadata:
  name: example
  labels:
    first: first
    second: second


# This is okay
apiVersion: batch/v1
kind: Job

metadata:
  name: example

  labels:
    first: first
    second: second

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

# yaml 注释


{{- /*
模板注释
*/ -}}


{{- /*
mychart.shortname provides a 6 char truncated version of the release name.
*/ -}}
{{ define "mychart.shortname" -}}
{{ .Release.Name | trunc 6 }}
{{- end -}}


# This may cause problems if the value is more than 100Gi
memory: {{ .Values.maxMem | quote }}

1
2
3
4
5
6
7
8
9

# 列表

# yaml
arguments:
  - "--dirname"
  - "/foo"

# json
arguments: ["--dirname", "/foo"]

1
2

# >= 1.2.3, < 1.3.0
version: ~1.2.3

1
2
3
4
5
6
7

# 条件的推荐格式
condition: somechart.enabled


# 标记
tags:
  - webaccelerator

1
2
3
4
5
6
7
8

名称    状态   描述
app.kubernetes.io/name  REC    这应该是app名称。通常使用{{ template "name" . }} 这由许多k8s manifests使用，不是Helm特定的
helm.sh/chart           REC  chart名称和版本: {{ .Chart.Name }}-{{ .Chart.Version }}
app.kubernetes.io/managed-by    REC    这应该始终设置为{{ .Release.Service }}
app.kubernetes.io/instance    REC    这应该为{{ .Release.Name }}，有助于在同意应用不同实例之间进行区分
app.kubernetes.io/version    OPT   应用的版本设置为{{ .Chart.AppVersion }}
app.kubernetes.io/component    OPT   This is a common label for marking the different roles that pieces may play in an application
|app.kubernetes.io/part-of    OPT   当多个charts或软件片一起使用来做一个应用

1

image: {{ .Values.redisImage | quote }}

1

image: "{{ .Values.redisImage }}:{{ .Values.redisTag }}"

1

imagePullPolicy: {{ .Values.image.pullPolicy }}

1
2
3

# values.yaml
image:
  pullPolicy: IfNotPresent

1
2
3
4
5
6
7

selector:
  matchLabels:
      app.kubernetes.io/name: MyName
template:
  metadata:
    labels:
      app.kubernetes.io/name: MyName

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

rbac:
  # Specifies whether RBAC resources should be created
  create: true

serviceAccount:
  # Specifies whether a ServiceAccount should be created
  create: true
  # The name of the ServiceAccount to use.
  # If not set and create is true, a name is generated using the fullname template
  name:

1
2
3
4
5
6
7
8

someComponent:
  serviceAccount:
    create: true
    name:
anotherComponent:
  serviceAccount:
    create: true
    name:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{{/*
Create the name of the service account to use
*/}}
{{- define "mychart.serviceAccountName" -}}
{{- if .Values.serviceAccount.create -}}
    {{ default (include "mychart.fullname" .) .Values.serviceAccount.name }}
{{- else -}}
    {{ default "default" .Values.serviceAccount.name }}
{{- end -}}
{{- end -}}

1
2
3
4
5
6

mychart/
  Chart.yaml
  values.yaml
  charts/
  templates/
  ...

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# 创建一个名为mychart的chart包
helm create mychart
Creating mychart


# 目录结构
tree ./mychart -L 2
./mychart
├── charts
├── Chart.yaml
├── templates
│   ├── deployment.yaml
│   ├── _helpers.tpl    #模板助手，你可以重新使用整个chart
│   ├── hpa.yaml    #
│   ├── ingress.yaml
│   ├── NOTES.txt    #chart包的帮助文本(help text)，会在运行helm install显示
│   ├── serviceaccount.yaml
│   ├── service.yaml
│   └── tests
└── values.yaml


# 创建自己的模板
rm -rf mychart/templates/*

1
2
3
4
5
6
7
8

# mychart/templates/configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configpmap
data:
  myvalue: "Hello World"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

helm install full-coral mychart
NAME: full-coral
LAST DEPLOYED: Sun Sep 27 10:38:03 2020
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None


helm ls
NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART           APP VERSION
full-coral      default         1               2020-09-27 10:38:03.546664865 +0800 CST deployed        mychart-0.1.0   1.16.0


helm get manifest full-coral
---
# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mychart-configmap
data:
  myvalue: "Hello World"


kubectl get configmap
NAME                DATA   AGE
mychart-configmap   1      9m47s


# 卸载
helm uninstall full-coral

1
2
3
4
5
6

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# 模板指令放置于{{ xxx }} 块内
helm install clunky-serval mychart/
NAME: clunky-serval
LAST DEPLOYED: Sun Sep 27 11:16:20 2020
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None


helm get manifest clunky-serval
---
# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: clunky-serval-configmap
data:
  myvalue: "Hello World"


# 可使用--debug查看详情
# 下面将渲染模板，返回渲染输出，不会真正安装
helm install --debug --dry-run goodly-guppy ./mychart

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

- `Release`对象
  - `Release.Name`
  - `Release.Namespace`
  - `Release.IsUpgrade`
  - `Release.IsInstall`
  - `Release.Revision`
  - `Release.Service`：在Helm中，总是Helm
- `Values`: `values.yaml`中传递给模板的值
- `Chart`: `Chart.yaml`文件内容
- `Files`: 访问chart包中非模板的文件
  - `Files.Get`: 通过名称生成文件的函数
  - `Files.GetBytes`
  - `Files.Glob`: 返回文件为列表的函数
  - `Files.Lines`: 一行行读取文件的函数
  - `Files.AsSecrets`: 返回文件内容为base64编码字符串的函数
  - `Files.AsConfig`: 返回文件内容为YAML map的函数
- `Capabilities`
  - `Capabilities.APIVersions`
  - `Capabilities.APIVersions.Has $version`
  - `Capabilities.KubeVersion`, `Capabilities.KubeVersion.Version`
  - `Capabilities.KubeVersion.Major`
  - `Capabilities.KubeVersion.Minor`
- `Template`
  - `Template.Name`
  - `Template.BasePath`

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# values.yaml
favoriteDrink: coffee


# configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favoriteDrink }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# 渲染
helm install geared-marsupi ./mychart --dry-run --debug
HOOKS:
MANIFEST:
---
# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: geared-marsupi-configmap
data:
  myvalue: "Hello World"
  drink: coffee


# 通过命令行选项覆盖值
helm install solid-vulture ./mychart --dry-run --debug --set favoriteDrink=slurm
HOOKS:
MANIFEST:
---
# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: solid-vulture-configmap
data:
  myvalue: "Hello World"
  drink: slurm

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

# values.yaml
favorite:
  drink: coffee
  food: pizza


# configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favorite.drink }}
  food: {{ .Values.favorite.food }}

1
2
3
4
5
6
7
8

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ quote .Values.favorite.drink }}
  food: {{ quote .Values.favorite.food }}

1
2
3
4
5
6
7
8

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favorite.drink | quote }}
  food: {{ .Values.favorite.food | quote }}

1
2
3
4
5

drink: {{ .Values.favorite.drink | repeat 5 | quote }}
food: {{ .Values.favorite.food | upper | quote }}

#drink: "coffeecoffeecoffeecoffeecoffee"
#food: "PIZZA"

1

drink: {{ .Values.favorite.drink | default "tea" | quote }}

1

drink: {{ .Values.favorite.drink | default (printf "%s-tea" (include "fullname" .)) }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# apiVersion, kind, namespace, name都是string
# name, namespace两个是可选的，可以为空进行传递


# 下列将会返回mynamespace对象的注释
(lookup "v1" "Namespace" "" "mynamespace").metadata.annotations


# 当lookup返回一个列表(list)对象时，可以通过items字段访问列表对象
{{ range $index, $service := (lookup "v1" "Service" "mynamespace" "").items }}
    {{/* do something with each service */}}
{{ end }}

1
2
3
4
5
6
7

{{ if PIPELINE }}
  # Do something
{{ else if OTHER PIPELINE }}
  # Do something else
{{ else }}
  # Default case
{{ end }}

1
2
3
4
5
6
7
8
9

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favorite.drink | default "tea" | quote }}
  food: {{ .Values.favorite.food | upper | quote }}
  {{ if eq .Values.favorite.drink "coffee" }}mug: true{{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favorite.drink | default "tea" | quote }}
  food: {{ .Values.favorite.food | upper | quote }}
  {{ if eq .Values.favorite.drink "coffee" }}
    mug: true
  {{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: eyewitness-elk-configmap
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "PIZZA"
    mug: true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favorite.drink | default "tea" | quote }}
  food: {{ .Values.favorite.food | upper | quote }}
  {{ if eq .Values.favorite.drink "coffee" }}
  mug: true
  {{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: telling-chimp-configmap
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "PIZZA"

  mug: true

1
2
3
4

# 首先，模板声明的花括号 {{ 可以使用特殊字符进行修改，来告诉模板引擎排列空白
{{- 表示空白应靠左(chomped left)
-}} 表示空白应在右边消耗(right should be consumed)
# 注意，换行也是空白（Newlines are whitespace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favorite.drink | default "tea" | quote }}
  food: {{ .Values.favorite.food | upper | quote }}
  {{- if eq .Values.favorite.drink "coffee" }}
  mug: true
  {{- end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: clunky-cat-configmap
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "PIZZA"
  mug: true

1
2
3
4

  food: {{ .Values.favorite.food | upper | quote }}
  {{- if eq .Values.favorite.drink "coffee" -}}
  mug: true
  {{- end -}}

1
2
3

# 最后，有时很容易告诉模板系统如何缩进，而不是试图掌握模板指令的空格。
# 出于此原因，你有时可能会发现使用 indent函数 处理缩进是很有用的
{{ indent 2 "mug: true" }}

1
2
3
4

# with语法和if语句类似
{{ with PIPELINE }}
  # restricted scope
{{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- with .Values.favorite }}
  drink: {{ .drink | default "tea" | quote }}
  food: {{ .food | upper | quote }}
  {{- end }}

1
2

# 注意，由于我们使用 with 将范围设置在了 .Values.favorite
# 所以我们使用 .drink, .food。范围在 {{ end }} 后被还原

1
2
3
4
5
6

{{- with .Values.favorite }}
drink: {{ .drink | default "tea" | quote }}
food: {{ .food | upper | quote }}
release: {{ .Release.Name }}
{{- end }}
release-2: {{ .Release.Name }}

1
2
3
4
5

{{- with .Values.favorite }}
drink: {{ .drink | default "tea" | quote }}
food: {{ .food | upper | quote }}
release: {{ $.Release.Name }}
{{- end }}

1
2
3
4
5
6
7
8

favorite:
  drink: coffee
  food: pizza
pizzaToppings:
  - mushrooms
  - cheese
  - peppers
  - onions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- with .Values.favorite }}
  drink: {{ .drink | default "tea" | quote }}
  food: {{ .food | upper | quote }}
  {{- end }}
  toppings: |-
    {{- ranage .Values.pizzaToppings }}
    - {{ . | title | quote }}
    {{- end }}    

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- with $.Values.favorite }}
  drink: {{ .drink | default "tea" | quote }}
  food: {{ .food | upper | quote }}
  toppings: |-
    {{- range $.Values.pizzaToppings }}
    - {{ .| title | quote }}
    {{- end }}    
  {{- end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: edgy-dragonfly-configmap
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "PIZZA"
  toppings: |-
    - "Mushrooms"
    - "Cheese"
    - "Peppers"
    - "Onions"    

1
2
3
4

sizes: |-
  {{- range ruple "small" "medium" "large"}}
  - {{ . }}
  {{- end }}  

1
2
3
4

sizes: |-
  - small
  - medium
  - large  

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Releae.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- $relname := .Release.Name -}}
  {{- with .Values.favorite }}
  drink: {{ .drink | default "tea" | quote }}
  food: {{ .food | upper | quote }}
  release: {{ $relname }}
  {{- end }}

1
2
3
4

  toppings: |-
    {{- range $index, $topping := .Values.pizzaToppings }}
      {{ $index }}: {{ $topping }}
    {{- end }    

1
2
3
4
5

  toppings: |-
      0: mushrooms
      1: cheese
      2: peppers
      3: onions      

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{{- range .Values.tlsSecrets }}
apiVersion: v1
kind: Secret
metadata:
  name: {{ .name }}
  labels:
    # Many helm templates would use `.` below, but that will not work,
    # however `$` will work here
    app.kubernetes.io/name: {{ template "fullname" $ }}
    # I cannot reference .Chart.Name, but I can do $.Chart.Name
    helm.sh/chart: "{{ $.Chart.Name }}-{{ $.Chart.Version }}"
    app.kubernetes.io/instance: "{{ $.Release.Name }}"
    # Value from appVersion in Chart.yaml
    app.kubernetes.io/version: "{{ $.Chart.AppVersion }}"
    app.kubernetes.io/managed-by: "{{ $.Release.Service }}"
type: kubernetes.io/tls
data:
  tls.crt: {{ .certificate }}
  tls.key: {{ .key }}
---
{{- end }}

1
2
3

# 一种流行的命名约定是使用chart名作为前缀：
{{ define "mychart.labels" }}
# 通过使用特定的chart名称作为前缀，我们可以避免相同模板名称所带来的冲突

1
2
3

{{ define "MY.NAME "}}
  # body of template here
{{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{{- define "mychart.labels" }}
  labels:
    generator: helm
    data: {{ now | htmlDate }}
{{- end }}
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  {{- template "mychart.labels" }}
  data:
    myvalue: "Hello World"
    {{- range $key, $va1 := .Values.favorite }}
    {{ $key }}: {{ $va1 | quote }}
    {{- end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: running-panda-configmap
  labels:
    generator: helm
    date: 2016-11-02
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "pizza"

1
2
3
4
5
6

{{/* Generate basic labels */}}
{{- define "mychart.labels" }}
  labels:
    generator: helm
    date: {{ now | htmlDate }}
{{- end }}

1
2

# 按照管理，define函数 应该有一个简单的文档块 {{/*...*/}}
# 如上。然后在其它模板文件中访问它。

1
2
3
4
5
6
7
8

{{/* Generate basic labels */}}
{{- define "mychart.labels" }}
  labels:
    generator: helm
    data: {{ now | htmlData }}
    chart: {{ .Chart.Name }}
    version: {{ .Chart.Version }}
{{- end }}

1
2
3
4
5

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  {{- template "mychart.labels" . }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: plinking-anaco-configmap
  labels:
    generator: helm
    date: 2016-11-02
    chart: mychart
    version: 0.1.0

1
2
3
4

{{- define "mychart.app" -}}
app_name: {{ .Chart.Name }}
app_version: "{{ .Chart.Version }}"
{{- end -}}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  labels:
    {{ template "mychart.app" . }}
data:
  myvalue: "Hello World"
  {{- range $key, $val := .Values.favorite }}
  {{ $key }}: {{ $val | quote }}
  {{- end }}
{{ template "mychart.app" . }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: measly-whippet-configmap
  labels:
    app_name: mychart
app_version: "0.1.0+1478129847"
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "pizza"
  app_name: mychart
app_version: "0.1.0+1478129847"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  labels:
{{ include "mychart.app" . | indent 4 }}
data:
  myvalue: "Hello World"
  {{- range $key, $va1 := .Values.favorite }}
  {{ $key }}: {{ $val | quote }}
  {{- end }}
  {{ include "mychart.app" . | indent 2 }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: edgy-mole-configmap
  labels:
    app_name: mychart
    app_version: "0.1.0+1478129987"
data:
  myvalue: "Hello World"
  drink: "coffee"
  food: "pizza"
  app_name: mychart
  app_version: "0.1.0+1478129987"

1
2
3
4
5
6
7
8

# config1.toml
message = Hello from config 1

# config1.tom2
message = Hello from config 2

# config1.tom3
message = Goodbye from config 3

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  {{- $files := .Files }}
  {{- range tuple "config1.tom1" "config2.toml" "config3.toml" }}
  {{ .}}: |-
        {{ $files.Get .}}
  {{- end }}

1
2
3

# 首先，创建了一个 $files变量 来保存.Files对象的引用
# 我们同样使用 tuple函数来创建循环的文件列表
# 接着打印每个文件名 {{ . }}: |- 后面接着文件内容 {{ $files.Get . }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: quieting-giraf-configmap
data:
  config1.toml: |-
        message = Hello from config 1

  config2.toml: |-
        message = This is config 2

  config3.toml: |-
        message = Goodbye from config 3

1
2
3
4
5
6

# 示例的目录结构
foo/:
  foo.txt foo.yaml

bar/:
  bar.go bar.conf baz.yaml

1
2
3
4
5
6

{{ $currentScope := .}}
{{ range $path, $_ :=  .Files.Glob  "**.yaml" }}
    {{- with $currentScope}}
        {{ .Files.Get $path }}
    {{- end }}
{{ end }}

1
2
3

{{ range $path, $_ :=  .Files.Glob  "**.yaml" }}
      {{ $.Files.Get $path }}
{{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

apiVersion: v1
kind: ConfigMap
metadata:
  name: conf
data:
{{ (.Files.Glob "foo/*").AsConfig | indent 2 }}
---
apiVersion: v1
kind: Secret
metadata:
  name: very-secret
type: Opaque
data:
{{ (.Files.Glob "bar/*").AsSecrets | indent 2 }}

1
2
3
4
5
6
7
8

apiVersion: v1
kind: Secret
metadata:
  name: {{ .Release.Name }}-secret
type: Opaque
data:
  token: |-
        {{ .Files.Get "config1.toml" | b64enc }}

1
2
3
4
5
6
7
8
9

# Source: mychart/templates/secret.yaml
apiVersion: v1
kind: Secret
metadata:
  name: lucky-turkey-secret
type: Opaque
data:
  token: |-
        bWVzc2FnZSA9IEhlbGxvIGZyb20gY29uZmlnIDEK

1
2
3

data:
  some-file.txt: {{ range .Files.Lines "foo/bar.txt" }}
    {{ . }}{{ end }}

1
2
3
4
5
6
7

Thank you for installing {{ .Chart.Name }}

Your release is named {{ .Release.Name }}

To learn more about the release, try:
  $ helm status {{ .Release.Name }}
  $ helm get all {{ .Release.Name }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

helm install rude-cardinal ./mychart

RESOURCES:
==> v1/Secret
NAME                   TYPE      DATA      AGE
rude-cardinal-secret   Opaque    1         0s

==> v1/ConfigMap
NAME                      DATA      AGE
rude-cardinal-configmap   3         0s


NOTES:
Thank you for installing mychart.

Your release is named rude-cardinal.

To learn more about the release, try:

  $ helm status rude-cardinal
  $ helm get all rude-cardinal

1
2
3
4
5

cd mychart/charts

helm create mysubchart

rm -rf mysubchart/templates/*.*

1
2

# values.yaml
dessert: cake

1
2
3
4
5
6

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-cfgmap2
data:
  dessert: {{ .Values.dessert }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

helm install --generate-name --dry-run --debug mychart/charts/mysubchart
SERVER: "localhost:44134"
CHART PATH: /Users/mattbutcher/Code/Go/src/helm.sh/helm/_scratch/mychart/charts/mysubchart
NAME:   newbie-elk
TARGET NAMESPACE:   default
CHART:  mysubchart 0.1.0
MANIFEST:
---
# Source: mysubchart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: newbie-elk-cfgmap2
data:
  dessert: cake

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# mychart/values.yaml
favorite:
  drink: coffee
  food: pizza
pizzaToppings:
  - mushrooms
  - cheese
  - peppers
  - onions

mysubchart:
  dessert: ice cream

1
2
3
4
5
6
7
8
9

helm install --dry-run --debug mychart

# Source: mychart/charts/mysubchart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: unhinged-bee-cfgmap2
data:
  dessert: ice cream

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

# mychart/values.yaml

favorite:
  drink: coffee
  food: pizza
pizzaToppings:
  - mushrooms
  - cheese
  - peppers
  - onions

mysubchart:
  dessert: ice cream

global:
  salad: caesar

1
2
3
4
5
6
7
8

# 任意chart和subchart都可以使用 {{ .Values.global.salad }} 来访问这个值
# mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  salad: {{ .Values.global.salad }}

1
2
3
4
5
6
7
8

# mysubchart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-cfgmap2
data:
  dessert: {{ .Values.dessert }}
  salad: {{ .Values.global.salad }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: silly-snake-configmap
data:
  salad: caesar

---
# Source: mychart/charts/mysubchart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: silly-snake-cfgmap2
data:
  dessert: ice cream
  salad: caesar

1

{{- define "labels" }}from: mychart {{ end }}

1

{{ include $mytemplate }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25