nomaster/netbox

NetBox Docker镜像文档

镜像概述

NetBox是一款专注于IP地址管理(IPAM)和数据中心基础设施管理(DCIM)的工具。该工具最初由DigitalOcean网络工程团队设计开发，专门满足网络和基础设施工程师的需求。NetBox作为Web应用程序运行，基于Django Python框架构建，并使用PostgreSQL数据库存储数据。其源代码托管于https://github.com/digitalocean/netbox%EF%BC%8C%E5%AE%8C%E6%95%B4%E6%96%87%E6%A1%A3%E5%8F%AF%E5%9C%A8Read the Docs查看。

核心功能与特性

• IP地址管理(IPAM): 提供IP地址空间规划、分配和跟踪功能，支持前缀层次结构管理
• 数据中心基础设施管理(DCIM): 支持机架 elevation 视图、设备部署跟踪等数据中心资源管理
• 技术架构: 基于Django框架开发，使用PostgreSQL数据库，确保稳定性和可扩展性
• 开源特性: 源代码完全开源，社区活跃，提供多种扩展和集成方案

使用场景与适用范围

NetBox适用于以下场景：

• 网络工程师管理企业IP地址空间
• 数据中心管理员跟踪物理基础设施(如机架、设备)
• 需要集中管理网络资源和数据中心资产的IT团队
• 希望实现IP和基础设施可视化管理的组织

使用方法与配置说明

官方文档参考

完整安装和配置指南请参见NetBox官方文档。升级NetBox时，需下载https://github.com/digitalocean/netbox/releases%E5%B9%B6%E8%BF%90%E8%A1%8C%60upgrade.sh%60%E8%84%9A%E6%9C%AC%E3%80%82

Docker部署方式

NetBox提供Docker容器化部署方案，具体可参考社区维护的https://github.com/netbox-community/netbox-docker%E3%80%82

基本Docker运行示例

bash
# 拉取NetBox Docker镜像
docker pull netboxcommunity/netbox:latest

# 运行NetBox容器(需配合PostgreSQL数据库)
docker run -d \
  --name netbox \
  -p 8000:8000 \
  -e DATABASE_URL=postgres://user:password@postgres:5432/netbox \
  -e SECRET_KEY=your-secret-key \
  netboxcommunity/netbox:latest

Docker Compose配置示例

推荐使用docker-compose进行部署，典型配置如下：

yaml
version: '3'

services:
  postgres:
    image: postgres:13
    environment:
      POSTGRES_USER: netbox
      POSTGRES_PASSWORD: netbox
      POSTGRES_DB: netbox
    volumes:
      - postgres_data:/var/lib/postgresql/data

  netbox:
    image: netboxcommunity/netbox:latest
    depends_on:
      - postgres
    environment:
      DATABASE_URL: postgres://netbox:netbox@postgres:5432/netbox
      SECRET_KEY: your-very-secure-secret-key
      ALLOWED_HOSTS: localhost,127.0.0.1
    ports:
      - "8000:8000"
    volumes:
      - netbox_data:/opt/netbox/netbox/media

volumes:
  postgres_data:
  netbox_data:

其他部署方式

除Docker外，NetBox还支持多种部署方式：

• https://github.com/ryanmerolle/netbox-vagrant
• https://github.com/lae/ansible-role-netbox

相关项目

官方SDK

• https://github.com/digitalocean/pynetbox: NetBox的Python API客户端库

社区SDK

• https://github.com/ninech/netbox-client-ruby: Netbox v2的Ruby客户端库

Ansible集成

• https://github.com/AAbouZaid/netbox-as-ansible-inventory: NetBox动态Ansible inventory脚本

社区支持

• 邮件列表: netbox-discuss
• Slack频道: #netbox (在NetworkToCode)