Helm-Wrapper 使用指南

Helm-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. 项目目录结构及介绍

Helm-Wrapper 是一个基于 Helm Go SDK 的 Helm3 HTTP 服务器包装器。以下是项目的目录结构及其说明：

helm-wrapper/
├── .github/              # GitHub 工作流配置文件
├── Dockerfile            # Docker 镜像构建文件
├── LICENSE               # 项目许可证文件
├── Makefile              # 项目构建脚本
├── README.md             # 项目说明文档
├── README_CN.md          # 项目中文说明文档
├── charts.go             # Helm 图表相关逻辑
├── config-example.yaml   # 配置文件示例
├── envs.go               # 环境变量处理逻辑
├── go.mod                # Go 依赖管理文件
├── go.sum                # Go 依赖校验文件
├── helm.go               # Helm 操作相关逻辑
├── main.go               # 程序入口文件
├── registries.go         # Helm 仓库注册逻辑
├── releases.go           # Helm 发布相关逻辑
├── repositories.go       # Helm 仓库相关逻辑
├── router.go             # HTTP 路由逻辑
├── upload.go             # Helm 图表上传逻辑

2. 项目的启动文件介绍

项目的启动文件为 main.go，它是程序的入口。以下是 main.go 的主要功能：

• 解析命令行参数。
• 加载配置文件。
• 设置 HTTP 服务器监听地址和端口。
• 初始化并启动 HTTP 服务器。

package main

import (
    "github.com/opskumu/helm-wrapper"
    "log"
)

func main() {
    // 初始化并解析命令行参数
    h := helm.New()
    if err := h.ParseFlags(); err != nil {
        log.Fatalf("parse flags: %v", err)
    }

    // 启动 HTTP 服务器
    log.Fatal(h.Start())
}

3. 项目的配置文件介绍

项目的配置文件为 config.yaml，位于项目根目录下。该文件用于配置 Helm-Wrapper 的运行参数。以下是配置文件的主要配置项：

uploadPath: /tmp/charts # Helm 图表上传路径
helmRepos:              # Helm 仓库配置
  - name: bitnami
    url: https://charts.bitnami.com/bitnami

• uploadPath: 指定上传的 Helm 图表存储的路径。
• helmRepos: 配置 Helm 仓库信息，包括仓库名称和 URL。

配置文件允许用户自定义 Helm-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