Helm3 HTTP Wrapper 使用指南

Helm3 HTTP Wrapper 使用指南

helm-wrapper A Helm3 HTTP Server Wrapper by helm Go SDK, help you manage helm charts with HTTP RESTFul API 项目地址: https://gitcode.com/gh_mirrors/he/helm-wrapper

1. 项目介绍

Helm3 HTTP Wrapper 是一个基于 Helm Go SDK 开发的 HTTP 服务器包装器。它提供了通过 HTTP RESTFul API 管理 Helm charts 的功能，使得用户可以不使用 Helm 命令行工具，直接通过 HTTP 请求来完成 Helm 的常见操作，如安装、卸载、升级、回滚等。

2. 项目快速启动

环境准备

• Go SDK
• Docker (可选，用于构建镜像)

构建项目

克隆项目仓库：

git clone https://github.com/opskumu/helm-wrapper.git
cd helm-wrapper

构建二进制文件：

make build

或者构建 Docker 镜像：

make build-docker

配置文件

项目默认使用 config.yaml 作为配置文件。您可以根据需要修改配置。

启动服务

启动服务前，确保已经设置了正确的 KUBECONFIG 路径或者配置了相应的 Kubernetes 上下文。

启动服务：

./helm-wrapper

或者使用 Docker：

docker run -p 8080:8080 --env KUBECONFIG=/path/to/your/kubeconfig helm-wrapper

访问 API

服务启动后，您可以使用 curl 或其他 HTTP 客户端访问提供的 API。

例如，获取 Helm release 列表：

curl -X GET "http://localhost:8080/api/namespaces/default/releases"

3. 应用案例和最佳实践

案例一：自动化 Helm 释放安装

通过编写脚本，可以自动化地使用 Helm3 HTTP Wrapper 的 API 进行 Helm 释放的安装。

curl -X POST "http://localhost:8080/api/namespaces/default/releases/my-release?chart=stable/wordpress" \
-H "Content-Type: application/json" \
-d '{
  "values": "image.tag=latest"
}'

案例二：自动化 Helm 释放升级

使用 API 进行 Helm 释放的升级，可以保持应用的一致性和最新状态。

curl -X PUT "http://localhost:8080/api/namespaces/default/releases/my-release?chart=stable/wordpress" \
-H "Content-Type: application/json" \
-d '{
  "values": "image.tag=latest"
}'

最佳实践

• 使用版本控制来管理 charts 和配置。
• 创建自动化流程以定期检查和升级 Helm 释放。
• 确保 API 访问有适当的认证和授权。

4. 典型生态项目

• Helm：Kubernetes 的包管理器。
• Kubernetes：用于自动化部署、扩展和管理容器化应用程序的开源系统。
• Go SDK：用于编写 Helm3 HTTP Wrapper 的编程语言。

以上是 Helm3 HTTP Wrapper 的使用指南，希望对您的项目有所帮助。

helm-wrapper A Helm3 HTTP Server Wrapper by helm Go SDK, help you manage helm charts with HTTP RESTFul API 项目地址: https://gitcode.com/gh_mirrors/he/helm-wrapper