voxpupuli/puppet_webhook

Puppet-r10k API服务器镜像

镜像概述

本镜像是一个基于Sinatra框架构建的Web API服务器，专门用于执行Puppet和r10k相关操作。通过RESTful API接口，用户可便捷地管理Puppet配置、触发Puppet agent运行、部署r10k环境及更新Puppet模块，适用于自动化配置管理和环境部署场景。

核心功能和特性

• 轻量级架构：基于Sinatra框架，资源占用低，部署简单
• Puppet操作支持：提供API接口执行Puppet agent运行、查看Puppet报告、管理Puppet配置等操作
• r10k集成：支持通过API触发r10k环境部署、模块更新、配置验证等功能
• RESTful API：标准化接口设计，易于集成到现有自动化流程
• 灵活配置：支持通过环境变量自定义服务端口、认证方式及配置路径
• 日志记录：内置操作日志功能，便于审计和问题排查

使用场景和适用范围

• DevOps自动化流程：集成到CI/CD管道，实现配置自动部署
• 远程配置管理：通过API远程触发Puppet运行，管理分布式节点
• r10k环境管理：集中化管理多个Puppet环境的部署和更新
• 自动化运维：减少手动操作，提高配置管理效率和一致性
• 适用于：需要通过编程方式管理Puppet和r10k的团队或个人

使用方法和配置说明

环境变量配置

Docker运行示例

bash
docker run -d \
  -p 8080:8080 \
  -e AUTH_TOKEN="your_secure_token" \
  -e PUPPET_CONFIG_PATH="/path/to/local/puppet/config" \
  -e R10K_CONFIG_PATH="/path/to/local/r10k/config" \
  -v /path/to/local/puppet/config:/etc/puppetlabs/puppet \
  -v /path/to/local/r10k/config:/etc/puppetlabs/r10k \
  --name puppet-r10k-api \
  [镜像名称]

Docker Compose配置示例

yaml
version: '3'
services:
  puppet-r10k-api:
    image: docker.xuanyuan.run/[镜像名称]
    ports:
      - "8080:8080"
    environment:
      - AUTH_TOKEN="your_secure_token"
      - PUPPET_CONFIG_PATH="/etc/puppetlabs/puppet"
      - R10K_CONFIG_PATH="/etc/puppetlabs/r10k"
      - LOG_LEVEL="info"
    volumes:
      - ./puppet/config:/etc/puppetlabs/puppet
      - ./r10k/config:/etc/puppetlabs/r10k
    restart: always

API接口使用示例

执行Puppet Agent运行

bash
curl -X POST http://localhost:8080/api/puppet/run \
  -H "Authorization: Bearer your_secure_token" \
  -H "Content-Type: application/json" \
  -d '{"node": "target-node.example.com"}'

部署r10k环境

bash
curl -X POST http://localhost:8080/api/r10k/deploy \
  -H "Authorization: Bearer your_secure_token" \
  -H "Content-Type: application/json" \
  -d '{"environment": "production", "modules": true}'

获取Puppet报告

bash
curl -X GET http://localhost:8080/api/puppet/report/node/target-node.example.com \
  -H "Authorization: Bearer your_secure_token"

注意事项

• 确保挂载的Puppet和r10k配置文件具有正确的权限
• 生产环境中建议使用强认证令牌，并通过HTTPS暴露API服务
• 首次运行前需确保宿主机已安装Puppet和r10k依赖
• 大规模部署时建议配合监控工具监控API服务状态