networktocode/nautobot-dev Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

Nautobot (开发构建版) Docker镜像文档

1. 镜像概述和主要用途

本镜像为Nautobot的开发构建版本（Development builds），用于提供网络源真相（Network Source of Truth）和自动化平台的开发测试环境。Nautobot是一个开源网络管理工具，旨在帮助网络团队维护网络基础设施的准确记录（源真相），并通过API和插件系统实现自动化工作流。

开发构建版镜像包含Nautobot的最新开发特性，适用于功能验证、插件开发和内部测试，不建议用于生产环境。

2. 核心功能和特性

2.1 Nautobot核心功能

• 网络源真相管理：标准化记录网络设备、IP地址、VLAN、电路等网络资源，支持自定义数据模型。
• 自动化框架：通过Jobs、Webhooks和自定义脚本实现网络配置生成、合规检查等自动化任务。
• REST API与GraphQL：提供完整的API接口，支持外部系统集成和数据查询。
• 插件生态：支持第三方插件扩展功能（如网络拓扑可视化、IPAM增强等）。
• 版本控制：网络资源变更的历史记录与审计追踪。

2.2 开发构建版特性

• 最新功能预览：包含Nautobot主线开发分支的最新特性，尚未正式发布。
• 频繁更新：随开发进度定期更新，可能包含未稳定的代码。
• 调试工具支持：默认启用开发相关工具（如详细错误日志、热重载）。
• 兼容性测试：用于验证插件与新版本Nautobot的兼容性。

3. 使用场景和适用范围

适用场景

• 开发人员测试Nautobot新功能或修复。
• 插件开发者调试插件与Nautobot的集成。
• 内部测试环境验证新功能对业务流程的影响。
• 教学或演示环境展示Nautobot的最新能力。

不适用场景

• 生产环境（稳定性和安全性未经过生产级验证）。
• 对数据一致性要求极高的关键业务系统。

4. 使用方法和配置说明

4.1 前置依赖

• Docker Engine 20.10+ 或 Docker Desktop。
• 若使用数据库/缓存服务，需满足：
  • PostgreSQL 13+（推荐）或 MySQL 8.0+。
  • Redis 6.2+（用于缓存和任务队列）。

4.2 获取镜像

从Docker仓库拉取镜像（具体仓库地址需根据实际分发渠道确认，以下为示例）：

bash
docker pull nautobot/nautobot:dev  # 开发构建版标签通常为"dev"或"latest-dev"

4.3 基本运行（docker run）

4.3.1 单容器快速启动（依赖外部数据库）

bash
docker run -d \
  --name nautobot-dev \
  -p 8080:8080 \
  -e NAUTOBOT_DB_HOST=db.example.com \
  -e NAUTOBOT_DB_NAME=nautobot_dev \
  -e NAUTOBOT_DB_USER=nautobot \
  -e NAUTOBOT_DB_PASSWORD=strong_password \
  -e NAUTOBOT_SECRET_KEY="your-long-random-secret-key" \
  -e NAUTOBOT_DEBUG=True \
  -v nautobot_media:/opt/nautobot/media \
  -v nautobot_static:/opt/nautobot/static \
  nautobot/nautobot:dev

4.3.2 参数说明

• -p 8080:8080：映射容器内Nautobot服务端口（默认8080）到宿主机。
• -v：挂载卷以持久化媒体文件（media）和静态资源（static）。
• 环境变量（见4.5节）：配置数据库连接、密钥、调试模式等核心参数。

4.4 Docker Compose配置（含依赖服务）

推荐使用docker-compose管理Nautobot及依赖服务（数据库、Redis），示例配置如下：

docker-compose.yml

yaml
version: '3.8'

services:
  nautobot:
    image: nautobot/nautobot:dev
    container_name: nautobot-dev
    restart: unless-stopped
    ports:
      - "8080:8080"
    environment:
      - NAUTOBOT_DB_HOST=postgres
      - NAUTOBOT_DB_NAME=nautobot
      - NAUTOBOT_DB_USER=nautobot
      - NAUTOBOT_DB_PASSWORD=nautobot_db_password
      - NAUTOBOT_DB_PORT=5432
      - NAUTOBOT_REDIS_HOST=redis
      - NAUTOBOT_REDIS_PORT=6379
      - NAUTOBOT_SECRET_KEY="your-long-random-secret-key"  # 必须手动生成，至少50字符
      - NAUTOBOT_DEBUG=True
      - NAUTOBOT_ALLOWED_HOSTS=localhost,127.0.0.1
    volumes:
      - nautobot_media:/opt/nautobot/media
      - nautobot_static:/opt/nautobot/static
      - nautobot_data:/opt/nautobot/data  # 存储插件、备份等数据
    depends_on:
      - postgres
      - redis

  postgres:
    image: postgres:14-alpine
    container_name: nautobot-dev-postgres
    restart: unless-stopped
    environment:
      - POSTGRES_DB=nautobot
      - POSTGRES_USER=nautobot
      - POSTGRES_PASSWORD=nautobot_db_password
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redis:
    image: redis:7-alpine
    container_name: nautobot-dev-redis
    restart: unless-stopped
    volumes:
      - redis_data:/data

volumes:
  nautobot_media:
  nautobot_static:
  nautobot_data:
  postgres_data:
  redis_data:

启动与停止

bash
# 启动所有服务（后台运行）
docker-compose up -d

# 查看日志
docker-compose logs -f nautobot

# 停止服务（保留数据）
docker-compose down

4.5 环境变量配置

以下为常用环境变量（完整列表见Nautobot官方文档)：

4.6 数据持久化

通过卷（Volume）挂载持久化关键数据，避免容器重建后数据丢失：

• /opt/nautobot/media：用户上传的媒体文件（如设备图片）。
• /opt/nautobot/static：静态资源（CSS/JS，由collectstatic生成）。
• /opt/nautobot/data：插件、备份、自定义配置文件等。

4.7 网络配置

• 端口映射：默认通过8080端口暴露Web服务，可通过-p <宿主机端口>:8080修改。
• 内部网络：若使用docker-compose，服务间通过默认桥接网络通信（如Nautobot通过postgres主机名访问数据库）。
• 外部访问：开发环境可绑定0.0.0.0:8080允许局域网访问（需配置NAUTOBOT_ALLOWED_HOSTS）。

5. 注意事项

• 安全提示：开发构建版可能包含未修复的漏洞，禁止暴露在公网；NAUTOBOT_SECRET_KEY需保密，不同环境使用不同密钥。
• 数据备份：开发环境数据仍需定期备份（尤其是插件开发过程中的自定义模型数据）。
• 依赖版本：数据库和Redis版本需与Nautobot开发分支兼容（参考Nautobot官方依赖说明)。
• 镜像更新：开发版镜像频繁更新，建议定期拉取最新版本：docker pull nautobot/nautobot:dev。

6. 参考链接

• Nautobot官方文档
• Nautobot GitHub仓库
• Nautobot插件开发指南