saashup/netbox-docker-agent

Netbox Docker Agent

镜像概述和主要用途

Netbox Docker Agent 是一款部署在 Docker 服务器上的代理程序，用于通过 https://github.com/SaaShup/netbox-docker-plugin 管理 Docker 容器。该代理基于 Node-RED 构建，提供了与 Docker 引擎的接口，使 Netbox 能够远程管理 Docker 实例。

!https://github.com/SaaShup/netbox-docker-agent/assets/***/06f81159-1830-45d2-9cd0-b4a949ab086e

核心功能和特性

• 通过 Netbox 插件远程管理 Docker 容器
• 提供 Web 管理界面进行配置
• 支持容器生命周期管理
• 内置监控指标，可与 Prometheus 集成
• 可配置的安全访问控制
• 灵活的环境变量配置

使用场景和适用范围

• 数据中心基础设施管理
• 通过 Netbox 集中管理多个 Docker 主机
• 需要从 Netbox 界面直接操作 Docker 容器的场景
• 希望通过单一平台监控和管理网络设备与容器的环境

安装与部署

环境要求

• Docker 引擎 18.06.0+
• 网络访问权限
• 对 Docker 套接字的读写权限

快速启动

使用以下命令快速启动容器：

bash
docker run -d \
  -p 1880:1880 \
  -v /var/run/docker.sock:/var/run/docker.sock:rw \
  -v netbox-docker-agent:/data \
  --name netbox-docker-agent \
  saashup/netbox-docker-agent

注意：容器必须对 Docker 套接字 (/var/run/docker.sock) 具有读写权限。快速测试权限的方法：chmod a+rw /var/run/docker.sock

默认访问凭据：admin/saashup

构建镜像

如需自定义构建镜像：

bash
docker build -t saashup/netbox-docker-agent .

配置说明

环境变量

配置管理

访问 Node-RED 管理页面 进行设置配置。

持久化数据

容器使用命名卷 netbox-docker-agent 存储持久化数据，包括配置和状态信息。

管理与维护

启动/停止容器

bash
# 启动容器
docker start netbox-docker-agent

# 停止容器
docker stop netbox-docker-agent

升级镜像

bash
# 停止并删除现有容器
docker stop netbox-docker-agent
docker rm netbox-docker-agent

# 拉取最新镜像
docker pull saashup/netbox-docker-agent

# 使用相同配置重新启动（保留数据卷）
docker run -d -p 1880:1880 -v /var/run/docker.sock:/var/run/docker.sock:rw -v netbox-docker-agent:/data --name netbox-docker-agent saashup/netbox-docker-agent

升级后，代理会自动更新 Netbox 中的版本信息。

清理环境

如需完全清理环境：

bash
docker stop netbox-docker-agent
docker rm netbox-docker-agent
docker image rm saashup/netbox-docker-agent
docker volume rm netbox-docker-agent

监控与日志

监控指标

应用提供 /metrics 端点，可与 Prometheus 集成，监控以下指标：

• 容器运行状态
• Docker 守护进程连接状态
• Netbox 错误响应计数

暴露的指标示例：

# HELP netbox_docker_agent_container_running 显示容器是否运行中
# TYPE netbox_docker_agent_container_running gauge
netbox_docker_agent_container_running{name="example-running", state="running", status="Up 5 seconds (health: starting)"} 1

# HELP netbox_docker_agent_docker_daemon 显示与守护进程的连接是否正常
# TYPE netbox_docker_agent_docker_daemon gauge
netbox_docker_agent_docker_daemon{socket="/var/run/docker.socket"} 1

Prometheus 配置示例

yaml
- job_name: 'netbox-docker-agent'
  scrape_interval: 5s
  static_configs:
    - targets: ['IP_ADDRESS:1880']
  metrics_path: "/metrics"
  basic_auth:
    username: 'admin'
    password: 'saashup'

日志

所有日志输出到标准输出(stdout)，当 Netbox 向代理发送错误消息时生成。错误消息格式：

${data.name} level=${level[lvl]} version=${data.version} msg=${JSON.stringify(msg.msg)}

可通过修改 INIT 流程中的 "settings.js template" 并更改 logging.console.handler 来自定义日志格式。

连接到管理界面

访问 管理界面 查看 Docker 资源，默认凭据为 admin/saashup。

托管信息

有关更多信息，请访问 [***]