NetBox Branching

This NetBox plugin introduces branching functionality. A branch is a discrete, static snapshot of the NetBox database which can be modified independently and later merged back into the main database. This enables users to make "offline" changes to objects within NetBox and avoid interfering with its integrity as the network source of truth. It also provides the opportunity to review changes in bulk prior to their application.

Requirements

• NetBox v4.1 or later
• PostgreSQL 12 or later

Installation

Brief installation instructions are provided below. For a complete installation guide, please refer to the included documentation.

1. Grant PostgreSQL permission for the NetBox database user to create schemas:

GRANT CREATE ON DATABASE $database TO $user;

2. Activate the NetBox virtual environment:

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

3. Install the plugin from PyPI:

$ pip install netboxlabs-netbox-branching

4. Add netbox_branching to the end of PLUGINS in configuration.py. Note that netbox_branching MUST be the last plugin listed.

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

5. Create local_settings.py to override the DATABASES & DATABASE_ROUTERS settings. This enables dynamic schema support.

from netbox_branching.utilities import DynamicSchemaDict
from .configuration import DATABASE

# Wrap DATABASES with DynamicSchemaDict for dynamic schema support
DATABASES = DynamicSchemaDict({
    'default': DATABASE,
})

# Employ our custom database router
DATABASE_ROUTERS = [
    'netbox_branching.database.BranchAwareRouter',
]

6. Run NetBox migrations:

$ ./manage.py migrate