netboxcommunity/netbox 新构建脚本预览版镜像文档

1. 镜像概述和主要用途

1.1 概述

本镜像为 netboxcommunity/netbox 官方镜像的新构建脚本预览版，旨在提供对NetBox Docker镜像构建流程的改进测试环境。该镜像基于NetBox核心功能，集成了重构后的构建逻辑，用于验证新构建脚本的稳定性、兼容性及性能优化效果。

1.2 主要用途

• 供NetBox开发者测试新构建脚本的功能完整性与流程优化效果；
• 帮助系统管理员评估新构建逻辑对现有NetBox部署架构的兼容性；
• 提供提前体验构建脚本新特性（如依赖管理、多平台支持等）的环境。

2. 核心功能和特性

2.1 构建流程优化

• 重构构建步骤，减少冗余依赖拉取与缓存失效场景，缩短镜像构建时间；
• 引入分层构建策略，分离核心依赖层与应用代码层，提升镜像复用率。

2.2 多平台支持

• 新增对linux/amd64、linux/arm64架构的原生构建支持，适配不同硬件环境。

2.3 依赖管理增强

• 支持通过构建参数锁定Python依赖版本，避免依赖自动升级导致的兼容性问题；
• 集成依赖安全扫描步骤，在构建阶段检测高危依赖包。

2.4 构建参数自定义

• 允许通过--build-arg自定义关键构建参数（如Python版本、NetBox源码分支、静态资源编译选项等）。

3. 使用场景和适用范围

3.1 适用对象

• NetBox开发者：验证新构建脚本对功能开发、版本迭代的支持能力；
• 系统管理员：在测试环境中评估新构建逻辑对现有部署流程（如CI/CD流水线、镜像仓库管理）的适配性。

3.2 适用环境

• 测试/开发环境：用于搭建非生产环境的NetBox实例，验证新构建脚本特性；
• 兼容性测试：模拟生产环境配置，测试新构建镜像与数据库（PostgreSQL）、缓存（Redis）等依赖服务的兼容性。

3.3 不适用场景

• 生产环境：本镜像为预览版，未经过完整的生产级稳定性验证，禁止用于生产环境部署。

4. 使用方法和配置说明

4.1 获取镜像

当前预览版镜像暂未推送至官方主仓库，需通过测试标签拉取（具体标签以官方通知为准）：

docker pull netboxcommunity/netbox:build-script-preview  # 示例标签，实际请以官方测试仓库为准

4.2 快速启动（单容器模式）

使用docker run直接启动镜像（需提前准备PostgreSQL和Redis服务）：

docker run -d \
  --name netbox-preview \
  -p 8000:8000 \
  -e DB_HOST=postgres-host \
  -e DB_NAME=netbox \
  -e DB_USER=netboxuser \
  -e DB_PASSWORD=strongpassword \
  -e REDIS_HOST=redis-host \
  -e SECRET_KEY=your-very-secure-secret-key \
  netboxcommunity/netbox:build-script-preview

4.3 Docker Compose 部署示例

通过docker-compose.yml整合NetBox、PostgreSQL和Redis服务（测试环境推荐）：

version: '3.8'

services:
  netbox:
    image: netboxcommunity/netbox:build-script-preview
    container_name: netbox-preview
    ports:
      - "8000:8000"
    environment:
      - DB_HOST=postgres
      - DB_NAME=netbox
      - DB_USER=netboxuser
      - DB_PASSWORD=strongpassword
      - DB_PORT=5432
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      - SECRET_KEY=your-very-secure-secret-key
      - DEBUG=False  # 预览版建议开启DEBUG=True以便调试
      - LOG_LEVEL=INFO
    depends_on:
      - postgres
      - redis

  postgres:
    image: postgres:14-alpine
    container_name: netbox-postgres
    environment:
      - POSTGRES_DB=netbox
      - POSTGRES_USER=netboxuser
      - POSTGRES_PASSWORD=strongpassword
    volumes:
      - postgres-data:/var/lib/postgresql/data

  redis:
    image: redis:7-alpine
    container_name: netbox-redis
    volumes:
      - redis-data:/data

volumes:
  postgres-data:
  redis-data:

启动命令：

docker-compose up -d

4.4 环境变量配置

4.5 构建参数（高级配置）

若需自定义构建流程，可通过docker build命令传入--build-arg参数（需获取构建脚本源码）：

# 示例：指定Python版本为3.11，NetBox源码分支为develop
docker build \
  --build-arg PYTHON_VERSION=3.11 \
  --build-arg NETBOX_BRANCH=develop \
  -t netbox-custom-build .

常用构建参数说明：

5. 注意事项

• 稳定性风险：本镜像为预览版，构建脚本可能存在未修复的Bug，请勿用于生产环境；
• 数据备份：测试环境中建议定期备份NetBox数据（数据库、媒体文件），避免因构建脚本问题导致数据丢失；
• 反馈渠道：使用中遇到的问题请通过NetBox官方GitHub仓库的Issues提交（标签注明build-script-preview）；
• 镜像更新：预览版镜像可能频繁更新，建议定期拉取最新版本以获取修复。