K8s:通过 Helmify 实现将 YAML 文件 转化为 Helm Charts

Posted 2023-02-15

写在前面

---

• 分享一个 Yaml 资源文件转 Helm Charts 包的小工具 helmify
• 博文内容涉及：
• helmify 工具安装，简单使用
• YAML 静态文件转化为 HELM charts 包
• 从 kustomize 输出转化为 Helm
• 理解不足小伙伴帮忙指正

我心匪石，不可转也。我心匪席，不可卷也。——《邶风·柏舟》

---

简单介绍及安装

如果部署环境涉及的 k8s API 资源比较多，往往会通过定义一个 charts 包来统一管理，变动的部分通过模板变量的方式引用。

正常我们创建一个 Helm chart 包。会通过命令 helm create 来创建

┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$helm create  liruilonghelm
Creating liruilonghelm
┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$ls
index.yaml  liruilonghelm  mysql  mysql-1.6.4.tgz

打包 push 私有 helm 源会通过下面的命令操作

┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$helm package liruilonghelm/
Successfully packaged chart and saved it to: /root/ansible/k8s-helm-create/liruilonghelm-0.1.0.tgz

那么对于已经存在的 yaml 资源文件，或者部署的集群中的环境，如何生成 chart 包，可以把对应的 资源文件导出来，然后手工编写对应的 charts 包，类似 Ansible 中 角色的编写。

通过 helmify 我们可以把上面的过程变成自动的。helmify 支持大部分的 api 资源转化为 对应的 charts 包。Helmify 从 标准输入 读取支持的 k8s 对象列表，并将其转换为 helm chasrts。

我们还可以获得 k8s 上现有服务的 YAML 文件，并可以将其转换为使用 helmify。

helmify 支持的 k8s 资源：

• deployment
• daemonset
• service, Ingress
• PersistentVolumeClaim
• RBAC (serviceaccount, (cluster-)role, (cluster-)rolebinding)
• configs (configmap, secret)
• webhooks (cert, issuer, ValidatingWebhookConfiguration)
• custom resource definitions

下载安装

下载二进制安装包

┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$wget https://github.com/arttor/helmify/releases/download/v0.3.22/helmify_0.3.22_Linux_64-bit.tar.gz

解压，配置为可执行文件

┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$tar -zxvf helmify_0.3.22_Linux_64-bit.tar.gz
helmify
┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$chmod +x helmify
┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$mv helmify  /usr/local/bin/
┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$helmify -version
Version:    0.3.22
Build Time: 2022-12-17T15:55:46Z
Git Commit: 253310a3cd32156f6952e9a4a9ec4d1e387f7775

这里需要注意支持 Helm >=v3.6.0

┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$helm  version
version.BuildInfoVersion:"v3.2.1", GitCommit:"fe51cd1e31e6a202cba7dead9552a6d418ded79a", GitTreeState:"clean", GoVersion:"go1.13.10"

如果 helm 版本太旧的话，需要更新 Helm

┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$tar -zxvf helm-v3.11.0-rc.1-linux-amd64.tar.gz
linux-amd64/
linux-amd64/helm
linux-amd64/LICENSE
linux-amd64/README.md
┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$mv linux-amd64/helm /usr/local/bin/
mv：是否覆盖"/usr/local/bin/helm"？ y
┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$helm version
version.BuildInfoVersion:"v3.11.0-rc.1", GitCommit:"9d8fee155bd7e7d3c1390f4076d9271a1147dce5", GitTreeState:"clean", GoVersion:"go1.18.9"
┌──[[e-mail]]-[~/ansible/k8s-helm-create]
└─$

使用方式

将 YAML 文件转换为 Helm chart 包

dashboard 创建服务账号 sa 的一个 yaml 文件。

┌──[[e-mail]]-[~/ansible]
└─$cat dashboard-adminuser.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: admin-user
  namespace: kubernetes-dashboard

---

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: admin-user
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: cluster-admin
subjects:
- kind: ServiceAccount
  name: admin-user
  namespace: kubernetes-dashboard
┌──[[e-mail]]-[~/ansible]
└─$cat  dashboard-adminuser.yaml | helmify mychart

可以通过下面的方式生成 charts 包

┌──[[e-mail]]-[~/ansible]
└─$cat  dashboard-adminuser.yaml | helmify mychart

生成的数据文件信息

┌──[[e-mail]]-[~/ansible/mychart]
└─$tree -h
.
├── [1.1K]  Chart.yaml
├── [  77]  templates
│   ├── [ 405]  admin-user-rbac.yaml
│   ├── [ 157]  deployment.yaml
│   └── [1.7K]  _helpers.tpl
└── [  39]  values.yaml

1 directory, 5 files

