search

networktocode / diffsync

A utility library for comparing and synchronizing different datasets.
https://diffsync.readthedocs.io/
Other
156 stars 27 forks source link

Data Ownership Facility #191

Open itdependsnetworks opened 1 year ago

itdependsnetworks commented 1 year ago

Environment

Proposed Functionality

Provide the ability to describe what is the "SoR" for a given attribute. Primarily as the system, but potentially also the owner as well.

Use Case

When viewing data at a target, it would be great to have the ability to declare what system the data came from.

Kircheneer commented 1 year ago

Is this maybe something that is SSoT-specific? In diffsync all we really have is two systems - the SoR for a given model can be derived by the direction in which you sync. If you want some fields to be SoR on the system that is synced to, you just don't load them, right? Maybe I'm misunderstanding something here.

itdependsnetworks commented 1 year ago

It should be applicable to all use cases.

Given the following scenario

Users need a way to know "do not update these fields in the excel document". A facility would allow tooling or documentation to be generated based on it.

Kircheneer commented 1 year ago

So a solution to this problem would be statically generating some HTML/Markdown/? from the models and offering meta-level options on the model fields to document whether a user is supposed to change them or not? Can you put this into a concrete practical use case of diffsync, possibly in the SSoT framework?

itdependsnetworks commented 1 year ago

So a solution to this problem would be statically generating some HTML/Markdown/?

yes

Can you put this into a concrete practical use case of diffsync, possibly in the SSoT framework?

sounds good.

mzbroch commented 1 year ago

Likely to solve the first user story in https://github.com/nautobot/nautobot/issues/1322

itdependsnetworks commented 1 year ago

This should be expanded to "how to classify the data", such as security, ownership, etc...