grandmaster/dockerweb2

Icinga Web 2 Docker镜像构建器

镜像概述

本Docker镜像用于构建和部署一个脚本，该脚本能够克隆最新版本的Icinga Web 2框架及可选的特定模块。生成的脚本适用于构建Icinga Web 2 Docker镜像，支持定时自动构建和部署功能。

核心功能与特性

• 自动克隆最新版Icinga Web 2框架代码
• 支持通过GitHub用户和仓库模式自动发现并克隆Icinga Web 2模块
• 定时构建与部署（基于crontab格式配置）
• 自动将生成的脚本部署到指定Git仓库
• 配置文件自动重载，无需重启容器
• 可选的邮件通知功能，用于通知未被配置模式覆盖的仓库

使用场景

适用于需要自动化构建和更新Icinga Web 2 Docker镜像的场景，尤其适合需要定期同步Icinga Web 2框架及模块最新代码的开发或运维环境。

使用方法与配置说明

前提条件

• 已安装Docker环境
• 拥有一个可写入的Git仓库（用于部署生成的脚本）
• 具备SSH密钥对生成和管理权限

配置步骤

1. 创建Git仓库
   创建一个包含提交记录的Git仓库，用于存放生成的部署脚本。

2. 配置SSH

   bash
   # 创建数据卷目录及SSH子目录
   mkdir -p dockerweb2-data/.ssh
   
   # 生成SSH密钥对（无密码）
   ssh-keygen -q -b 4096 -t rsa -N '' -C bot@example.com -f dockerweb2-data/.ssh/id_rsa
   
   # 添加Git服务器到已知主机
   ssh-keyscan git.example.com > dockerweb2-data/.ssh/known_hosts
   

3. 配置Deploy Key
   将生成的公钥 dockerweb2-data/.ssh/id_rsa.pub 添加为目标Git仓库的Deploy Key，并授予写入权限。

4. 配置邮件（可选）
   如需邮件通知，创建 dockerweb2-data/.mailrc 文件，配置s-nail所需的邮件发送变量。

5. 创建配置文件
   创建 dockerweb2-data/config.yml 配置文件，示例如下：

   yaml
   #log:
     # 日志详细级别（trace / debug / info / warn / error）
     #level: info
   build:
     # 构建部署时间（crontab格式）
     every: '0 0 * * *'
   github:
     # Icinga Web 2框架GitHub仓库
     framework: Icinga/icingaweb2
     mods:
       # 自动发现模块的GitHub用户
     - user: Icinga
       repos:
         # 模块仓库匹配模式（含模块名捕获组），Golang正则格式
       - |-
         \Aicingaweb2-module-(.+)\z
   deploy:
     # 部署目标Git仓库地址
     remote: 'git@git.example.com:jdoe/icingaweb2-docker.git'
     # Git配置信息
     config:
       user.name: JD-OE Bot
       user.email: bot@example.com
     # 生成的脚本名称
     script: get-iw2.sh
     # 提交信息
     commit: Update get-iw2.sh
   #notify:
     # 邮件通知接收者（通过s-nail）
     #s_nail: jdoe@example.com
   

运行容器

使用以下命令启动容器，挂载数据卷以持久化配置和SSH密钥：

bash
docker run --rm -d -v dockerweb2-data:/data grandmaster/dockerweb2

配置参数详解

log（可选）

• level: 日志级别，可选值：trace、debug、info、warn、error，默认info

build

• every: 构建部署时间，采用crontab格式，如0 0 * * *表示每天午夜执行

github

• framework: Icinga Web 2框架的GitHub仓库，格式为用户名/仓库名
• mods: 模块发现配置数组
  • user: GitHub用户名，用于发现该用户下的模块仓库
  • repos: 仓库匹配正则表达式数组，需包含模块名捕获组（如\Aicingaweb2-module-(.+)\z）

deploy

• remote: 部署目标Git仓库的SSH地址（如git@git.example.com:user/repo.git）
• config: Git提交配置
  • user.name: 提交者姓名
  • user.email: 提交者***
• script: 生成的脚本文件名
• commit: Git提交信息

notify（可选）

• s_nail: 邮件通知接收者***地址，用于接收未被配置模式覆盖的仓库通知