NetBox Branching 插件最佳实践教程

1. 项目介绍

NetBox Branching 是一个为 NetBox 网络自动化平台设计的官方插件，它实现了类似 Git 分支的功能。通过该插件，用户可以创建 NetBox 数据库的静态快照，作为独立的分支进行修改，而不会干扰主数据库的完整性。这种能力使得用户能够在不中断网络源真实性的情况下，进行“离线”更改，并在变更应用前批量审查这些更改。

2. 项目快速启动

环境要求

• NetBox 版本 4.1 或更高
• PostgreSQL 版本 12 或更高

安装步骤

1. 为 NetBox 数据库用户授予权限以创建模式：

   GRANT CREATE ON DATABASE $database TO $user;
   

   其中 $database 是 NetBox 数据库的名称，$user 是数据库用户的名称。

2. 激活 NetBox 虚拟环境：

   $ source /opt/netbox/venv/bin/activate
   

3. 从 PyPI 安装插件：

   $ pip install netboxlabs-netbox-branching
   

4. 在 configuration.py 文件的 PLUGINS 列表中添加 netbox_branching。注意 netbox_branching 必须是列表中的最后一个插件。

   PLUGINS = [
   # ...
   'netbox_branching',
   ]
   

5. 创建 local_settings.py 文件（与 settings.py 相同目录），以覆盖 DATABASES 和 DATABASE_ROUTERS 设置，以支持动态模式。

   from netbox_branching.utilities import DynamicSchemaDict
   from .configuration import DATABASE
   
   # 使用 DynamicSchemaDict 包装 DATABASES 以支持动态模式
   DATABASES = DynamicSchemaDict({
       'default': DATABASE,
   })
   
   # 使用自定义数据库路由器
   DATABASE_ROUTERS = [
       'netbox_branching.database.BranchAwareRouter',
   ]
   

6. 运行 NetBox 迁移：

   $ ./manage.py migrate
   

3. 应用案例和最佳实践

案例一：网络设备配置版本控制

在 NetBox 中，可以利用 NetBox Branching 插件对网络设备的配置进行版本控制。创建一个分支，对设备的配置进行更改，然后审查更改，最后将更改合并回主数据库。

最佳实践

• 在进行重大更改前，总是创建一个新分支。
• 使用分支来测试网络配置的变更，确保不会对生产环境造成影响。
• 在合并分支前，进行彻底的审查和测试。

4. 典型生态项目

NetBox Branching 作为 NetBox 生态的一部分，与其他开源项目如 Ansible、NAPALM 等相结合，可以提供更加强大和灵活的网络自动化解决方案。通过这些项目的整合，可以实现从配置管理到自动化部署的整个网络生命周期管理。