从入门到实践:创作一个自己的 Helm Chart
前言
我们平时在日常生活中会经常在不同的平台上与各种各样的应用打交道,比如从苹果的 App Store 里下载的淘宝、高德、支付宝等应用,或者是在 PC 端安装的 Word、Photoshop、Steam。这些各类平台上的应用程序,对用户而言,大多只需要点击安装就可使用。
然而,在云 (Kubernetes)上,部署一个应用往往却不是那么简单。如果想要部署一个应用程序到云上,首先要准备好它所需要的环境,打包成 Docker 镜像,进而把镜像放在部署文件 (Deployment) 中、配置服务 (Service)、应用所需的账户 (ServiceAccount) 及权限 (Role)、命名空间 (Namespace)、密钥信息 (Secret)、可持久化存储 (PersistentVolumes) 等资源。也就是编写一系列互相相关的 YAML 配置文件,将它们部署在 Kubernetes 集群上。
但是即便应用的开发者可以把这些 Docker 镜像存放在公共仓库中,并且将所需的 YAML 资源文件提供给用户,用户仍然需要自己去寻找这些资源文件,并把它们一一部署。倘若用户希望修改开发者提供的默认资源,比如使用更多的副本 (Replicas) 或是修改服务端口 (Port),他还需要自己去查需要在这些资源文件的哪些地方修改,更不用提版本变更与维护会给开发者和用户造成多少麻烦了。
可见最原始的 Kubernetes 应用形态并不便利。
Helm 与 Helm Chart
在这样的大环境下,有一系列基于 Kubernetes 的应用包管理工具横空出世。而我们今天的主角 Helm,就是这其中最受欢迎的选择之一。
开发者按照 Helm Chart 的格式,将应用所需的资源文件包装起来,通过模版化 (Templating) 的方式将一些可变字段(比如我们之前提到的暴露哪个端口、使用多少副本)暴露给用户,最后将封装好的应用包,也就是 Helm Chart,集中存放在统一的仓库中供用户浏览下载。
站在用户角度,用户只需要一行简单的命令就可以完成应用的安装、卸载与升级。对于安装之后状态,也可以通过 helm list
或者是原生的 kubectl 进行查询。
$ helm install redis stable/redis
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
redis-master-0 1/1 Running 0 63s
redis-slave-0-0 1/1 Running 0 63s
redis-slave-1-0 1/1 Running 0 13s
$ helm delete redis
创作 Helm Chart
那么站在开发者的角度上,我们应该如何去创作一个 Helm 应用包呢?
准备工作
首先我们需要一个准备部署的镜像。这个镜像可以是一个 Java 程序、一个 Python 脚本、甚至是一个空的 linux 镜像跑几条命令。
这里我们使用一个简单的基于 golang 的 hello world HTTP 服务。该服务通过读取环境变量 USERNAME
获得用户自己定义的名称,然后监听 80 端口。对于任意 HTTP 请求,返回 Hello ${USERNAME}
。比如如果设置 USERNAME=world
(默认场景),该服务会返回 Hello world
。
然后我们使用 Dockerfile 对镜像进行打包。先对 Golang 代码进行编译,然后将编译后的程序放在基于 alpine 的镜像中,以缩小镜像体积。
在 Docker 构建好镜像之后,我们把镜像上传到仓库中,比如 Docker Hub 或是阿里云容器镜像仓库。准备工作做好之后,我们就可以开始创作 Helm Chart 了。
开始创作
运行 helm create my-hello-world
,会得到一个 helm 自动生成的空 chart。这个 chart 里的名称是 my-hello-world
。 需要注意的是,Chart 里面的 my-hello-world 名称需要和生成的 Chart 文件夹名称一致。如果修改 my-hello-world,则需要做一致的修改。 现在,我们看到 Chart 的文件夹目录如下:
my-hello-world
├── charts
├── Chart.yaml
├── templates
│ ├── deployment.yaml
│ ├── _helpers.tpl
│ ├── ingress.yaml
│ ├── NOTES.txt
│ └── service.yaml
└── values.yaml
在根目录下的 Chart.yaml 文件内,声明了当前 Chart 的名称、版本等基本信息,这些信息会在该 Chart 被放入仓库后,供用户浏览检索。比如我们可以把 Chart 的 Description 改成 "My first hello world helm chart"。在 Chart.yaml 里有两个跟版本相关的字段,其中 version 指明的是 Chart 的版本,也就是我们应用包的版本;而 appVersion 指明的是内部实际使用的应用版本。
在 templates 文件夹内存放了各类应用部署所需要使用的 YAML 文件,比如 Deployment 和 Service。在我们当前的应用内,我们只需要一个 deployment,而有的应用可能包含不同组件,需要多个 deployments,那么我们就可以在 templates 文件夹下放置 deploymentA、deploymentB 等。同样的,如果我们需要配置 serviceaccount, secret, volumes 等内容,也可以在里面添加相应的配置文件。
apiVersion: apps/v1beta2
kind: Deployment
metadata:name: {{ template "my-hello-world.fullname" . }}labels:
{{ include "my-hello-world.labels" . | indent 4 }}
spec:replicas: {{ .Values.replicaCount }}selector:matchLabels:app.kubernetes.io/name: {{ include "my-hello-world.name" . }}app.kubernetes.io/instance: {{ .Release.Name }}template:metadata:labels:app.kubernetes.io/name: {{ include "my-hello-world.name" . }}app.kubernetes.io/instance: {{ .Release.Name }}spec:containers:- name: {{ .Chart.Name }}image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}"imagePullPolicy: {{ .Values.image.pullPolicy }}env:- name: USERNAMEvalue: {{ .Values.Username }}
......
Helm Chart 对于应用的打包,不仅仅是将 Deployment 和 Service 以及其它资源整合在一起。我们看到 deployment.yaml 和 service.yaml 文件被放在 templates/ 文件夹下,相较于原生的 Kubernetes 配置,多了很多渲染所用的可注入字段。比如在 deployment.yaml 的 spec.replicas
中,使用的是 .Values.replicaCount
而不是 Kubernetes 本身的静态数值。这个用来控制应用在 Kubernetes 上应该有多少运行副本的字段,在不同的应用部署环境下可以有不同的数值,而这个数值便是由注入的 Values
提供。
replicaCount: 1
image:repository: somefive/hello-worldpullPolicy: IfNotPresent
nameOverride: ""
fullnameOverride: ""
service:type: ClusterIPport: 80
......
Username: AppHub
在根目录下我们看到有一个 values.yaml
文件,这个文件提供了应用在安装时的默认参数。在默认的 Values
中,我们看到 replicaCount: 1
,说明该应用在默认部署的状态下只有一个副本。
为了使用我们要部署应用的镜像,我们看到 deployment.yaml 中,在 spec.template.spec.containers
里, image
和 imagePullPolicy
都使用了 Values
中的值。其中 image
字段由 .Values.image.repository
和 .Chart.AppVersion
组成。
看到这里,同学们应该就知道需要变更的字段了:一个是位于 values.yaml 内的 image.repository
,另一个是位于 Chart.yaml 里的 AppVersion
。将它们与我们需要部署应用的 docker 镜像匹配起来,这里我们把 values.yaml 里的 image.repository
设置成 somefive/hello-world
,把 Chart.yaml 里的 AppVersion
设置成 1.0.0
即可。
类似的,我们可以查看 service.yaml 内要部署的服务,其中的主要配置也在 values.yaml 中。默认生成的服务将 80 端口暴露在 Kubernetes 集群内部。我们暂时不需要对这一部分进行修改。
由于部署的 hello-world 服务会从环境变量中读取 USERNAME
环境变量,所以将这个配置加入 deployment.yaml。
- name: {{ .Chart.Name }}image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}"imagePullPolicy: {{ .Values.image.pullPolicy }}env:- name: USERNAMEvalue: {{ .Values.Username }}
现在我们的 deployment.yaml 模版会从 values.yaml 中加载 Username
字段,因此相应的,我们也在 values.yaml 中添加 Username: AppHub
。这样,我们的应用就会从 values.yaml 中读取 Username
,把它放入镜像的环境变量中启动了。
校验打包
在准备好我们的应用后,我们可以使用 Helm lint 来粗略地检查一下制作的 Chart 有没有什么语法上的错误。如果没有问题的话,就可以使用 helm package 命令对我们的 Chart 文件夹进行打包,打包后我们可以得到一个 my-hello-world-0.1.0.tgz 的应用包。这个便是我们完成的应用了。
$ helm lint --strict my-hello-world
1 chart(s) linted, 0 chart(s) failed[INFO] Chart.yaml: icon is recommended
$ helm package my-hello-world
我们可以使用 helm install
命令尝试安装一下刚刚做好的应用包,然后用 kubectl 查看一下运行 pod 的状态。通过 port-forward 命令将该 pod 的端口映射到本地端口上,这个时候就可以通过访问 localhost 来访问部署好的应用了。
$ helm install my-hello-world-chart-test my-hello-world-0.1.0.tgz
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
my-hello-world-chart-test-65d6c7b4b6-ptk4x-0 1/1 Running 0 4m3s
$ kubectl port-forward my-hello-world-chart-test-65d6c7b4b6-ptk4x 8080:80
$ curl localhost:8080
Hello AppHub
参数重载
有的同学可能会有疑惑,虽然我们应用开发者把可配置的信息暴露在 values.yaml 中,用户使用应用的时候想要修改该怎么办呢?答案很简单,用户只需要在 install 时使用 set 参数,设置想要覆盖的参数即可。
应用开发者在 Chart 的 values 配置中只是提供了默认的安装参数,用户也可以在安装时指定自己的配置。类似的,如果用户可以用 upgrade 命令替代 install,实现在原有部署好的应用的基础上变更配置。
$ helm install my-app my-hello-world-0.1.0.tgz --set Username="Cloud Native"
$ helm install my-super-app my-hello-world-0.1.0.tgz -f my-values.yaml
$ helm upgrade my-super-app my-hello-world-0.1.0.tgz -f my-new-values.yaml
修改提示信息
我们注意到在安装 Chart 指令运行后,屏幕的输出会出现:
NOTES:
1. Get the application URL by running these commands:export POD_NAME=$(kubectl get pods -l "app=my-hello-world,release=my-hello-world-chart-test2" -o jsonpath="{.items[0].metadata.name}")echo "Visit http://127.0.0.1:8080 to use your application"kubectl port-forward $POD_NAME 8080:80
这里的注释是由 Chart 中的 templates/NOTES.txt
提供的。
我们注意到原始的 NOTES 中,所写的 "app={{ template "my-hello-world.name" . }},release={{ .Release.Name }}"
和 deployment.yaml 中所写的配置不太一样,可以把它改成 "app.kubernetes.io/name={{ template "my-hello-world.name" . }},app.kubernetes.io/instance={{ .Release.Name }}"
,将 values.yaml 中的 version
更新成 0.1.1
。然后重新打包 Chart(运行 helm package
),得到新的 my-hello-world-0.1.1.tgz 之后,升级原有 Chart(运行 helm upgrade my-hello-world-chart-test2 my-hello-world-0.1.1.tgz --set Username="New Chart"
),就能看到更新过后的 NOTES 了。
NOTES:
1. Get the application URL by running these commands:export POD_NAME=$(kubectl get pods -l "app.kubernetes.io/name=my-hello-world,app.kubernetes.io/instance=my-hello-world-chart-test2" -o jsonpath="{.items[0].metadata.name}")echo "Visit http://127.0.0.1:8080 to use your application"kubectl port-forward $POD_NAME 8080:80
应用分享
那么制作完成的应用如何和其他人分享呢?Helm 官方推出的 ChartMuseum 提供了 Chart 仓库的构建方法,使用它可以创建自己的 Chart 仓库。然而自行维护一个仓库本身成本不小,而且对于用户而言如果每一个开发者都是自己的仓库,他就需要将所需应用对应的仓库都加入自己的检索列表中,很不利于应用的传播与分享。我们团队近期推出了开放云原生应用中心,Cloud Native App Hub,同步了各类应用,同时还提供了开发者上传应用的渠道。
在我们的开放云原生应用中心中,应用来自两个渠道:
- 一方面,我们定期从一些国外的知名 Helm 仓库同步 Chart 资源,在同步的过程中,会对 Chart 内部使用的一部分 Docker 镜像进行同步替换(例如 gcr.io 或者 quay.io 的镜像),方便国内用户访问使用;
- 另一方面,我们和 Helm 官方库一样在 Github 上接受开发者通过 Pull Request 的形式提交自己的应用。提交成功的应用会在短期内同步至云原生应用中心,和其他官方应用展示在一起供其他用户使用。
云原生应用开发大赛
参赛点击:https://developer.aliyun.com/special/apphubchallenge
参考
- Helm Chart 创作指南 https://cloudnativeapp.gitbook.io/handbook/helm-chart-creation-tutorial
- 开放云原生应用中心 - Cloud Native App Hub https://developer.aliyun.com/hub
- 开放云原生应用中心 Github 仓库 https://github.com/cloudnativeapp/charts
从入门到实践:创作一个自己的 Helm Chart相关推荐
- 如何开发一个完整的Helm charts应用实例
文章目录 1. 简介 2. 条件 3. 应用 4. 基础模板 5. 命名模板 6. 版本兼容 7. 持久化 8. 定制 9. 共享 Charts 1. 简介 Helm 图表是在 Kubernetes ...
- Helm 从入门到实践 | 从 0 开始制作一个 Helm Charts
本周 Helm 官方发布博客,指导用户从 v2 迁移到 v3,这标志 Helm 逐渐走向成熟.早在今年 6 月,阿里云就正式发布了国内首个 Helm Hub 中国镜像站:开放云原生应用中心 - Clo ...
- 玩转python网络爬虫黄永祥pdf下载_Python网络爬虫从入门到实践pdf
Python网络爬虫从入门到实践 内容简介 本书将介绍如何使用Python编写网络爬虫程序获取互联网上的大数据.本书包括三部分内容:基础部分.进阶部分和项目实践.基础部分(第1~6章)主要介绍爬虫的三 ...
- 类型即正义:TypeScript 从入门到实践(序章)
作者:一只图雀 仓库:Github .Gitee 图雀社区主站(首发):图雀社区 博客:掘金.知乎.慕课 公众号:图雀社区 联系我:关注公众号后可以加图雀酱微信哦 原创不易,❤️点赞+评论+收藏 ❤️ ...
- 免费送书啦!《 OpenCV图像处理入门与实践》一本全搞定
OpenCV 的基础图像操作都只是针对图像中的像素点,并不是直接对图像整体进行的操作.而很多时候并不能仅通过改变像素点来进行图像的操作,为此我们需要学习关于图像的算术操作. 1.图像加法 对于两张相同 ...
- 深入浅出Istio:Service mesh快速入门与实践-读书笔记(By GisonWin)
01 服务网格历史 (以后补充) 02 服务网格的基本特性 连接 微服务错综复杂,要完成其业务目标,连接问题是首要问题.连接存在于所有服务的整个lifcecycle中,用于维持服务的运行. 安全 保障 ...
- python快速编程入门课后简答题答案-Python编程:从入门到实践(第2版)第1章习题答案...
<Python编程:从入门到实践>是一本不错的书.第2版已经公开预售,预计会在10月份正式上市. 动手试一试 本章的练习都是探索性的,但从第2章开始将要求你用那一章学到的知识来解决问题. ...
- python入门到实践-一本书搞定Python入门到实践
上周介绍了几本Python从入门到进阶书籍,今天继续推荐好书,这本书是<Python编程:从入门到实践>.入门 Python 最好的书之一,适合零基础小白,也适合有其它语言背景的程序员 书 ...
- python如何导入txt数据集-终于找到python入门到实践数据集
Python是一款功能强大的脚本语言,具有丰富和强大的库,重要的是,它还具有很强的可读性,易用易学,非常适合编程初学者入门.以下是小编为你整理的python入门到实践数据集 环境配置:下载Python ...
最新文章
- 打不开_网页打不开,怎解?
- A TLS packet with unexpected length was received 解决方法
- PHPCMS V9 框架代码分析(入口程序)
- 一行Java代码竟能获取tomcat的绝对路径
- 计算机系学生的简单立体宿舍装潢大赏
- 实验三——vlan间路由
- 【深度学习】Pytorch编写代码基本步骤思想
- MySQL 高级 - 索引 - 索引设计原则
- vue created
- grpc 流式传输_编写下载服务器。 第一部分:始终流式传输,永远不要完全保留在内存中...
- Lucene中string docvalues使用utf-16的优化
- Python_微信开发
- 知名互联网公司系统架构图[第2期]
- 博文视点云原生书单丨释放云原生技术红利
- 将强化学习应用到量化投资中实战篇(学习模块开发上)
- 绩效打c被开除,员工将新东方告上法院,获赔416000元!
- SIM900A 开发板连线图
- 论文笔记:A novel DRM scheme for accommodating expectations of personal use
- 在Windows下使用Python编程
- 宜未雨而绸缪,毋临渴而掘井。