gNMI: Add section to cover atomic datasets#229
gNMI: Add section to cover atomic datasets#229earies wants to merge 1 commit intoopenconfig:masterfrom
Conversation
|
|
||
| If the data content is modeled in the YANG language, a YANG extension SHOULD be | ||
| annotated on a corresponding structure to be delivered atomically. Valid YANG | ||
| structures are: `[ list, container ]` and scale MUST be taken into |
There was a problem hiding this comment.
We need go consider atomic list entries vs the whole list is atomic. I suspect that this would need different annotations.
There was a problem hiding this comment.
Good point to call out. So far, I believe every use-case of atomicity to date has been on a list entry level (each entry can be treated as an atomic unit) - I am currently unaware of a scenario in which all list entries would be mandated to be delivered atomically but it is very well possible.
To the point of another possible annotation, what if we cleaned up the verbiage here to something like:
If the data content is modeled in the YANG language, a YANG extension SHOULD be
annotated on a corresponding structure to be delivered atomically. Valid YANG
structures are: `[ list, container ]` and scale MUST be taken into consideration with
respect to atomic annotations.
When an annotation exists on a container, all child nodes of that container are to be
delivered atomically within a single `Notification` message.
When an annotation exists on a list, all child nodes of a single list entry are to be
delivered atomically within a single `Notification` message. Delivering _all_ list entries
atomically is not currently supported. Should the need arise, a future extension to
annotate at the list level can be taken into consideration.
Then follow-up w/ a description update to the oc-ext:telemetry-atomic extension detailing out this same ruleset w/ a reference to the spec section.
If we encounter a use-case of wanting to attach an annotation to a list to indicate all entries to be delivered atomically, this would then call for a new extension + spec update in the future.
WDYT?
|
Reference to documentation update: https://github.com/openconfig/public/pull/1238/files |
Addition of subsection to
3.5.2.1 Bundling of Telemetry Updatesthat coversatomic datasets and when there is a relationship to YANG modeled data.
Reference: openconfig/gnmi#180