Plugins¶

Plugins are packaged Django apps that can be installed alongside Nautobot to provide custom functionality not present in the core application. Plugins can introduce their own models and views, but cannot interfere with existing components. A Nautobot user may opt to install plugins provided by the community or build his or her own.

Capabilities¶

The Nautobot plugin architecture allows for the following:

• Add new data models. A plugin can introduce one or more models to hold data. (A model is essentially a table in the SQL database.) These models can be integrated with core implmentations of GraphQL, webhooks, logging, custom relationships, custom fields, and tags.
• Add custom validation logic to existing data models. A plugin can provide additional logic to customize the rules for validating created/updated data records.
• Add new URLs and views. Plugins can register URLs under the /plugins root path to provide browsable views for users.
• Provide Jobs. Plugins can serve as a convenient way to package and install Jobs.
• Add content to existing model templates. A template content class can be used to inject custom HTML content within the view of a core Nautobot model. This content can appear in the left side, right side, or bottom of the page.
• Add navigation menu items. Each plugin can register new links in the navigation menu. Each link may have a set of buttons for specific actions, similar to the built-in navigation items.
• Add new REST API endpoints. Plugins can register URLs under the /api/plugins/ root path to provide new REST API views.
• Add custom middleware. Custom Django middleware can be registered by each plugin.
• Add additional dependencies. Custom Django application dependencies can be registered by each plugin.
• Declare configuration parameters. Each plugin can define required, optional, and default configuration parameters within its unique namespace. Plug configuration parameter are defined by the user under PLUGINS_CONFIG in nautobot_config.py.
• Limit installation by Nautobot version. A plugin can specify a minimum and/or maximum Nautobot version with which it is compatible.
• Add additional Git Providers. Add additional Git Providers with a defined callback function to post process data received from the Git Repository.
• Register Jinja2 filters. A plugin can define custom Jinja2 filters to be used in computed fields, webhooks, custom links, and export templates.

Limitations¶

Either by policy or by technical limitation, the interaction of plugins with Nautobot core is restricted in certain ways. A plugin may not:

• Modify core models. Plugins may not alter, remove, or override core Nautobot models in any way. This rule is in place to ensure the integrity of the core data model.
• Register URLs outside the /plugins root. All plugin URLs are restricted to this path to prevent path collisions with core or other plugins.
• Override core templates. Plugins can inject additional content where supported, but may not manipulate or remove core content.
• Modify core settings. A configuration registry is provided for plugins, however they cannot alter or delete the core configuration.
• Disable core components. Plugins are not permitted to disable or hide core Nautobot components.

Installing Plugins¶

The instructions below detail the process for installing and enabling a Nautobot plugin.

You must be absolutely sure to install the plugin within Nautobot's virtual environment.

Install the Package¶

Download and install the plugin package per its installation instructions. Plugins published via PyPI are typically installed using pip3.

$ pip3 install <package>

Alternatively, if you're or installing a plugin from from a local source copy, you may wish to install the plugin manually by running python setup.py install.

If you are developing a plugin and want to install it only temporarily, run python setup.py develop instead.

Enable the Plugin¶

In your nautobot_config.py, add the plugin's name to the PLUGINS list:

PLUGINS = [
    'plugin_name',
]

Configure the Plugin¶

If the plugin requires any configuration, define it in nautobot_config.py under the PLUGINS_CONFIG parameter. The available configuration parameters should be detailed in the plugin's README file.

PLUGINS_CONFIG = {
    'plugin_name': {
        'foo': 'bar',
        'buzz': 'bazz'
    }
}

Run Database Migrations¶

If the plugin introduces new database models, run the provided schema migrations:

$ nautobot-server migrate

Collect Static Files¶

Plugins may package static files to be served directly by the HTTP front end. Ensure that these are copied to the static root directory with the collectstatic management command:

$ nautobot-server collectstatic

Restart the WSGI Service¶

Restart the WSGI service to load the new plugin:

# sudo systemctl restart nautobot nautobot-worker