consol/omd-labs-debian

OMD Labs Docker镜像文档

镜像概述

OMD（Open Monitoring Distribution）"Labs"版Docker镜像，基于Debian 11和Rocky 9系统构建，提供开源监控分发的实验版本（[***]"demo"监控站点，支持自动化构建与多版本管理，适用于快速部署、测试和定制监控环境。

作者：Sven Nierlein (sven.nierlein at consol.de)
原作者：Simon Meggle

自动化构建、分支与标签

镜像构建由OMD Labs构建系统自动触发，当有新包可用时更新。支持以下官方仓库：

• Rocky系统：https://hub.docker.com/r/consol/omd-labs-rocky/
• Debian系统：https://hub.docker.com/r/consol/omd-labs-debian/

分支与标签对应关系

• master分支 → :nightly（快照构建，开发版）
• vX.XX分支 → :vX.XX（稳定版本，如:v2.10）
• latest分支 → :latest（最新稳定版本）

每个镜像均已预包含"demo"监控站点，可直接启动使用。

核心功能与特性

• 多系统支持：基于Debian 11和Rocky 9构建，适配不同操作系统需求
• 自动化版本管理：提供nightly（开发版）、stable（稳定版）和latest（最新稳定版）标签
• 预设监控站点：内置"demo"站点，开箱即可启动监控服务
• 数据持久化：支持主机卷挂载，持久化配置文件、监控数据和本地配置
• Ansible集成：支持通过Ansible playbook自定义容器配置，灵活扩展功能
• 动态站点配置：可修改默认站点名或动态添加新站点，无需重新构建基础镜像
• 空间检查机制：启动前验证挂载卷可用空间，确保数据存储可靠性

使用场景

• 快速部署临时监控环境进行功能测试
• 开发自定义监控插件或配置
• 演示OMD Labs版的监控功能
• 构建持久化的生产级监控系统
• 通过Ansible自动化管理监控配置

使用方法

运行demo站点

OMD Labs镜像预设"demo"站点，可直接启动体验监控功能。

直接启动容器

Rocky 9系统：

bash
docker run -p 8443:443 consol/omd-labs-rocky

Debian 11系统：

bash
docker run -p 8443:443 consol/omd-labs-debian

使用Makefile管理本地镜像

通过Makefile可简化本地构建和启动流程：

bash
# 启动本地构建的Rocky镜像
make -f Makefile.omd-labs-rocky start

# 构建本地镜像（不覆盖官方consol/镜像）
make -f Makefile.omd-labs-rocky build

# 仅启动容器bash终端
make -f Makefile.omd-labs-rocky bash

启动日志示例

容器启动时会输出初始化过程日志：

Config and start OMD site: demo
--------------------------------------
Checking for volume mounts...
--------------------------------------
 * local/: [No Volume]
 * etc/: [No Volume]
 * var/: [No Volume]


Checking for Ansible drop-in...
--------------------------------------
Nothing to do (/root/ansible_dropin/playbook.yml not found).

omd-labs: Starting site demo...
--------------------------------------
Preparing tmp directory /omd/sites/demo/tmp...Starting rrdcached...OK
Starting npcd...OK
Starting naemon...OK
Starting dedicated Apache for site demo...OK
Initializing Crontab...OK
OK

自定义站点

修改默认站点名

默认站点名为"demo"，可通过构建自定义镜像修改：

1. 克隆仓库并进入目标系统目录（如omd-labs-rocky）
2. 导出SITENAME环境变量并构建：

bash
export SITENAME=mynewsite; make -f Makefile.omd-labs-rocky build

构建后的镜像将使用新站点名（如mynewsite）启动。

动态添加站点

基于官方镜像创建子镜像，可动态添加新站点：

1. 创建自定义Dockerfile：

dockerfile
FROM consol/omd-labs-rocky:nightly
# 添加自定义站点配置（如安装插件、修改权限等）

