Configure scripts and reports for high availability

The NetBox charm is designed with high availability (HA) in mind. As there is no support for a shared filesystem, this implies that reports and scripts should not be uploaded as file uploads, as they will not work correctly with multiple instances and there is risk of data loss.

To use scripts and reports, it is necessary to configure a Data Source, which can be of type “Git” or “Amazon S3”. The git repository GitHub - netbox-community/customizations: A collection of community submitted and maintained customizations including reports, scripts, validators and export templates is a good source of examples of both scripts and reports.

Once a data source for “Git” or “Amazon S3” is configured (menu Operations → Data Sources), it should be synced (blue button in the top right of the data source screen).

Once a data source is created and synced, scripts and reports can be created from the data source (menu Customization → reports & scripts). For that, select the file in the data source and click the checkbox “Auto sync enabled”.

After a few minutes, the script or report will be synchronised over all instances of NetBox and will be usable.

See this video for more information NetBox Custom Scripts and Reports, plus Remote Data Sources .