uberspace/cachet_netbox_sync

Cachet Netbox Sync镜像说明

镜像概述

本镜像提供的工具可将Netbox（基础设施管理平台）中的数据（如电路、虚拟机、站点、IP地址、租户、集群等）导入到Cachet（状态页系统）中，无需手动更新状态页 inventory，通过简单的配置文件即可实现数据的过滤与分组，无需编写代码。

核心功能

1. 数据同步：将Netbox中的指定数据同步至Cachet，支持组件（虚拟机、网络等）和组件组的双向筛选同步；
2. 灵活配置：通过INI配置文件按租户、状态等条件过滤数据，并按指定字段（如租户名称）分组；
3. 安全控制：仅删除符合限制条件的组件/组，且仅处理带有cachet-netbox-sync标签的组件，保留手动创建内容；
4. 多部署方式：支持Python pip安装、Docker运行、自定义镜像及Gitlab CI自动化同步。

使用场景

• 企业IT运维团队：同步基础设施状态到Cachet状态页，实时展示服务可用性；
• 技术团队：减少手动维护状态页的工作量，确保数据一致性；
• 自动化场景：通过定时任务（如Cron）或CI/CD系统定期同步数据。

配置说明

前提条件

1. 获取Cachet API Token：从https://cachet.example.com/dashboard/user获取；
2. 获取Netbox只读API Token：从https://netbox.example.com/admin/users/token/获取；
3. 复制config.example.ini并编辑，或通过环境变量设置CACHET_TOKEN和NETBOX_TOKEN。

Docker部署示例

拉取镜像

console
docker pull uberspace/cachet_netbox_sync

运行镜像

console
docker run -v /path/to/config.ini:/config.ini uberspace/cachet_netbox_sync --config /config.ini

自定义镜像

创建Dockerfile（注意避免嵌入敏感信息）：

dockerfile
FROM uberspace/cachet_netbox_sync
COPY config.ini /config.ini
ENTRYPOINT ["cachet_netbox_sync", "-c", "/config.ini"]

Gitlab CI配置

在Gitlab项目中添加.gitlab-ci.yml：

yaml
---
sync_cachet:
  image:
    name: uberspace/cachet_netbox_sync
    entrypoint: [""]
  script:
    - cachet_netbox_sync --config cachet_netbox_sync.ini

运行步骤

1. 准备配置文件（包含API地址、Token、数据过滤规则等）；
2. 通过Docker或Python命令运行工具：cachet_netbox_sync -c /path/to/config.ini；
3. 可通过Cron定时同步（如每小时一次）：

cron
0 * * * * cachet_netbox_sync -c ~/.cachet_netbox_sync.config.ini