Helm
Helm 是一个类似于 yum/apt/homebrew 的 Kubernetes 应用管理工具。Helm 使用 Chart 来管理 Kubernetes manifest 文件。

Helm 基本使用

安装 helm 客户端
1
brew install kubernetes-helm
Copied!
初始化 Helm 并安装 Tiller 服务(需要事先配置好 kubectl)
1
helm init
Copied!
对于 Kubernetes v1.16.0 以上的版本,有可能会碰到 Error: error installing: the server could not find the requested resource 的错误。这是由于 extensions/v1beta1 已经被 apps/v1 替代,解决方法是
1
kubectl create serviceaccount --namespace kube-system tiller
2
kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=kube-system:tiller
3
helm init --service-account tiller --override spec.selector.matchLabels.'name'='tiller',spec.selector.matchLabels.'app'='helm' --output yaml | sed '[email protected]: extensions/[email protected]: apps/[email protected]' | kubectl apply -f -
Copied!
更新 charts 列表
1
helm repo update
Copied!
部署服务,比如 mysql
1
➜ ~ helm install stable/mysql
2
NAME: quieting-warthog
3
LAST DEPLOYED: Tue Feb 21 16:13:02 2017
4
NAMESPACE: default
5
STATUS: DEPLOYED
6
7
RESOURCES:
8
==> v1/Secret
9
NAME TYPE DATA AGE
10
quieting-warthog-mysql Opaque 2 1s
11
12
==> v1/PersistentVolumeClaim
13
NAME STATUS VOLUME CAPACITY ACCESSMODES AGE
14
quieting-warthog-mysql Pending 1s
15
16
==> v1/Service
17
NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
18
quieting-warthog-mysql 10.3.253.105 <none> 3306/TCP 1s
19
20
==> extensions/v1beta1/Deployment
21
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
22
quieting-warthog-mysql 1 1 1 0 1s
23
24
25
NOTES:
26
MySQL can be accessed via port 3306 on the following DNS name from within your cluster:
27
quieting-warthog-mysql.default.svc.cluster.local
28
29
To get your root password run:
30
31
kubectl get secret --namespace default quieting-warthog-mysql -o jsonpath="{.data.mysql-root-password}" | base64 --decode; echo
32
33
To connect to your database:
34
35
1. Run an Ubuntu pod that you can use as a client:
36
37
kubectl run -i --tty ubuntu --image=ubuntu:16.04 --restart=Never -- bash -il
38
39
2. Install the mysql client:
40
41
$ apt-get update && apt-get install mysql-client -y
42
43
3. Connect using the mysql cli, then provide your password:
44
$ mysql -h quieting-warthog-mysql -p
Copied!
更多命令的使用方法可以参考下面的 "Helm 命令参考" 部分。

Helm 工作原理

基本概念

Helm 的三个基本概念
    Chart:Helm 应用(package),包括该应用的所有 Kubernetes manifest 模版,类似于 YUM RPM 或 Apt dpkg 文件
    Repository:Helm package 存储仓库
    Release:chart 的部署实例,每个 chart 可以部署一个或多个 release

Helm 工作原理

Helm 包括两个部分,helm 客户端和 tiller 服务端。
the client is responsible for managing charts, and the server is responsible for managing releases.

helm 客户端

helm 客户端是一个命令行工具,负责管理 charts、repository 和 release。它通过 gPRC API(使用 kubectl port-forward 将 tiller 的端口映射到本地,然后再通过映射后的端口跟 tiller 通信)向 tiller 发送请求,并由 tiller 来管理对应的 Kubernetes 资源。
helm 命令的使用方法可以参考下面的 "Helm 命令参考" 部分。

tiller 服务端

tiller 接收来自 helm 客户端的请求,并把相关资源的操作发送到 Kubernetes,负责管理(安装、查询、升级或删除等)和跟踪 Kubernetes 资源。为了方便管理,tiller 把 release 的相关信息保存在 kubernetes 的 ConfigMap 中。
tiller 对外暴露 gRPC API,供 helm 客户端调用。

