Pre-release

This release is a pre-release and may not be stable for production use.

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.

See the compatibility matrix for supported NetBox versions.

[!TIP] To use NetBox Branching with NetBox Docker, click here

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;
  1. Activate the NetBox virtual environment:
$ source /opt/netbox/venv/bin/activate
  1. Install the plugin from PyPI:
$ pip install netboxlabs-netbox-branching
  1. Add netbox_branching to PLUGINS in configuration.py.
PLUGINS = [
    # ...
    'netbox_branching',
]
  1. Configure the database and router in configuration.py:
from netbox_branching.utilities import DynamicSchemaDict

DATABASES = DynamicSchemaDict({
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'netbox',               # Database name
        'USER': 'netbox',               # PostgreSQL username
        'PASSWORD': 'password',         # PostgreSQL password
        'HOST': 'localhost',            # Database server
        'PORT': '',                     # Database port (leave blank for default)
        'CONN_MAX_AGE': 300,            # Max database connection age
    }
})

DATABASE_ROUTERS = [
    'netbox_branching.database.BranchAwareRouter',
]
  1. Run NetBox migrations:
$ ./manage.py migrate

Running Tests

Plugin tests must be run from the NetBox application directory. Pass the PYTHONPATH environment variable to specify the testing/ directory which holds the testing configuration.

cd $NETBOX_ROOT/netbox
PYTHONPATH=$PLUGIN_ROOT/testing \
NETBOX_CONFIGURATION=configuration \
python manage.py test netbox_branching.tests

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.2.0)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for jeremystretch from gravatar.com jeremystretch Avatar for netboxlabs-publisher from gravatar.com netboxlabs-publisher

Credits

Author/Maintainer: NetBox Labs

License

NetBox Limited Use License 1.0

Requires

Python >=3.10

Provides Extra

dev test

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netboxlabs_netbox_branching-1.2.0b1.tar.gz (96.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netboxlabs_netbox_branching-1.2.0b1-py3-none-any.whl (121.6 kB view details)

Uploaded Python 3

File details

Details for the file netboxlabs_netbox_branching-1.2.0b1.tar.gz.

File metadata

File hashes

Hashes for netboxlabs_netbox_branching-1.2.0b1.tar.gz
Algorithm Hash digest
SHA256 a6a39d3727b0a50630604311c671c88000d208d3f2467760bba3998807d280b1
MD5 2191cf3fbdc930d0bdb1ac12f8244669
BLAKE2b-256 eb1eb4a0897e1fa281b7fefa75a8097254417afeede7ea65b80632cdc0728261

See more details on using hashes here.

Provenance

The following attestation bundles were made for netboxlabs_netbox_branching-1.2.0b1.tar.gz:

Publisher: release.yaml on netboxlabs/netbox-branching

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netboxlabs_netbox_branching-1.2.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for netboxlabs_netbox_branching-1.2.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 fd8b356668b7767e061094a2931447bb955f79f921648a3b099b0c04227aaa6e
MD5 9f0f64f87fcd5bb63587bc2c488a7b55
BLAKE2b-256 3889deece1ca1412e704085dff50b4299d0f01601471f1d04cd72384b129228e

See more details on using hashes here.

Provenance

The following attestation bundles were made for netboxlabs_netbox_branching-1.2.0b1-py3-none-any.whl:

Publisher: release.yaml on netboxlabs/netbox-branching

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.2.0

2 files

This release
Pre-release

1.2.0b1 This release

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

Pre-release

0.6.0b1

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

1 file

0.5.2

1 file

0.5.1

1 file

0.5.0

1 file

0.4.0

1 file

0.3.1

1 file

0.3.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page