Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abates/nautobot-app-ssot-unifi

Nautobot SSoT integration for Ubiquiti Unifi.
https://github.com/abates/nautobot-app-ssot-unifi

Last synced: about 7 hours ago
JSON representation

Nautobot SSoT integration for Ubiquiti Unifi.

Awesome Lists containing this project

README 

        
# Nautobot Ssot Unifi SSoT



An app for [Nautobot](https://github.com/nautobot/nautobot).



The term SSoT, or Single Source of Truth, refers to the intention of using Nautobot to consolidate data from disparate Systems of Record to create a single resource for all automation needs. This is done by extending the [Nautobot SSoT framework](https://github.com/nautobot/nautobot-plugin-ssot) which uses the DiffSync library. This plug-in is built with the capability in mind to import and export data from your desired System of Record.





  

  


  

  

  

  

  


  An App for Nautobot.




## Overview



> Developer Note: Add a long (2-3 paragraphs) description of what the App does, what problems it solves, what functionality it adds to Nautobot, what external systems it works with etc.



### Screenshots



> Developer Note: Add any representative screenshots of the App in action. These images should also be added to the `docs/user/app_use_cases.md` section.



> Developer Note: Place the files in the `docs/images/` folder and link them using only full URLs from GitHub, for example: `![Overview](https://raw.githubusercontent.com/abates/nautobot-app-ssot-unifi/develop/docs/images/app-overview.png)`. This absolute static linking is required to ensure the README renders properly in GitHub, the docs site, and any other external sites like PyPI.



More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/user/app_use_cases/) page in the documentation. Here's a quick overview of some of the app's added functionality:



![](https://raw.githubusercontent.com/abates/nautobot-app-ssot-unifi/develop/docs/images/placeholder.png)



## Try it out!



> Developer Note: Only keep this section if appropriate. Update link to correct sandbox.



This App is installed in the Nautobot Community Sandbox found over at [demo.nautobot.com](https://demo.nautobot.com/)!



> For a full list of all the available always-on sandbox environments, head over to the main page on [networktocode.com](https://www.networktocode.com/nautobot/sandbox-environments/).



## Documentation



Full documentation for this App can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:



- [User Guide](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.

- [Administrator Guide](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.

- [Developer Guide](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.

- [Release Notes / Changelog](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/admin/release_notes/).

- [Frequently Asked Questions](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/user/faq/).



### Contributing to the Documentation



You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/abates/nautobot-app-ssot-unifi/tree/develop/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](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](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](https://docs.nautobot.com/projects/nautobot-ssot-unifi/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.