openconfig / reference

This repository contains reference implementations, specifications and tooling related to OpenConfig-based network management.
Apache License 2.0
155 stars 88 forks source link

Clarification: STREAM subscription #184

Open borisbanjanin opened 1 year ago

borisbanjanin commented 1 year ago

STREAM subscription has two modes, ON_CHANGE and SAMPLE. ON_CHANGE is defined to push data updates and SAMPLE to periodically push a complete data snapshots, both filtered by a set of paths. ON_CHANGE mode uses the heartbeat_interval to periodically push a complete data snapshots and SAMPLE mode uses the suppress_redundant to push only changes and the heartbeat_interval to force full data push periodically. Basically, it is the same story, push changes only, or full data periodically, or both, changes with periodic re-synchronizations. The only thin difference I can see is: in SAMPLE mode with suppress_redundant changes are pushed on a period (sample_interval) and in ON_CHANGE mode changes are pushed immediately when they happen. Is that right or have I missed something? Are changes-only notifications in both modes identical? Should SAMPLE mode with suppress_redundant push deleted nodes as well? As there are two very similar modes of operation, I think that this part of specification should be updated in order to exactly cover all cases and to emphasize the differences between ON_CHANGE and SAMPLE modes. It should also state that when sending updates only with aggregation, YANG list keys must always be reported.

I would be very grateful for clarification! Boris