A Helm3 HTTP Wrapper With Go SDK
Helm3 摒弃了 Helm2 的 Tiller 架构，使用纯命令行的方式执行相关操作。如果想通过 Helm API 来实现相关功能，很遗憾官方并没有提供类似的服务。不过，因为官方提供了相对友好的 Helm Go SDK，我们只需在此基础上做封装即可实现。helm-wrapper 就是这样一个通过 Go Gin Web 框架，结合 Helm Go SDK 封装的 HTTP Server，让 Helm 相关的日常命令操作可以通过 Restful API 的方式来实现同样的操作。
helm 原生命令行和相关 API 对应关系：
- helm install
POST/api/namespaces/:namespace/releases/:release
POST Body:
{
"values": "", // `--values`
"set": [], // `--set`
"set_string": [] // `--set-string`
}此处 values 内容同 helm install
--values选项
- helm uninstall
DELETE/api/namespaces/:namespace/releases/:release
- helm upgrade
PUT/api/namespaces/:namespace/releases/:release
PUT Body:
{
"values": "", // `--values`
"set": [], // `--set`
"set_string": [] // `--set-string`
}此处 values 内容同 helm upgrade
--values选项
- helm rollback
PUT/api/namespaces/:namespace/releases/:release/versions/:reversion
- helm list
GET/api/namespaces/:namespace/releases
- helm get
GET/api/namespaces/:namespace/releases/:release
| Params | Name |
|---|---|
| info | 支持 all/hooks/manifest/notes/values 信息 |
-
helm release history
GET/api/namespaces/:namespace/releases/:release/histories
-
helm show
GET/api/charts
| Params | Name |
|---|---|
| chart | 指定 chart 名，必填 |
| info | 支持 readme/values/chart 信息 |
| version | 支持版本指定，同命令行 |
- helm search repo
GET/api/repositories/charts
| Params | Name |
|---|---|
| keyword | 搜索关键字，必填 |
| version | 指定 chart version |
| versions | if "true", all versions |
-
helm repo update
PUT/api/repositories
-
helm env
GET/api/envs
当前该版本处于 Alpha 状态，还没有经过大量的测试，只是把相关的功能测试了一遍，你也可以在此基础上自定义适合自身的版本。
为了简化，所有请求统一返回 200 状态码，通过返回 Body 中的 Code 值来判断响应是否正常：
type respBody struct {
Code int `json:"code"` // 0 or 1, 0 is ok, 1 is error
Data interface{} `json:"data,omitempty"`
Error string `json:"error,omitempty"`
}源码提供了简单的 Makefile 文件，如果要构建二进制，只需要通过以下方式构建即可。
make build // 构建当前主机架构的二进制版本
make build-linux // 构建 Linux 版本的二进制
make build-docker // 构建 Docker 镜像
直接构建会生成名为 helm-wrapper 的二进制程序，你可以通过如下方式获取帮助：
$ helm-wrapper -h
Usage of helm-wrapper:
--addr string server listen addr (default "0.0.0.0")
--alsologtostderr log to standard error as well as files
--config string helm wrapper config (default "config.yaml")
--debug enable verbose output
--kube-context string name of the kubeconfig context to use
--kubeconfig string path to the kubeconfig file
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default true)
-n, --namespace string namespace scope for this request
--port string server listen port (default "8080")
--registry-config string path to the registry config file (default "/root/.config/helm/registry.json")
--repository-cache string path to the file containing cached repository indexes (default "/root/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "/root/.config/helm/repositories.yaml")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
pflag: help requested
关键性的选项说明一下：
--confighelm-wrapper 的配置项，内容如下，主要是指定 Helm Repo 命名和 URL，用于 Repo 初始化。
$ cat config-example.yaml
helmRepos:
- name: bitnami
url: https://charts.bitnami.com/bitnami
--kubeconfig默认如果你不指定的话，使用默认的路径，一般是~/.kube/config。这个配置是必须的，这指明了你要操作的 Kubernetes 集群地址以及访问方式。kubeconfig文件如何生成，这里不过多介绍，具体可以详见 Configure Access to Multiple Clusters
运行比较简单，如果你本地已经有默认的 kubeconfig 文件，只需要把 helm-wrapper 需要的 repo 配置文件配置好即可，然后执行以下命令即可运行，示例如下：
$ ./helm-wrapper --config config-example.yaml
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
- using env: export GIN_MODE=release
- using code: gin.SetMode(gin.ReleaseMode)
[GIN-debug] GET / --> main.main.func1 (3 handlers)
[GIN-debug] GET /api/envs --> main.getHelmEnvs (3 handlers)
[GIN-debug] GET /api/repositories/charts --> main.listRepoCharts (3 handlers)
[GIN-debug] PUT /api/repositories --> main.updateRepositories (3 handlers)
[GIN-debug] GET /api/charts --> main.showChartInfo (3 handlers)
[GIN-debug] GET /api/namespaces/:namespace/releases --> main.listReleases (3 handlers)
[GIN-debug] GET /api/namespaces/:namespace/releases/:release --> main.showReleaseInfo (3 handlers)
[GIN-debug] POST /api/namespaces/:namespace/releases/:release --> main.installRelease (3 handlers)
[GIN-debug] PUT /api/namespaces/:namespace/releases/:release --> main.upgradeRelease (3 handlers)
[GIN-debug] DELETE /api/namespaces/:namespace/releases/:release --> main.uninstallRelease (3 handlers)
[GIN-debug] PUT /api/namespaces/:namespace/releases/:release/versions/:reversion --> main.rollbackRelease (3 handlers)
[GIN-debug] GET /api/namespaces/:namespace/releases/:release/status --> main.getReleaseStatus (3 handlers)
[GIN-debug] GET /api/namespaces/:namespace/releases/:release/histories --> main.listReleaseHistories (3 handlers)
启动时会先初始化 repo，因此根据 repo 本身的大小或者网络因素，会耗费些时间
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent