netboxlabs-diode-netbox-plugin 0.1.0

NetBox Labs, Diode NetBox plugin

Diode NetBox Plugin

The Diode NetBox plugin is a NetBox plugin and a required component of the Diode ingestion service.

Diode is a NetBox ingestion service that greatly simplifies and enhances the process to add and update network data in NetBox, ensuring your network source of truth is always accurate and can be trusted to power your network automation pipelines.

More information about Diode can be found at https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/.

Compatibility

NetBox Version	Plugin Version
>= 3.7.2	0.1.0

Installation

pip install netboxlabs-diode-netbox-plugin

In your NetBox configuration.py file, add netbox_diode_plugin to the PLUGINS list.

PLUGINS = [
    "netbox_diode_plugin",
]

See NetBox Documentation for details.

Configuration

Source the NetBox Python virtual environment:

cd /opt/netbox
source venv/bin/activate

Generate 3 API keys as random 40 character long alphanumeric strings:

echo "export DIODE_TO_NETBOX_API_KEY=$(head -c20 </dev/urandom|xxd -p)"
echo "export NETBOX_TO_DIODE_API_KEY=$(head -c20 </dev/urandom|xxd -p)"
echo "export INGESTION_API_KEY=$(head -c20 </dev/urandom|xxd -p)"

Note: store these API key strings in a safe place as they will be needed later to configure the Diode server

Set the environment variables based on the random generated strings:

export DIODE_TO_NETBOX_API_KEY={random_string_1} # API key for the Diode service to interact with NetBox
export NETBOX_TO_DIODE_API_KEY={random_string_2} # API key for the NetBox service to interact with Diode
export INGESTION_API_KEY={random_string_3} # API key for Diode SDKs to ingest data into Diode

Configure the plugin:

cd /opt/netbox/netbox
./manage.py configurediodeplugin

Running Tests

make docker-compose-netbox-plugin-test

License

Distributed under the PolyForm Shield License 1.0.0 License. See LICENSE.md for more information.