Helm Charts

Helm 使用 Chart 来管理 Kubernetes manifest 文件。每个 chart 都至少包括
    应用的基本信息 Chart.yaml
    一个或多个 Kubernetes manifest 文件模版(放置于 templates / 目录中),可以包括 Pod、Deployment、Service 等各种 Kubernetes 资源

Chart.yaml 示例

1
name: The name of the chart (required)
2
version: A SemVer 2 version (required)
3
description: A single-sentence description of this project (optional)
4
keywords:
5
- A list of keywords about this project (optional)
6
home: The URL of this project's home page (optional)
7
sources:
8
- A list of URLs to source code for this project (optional)
9
maintainers: # (optional)
10
- name: The maintainer's name (required for each maintainer)
11
email: The maintainer's email (optional for each maintainer)
12
engine: gotpl # The name of the template engine (optional, defaults to gotpl)
13
icon: A URL to an SVG or PNG image to be used as an icon (optional).
Copied!

依赖管理

Helm 支持两种方式管理依赖的方式:
    直接把依赖的 package 放在 charts/ 目录中
    使用 requirements.yaml 并用 helm dep up foochart 来自动下载依赖的 packages
1
dependencies:
2
- name: apache
3
version: 1.2.3
4
repository: http://example.com/charts
5
- name: mysql
6
version: 3.2.1
7
repository: http://another.example.com/charts
Copied!

Chart 模版

Chart 模板基于 Go template 和 Sprig,比如
1
apiVersion: v1
2
kind: ReplicationController
3
metadata:
4
name: deis-database
5
namespace: deis
6
labels:
7
heritage: deis
8
spec:
9
replicas: 1
10
selector:
11
app: deis-database
12
template:
13
metadata:
14
labels:
15
app: deis-database
16
spec:
17
serviceAccount: deis-database
18
containers:
19
- name: deis-database
20
image: {{.Values.imageRegistry}}/postgres:{{.Values.dockerTag}}
21
imagePullPolicy: {{.Values.pullPolicy}}
22
ports:
23
- containerPort: 5432
24
env:
25
- name: DATABASE_STORAGE
26
value: {{default "minio" .Values.storage}}
Copied!
模版参数的默认值必须放到 values.yaml 文件中,其格式为
1
imageRegistry: "quay.io/deis"
2
dockerTag: "latest"
3
pullPolicy: "alwaysPull"
4
storage: "s3"
5
6
# 依赖的 mysql chart 的默认参数
7
mysql:
8
max_connections: 100
9
password: "secret"
Copied!

Helm 插件

插件提供了扩展 Helm 核心功能的方法,它在客户端执行,并放在 $(helm home)/plugins 目录中。
一个典型的 helm 插件格式为
1
$(helm home)/plugins/
2
|- keybase/
3
|
4
|- plugin.yaml
5
|- keybase.sh
Copied!
而 plugin.yaml 格式为
1
name: "keybase"
2
version: "0.1.0"
3
usage: "Integreate Keybase.io tools with Helm"
4
description: |-
5
This plugin provides Keybase services to Helm.
6
ignoreFlags: false
7
useTunnel: false
8
command: "$HELM_PLUGIN_DIR/keybase.sh"
Copied!
这样,就可以用 helm keybase 命令来使用这个插件。

Helm 命令参考

查询 charts

1
helm search
2
helm search mysql
Copied!

查询 package 详细信息

1
helm inspect stable/mariadb
Copied!

部署 package

1
helm install stable/mysql
Copied!
部署之前可以自定义 package 的选项:
1
# 查询支持的选项
2
helm inspect values stable/mysql
3
4
# 自定义 password
5
echo "mysqlRootPassword: passwd" > config.yaml
6
helm install -f config.yaml stable/mysql
Copied!
另外,还可以通过打包文件(.tgz)或者本地 package 路径(如 path/foo)来部署应用。

