-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-ietf-netconf-distributed-notif-07.txt
1176 lines (762 loc) · 39.6 KB
/
draft-ietf-netconf-distributed-notif-07.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
NETCONF T. Zhou
Internet-Draft G. Zheng
Intended status: Standards Track Huawei
Expires: 8 January 2024 E. Voit
Cisco Systems
T. Graf
Swisscom
P. Francois
INSA-Lyon
7 July 2023
Subscription to Distributed Notifications
draft-ietf-netconf-distributed-notif-07
Abstract
This document describes extensions to the YANG notifications
subscription to allow metrics being published directly from
processors on line cards to target receivers, while subscription is
still maintained at the route processor in a distributed forwarding
system.
Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 8 January 2024.
Zhou, et al. Expires 8 January 2024 [Page 1]
Internet-Draft Distributed Notifications July 2023
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminologies . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Motivation . . . . . . . . . . . . . . . . . . . . . . . . . 4
4. Solution Overview . . . . . . . . . . . . . . . . . . . . . . 4
5. Subscription Decomposition . . . . . . . . . . . . . . . . . 6
6. Publication Composition . . . . . . . . . . . . . . . . . . . 6
7. Subscription State Change Notifications . . . . . . . . . . . 7
8. Publisher Configurations . . . . . . . . . . . . . . . . . . 7
9. YANG Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 7
10. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 8
11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10
12. Implementation Status . . . . . . . . . . . . . . . . . . . . 10
12.1. Open Source Publisher . . . . . . . . . . . . . . . . . 10
12.2. Open Source Receiver Library . . . . . . . . . . . . . . 11
12.3. Pmacct Data Collection . . . . . . . . . . . . . . . . . 11
12.4. Huawei VRP . . . . . . . . . . . . . . . . . . . . . . . 11
13. Operational Considerations . . . . . . . . . . . . . . . . . 11
14. Security Considerations . . . . . . . . . . . . . . . . . . . 11
15. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 12
16. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 12
17. References . . . . . . . . . . . . . . . . . . . . . . . . . 12
17.1. Normative References . . . . . . . . . . . . . . . . . . 12
17.2. Informative References . . . . . . . . . . . . . . . . . 13
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 14
A.1. Dynamic Subscription . . . . . . . . . . . . . . . . . . 14
A.2. Configured Subscription . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 20
Zhou, et al. Expires 8 January 2024 [Page 2]
Internet-Draft Distributed Notifications July 2023
1. Introduction
The mechanism to support a subscription of a continuous and
customized stream of updates from a YANG datastore [RFC8342] is
defined in [RFC8639] and [RFC8641]. Requirements for Subscription to
YANG Datastores are defined in [RFC7923].
By streaming data from publishers to receivers, much better
performance and fine-grained sampling can be achieved than with
polling. In a distributed forwarding system, the packet forwarding
is delegated to multiple processors on line cards. To not to
overwhelm the route processor resources, it is not uncommon that data
records are published directly from processors on line cards to
target Receivers to further increase efficiency on the routing
system.
This document complements the general subscription requirements
defined in section 4.2.1 of [RFC7923] by the paragraph: A
Subscription Service MAY support the ability to export from multiple
software processes on a single routing system and expose the
information which software process produced which message to maintain
data integrity.
2. Terminologies
The following terms are defined in [RFC8639] and are not redefined
here:
Subscriber
Publisher
Receiver
Subscription
In addition, this document defines the following terms:
Global Subscription: is the Subscription requested by the subscriber.
It may be decomposed into multiple Component Subscriptions.
Component Subscription: is the Subscription that defines a data
source which is managed and controlled by a single Publisher.
Global Capability: is the overall subscription capability that the
group of Publishers can expose to the Subscriber.
Zhou, et al. Expires 8 January 2024 [Page 3]
Internet-Draft Distributed Notifications July 2023
Component Capability: is the subscription capability that each
Publisher can expose to the Subscriber.
Master: is the Publisher that interacts with the Subscriber to deal
with the Global Subscription. It decomposes the Global Subscription
to multiple Component Subscriptions and interacts with the Agents.
Agent: is the Publisher that interacts with the Master to deal with
the Component Subscription and pushing the data to the Receiver.
Observation Domain: An Observation Domain is the largest set of
observation points for which metrics can be collected, stored and
exported by an Agent. For example, a router line card may be an
Observation Domain if it is composed of several interfaces, each of
which is an observation point.
Observation Domain ID: A 32-bit identifier of the Observation Domain
that is locally unique to the network node. In the YANG notification
messages it generates, the Observation Domain includes its
Observation Domain ID. That way, the collecting process can identify
the specific Observation Domain from the publisher that sends the
YANG notification messages. Receivers SHOULD use the transport
session and the Observation Domain ID field to separate different
publisher streams originating from the same publisher.
3. Motivation
Lost and corrupt YANG notification messages need to be recognized at
the receiver to ensure data integrity even when multiple publisher
processes publishing from the same transport session.
To preserve data integrity down to the publisher process, the
Observation Domain ID in the transport message header of the YANG
notification message is introduced. In case of UDP transport, this
is described in Section 3.2 of UDP-based transport
[I-D.ietf-netconf-udp-notif].
4. Solution Overview
Figure 1 below shows the distributed data export framework.
A collector usually includes two components,
* the Subscriber generates the subscription instructions to express
what and how the Receiver wants to receive the data;
* the Receiver is the target for the data publication.
Zhou, et al. Expires 8 January 2024 [Page 4]
Internet-Draft Distributed Notifications July 2023
For one subscription, there can be one or more Receivers. And the
Subscriber does not necessarily share the same IP address as the
Receivers.
In this framework, the Publisher pushes data to the Receiver
according to the subscription. The Publisher is either in the Master
or Agent role. The Master knows all the capabilities that his Agents
can provide and exposes the Global Capability to the collector. The
Subscriber maintains the Global Subscription at the Master and
disassembles the Global Subscription to multiple Component
Subscriptions, depending which source data is needed. The Component
Subscriptions are then distributed to the corresponding Publisher
Agents on route and processors on line cards.
Publisher Agents collects metrics according to the Component
Subscription, add its metadata, encapsulates, and pushes data to the
Receiver where packets are reassembled and decapsulated.
+-----------------------------------------+
| Collector |-------------+ |
| +------------+ | |
| +------------+ || Receiver | | |
| | Subscriber | |--------------+ |
| +-----^-+----+ +------------^ |
| | | | |
+-----------------------------------------+
Global | | Global |
Capability| | Subscription |
+-----------------------------------------+
| | | | |
| +--------+-v-------------------+ | |
| | Publisher(Master) | | |
| +--------^-+-------------------+ | |
| | | | |
| | | | |
| Component | | Component Push | |
| Capability| | Subscription | |
| +--------+-v-------------------+ | |
| | Publisher(Agent) +--+ |
| +------------------------------+ |
| |
| Device |
+-----------------------------------------+
Figure 1: The Distributed Data Export Framework
Master and Agents interact with each other in several ways:
Zhou, et al. Expires 8 January 2024 [Page 5]
Internet-Draft Distributed Notifications July 2023
* Agents need to register at the Master at the beginning of their
process life cycle.
* Contracts are created between the Master and each Agent on the
Component Capability, and the format for streaming data structure.
* The Master relays the component subscriptions to the Agents.
* The Agents announce the status of their Component Subscriptions to
the Master. The status of the overall subscription is maintained
by the Master. The Master is responsible for notifying the
subscriber in case of problems with the Component Subscriptions.
The technical mechanisms or protocols used for the coordination of
operational information between Master and Agent is out-of-scope of
this document.
5. Subscription Decomposition
The Collector can only subscribe to the Master. This requires the
Master to:
1. expose the Global Capability that can be served by multiple
Publisher Agents;
2. disassemble the Global Subscription to multiple Component
Subscriptions, and distribute them to the Publisher Agents of the
corresponding metric sources so that they not overlap;
3. notify on changes when portions of a subscription moving between
different Publisher Agents over time.
And the Agent to:
* Inherit the Global Subscription properties from Publisher Master
for its Component Subscription;
* share the same life-cycle as the Global Subscription;
* share the same Subscription ID as the Global Subscription.
6. Publication Composition
The Publisher Agent collects data and encapsulates the packets per
Component Subscription. The format and structure of the data records
are defined by the YANG schema, so that the decomposition at the
Receiver can benefit from the structured and hierarchical data
records.
Zhou, et al. Expires 8 January 2024 [Page 6]
Internet-Draft Distributed Notifications July 2023
The Receiver is able to associate the YANG data records with
Subscription ID [RFC8639] to the subscribed subscription and with
Message Observation Domain ID to one of the Publisher Agents software
processes to enable message integrity.
For the dynamic subscription, the output of the "establish-
subscription" RPC defined in [RFC8639] MUST include a list of Message
Observation Domain IDs to indicate how the Global Subscription is
decomposed into several Component Subscriptions.
The "subscription-started" and "subscription-modified" notification
defined in [RFC8639] MUST also include a list of Message Observation
Domain IDs to notify the current Publishers for the corresponding
Global Subscription.
7. Subscription State Change Notifications
In addition to sending event records to Receivers, the Master MUST
also send subscription state change notifications [RFC8639] when
events related to subscription management have occurred. All the
subscription state change notifications MUST be delivered by the
Master.
When the subscription decomposition result changed, the
"subscription-modified" notification MUST be sent to indicate the new
list of Publishers.
8. Publisher Configurations
This document assumes that all Publisher Agents are preconfigured to
push data. The actual working Publisher Agents are selected based on
the subscription decomposition result.
All Publisher Agents share the same source IP address for data
export. For connectionless data transport such as UDP based
transport [I-D.ietf-netconf-udp-notif] the same Layer 4 source port
for data export can be used. For connection based data transport
such as HTTPS based transport [I-D.ietf-netconf-https-notif], each
Publisher Agent MUST be able to acknowledge packet retrieval from
Receivers, and therefore requires a dedicated Layer 4 source port per
software process.
The specific configuration on transports is described in the
responsible documents.
9. YANG Tree
Zhou, et al. Expires 8 January 2024 [Page 7]
Internet-Draft Distributed Notifications July 2023
module: ietf-distributed-notif
augment /sn:subscriptions/sn:subscription:
+--ro message-observation-domain-id* uint32
augment /sn:subscription-started:
+--ro message-observation-domain-id* uint32
augment /sn:subscription-modified:
+--ro message-observation-domain-id* uint32
augment /sn:establish-subscription/sn:output:
+--ro message-observation-domain-id* uint32
10. YANG Module
<CODE BEGINS> file "[email protected]"
module ietf-distributed-notif {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-distributed-notif";
prefix dn;
import ietf-subscribed-notifications {
prefix sn;
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Editor: Tianran Zhou
<mailto:[email protected]>
Editor: Guangying Zheng
<mailto:[email protected]>";
description
"Defines augmentation for ietf-subscribed-notifications to
enable the distributed publication with single subscription.
Copyright (c) 2018 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
Zhou, et al. Expires 8 January 2024 [Page 8]
Internet-Draft Distributed Notifications July 2023
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see the
RFC itself for full legal notices.";
revision 2023-03-06 {
description
"Initial version";
reference
"RFC XXXX: Subscription to Distributed Notifications";
}
grouping message-observation-domain-ids {
description
"Provides a reusable list of message-observation-domain-ids.";
leaf-list message-observation-domain-id {
type uint32;
config false;
ordered-by user;
description
"Software process which created the message (e.g.,
processor 1 on line card 1). This field is
used to notify the collector the working originator.";
}
}
augment "/sn:subscriptions/sn:subscription" {
description
"This augmentation allows the message
Observation Domain ID to be exposed for a subscription.";
uses message-observation-domain-ids;
}
augment "/sn:subscription-started" {
description
"This augmentation allows MSO specific parameters to be
exposed for a subscription.";
uses message-observation-domain-ids;
}
augment "/sn:subscription-modified" {
description
"This augmentation allows MSO specific parameters to be
exposed for a subscription.";
Zhou, et al. Expires 8 January 2024 [Page 9]
Internet-Draft Distributed Notifications July 2023
uses message-observation-domain-ids;
}
augment "/sn:establish-subscription/sn:output" {
description
"This augmentation allows MSO specific parameters to be
exposed for a subscription.";
uses message-observation-domain-ids;
}
}
<CODE ENDS>
11. IANA Considerations
This document registers the following namespace URI in the IETF XML
Registry [RFC3688]:
URI: urn:ietf:params:xml:ns:yang:ietf-distributed-notif
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
This document registers the following YANG module in the YANG Module
Names registry [RFC3688]:
Name: ietf-distributed-notif
Namespace: urn:ietf:params:xml:ns:yang:ietf-distributed-notif
Prefix: dn
Reference: RFC XXXX
12. Implementation Status
Note to the RFC-Editor: Please remove this section before publishing.
12.1. Open Source Publisher
INSA Lyon implemented this document for a YANG Push publisher on
UDP-based Transport for Configured Subscriptions
[I-D.ietf-netconf-udp-notif] in an example implementation.
The open source code can be obtained here: [INSA-Lyon-Publisher].
Zhou, et al. Expires 8 January 2024 [Page 10]
Internet-Draft Distributed Notifications July 2023
12.2. Open Source Receiver Library
INSA Lyon implemented this document for a YANG Push receiver on
UDP-based Transport for Configured Subscriptions
[I-D.ietf-netconf-udp-notif] as a library.
The open source code can be obtained here: [INSA-Lyon-Receiver].
12.3. Pmacct Data Collection
The open source YANG push receiver library has been integrated into
the Pmacct open source Network Telemetry data collection.
12.4. Huawei VRP
Huawei implemented this document for a YANG Push publisher on
UDP-based Transport for Configured Subscriptions
[I-D.ietf-netconf-udp-notif] in their VRP platform.
13. Operational Considerations
In Section 2 of [RFC7011] the Observation Domain term has been used
to identify the largest set of Observation Points for which IPFIX
Flow information can be aggregated by a Metering Process which
usually applies to a router line card. Note that, even if the terms
are similar, the concepts are different: indeed, in this case, one
router line card can contain multiple publisher processes.
The Observation Domain ID term, issue from IPFIX [RFC7011], has been
kept, as opposed to create a new term such as Publisher ID, it is
expected that most network node with line cards will contain just one
publisher per line card. In which case, the observation domain (ID)
concepts in IPFIX and in this draft are similar.
14. Security Considerations
The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such
as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
is the secure transport layer, and the mandatory-to-implement secure
transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
is HTTPS, and the mandatory-to-implement secure transport is TLS
[RFC5246].
The NETCONF Access Control Model (NACM) [RFC6536] provides the means
to restrict access particulary for NETCONF or RESTCONF users to a
preconfigured subset of all available NETCONF or RESTCONF protocol
operations and content.
Zhou, et al. Expires 8 January 2024 [Page 11]
Internet-Draft Distributed Notifications July 2023
The new data nodes introduced in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get-config or
notification) to this data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability:
* /subscriptions/subscription/message-observation-domain-ids
The entries in the two lists above will show where subscribed
resources might be located on the publishers. Access control MUST be
set so that only someone with proper access permissions has the
ability to access this resource.
Other Security Considerations is the same as those discussed in
[RFC8639].
15. Contributors
Alexander Clemm
Futurewai
2330 Central Expressway
Santa Clara
California
United States of America
Email: [email protected]
16. Acknowledgements
We thank Kent Watsen, Mahesh Jethanandani, Martin Bjorklund, Tim
Carey, Qin Wu, Robert Wilton, Benoit Claise and Alex Huang Feng for
their constructive suggestions for improving this document.
17. References
17.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
Zhou, et al. Expires 8 January 2024 [Page 12]
Internet-Draft Distributed Notifications July 2023
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246,
DOI 10.17487/RFC5246, August 2008,
<https://www.rfc-editor.org/info/rfc5246>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012,
<https://www.rfc-editor.org/info/rfc6536>.
[RFC7923] Voit, E., Clemm, A., and A. Gonzalez Prieto, "Requirements
for Subscription to YANG Datastores", RFC 7923,
DOI 10.17487/RFC7923, June 2016,
<https://www.rfc-editor.org/info/rfc7923>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard,
E., and A. Tripathy, "Subscription to YANG Notifications",
RFC 8639, DOI 10.17487/RFC8639, September 2019,
<https://www.rfc-editor.org/info/rfc8639>.
[RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications
for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641,
September 2019, <https://www.rfc-editor.org/info/rfc8641>.
17.2. Informative References
Zhou, et al. Expires 8 January 2024 [Page 13]
Internet-Draft Distributed Notifications July 2023
[I-D.ietf-netconf-https-notif]
Jethanandani, M. and K. Watsen, "An HTTPS-based Transport
for YANG Notifications", Work in Progress, Internet-Draft,
draft-ietf-netconf-https-notif-13, 4 November 2022,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
https-notif-13>.
[I-D.ietf-netconf-udp-notif]
Zheng, G., Zhou, T., Graf, T., Francois, P., Feng, A. H.,
and P. Lucente, "UDP-based Transport for Configured
Subscriptions", Work in Progress, Internet-Draft, draft-
ietf-netconf-udp-notif-09, 10 March 2023,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
udp-notif-09>.
[INSA-Lyon-Publisher]
"INSA Lyon, YANG Push publisher example implementation",
<https://github.com/network-analytics/udp-notif-scapy>.
[INSA-Lyon-Receiver]
"INSA Lyon, YANG Push receiver library implementation",
<https://github.com/network-analytics/udp-notif-
c-collector>.
[Paolo-Lucente-Pmacct]
"Paolo Lucente, Pmacct open source Network Telemetry Data
Collection", <https://github.com/pmacct/pmacct>.
[RFC7011] Claise, B., Ed., Trammell, B., Ed., and P. Aitken,
"Specification of the IP Flow Information Export (IPFIX)
Protocol for the Exchange of Flow Information", STD 77,
RFC 7011, DOI 10.17487/RFC7011, September 2013,
<https://www.rfc-editor.org/info/rfc7011>.
Appendix A. Examples
This appendix is non-normative.
A.1. Dynamic Subscription
Figure 2 shows a typical dynamic subscription to the device with
distributed data export capability.
Zhou, et al. Expires 8 January 2024 [Page 14]
Internet-Draft Distributed Notifications July 2023
+-------------+ +-------------+ +-------------+
| Subscriber/ | | Publisher | | Publisher |
| Receiver | | (Master) | | (Agent) |
+-------------+ +------+------+ +------+------+
| | |
| establish-subscription | |
+------------------------------>+ component |
| | subscription |
| RPC Reply: OK, id #22 +-------------->+
| Observation Domain ID [#1,#2] | |
+<------------------------------+ |
| | |
| notif-mesg, id #22 | |
| Observation Domain ID #1 | |
+<------------------------------+ |
| | |
| notif-mesg, id#22 | |
| Observation Domain ID #2 | |
+<----------------------------------------------+
| | |
| modify-subscription (id#22) | |
+------------------------------>+ component |
| | subscription |
| RPC Reply: OK, id #22 +-------------->+
+<------------------------------+ |
| | |
| subscription-modified, id#22 | |
| Observation Domain ID [#1] | |
+<------------------------------+ |
| | |
| notif-mesg, id #22 | |
| Observation Domain ID #1 | |
+<------------------------------+ |
| | |
| | |
+ + +
Figure 2: Call Flow for Dynamic Subscription
A "establish-subscription" RPC request as per [RFC8641] is sent to
the Master with a successful response. An example of using NETCONF:
Zhou, et al. Expires 8 January 2024 [Page 15]
Internet-Draft Distributed Notifications July 2023
<netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<yp:datastore
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
ds:operational
</yp:datastore>
<yp:datastore-xpath-filter
xmlns:ex="https://example.com/sample-data/1.0">
/ex:foo
</yp:datastore-xpath-filter>
<yp:periodic>
<yp:period>500</yp:period>
</yp:periodic>
</establish-subscription>
</netconf:rpc>
Figure 3: "establish-subscription" Request
As the device is able to fully satisfy the request, the request is
given a subscription ID of 22. The response as in Figure 4 indicates
that the subscription is decomposed into two component subscriptions
which will be published by two message Observation Domain ID: #1 and
#2.
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<id
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
22
</id>
<message-observation-domain-id
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications>
1
</message-observation-domain-id>
<message-observation-domain-id
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications>
2
</message-observation-domain-id>
</rpc-reply>
Figure 4: "establish-subscription" Positive RPC Response
Then, both Publishers send notifications with the corresponding piece
of data to the Receiver.
Zhou, et al. Expires 8 January 2024 [Page 16]
Internet-Draft Distributed Notifications July 2023
The subscriber may invoke the "modify-subscription" RPC for a
subscription it previously established. The RPC has no difference to
the single publisher case as in [RFC8641]. Figure 5 provides an
example where a subscriber attempts to modify the period and
datastore XPath filter of a subscription using NETCONF.
<rpc message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<modify-subscription
xmlns=
"urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<id>22</id>
<yp:datastore
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
ds:operational
</yp:datastore>
<yp:datastore-xpath-filter
xmlns:ex="https://example.com/sample-data/1.0">
/ex:bar
</yp:datastore-xpath-filter>
<yp:periodic>
<yp:period>250</yp:period>
</yp:periodic>
</modify-subscription>
</rpc>
Figure 5: "modify-subscription" Request
If the modification is successfully accepted, the "subscription-
modified" subscription state notification is sent to the subscriber
by the Master. The notification, Figure 6 for example, indicates the
modified subscription is decomposed into one component subscription
which will be published by message Observation Domain #1.
Zhou, et al. Expires 8 January 2024 [Page 17]
Internet-Draft Distributed Notifications July 2023
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2007-09-01T10:00:00Z</eventTime>
<subscription-modified
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<id>22</id>
<yp:datastore
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
ds:operational
</yp:datastore>
<yp:datastore-xpath-filter
xmlns:ex="https://example.com/sample-data/1.0">
/ex:bar
</yp:datastore-xpath-filter>
<yp:periodic>
<yp:period>250</yp:period>
</yp:periodic>
<message-observation-domain-id
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notificationss>
1
</message-observation-domain-id>
</subscription-modified>
</notification>
Figure 6: "subscription-modified" Subscription State Notification
A.2. Configured Subscription
Figure 7 shows a typical configured subscription to the device with
distributed data export capability.