networktocode/diffsync

Data Ownership Facility

itdependsnetworks opened this issue · 6 comments

Environment

  • DiffSync version: 1.X

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.

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.

It should be applicable to all use cases.

Given the following scenario

  • You have an excel doc on Side A
  • You have a yaml file on Side B

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.

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?

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.

Likely to solve the first user story in nautobot/nautobot#1322

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