可以通过下面的命令查看生成的 charts 包 的资源文件

┌──[[e-mail]]-[~/ansible/mychart]
└─$helm template  ./
---
# Source: mychart/templates/deployment.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: release-name-mychart-admin-user
  labels:
    helm.sh/chart: mychart-0.1.0
    app.kubernetes.io/name: mychart
    app.kubernetes.io/instance: release-name
    app.kubernetes.io/version: "0.1.0"
    app.kubernetes.io/managed-by: Helm
---
# Source: mychart/templates/admin-user-rbac.yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: release-name-mychart-admin-user
  labels:
    helm.sh/chart: mychart-0.1.0
    app.kubernetes.io/name: mychart
    app.kubernetes.io/instance: release-name
    app.kubernetes.io/version: "0.1.0"
    app.kubernetes.io/managed-by: Helm
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: cluster-admin
subjects:
- kind: ServiceAccount
  name: release-name-mychart-admin-user
  namespace: liruilong-topo-namespace
┌──[[e-mail]]-[~/ansible/mychart]
└─$

也可以从带有 yamls 的目录生成：

awk FNR==1 && NR!=1  print "---"print /<my_directory>/*.yaml | helmify mychart

从kustomize输出转换为 Helm chart 包

一个简单的 Demo

下面为一个 kustomize 元文件。

┌──[[e-mail]]-[~/kustomize/failed]
└─$cat kustomization.yaml
namespace: my-namespace
namePrefix: dev-
nameSuffix: "-001"
commonLabels:
  app: liruilong-app
commonAnnotations:
  isDemo: "true"
configMapGenerator:
- name: example-configmap-liruilong-env
  literals:
  - FOO=Bar

通过下面的命令我们可以看到 kustomize 生成的 yaml 文件的内容。

┌──[[e-mail]]-[~/kustomize/failed]
└─$kustomize  build ./
apiVersion: v1
data:
  FOO: Bar
kind: ConfigMap
metadata:
  annotations:
    isDemo: "true"
  labels:
    app: liruilong-app
  name: dev-example-configmap-liruilong-env-001-42cfbf598f
  namespace: my-namespace

使用下面的命令我们可以生成上面 kustomize build 生成的 charts 包

┌──[[e-mail]]-[~/kustomize/failed]
└─$kustomize  build ./ | helmify mychart
┌──[[e-mail]]-[~/kustomize/failed]
└─$ls
kustomization.yaml  mychart
┌──[[e-mail]]-[~/kustomize/failed]
└─$tree -h mychart/
mychart/
├── [1.1K]  Chart.yaml
├── [  89]  templates
│   ├── [ 333]  dev-example-configmap-liruilong-env-001-42cfbf598f.yaml
│   └── [1.7K]  _helpers.tpl
└── [  96]  values.yaml

1 directory, 4 files
┌──[[e-mail]]-[~/kustomize/failed]
└─$

查看生成的 charts 包的 yaml 资源内容。

┌──[[e-mail]]-[~/kustomize/failed]
└─$helm template  ./mychart
---
# Source: mychart/templates/dev-example-configmap-liruilong-env-001-42cfbf598f.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: release-name-mychart-dev-example-configmap-liruilong-env-001-42cfbf598f
  labels:
    app: liruilong-app
    helm.sh/chart: mychart-0.1.0
    app.kubernetes.io/name: mychart
    app.kubernetes.io/instance: release-name
    app.kubernetes.io/version: "0.1.0"
    app.kubernetes.io/managed-by: Helm
  annotations:
    isDemo: "true"
data:
  FOO: "Bar"

Deployment Demo

一个通过 kustomize 来生成一个 Deployment 资源的 Demo,kustomization 文件定义。

┌──[[e-mail]]-[~/kustomize]
└─$cat kustomization.yaml
resources:
- deploy.yaml
configMapGenerator:
- name: example-configmap-liruilong
  files:
  - application.properties

┌──[[e-mail]]-[~/kustomize]
└─$

生成的 YAML 资源文件

┌──[[e-mail]]-[~/kustomize]
└─$kubectl kustomize ./
apiVersion: v1
data:
  application.properties: |
    sendSMS.maxAuthSendNumber=3
    sendSMS.maxAuthNumber=3
    sendSMS.validationCodeExpirationTime=300000
    sendSMS.VerificationCodeLength=4
kind: ConfigMap
metadata:
  name: example-configmap-liruilong-42d226k4h6
---
apiVersion: apps/v1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    app: web
  name: web
spec:
  replicas: 3
  selector:
    matchLabels:
      app: web
  strategy: 
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: web
    spec:
      containers:
      - image: nginx:1.14.2
        name: nginx-web
        ports:
        - containerPort: 80
          name: nginx-web
      volumes:
      - configMap:
          name: example-configmap-liruilong-42d226k4h6
        name: config
        resources: 
status: 

通过 helmify 生成对应的 chart 包， -v 可以查看详细的生成信息。

┌──[[e-mail]]-[~/kustomize]
└─$kubectl kustomize ./ | helmify -v nginx-web
INFO[0000] creating a chart                              ChartName=nginx-web Namespace=
INFO[0000] Skip creating Chart skeleton: Chart.yaml already exists.
INFO[0000] overwritten                                   file=nginx-web/templates/example-configmap-liruilong-42d226k4h6.yaml
INFO[0000] overwritten                                   file=nginx-web/templates/deployment.yaml
INFO[0000] overwritten                                   file=nginx-web/values.yaml
┌──[[e-mail]]-[~/kustomize]
└─$kubectl kustomize ./ | helmify -vv nginx-web
DEBU[0000] Start processing...
DEBU[0000] decoded                                       ApiVersion=v1 Kind=ConfigMap Name=example-configmap-liruilong-42d226k4h6
DEBU[0000] decoded                                       ApiVersion=apps/v1 Kind=Deployment Name=web
DEBU[0000] EOF received. Finishing input objects decoding.
INFO[0000] creating a chart                              ChartName=nginx-web Namespace=
DEBU[0000] processed                                     ApiVersion=v1 Kind=ConfigMap Name=example-configmap-liruilong-42d226k4h6
DEBU[0000] processed                                     ApiVersion=apps/v1 Kind=Deployment Name=web
INFO[0000] Skip creating Chart skeleton: Chart.yaml already exists.
DEBU[0000] writing a template into                       file=nginx-web/templates/example-configmap-liruilong-42d226k4h6.yaml
INFO[0000] overwritten                                   file=nginx-web/templates/example-configmap-liruilong-42d226k4h6.yaml
DEBU[0000] writing a template into                       file=nginx-web/templates/deployment.yaml
INFO[0000] overwritten                                   file=nginx-web/templates/deployment.yaml
INFO[0000] overwritten                                   file=nginx-web/values.yaml

生成的 helm charts 文件结构

┌──[[e-mail]]-[~/kustomize]
└─$tree nginx-web/
nginx-web/
├── Chart.yaml
├── templates
│   ├── deployment.yaml
│   ├── example-configmap-liruilong-42d226k4h6.yaml
│   └── _helpers.tpl
└── values.yaml

1 directory, 5 files

可以通过下面的方式查看 chart 包的 YAML 文件信息

┌──[[e-mail]]-[~/kustomize]
└─$helm template nginx-web/
---
# Source: nginx-web/templates/example-configmap-liruilong-42d226k4h6.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: release-name-nginx-web-example-configmap-liruilong-42d226k4h6
  labels:
    helm.sh/chart: nginx-web-0.1.0
    app.kubernetes.io/name: nginx-web
    app.kubernetes.io/instance: release-name
    app.kubernetes.io/version: "0.1.0"
    app.kubernetes.io/managed-by: Helm
data:
  application.properties: |
    sendSMS.maxAuthSendNumber="3"
    sendSMS.maxAuthNumber="3"
    sendSMS.validationCodeExpirationTime="300000"
    sendSMS.VerificationCodeLength="4"
---
# Source: nginx-web/templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: release-name-nginx-web-web
  labels:
    app: web
    helm.sh/chart: nginx-web-0.1.0
    app.kubernetes.io/name: nginx-web
    app.kubernetes.io/instance: release-name
    app.kubernetes.io/version: "0.1.0"
    app.kubernetes.io/managed-by: Helm
spec:
  replicas: 3
  selector:
    matchLabels:
      app: web
      app.kubernetes.io/name: nginx-web
      app.kubernetes.io/instance: release-name
  template:
    metadata:
      labels:
        app: web
        app.kubernetes.io/name: nginx-web
        app.kubernetes.io/instance: release-name
    spec:
      containers:
      - env:
        - name: KUBERNETES_CLUSTER_DOMAIN
          value: cluster.local
        image: nginx:1.14.2
        name: nginx-web
        ports:
        - containerPort: 80
          name: nginx-web
        resources: 
      volumes:
      - configMap:
          name: release-name-nginx-web-example-configmap-liruilong-42d226k4h6
        name: config
┌──[[e-mail]]-[~/kustomize]
└─$

博文参考

---

https://github.com/arttor/helmify

https://medium.com/geekculture/convert-kubernetes-yaml-files-into-helm-charts-4107de079455

---

© 2018-2023 [e-mail], All rights reserved. 保持署名-非商用-自由转载-相同方式共享(创意共享3.0许可证)