Nautobot Single Source of Truth
Project description
Nautobot Single Source of Truth (SSoT)
Overview
An app for Nautobot. This Nautobot app facilitates integration and data synchronization between various "source of truth" (SoT) systems, with Nautobot acting as a central clearinghouse for data - a Single Source of Truth, if you will.
The Nautobot SSoT app builds atop the DiffSync Python library and Nautobot's Jobs feature. This enables the rapid development and integration of Jobs that can be run within Nautobot to pull data from other systems ("Data Sources") into Nautobot and/or push data from Nautobot into other systems ("Data Targets") as desired. Key features include the following:
- A dashboard UI lists all registered Data Sources and Data Targets and provides a summary of the synchronization history.
- The outcome of executing of a data synchronization Job is automatically saved to Nautobot's database for later review.
- Detailed logging output generated by DiffSync is automatically captured and saved to the database as well.
Integrations
This Nautobot application framework includes the following integrations:
- Cisco ACI
- Arista CloudVision
- Device42
- Infoblox
- IPFabric
- Itential
- ServiceNow
Read more about integrations here. To enable and configure integrations follow the instructions from the install guide.
Screenshots
The dashboard view of the app.
The detailed view of the example data source that is prepackaged within this app.
The detailed view of an executed sync.
More screenshots can be found in the Using the App page in the documentation.
Try it out!
This Nautobot 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.
Documentation
Full documentation for this app can be found over on the Nautobot Docs website:
- User Guide - Overview, Using the App, Getting Started, Developing Jobs.
- Administrator Guide - How to Install, Configure, Upgrade, or Uninstall the App.
- Developer Guide - Extending the App, Code Reference, Contribution Guide.
- Release Notes / Changelog.
Note On Integration Compatability
The SSoT framework includes a number of integrations with external Systems of Record:
- Cisco ACI
- Arista CloudVision
- Device42
- Infoblox
- Itential
- ServiceNow
Note that the Arista CloudVision integration is currently incompatible with the Arista Labs environment due to a TLS issue. It has been confirmed to work in on-prem environments previously.
Contributing to the Documentation
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 documentation can be started using the invoke
commands (details in the Development Environment Guide) on http://localhost:8001. Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
Any PRs with fixes or improvements are very welcome!
Questions
For any questions or comments, please check the FAQ first. Feel free to also swing by the Network to Code Slack (channel #nautobot
), sign up here if you don't have an account.
Acknowledgements
This project includes code originally written in separate Nautobot apps, which have been merged into this project:
- nautobot-plugin-ssot-aci: Thanks @chadell, @dnewood, @progala, @ubajze
- nautobot-plugin-ssot-arista-cloudvision: Thanks @burnyd, @chipn, @jdrew82, @jvanderaa, @nniehoff, @qduk, @ubajze
- nautobot-plugin-ssot-device42: Thanks @jdrew82
- nautobot-plugin-ssot-infoblox: Thanks @FragmentedPacket, @chadell, @jdrew82, @jtdub, @pke11y, @smk4664, @ubajze @whitej6,
- nautobot-plugin-ssot-ipfabric: Thanks @FragmentedPacket, @armartirosyan, @chadell, @grelleum, @h4ndzdatm0ld, @jdrew82, @justinjeffery-ipf, @pke11y, @ubajze @whitej6,
- nautobot-plugin-ssot-servicenow: Thanks @chadell, @glennmatthews, @qduk, @ubajze
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nautobot_ssot-2.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d675c6ee0a87dc92383e8617c5e9cf50325f9f70ba7e869760df53b40625ec4 |
|
MD5 | 92ab8ef2b2d0bcbcddd8f69ab6d630cb |
|
BLAKE2b-256 | c7f7221f9b655ffd09708ae10fa3041fec4ec4fabec22a8e578c688ecbbdf5f7 |