2. 通过NEW_SITENAME环境变量修改子镜像中的站点名：

bash
export NEW_SITENAME=anothersite

子镜像构建完成后，ONBUILD指令会自动应用站点名修改。

使用数据容器

容器默认不持久化数据，需通过主机卷挂载实现监控数据、配置的持久化存储。

主机挂载数据目录

使用以下命令启动带卷挂载的容器：

bash
make -f Makefile.omd-labs-rocky startvol

该命令自动挂载三个目录：

• ./site/etc → $OMD_ROOT/etc.mount（配置文件）
• ./site/local → $OMD_ROOT/local.mount（本地配置）
• ./site/var → $OMD_ROOT/var.mount（监控数据，如RRD文件、日志）

首次启动数据同步

首次启动时，主机目录会自动创建，start.sh脚本通过lsyncd同步原始目录内容到卷中：

• $OMD_ROOT/etc → $OMD_ROOT/etc.mount
• $OMD_ROOT/local → $OMD_ROOT/local.mount
• $OMD_ROOT/var → $OMD_ROOT/var.mount

同步日志示例：

Config and start OMD site: demo
--------------------------------------
Checking for volume mounts...
--------------------------------------
 * local/: [EXTERNAL Volume] at /opt/omd/sites/demo/local.mount
   * mounted volume is writable
   => local.mount is empty; initial sync from local local ...
   * writing the lsyncd config for local.mount...
 * etc/: [EXTERNAL Volume] at /opt/omd/sites/demo/etc.mount
   * mounted volume is writable
   => etc.mount is empty; initial sync from local etc ...
   * writing the lsyncd config for etc.mount...
 * var/: [EXTERNAL Volume] at /opt/omd/sites/demo/var.mount
   * mounted volume is writable
   => var.mount is empty; initial sync from local var ...
   * writing the lsyncd config for var.mount...

挂载点空间检查

启动前可通过环境变量设置挂载卷的最小可用空间阈值，不足则启动失败。示例：

bash
docker run -d -p 8443:443 \
  -v $(pwd)/site/local:/omd/sites/demo/local.mount \
  -v $(pwd)/site/etc:/omd/sites/demo/etc.mount \
  -v $(pwd)/site/var:/omd/sites/demo/var.mount \
  -e VOL_VAR_MB_MIN=700000  \  # var卷最小可用空间(MB)
  -e VOL_ETC_MB_MIN=500     \  # etc卷最小可用空间(MB)
  -e VOL_LOCAL_MB_MIN=6000  \  # local卷最小可用空间(MB)
  consol/omd-labs-rocky:nightly

Ansible Drop-ins

通过Ansible playbook可在容器启动时自定义配置，实现灵活扩展。

启动序列

容器默认启动流程：

1. 检查$ANSIBLE_DROPIN目录（默认/root/ansible_dropin）是否存在playbook.yml
2. 若存在，执行Ansible playbook
3. 启动OMD站点和Apache前台进程

包含Ansible Drop-ins

挂载本地Ansible配置目录到容器的/root/ansible_drop：

bash
docker run -it -p 8443:443 -v $(pwd)/my_ansible_dropin:/root/ansible_drop consol/omd-labs-debian

my_ansible_dropin目录需包含有效的playbook.yml。

自定义登录密码

容器启动时自动为omdadmin用户生成随机密码，可通过Ansible设置自定义密码：

创建playbook.yml：

yaml
---
- hosts: all
  tasks:
  - shell: sudo su - demo -c "set_admin_password omd"

上述配置将demo站点的omdadmin密码设置为"omd"。

调试Ansible配置

通过ANSIBLE_VERBOSITY环境变量开启Ansible详细输出（1-4级，级别越高输出越详细）：

bash
docker run -it -p 8443:443 -e ANSIBLE_VERBOSITY=3 -v $(pwd)/my_ansible_dropin:/root/ansible_drop consol/omd-labs-debian