voxpupuli/r10k-webhook

Vox Pupuli R10k Webhook

概述

该容器旨在通过webhook触发r10k来部署Puppet代码。它包含webhook-go守护进程和r10k gem，以及所有预安装的必要依赖，确保部署过程无缝进行。

核心功能和特性

• 集成webhook-go守护进程，支持通过webhook触发部署
• 内置r10k gem及所有依赖，无需额外安装
• 以puppet用户（UID/GID 999）运行，确保权限安全
• 支持HTTPS加密传输
• 提供聊天通知功能，可集成Slack等服务
• 支持请求排队和后台处理
• 部署后自动生成数据类型

使用场景和适用范围

适用于需要通过版本控制系统（如Git）的webhook自动部署Puppet代码的环境，特别适合Puppet服务器的代码自动化部署流程。

使用方法和配置说明

基本部署

容器默认入口点为r10k二进制文件。可通过共享卷与Puppet服务器共享代码目录，挂载至/etc/puppetlabs/code/environments。

Docker Compose示例

yaml
services:
  webhook:
    image: ***-ghcr.xuanyuan.run/voxpupuli/r10k-webhook:2.9.0
    ports:
      - 4000:4000
    environment:
      - PUPPET_CONTROL_REPO="https://git.example.org/puppet/control.git"
      - USER="puppet"
      - PASSWORD="puppet"
      # 如需使用HTTPS，启用TLS并取消以下行注释
      #- TLS=true
      #- TLS_CERT="/etc/puppetlabs/puppet/ssl/certs/puppet.pem"
      #- TLS_KEY="/etc/puppetlabs/puppet/ssl/private_keys/puppet.pem"
    volumes:
      - ./code:/etc/puppetlabs/code
      # 如需使用HTTPS，启用上述TLS并挂载密钥/证书目录
      #- openvoxserver-ssl:/etc/puppetlabs/puppet/ssl

环境变量

该容器基于https://github.com/voxpupuli/container-r10k%E6%9E%84%E5%BB%BA%EF%BC%8C%E5%9B%A0%E6%AD%A4%E4%B9%9F%E9%80%82%E7%94%A8%E5%85%B6%E6%89%80%E6%9C%89%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E3%80%82

添加自定义证书

如需在容器内添加自定义证书，可通过入口点脚本实现。例如，在需要自定义CA证书的环境中，可导出CERT_JSON环境变量，容器将在运行时导入证书。证书应为PEM格式的JSON哈希，建议压缩为单行。

可在Github/Gitlab的CI变量中添加此配置。

示例JSON：

json
{"certificates":{"root_ca":"-----BEGIN CERTIFICATE-----\n...","signing_ca":"-----BEGIN CERTIFICATE-----\n..."}}

构建信息

构建参数

版本 schema

版本格式如下：

text
<webhook-go.major>.<webhook-go.minor>.<webhook-go.patch>-v<container.major>.<container.minor>.<container.patch>
<webhook-go.major>.<webhook-go.minor>.<webhook-go.patch>-latest
latest

示例用法：

shell
docker pull ***-ghcr.xuanyuan.run/voxpupuli/r10k-webhook:2.9.0-v1.0.1
docker pull ***-ghcr.xuanyuan.run/voxpupuli/r10k-webhook:2.9.0-latest
docker pull ***-ghcr.xuanyuan.run/voxpupuli/r10k-webhook:latest

发布说明

详见 RELEASE.md

贡献指南

详见 CONTRIBUTING.md