renaultdigital/helm-docs

helm-docs

https://travis-ci.com/renault-digital/docker-helm-docs.svg?token=ncotYzyGStjuDrTy46xs&branch=master](https://travis-ci.com/renault-digital/docker-helm-docs)

当https://github.com/norwoodj/helm-docs%E6%9C%89%E6%96%B0%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%97%B6%EF%BC%8C%E8%87%AA%E5%8A%A8%E8%A7%A6%E5%8F%91%E6%AD%A4Docker%E9%95%9C%E5%83%8F%E7%9A%84%E6%9E%84%E5%BB%BA%E3%80%82

http://dockeri.co/image/renaultdigital/helm-docs](https://hub.docker.com/r/renaultdigital/helm-docs/)

注意事项

latest标签对应最新发布版本（https://github.com/helm-docs/helm-docs/releases/latest%EF%BC%89%E3%80%82

生产环境部署时请避免使用latest标签，正确的做法是使用具体版本标签，例如renaultdigital/helm-docs:3.1.1。

GitHub仓库

https://github.com/renault-digital/helm-docs

Travis CI每日构建日志

https://travis-ci.com/github/renault-digital/docker-helm-docs

Docker镜像标签

https://hub.docker.com/r/renaultdigital/helm-docs/tags/

镜像概述和主要用途

本镜像为norwoodj/helm-docs项目提供自动构建的Docker化解决方案。当原项目发布新版本时，会自动触发镜像构建，确保用户能够快速获取最新版本。主要用于在CI/CD流程或自动化构建部署中，便捷地生成和管理Helm图表文档。

核心功能和特性

• 自动构建：通过Travis CI定时检查原项目新版本，自动触发镜像构建和推送
• 版本管理：提供与原项目版本对应的镜像标签，支持指定版本使用
• 便捷集成：可通过别名设置将容器作为本地命令使用，简化操作流程
• 数据持久化：支持挂载本地目录至容器，保存配置、缓存等数据

使用场景和适用范围

• CI/CD流程中自动生成Helm图表文档
• 自动化构建部署流水线中集成文档生成步骤
• 本地开发环境中快速使用helm-docs生成文档

使用方法和配置说明

基本使用

挂载本地目录到容器中运行：

bash
docker run -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    docker.xuanyuan.run/renaultdigital/helm-docs

指定版本使用

使用特定版本的镜像（标签对应helm-docs版本）：

bash
docker run -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    docker.xuanyuan.run/renaultdigital/helm-docs:3.1.1

设置为命令别名

将容器作为本地命令使用：

bash
alias helm-docs="docker run -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    renaultdigital/helm-docs"
helm-docs --help

示例：在.bash_profile中配置

bash
alias helm-docs='docker run -e KUBECONFIG="/root/.kube/config:/root/.kube/some-other-context.yaml" -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    renaultdigital/helm-docs'

构建流程

1. 在本仓库启用Travis CI定时任务，每日在master分支运行构建
2. 通过GitHub REST API检查原项目是否有新标签/版本发布
3. 通过Docker Hub REST API匹配已存在的镜像标签
4. 如不匹配，使用发布版本构建镜像并推送到https://hub.docker.com/
5. 从https://github.com/norwoodj/helm-docs/releases/latest%E8%8E%B7%E5%8F%96%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%EF%BC%8C%E6%8B%89%E5%8F%96%E5%AF%B9%E5%BA%94%E7%89%88%E6%9C%AC%E9%95%9C%E5%83%8F%EF%BC%8C%E6%A0%87%E8%AE%B0%E4%B8%BA%60renaultdigital/helm-docs:latest%60%E5%B9%B6%E6%8E%A8%E9%80%81%E5%88%B0Docker Hub

致谢

• 借鉴自https://github.com/renault-digital/docker-helm
• 原始工作来自https://github.com/alpine-docker/helm-docs