查询服务 (Release) 列表

1
➜ ~ helm ls
2
NAME REVISION UPDATED STATUS CHART NAMESPACE
3
quieting-warthog 1 Tue Feb 21 20:13:02 2017 DEPLOYED mysql-0.2.5 default
Copied!

查询服务 (Release) 状态

1
➜ ~ helm status quieting-warthog
2
LAST DEPLOYED: Tue Feb 21 16:13:02 2017
3
NAMESPACE: default
4
STATUS: DEPLOYED
5
6
RESOURCES:
7
==> v1/Secret
8
NAME TYPE DATA AGE
9
quieting-warthog-mysql Opaque 2 9m
10
11
==> v1/PersistentVolumeClaim
12
NAME STATUS VOLUME CAPACITY ACCESSMODES AGE
13
quieting-warthog-mysql Bound pvc-90af9bf9-f80d-11e6-930a-42010af00102 8Gi RWO 9m
14
15
==> v1/Service
16
NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
17
quieting-warthog-mysql 10.3.253.105 <none> 3306/TCP 9m
18
19
==> extensions/v1beta1/Deployment
20
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
21
quieting-warthog-mysql 1 1 1 1 9m
22
23
24
NOTES:
25
MySQL can be accessed via port 3306 on the following DNS name from within your cluster:
26
quieting-warthog-mysql.default.svc.cluster.local
27
28
To get your root password run:
29
30
kubectl get secret --namespace default quieting-warthog-mysql -o jsonpath="{.data.mysql-root-password}" | base64 --decode; echo
31
32
To connect to your database:
33
34
1. Run an Ubuntu pod that you can use as a client:
35
36
kubectl run -i --tty ubuntu --image=ubuntu:16.04 --restart=Never -- bash -il
37
38
2. Install the mysql client:
39
40
$ apt-get update && apt-get install mysql-client -y
41
42
3. Connect using the mysql cli, then provide your password:
43
$ mysql -h quieting-warthog-mysql -p
Copied!

升级和回滚 Release

1
# 升级
2
cat "mariadbUser: user1" >panda.yaml
3
helm upgrade -f panda.yaml happy-panda stable/mariadb
4
5
# 回滚
6
helm rollback happy-panda 1
Copied!

删除 Release

1
helm delete quieting-warthog
Copied!

repo 管理

1
# 添加 incubator repo
2
helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
3
4
# 查询 repo 列表
5
helm repo list
6
7
# 生成 repo 索引(用于搭建 helm repository)
8
helm repo index
Copied!

chart 管理

1
# 创建一个新的 chart
2
helm create deis-workflow
3
4
# validate chart
5
helm lint
6
7
# 打包 chart 到 tgz
8
helm package deis-workflow
Copied!

Helm UI

Kubeapps 提供了一个开源的 Helm UI 界面,方便以图形界面的形式管理 Helm 应用。
1
curl -s https://api.github.com/repos/kubeapps/kubeapps/releases/latest | grep -i $(uname -s) | grep browser_download_url | cut -d '"' -f 4 | wget -i -
2
sudo mv kubeapps-$(uname -s| tr '[:upper:]' '[:lower:]')-amd64 /usr/local/bin/kubeapps
3
sudo chmod +x /usr/local/bin/kubeapps
4
5
kubeapps up
6
kubeapps dashboard
Copied!
更多使用方法请参考 Kubeapps 官方网站

Helm Repository

官方 repository:
第三方 repository:

常用 Helm 插件

    1.
    helm-tiller - Additional commands to work with Tiller
    2.
    Technosophos's Helm Plugins - Plugins for GitHub, Keybase, and GPG
    3.
    helm-template - Debug/render templates client-side
    4.
    Helm Value Store - Plugin for working with Helm deployment values
    5.
    Drone.io Helm Plugin - Run Helm inside of the Drone CI/CD system
最近更新 2yr ago