Skip to content

Installing the App in Nautobot

Here you will find detailed instructions on how to install and configure the App within your Nautobot environment.

Prerequisites

  • The app is compatible with Nautobot 2.4.2 and higher.
  • Databases supported: PostgreSQL, MySQL

Note

Please check the dedicated page for a full compatibility matrix and the deprecation policy.

Access Requirements

Nautobot Netobs can utilize Git Repositories to write Telegraf configurations to. The Nautobot server will need HTTP/HTTPS access to the Git servers.

Install Guide

The app is available as a Python package and can be installed with pip:

pip install nautobot-netobs

To ensure Nautobot Network Observability App is automatically re-installed during future upgrades, create a file named local_requirements.txt (if not already existing) in the Nautobot root directory (alongside requirements.txt) and list the nautobot-netobs package:

echo nautobot-netobs >> local_requirements.txt

Once installed, the app needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your nautobot_config.py file:

  • Append "nautobot_netobs" to the PLUGINS list.
  • Append the "nautobot_netobs" dictionary to the PLUGINS_CONFIG dictionary and override any defaults.
# In your nautobot_config.py
PLUGINS = ["nautobot_netobs"]

# PLUGINS_CONFIG = {
#   "nautobot_netobs": {
#     "ADD YOUR SETTINGS HERE"
#   }
# }

Once the Nautobot configuration is updated, run the Post Upgrade command (nautobot-server post_upgrade) to run migrations and clear any cache:

nautobot-server post_upgrade

Then restart (if necessary) the Nautobot services which may include:

  • Nautobot
  • Nautobot Workers
  • Nautobot Scheduler
sudo systemctl restart nautobot nautobot-worker nautobot-scheduler

App Configuration

Nautobot Config

The following settings can only be set within the Nautobot Config as they control the way the app is initialized.

Key Example Default Description
ENABLE_JOBS True True Enable Jobs after installing
ENABLE_JOB_HOOKS True False Enable Job Hooks after installing

Constance Config

The app can use settings via Constance. If set in the config file, the database values will be ignored. Therefore, it is preferable to configure these settings via Constance. A link is provided in the Netobs dashboard.

The app behavior can be controlled with the following list of settings:

Key Example Default Description
USE_VC_NAME True False If a Device has a Virtual Chassis, use that name instead of the device name. Useful for cases where none of the devices in a VC have the DNS name.
GRAFANA_COLOR green green Set the color choice for the GraphQL query for TelegrafAgentGroups for when they match using the Config from Query Results transform.