Data Validation Engine¶
An App for Nautobot.
An app for Nautobot with a UI to build custom data validation rules for Source of Truth data.
The Data Validation Engine app offers a set of user definable rules which are used to enforce business constraints on the data in Nautobot. These rules are tied to particular models and each rule is meant to enforce one aspect of a business use case.
Supported rule types include: - Regular expression - Min/max value - Required fields - Unique values
Another feature within the app called Data Compliance can audit any object within Nautobot according to a set of rules that you can define programmatically. Unlike the other rule types within the Data Validation Engine app that only check for adherence to specified rules during the creation or modification of objects, Data Compliance will run a job that produces compliance statuses across all objects including pre-existing ones (such as all existing devices).
More screenshots can be found in the Using the App page in the documentation. Here's a quick overview of some of the app's added functionality:
Regular Expression Rules
Try it out!¶
This App is installed in the Nautobot Community Sandbox found over at demo.nautobot.com!
For a full list of all the available always-on sandbox environments, head over to the main page on networktocode.com.
Full web-based HTML documentation for this app can be found over on the Nautobot Docs website:
- User Guide - Overview, Getting Started, Using the App.
- Administrator Guide - How to Install, Configure, Upgrade, or Uninstall the App.
- Developer Guide - Extending the App, Code Reference, Contribution Guide.
- Release Notes / Changelog.
- Frequently Asked Questions.
Contributing to the Docs¶
You can find all the Markdown source for the App documentation under the docs folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.
If you need to view the fully generated documentation site, you can build it with mkdocs. A container hosting the docs will be started using the invoke commands (details in the Development Environment Guide) on http://localhost:8001. As your changes are saved, the live docs will be automatically reloaded.
Any PRs with fixes or improvements are very welcome!