docker/compose-bridge-helm

compose-bridge-transformer 镜像文档

镜像概述和主要用途

compose-bridge-transformer 是一款用于将 Docker Compose 配置文件转换为 Helm Chart 的工具镜像。该镜像内置默认转换逻辑，可解析 Docker Compose 中的服务定义、网络配置、卷挂载等关键信息，并自动生成符合 Helm 规范的 Chart 目录结构，简化从 Docker Compose 部署迁移至 Kubernetes 的流程。

镜像源代码托管于：https://github.com/docker/compose-bridge-transformer

核心功能和特性

• Docker Compose 解析：支持解析 Docker Compose v2+ 版本 YAML 文件，兼容主流 Compose 语***范
• Helm Chart 自动生成：自动构建符合 Helm 3 标准的 Chart 结构，包含 Chart.yaml、values.yaml 及 templates 目录
• 服务配置映射：将 Compose 服务的镜像、端口、环境变量、命令等参数转换为 Helm 可管理的配置项
• 资源类型转换：支持将 Compose 服务转换为 Kubernetes Deployment 资源，端口映射转换为 Service 资源，卷配置映射为 PersistentVolumeClaim 等
• 标准化输出：生成的 Helm Chart 符合 OCI 镜像规范，支持 Helm 包管理工具直接部署

核心功能和特性

• Docker Compose 解析：支持解析 Docker Compose v2+ 版本 YAML 文件，提取服务、网络、卷等核心配置
• Helm 结构生成：自动创建 Chart 基础文件（Chart.yaml、values.yaml）及 Kubernetes 资源模板（Deployment、Service 等）
• 配置参数映射：将 Compose 中的环境变量、端口映射、依赖关系等转换为 Helm values 参数
• 可扩展规则：支持通过挂载自定义转换规则文件调整生成逻辑（需参考源码文档）

使用场景和适用范围

适用场景

• Docker Compose 到 Kubernetes 迁移：快速将基于 Compose 的应用部署架构转换为 Kubernetes 可管理的 Helm Chart
• CI/CD 流程集成：在持续集成管道中自动将更新后的 Compose 文件转换为 Helm Chart，确保部署配置同步
• 开发环境快速部署：为开发团队提供从本地 Compose 配置到 K8s 测试环境的一键转换工具

适用范围

• 中小型 Docker Compose 应用（建议服务数量 ≤ 10 个）
• 无复杂自定义资源或特殊部署逻辑的标准 Compose 配置
• Helm 3.x 及以上版本环境

使用方法和配置说明

基本使用流程

1. 准备 Docker Compose 文件（如 docker-compose.yml）
2. 通过 Docker 命令挂载文件目录并指定转换参数
3. 生成 Helm Chart 至指定输出目录

核心参数说明

数据卷挂载要求

需将本地工作目录挂载至容器内路径（建议 /workspace），确保输入文件可访问且输出结果可持久化：

• 本地 Compose 文件路径需与 --input 参数指定的容器内路径对应
• 输出目录需与 --output 参数指定的容器内路径对应

Docker 部署方案示例

示例 1：基础转换命令

将当前目录的 docker-compose.yml 转换为版本为 1.0.0 的 Helm Chart，输出至 ./my-helm-chart：

bash
docker run -v $(pwd):/workspace \
  compose-bridge-transformer \
  --input /workspace/docker-compose.yml \
  --output /workspace/my-helm-chart \
  --chart-version 1.0.0 \
  --app-version 2.3.1

示例 2：覆盖现有 Chart

强制覆盖已存在的输出目录：

bash
docker run -v $(pwd):/workspace \
  compose-bridge-transformer \
  --input /workspace/docker-compose.prod.yml \
  --output /workspace/prod-chart \
  --force \
  --chart-version 3.2.0

示例 3：集成 docker-compose 工作流

创建 docker-compose.transform.yml：

yaml
version: '3'
services:
  transformer:
    image: compose-bridge-transformer
    volumes:
      - ./:/workspace
    command: >
      --input /workspace/docker-compose.yml
      --output /workspace/helm/chart
      --chart-version 2.1.0
      --app-version 1.5.0

执行转换：

bash
docker-compose -f docker-compose.transform.yml up

生成结果说明

成功转换后，输出目录将生成标准 Helm Chart 结构：

<output-dir>/
├── Chart.yaml       # 包含 Chart 名称、版本、应用版本等元数据
├── values.yaml      # 应用配置参数（从 Compose 转换而来）
├── templates/       # Kubernetes 资源模板目录
│   ├── deployment.yaml  # 服务部署模板
│   ├── service.yaml     # 服务访问模板
│   └── ...
└── .helmignore      # Helm 忽略规则文件

注意事项

• 复杂 Compose 配置（如外部网络、自定义驱动）可能需要手动调整生成的 Chart
• 生成的模板需根据目标 Kubernetes 集群环境（存储类、网络策略等）进行验证
• 高级自定义转换规则可参考 https://github.com/docker/compose-bridge-transformer 实现