nautobot / nautobot-app-ssot

Single Source of Truth for Nautobot
https://docs.nautobot.com/projects/ssot/en/latest/
Other
36 stars 34 forks source link

relocate and/or add SSoT to Extensibility navbar item #389

Open jedelman8 opened 6 months ago

jedelman8 commented 6 months ago

It is not intuitive to think that SSoT (Data Sources and Targets) would be under "Plugins". We have a DATA SOURCES section under "Extensibility." We should leverage that for each data source in SSoT.

Data Sources

Any enabled/configured SSoT source/target would show. As a byproduct, this helps showcase and brand data sources/targets.

Today, Git repositories is a data source for core functions, e.g. Jobs, Config Contexts, but could also be a target, e.g. Golden Config backups. So, if we want to be more nuanced, we should consider adding a Data Targets section under Extensibility (this is following current paradigms without introducing more menu items we way want in the future for Data Management). Otherwise, we can just call any integration a Data Source.

It may be for now the Dashboard/History/Logs stay where they are.

jdrew82 commented 6 months ago

A few questions for this:

  1. Would we consider this a breaking change? I might consider it one since it's moving where the information is in the UI so could be confusing to users.
  2. We don't currently have any navigation/URL work done in the integrations. Those are all collected together in the SSoT dashboard automagically.
jedelman8 commented 6 months ago

This is what I was thinking to add this in a first iteration:

If we did this, I wouldn't think it'd be considered a breaking change as it is improving overall UX and discoverability.

Other thoughts as I alluded to earlier:

Kircheneer commented 6 months ago

Do we have any real-world use case for data targets with SSoT? I have not seen one so far.

jedelman8 commented 6 months ago

Sure. Any data enrichment to a remote data source and any data Nautobot is the SoR for and sends to a target. They make sense but going back to UI, if the same tool as a source and a target, ideally it is not shown twice.

jdrew82 commented 6 months ago

Do we have any real-world use case for data targets with SSoT? I have not seen one so far.

Infoblox and ServiceNow are the only integrations that I'm aware of that currently have a DataTarget pushing data from Nautobot to the other SoR.

Sure. Any data enrichment to a remote data source and any data Nautobot is the SoR for and sends to a target. They make sense but going back to UI, if the same tool as a source and a target, ideally it is not shown twice.

I would agree that we probably want to reduce duplication. Perhaps it might make more sense then to instead of calling the section DataSources, call it something like Systems of Record? If a SoR has both a Source and Target it'd need it's own page to allow you to choose which way the data is being transferred?

jedelman8 commented 6 months ago

Not sure on the name change, but I believe there are more custom integrations to consider than just the ones in the repo.

jdrew82 commented 6 months ago

Not sure on the name change, but I believe there are more custom integrations to consider than just the ones in the repo.

But we can only directly influence where these particular integrations are placed. The name change was more to allow the intention to be a more abstracted away from defining whether it's an import or export of data.