NetBox Branching 项目启动与配置教程

1. 项目的目录结构及介绍

NetBox Branching 是一个为 NetBox 提供分支功能的开源插件。其目录结构如下：

• .github/: 存放与 GitHub 有关的配置文件，例如工作流（workflow）和标签模板等。
• docs/: 存放项目文档，包括安装指南和用户手册等。
• netbox_branching/: 核心插件代码所在目录。
  • migrations/: 数据库迁移脚本。
  • models/: 数据模型定义。
  • database/: 自定义数据库路由和数据库相关逻辑。
  • utilities/: 实用工具函数。
• tests/: 单元测试和集成测试代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE.md: 项目许可证文件。
• NOTICE.txt: 项目通知文件。
• README.md: 项目说明文件。
• SECURITY.md: 安全策略文件。
• mkdocs.yml: MkDocs 文档生成器的配置文件。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动主要是通过 NetBox 的插件系统完成。在插件被安装并配置后，以下步骤将会启动插件的分支功能：

• 在 NetBox 的虚拟环境中激活插件。
• 通过 PyPI 安装 netboxlabs-netbox-branching 插件。
• 在 NetBox 的配置文件 configuration.py 的 PLUGINS 列表中添加 netbox_branching。

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• 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',
  ]
  

• configuration.py: 这是 NetBox 的主配置文件，其中 PLUGINS 需要添加 netbox_branching，确保插件被正确加载。

完成以上配置后，运行 NetBox 的迁移命令 ./manage.py migrate 来应用插件的数据库迁移脚本，从而完成插件的安装和启动。