diamon/helmwave

Helmwave 镜像文档

概述

Helmwave是一个基于Helm3的原生工具，旨在简化Helm Charts的部署与管理，常被类比为"Helm的Docker Compose"。它专注于执行速度、轻量级设计和调试友好性，帮助用户高效处理Helm发布流程，支持多环境配置、版本控制及资源监控等核心场景。

核心功能与特性

• 多环境一键部署：支持通过单一命令部署多个环境，简化复杂部署流程
• 环境配置分离：为不同环境（如开发、测试、生产）维护独立的配置值
• 应用通用配置：支持定义跨应用的通用配置值，减少重复配置
• 配置文件管理：维护Helm Chart配置文件目录，便于集中管理
• 版本控制集成：支持将配置变更纳入版本控制系统，追踪部署历史
• 配置值模板化：提供模板功能，动态生成配置值
• 分步部署控制：支持基于依赖关系（depends_on）和失败容忍（allow_failure）的分步部署
• 资源实时跟踪：通过kubedog实时监控Kubernetes资源状态
• 外部数据源集成：支持从Vault、AWS Secrets Manager等外部数据源获取配置数据

使用场景与适用范围

• 多环境管理：需要统一管理开发、测试、生产等多环境Helm部署的团队
• 版本化部署：希望将Helm配置变更纳入Git等版本控制系统的场景
• 简化部署流程：需要减少手动操作、标准化部署步骤的用户或团队
• 复杂部署依赖：存在多应用依赖关系，需按顺序部署的场景
• 资源监控需求：需要实时跟踪部署后Kubernetes资源状态的管理员

使用方法与配置说明

基本使用（Docker Run）

Helmwave镜像可通过docker run命令直接使用，通常需要挂载本地配置目录（包含Helmwave配置文件，如helmwave.yml）到容器中：

bash
docker run --rm -v $(pwd):/workdir helmwave/helmwave [command]

参数说明：

• -v $(pwd):/workdir：挂载当前目录到容器的/workdir，用于读取本地配置文件
• [command]：Helmwave命令，如deploy（部署）、plan（生成部署计划）、diff（对比配置差异）等

常用命令示例

1. 生成部署计划：

bash
docker run --rm -v $(pwd):/workdir helmwave/helmwave plan

2. 执行部署：

bash
docker run --rm -v $(pwd):/workdir helmwave/helmwave deploy

3. 查看部署状态：

bash
docker run --rm -v $(pwd):/workdir helmwave/helmwave status

配置文件说明

Helmwave的核心配置文件为helmwave.yml，用于定义部署计划、环境配置、Chart信息等。详细配置语法可参考https://helmwave.github.io/docs%E3%80%82

参考链接

• 官方文档：https://helmwave.github.io/docs
• 项目源码：https://github.com/helmwave/helmwave