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.0.0 and higher.
- Databases supported: PostgreSQL, MySQL
Note
Please check the dedicated page for a full compatibility matrix and the deprecation policy.
Access Requirements¶
Install Guide¶
Note
Apps can be installed manually or using Python's pip
. See the nautobot documentation for more details. The pip package name for this app is nautobot-data-validation-engine
.
The app is available as a Python package via PyPI and can be installed with pip
:
To ensure Data Validation Engine 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-data-validation-engine
package:
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_data_validation_engine"
to thePLUGINS
list. - Append the
"nautobot_data_validation_engine"
dictionary to thePLUGINS_CONFIG
dictionary and override any defaults.
# In your nautobot_config.py
PLUGINS = ["nautobot_data_validation_engine"]
# PLUGINS_CONFIG = {
# "nautobot_data_validation_engine": {
# 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:
Then restart (if necessary) the Nautobot services which may include:
- Nautobot
- Nautobot Workers
- Nautobot Scheduler