-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-ietf-nmop-yang-message-broker-integration-05.xml
1175 lines (961 loc) · 48.3 KB
/
draft-ietf-nmop-yang-message-broker-integration-05.xml
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
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="2"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="info"
docName="draft-ietf-nmop-yang-message-broker-integration-05"
ipr="trust200902">
<front>
<title abbrev="YANG-Push to Message Broker Integration">An Architecture
for YANG-Push to Message Broker Integration</title>
<author fullname="Thomas Graf" initials="T" surname="Graf">
<organization>Swisscom</organization>
<address>
<postal>
<street>Binzring 17</street>
<city>Zurich</city>
<code>8045</code>
<country>Switzerland</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Ahmed Elhassany" initials="A" surname="Elhassany">
<organization>Swisscom</organization>
<address>
<postal>
<street>Binzring 17</street>
<city>Zuerich 8045</city>
<region/>
<code/>
<country>Switzerland</country>
</postal>
<phone/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<date day="19" month="October" year="2024"/>
<area>Operations and Management</area>
<workgroup>NMOP</workgroup>
<abstract>
<t>This document describes the motivation and architecture of a native
YANG-Push notifications and YANG Schema integration into a Message
Broker and YANG Schema Registry.</t>
</abstract>
<note removeInRFC="true">
<name>Discussion Venues</name>
<t>Discussion of this document takes place on the Operations and
Management Area Working Group Working Group mailing list
([email protected]), which is archived at <eref
target="https://mailarchive.ietf.org/arch/browse/nmop/"/>.</t>
<t>Source for this draft and an issue tracker can be found at <eref
target="https://github.com/network-analytics/draft-daisy-kafka-yang-integration/"/>.</t>
</note>
</front>
<middle>
<section anchor="Introduction" title="Introduction">
<t>Nowadays network operators are using <xref
target="RFC7950">YANG</xref> to model their configurations and obtain
YANG modelled data from their networks. It is well understood that plain
text are initially intended for humans and need effort to make it
machine readable due to the lack of semantics. YANG modeled data is
addressing most of these needs.</t>
<t>Increasingly more network operators organizing their data in a <xref
target="Deh22">Data Mesh</xref> where a Message Broker such as <xref
target="Kaf11">Apache Kafka</xref> or <xref
target="Rab07">RabbitMQ</xref> facilitates the exchange of messages
among data processing components like a stream processor to filter,
enrich, correlate or aggregate, or a time series database to store
data.</t>
<t>Even though YANG is intend to ease the handling of data, this promise
has not yet been fulfilled for <xref target="RFC9232">Network
Telemetry</xref>. From subscribing on a YANG datastore, publishing a
YANG modeled notifications message from the network and viewing the data
in a time series database, manual labor, such as obtaining the YANG
schema from the network and creating a transformation or ingestion
specification into a time series database, is needed to make a Message
Broker and its data processing components with YANG notifications
interoparable. Since YANG modules can change over time, for example when
a router is being upgraded to a newer software release, this process
needs to be adjusted contionously, leading often to errors in the data
chain if dependencies are not properly tracked and schema changes
adjusted simultaneously.</t>
<section anchor="Origins_of_YANG_Push" title="Origins of YANG-Push">
<t>With <xref target="RFC3535"/> the IAB set the requirements for
Network Management in 2003. From these requirements <xref
target="RFC6241">NETCONF</xref>, <xref target="RFC5277">NETCONF
Notifications</xref> and <xref target="RFC8040">RESTCONF</xref> have
been defined to configure through <edit-config> and retrieve
operational data through <get> and NETCONF notifications through
<notification> from a YANG datastore on a network node.</t>
<t>With YANG-Push, as defined in <xref target="RFC8639"/>, <xref
target="RFC8640"/> and <xref target="RFC8641"/>, periodical and
on-change subscriptions to the YANG datastore can be dynamically or
statically configured. When notifications are dynamically configured,
messages are published over the initially established NETCONF session,
while when it is statically configured messages are published through
<xref target="I-D.ietf-netconf-https-notif">HTTPS-based</xref> or
<xref target="I-D.ietf-netconf-udp-notif">UDP-based</xref> transport.
<xref section="3.7" sectionFormat="of" target="RFC8641"/> describes
push-update messages where the YANG subscribed data is being
published, where <xref section="2.7" sectionFormat="of"
target="RFC8639"/> describes the subscription state change
notifications where changes in the subscription are being
described.</t>
</section>
<section anchor="Origins_of_Apache_Kafka"
title="Origins of Apache Kafka">
<t><xref target="Kaf11">Apache Kafka</xref> is a Message Broker that
supports producing and consuming messages from so called topics. Each
topic has one or more partitions where messages are replicated or load
balanced to scale out. With the introduction of <xref
target="Con18">Confluent Schema Registry</xref> a topic can contain
one or more subjects. A subject refers to a Schema defining the
structure of the message. The Schema then is used to validate messages
sent through topics and are identified by a Schema ID. The Schema ID
is issued when the Schema is registered to the Confluent Schema
Registry. Once the Schema ID is obtained, it can be prefixed to the
message with a Confluent Schema Registry compatible serializer.
Messages can then be validated against Schema at the producer or at
the consumer from a topic to ensure Schema integrity of the message.
The type of Schema evolution scheme can be defined per subject,
wherever non backward compatibility changes are allowed or not.</t>
</section>
<section anchor="Document_Scope" title="Document Scope">
<t>This document focuses on <xref target="RFC8641">YANG-Push</xref> as
the messaging protocol between the network node and the <xref
target="RFC9232">Network Telemetry</xref> data collection. It
describes the main components and the aimed architecture for deploying
such solution in a production network. Then, it illustrates the
integration of the <xref target="RFC7950"> YANG 1.1</xref> as a schema
modeling language into the Apache Kafka Message Broker and <xref
target="Con18"> Confluent Schema Registry</xref>.</t>
</section>
</section>
<section anchor="Conventions_and_Definitions"
title="Conventions and Definitions">
<t>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
<xref target="RFC2119"/> <xref target="RFC8174"/> when, and only when,
they appear in all capitals, as shown here.</t>
<section anchor="Terminology" title="Terminology">
<t>This document defines the following terms:</t>
<t>Message Broker: is an intermediary software component that
translates messages from the formal messaging protocol of the sender
to the formal messaging protocol of the receiver routed in topics.
Message brokers are elements in Data Mesh where software applications
communicate by exchanging formally-defined messages.</t>
<t>Stream Catalog: provides a single point of access that allows users
to centrally search semantics for information across a Message
Broker.</t>
<t>Additionally it makes use of the terms defined in <xref
target="RFC8639"/>, <xref target="Kaf11">Apache Kafka</xref> and <xref
target="ConDoc18">Confluent Schema Registry Documentation</xref>.</t>
<t>The following terms are used as defined in <xref
target="RFC8639"/>:</t>
<t><list style="symbols">
<t>Publisher</t>
<t>Receiver</t>
<t>Subscription</t>
<t>Subscription ID</t>
<t>Event stream filter</t>
<t>Notification message</t>
</list></t>
<t>The following terms are used as defined in <xref
target="Kaf11">Apache Kafka Message Broker</xref>:</t>
<t><list style="symbols">
<t>Producer</t>
<t>Consumer</t>
<t>Topic</t>
<t>Partition</t>
</list></t>
<t>The following terms are used as defined in <xref
target="ConDoc18">Confluent Schema Registry Documentation</xref>:</t>
<t><list style="symbols">
<t>Schema</t>
<t>Schema ID</t>
<t>Schema Registry</t>
<t>Subject</t>
</list></t>
</section>
</section>
<section anchor="Motivation" title="Motivation">
<t>There are four main objectives for native YANG-Push notifications and
YANG Schema integration into a Message Broker.</t>
<section anchor="Automtaic_Onboarding" title="Automatic Onboarding">
<t>Automate the Data Mesh onboarding of newly subscribed YANG
metrics.</t>
</section>
<section anchor="Preserve_Schema" title="Preserve Schema">
<t>The preservation of the YANG schema, that includes the YANG data
types as defined in <xref target="RFC6991"/> and the nested structure
of the YANG module, throughout the data processing chain ensures that
metrics can be processed and visualized as they were originally
intended. Not only for users but also for automated closed loop
operation actions.</t>
</section>
<section anchor="Preserve_Semantic_Information"
title="Preserve Semantic Information">
<t><xref target="RFC7950"/> defines in Section 7.21.3 and 7.21.4 the
description and reference statement. This information is intended for
the user, describing in a human-readable fashion the meaning of a
definition. In Data Mesh, this information can be imported from the
YANG Schema Registry into a Stream Catalog where subjects within
Message Broker are identifiable and searchable. An example of a Stream
Catalog is <xref target="Atl15">Apache Atlas</xref>. It can also be
applied for time series data visualization in a similar fashion.</t>
</section>
<section anchor="Standardize_Data_Processing_Integration"
title="Standardize Data Processing Integration">
<t>Since the YANG Schema is preserved for operational metrics in the
Message Broker, a standardization for integration between network data
collection and stream processor or time series database is
implied.</t>
</section>
</section>
<section anchor="Elements_of_the_Architecture"
title="Elements of the Architecture">
<t>The architecture consists of 6 elements. <xref
target="workflow_diagram"/> gives an overview on the workflow.</t>
<figure anchor="workflow_diagram" title="End to End Workflow">
<artwork align="center"><![CDATA[
+------------------------------------------------------------+
| Data Storage |
+------------------------------------------------------------+
^
| (12) Ingest Data
| According to Schema
+------------------------------------------------------------+
| Data Consumer |
+------------------------------------------------------------+
(10) Get | ^ ^ (9) Validate
Schema | | | Serialized Message
| | | Schema on Consumer
| | |
| | +--------------------+
| | | Message |
| | | Broker |
| | +--------------------+
| | |
| | (11) Issue | (8) Serialize
| | | YANG-Push Message
| | | annotated Schema
v | Schema (6) Post | ID on Producer
+--------------------+ Schema +--------------------+
| YANG | <-------------- | Data Collection |
| Schema Registry | --------------> | YANG-Push Receiver |
+--------------------+ (7) Issue +--------------------+
Schema ID (4) Get | ^ (3) Receive
Schema | | YANG-Push
| | Subscription
| | Start Message
| | ^
| | |
| | | (5) Publish
| | | YANG-Push
| | | Message
| | | with
(1) Discover Notif. v | | Subscr. ID
+--------------------+ Capabilities +--------------------+
| Manage YANG-Push | ---------------> | Network Node |
| Subscription | (2) Subscribe | YANG-Push Publisher|
+--------------------+ ---------------> +--------------------+
]]></artwork>
</figure>
<t>The <xref target="workflow_diagram">workflow diagram</xref> describes
the steps from establishing the YANG-Push subscription to Data Storage
ingestion.</t>
<section anchor="YANG_Push_Subscription" title="YANG-Push Subscription">
<t>With step number (1) in the workflow diagram, the YANG-Push
notification transport capabilities are being discovered according to
<xref target="I-D.netana-netconf-yp-transport-capabilities"/>,
notification capabilities according to <xref
target="I-D.netana-netconf-notif-envelope"/> and notification subscription
capabilities according to <xref section="3" sectionFormat="of"
target="RFC9196"/>, in with step (2) a YANG-Push subscription is
according to Section 2.4 and 2.5 of <xref target="RFC8639"/>
dynamically or statically configured, and with step (3) subscription
state change notifications are sent according to section 2.7 from the
YANG-Push publisher to the receiver to inform which event stream filter
has been applied to which subscription ID.</t>
<t>When the YANG-Push subscription is managed dynamically, the YANG
data is being received on the same NETCONF session where the
subscription is being maintained. With configured subscription the
YANG data is sent to the YANG-Push receiver through a separate
transport session.</t>
<t><xref target="I-D.ietf-netconf-yang-notifications-versioning"/>
adds the capability to subscribe to a specific YANG module revision or
a YANG module which needs to be backward compatible to in step (2) and
adds the module name, revision and revision-label information into the
subscription state change notifications in step (3).</t>
<t><xref
target="netconf_edit_config_establish_subscription_example_xml_fig"/>
provides and example how to create a YANG-Push configured subscription
with NETCONF in XML <xref target="W3C.REC-xml-20081126"/> with
UDP-based <xref target="I-D.ietf-netconf-udp-notif"/> transport</t>
<figure anchor="netconf_edit_config_establish_subscription_example_xml_fig"
title="NETCONF Example to establish configured subscription">
<artwork><![CDATA[
========== NOTE: '\' line wrapping per RFC 8792) ===========
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config>
<subscriptions xmlns="urn:ietf:params:xml:ns:yang:ietf\
-subscribed-notifications">
<subscription>
<id>6666</id>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf\
-yang-push"
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf\
-datastores">ds:operational</datastore>
<datastore-xpath-filter xmlns="urn:ietf:params:xml:ns\
:yang:ietf-yang-push"
xmlns:if="urn:ietf:params:xml:ns:yang:ietf-inter\
faces">/if:interfaces</datastore-xpath-filter>
<revision xmlns="urn:ietf:params:xml:ns:yang:ietf-yang\
-push-revision">2018-02-20</revision>
<transport xmlns:unt="urn:ietf:params:xml:ns:yang:ietf\
-udp-notif-transport">unt:udp-notif</transport>
<encoding>encode-json</encoding>
<receivers>
<receiver>
<name>subscription-specific-receiver-def</name>
<receiver-instance-ref xmlns="urn:ietf:params:xml\
:ns:yang:ietf-subscribed-notif-receivers">\
global-udp-notif-receiver-def</receiver-instance-ref>
</receiver>
</receivers>
<periodic xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<period>6000</period>
</periodic>
</subscription>
<receiver-instances xmlns="urn:ietf:params:xml:ns:yang:ietf\
-subscribed-notif-receivers">
<receiver-instance>
<name>global-udp-notif-receiver-def</name>
<udp-notif-receiver xmlns="urn:ietf:params:xml:ns:yang\
:ietf-udp-notif-transport">
<address>192.0.5.1</address>
<port>12345</port>
<enable-segmentation>false</enable-segmentation>
<max-segment-size/>
</udp-notif-receiver>
</receiver-instance>
</receiver-instances>
</subscriptions>
</config>
</edit-config>
</rpc>
]]></artwork>
</figure>
<t><xref target="subscription_started_notif_example_json_fig"/>
provides an example of a JSON encoded, <xref target="RFC7951"/>,
subscription-started state change notification message over
HTTPS-based <xref target="I-D.ietf-netconf-https-notif"/> or UDP-based
<xref target="I-D.ietf-netconf-udp-notif"/> transport with <xref
target="I-D.netana-netconf-notif-envelope"/>, <xref
target="I-D.tgraf-netconf-yang-push-observation-time"/> and <xref
target="I-D.ietf-netconf-yang-notifications-versioning"/> as
extensions for the same subscription.</t>
<figure anchor="subscription_started_notif_example_json_fig"
title="JSON YANG-Push Example for a subscription-started notification message">
<artwork><![CDATA[
{
"ietf-yp-notification:envelope": {
"event-time": "2023-03-25T08:30:11.22Z",
"hostname": "example-router",
"sequence-number": 1,
"notification-contents": {
"ietf-subscribed-notification:subscription-started": {
"id": 6666,
"ietf-yang-push:datastore": "ietf-datastores:operational",
"ietf-yang-push:datastore-xpath-filter": "/if:interfaces",
"ietf-yang-push-revision:revision": "2014-05-08",
"ietf-yang-push-revision:module-name": "ietf-interfaces",
"ietf-yang-push-revision:revision-label": "",
"ietf-distributed-notif:message-publisher-ids": [1,2],
"transport": "ietf-udp-notif-transport:udp-notif",
"encoding": "encode-json",
"ietf-yang-push:periodic": {
"ietf-yang-push:period": 100
}
}
}
}
}
]]></artwork>
</figure>
</section>
<section anchor="YANG_Push_Publisher" title="YANG-Push Publisher">
<t>With step number (4) in the workflow diagram, a YANG-Push
push-update or push-change-update message, depending on wherever
periodical or on-change subscription has been established, is sent
from the YANG-Push publisher to the receiver according to <xref
section="3.7" sectionFormat="of" target="RFC8639"/>.</t>
<t><xref target="I-D.netana-netconf-notif-envelope"/> defines the
YANG-Push notification header in YANG with event-time, hostname
and sequence-number to enable a YANG data consumer to recognize
with the hostname from which network node the message was
published from and with sequence-number message reordering or
loss.</t>
<t><xref target="I-D.ietf-netconf-distributed-notif"/> adds a
message-publisher-id for network nodes with
distributed architecture where multiple YANG-Push publishing
processes are publishing messages. The message-publisher-id enables
a YANG data consumer to recognize from which YANG-Push publisher
process the message was published from.</t>
<t><xref target="I-D.tgraf-netconf-yang-push-observation-time"/> adds
observation timestamp and point-in-time in the YANG-Push push-update
or push-change-update message. observation timestamp contains the
timestamp and point-in-time when the metrics where observed. See <xref
section="3" sectionFormat="of"
target="I-D.tgraf-netconf-yang-push-observation-time"/> for more
details.</t>
<t><xref target="push_update_notif_example_json_fig"/> provides an
example of a JSON encoded, <xref target="RFC7951"/>, push-update
notification message over HTTPS-based <xref
target="I-D.ietf-netconf-https-notif"/> or UDP-based <xref
target="I-D.ietf-netconf-udp-notif"/> transport with <xref
target="I-D.netana-netconf-notif-envelope"/> and <xref
target="I-D.tgraf-netconf-yang-push-observation-time"/> as extensions
for the same subscription.</t>
<figure anchor="push_update_notif_example_json_fig"
title="JSON YANG-Push Example for a push-update notification message">
<artwork><![CDATA[
========== NOTE: '\' line wrapping per RFC 8792) ===========
{
"ietf-yp-notification:envelope": {
"event-time": "2023-03-25T08:30:11.22Z",
"hostname": "example-router",
"sequence-number": 1,
"notification-contents": {
"ietf-yang-push:push-update": {
"id": 6666,
"ietf-yp-observation:timestamp": \
"2023-03-25T08:30:11.22Z",
"ietf-yp-observation:point-in-time": \
"current-accounting",
"datastore-contents": {
"ietf-interfaces:interfaces": [
{
"interface": {
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"oper-status": "up",
"mtu": 1500
}
}
}
]
}
}
}
}
]]></artwork>
</figure>
<t><xref target="push_change_update_notif_example_json_fig"/> provides
an example of a JSON encoded, <xref target="RFC7951"/>,
push-change-update notification message over HTTPS-based <xref
target="I-D.ietf-netconf-https-notif"/> or UDP-based <xref
target="I-D.ietf-netconf-udp-notif"/> transport with <xref
target="I-D.netana-netconf-notif-envelope"/> and <xref
target="I-D.tgraf-netconf-yang-push-observation-time"/> as extensions
for the same subscription.</t>
<figure anchor="push_change_update_notif_example_json_fig"
title="JSON YANG-Push Example for a push-change-update notification message">
<artwork><![CDATA[
========== NOTE: '\' line wrapping per RFC 8792) ===========
{
"ietf-yp-notification:envelope": {
"event-time": "2023-03-25T08:30:11.22Z",
"hostname": "example-router",
"sequence-number": 1,
"notification-contents": {
"ietf-yang-push:push-change-update": {
"id": 2222,
"ietf-yp-observation:timestamp": \
"2023-03-25T08:30:11.22Z",
"ietf-yp-observation:point-in-time": \
"state-changed",
"datastore-contents": {
"yang-patch": {
"patch-id": "patch_54",
"comment": "Changing encoding to JSON and increasing \
the period to 10 minutes",
"edit": [
{
"edit-id": "id_change_1",
"operation": "merge",
"target": "/ietf-subscribed-notifications\:subs\
criptions/subscription[id=2222]",
"value": {
"ietf-subscribed-notifications:encoding": \
"ietf-subscribed-notifications:encode-json",
"ietf-yang-push:periodic": {
"period": 60000
}
}
}
}
]
}
}
}
}
}
]]></artwork>
</figure>
</section>
<section anchor="YANG_Push_Receiver" title="YANG-Push Receiver">
<t>For all the YANG modules and revisions of each sysName and
subscription ID in the subscription state change notification received
in step number (3) in the workflow diagram, all the YANG module
dependencies need to be determined through the <xref
target="RFC8525">YANG Library</xref>, and then through NETCONF
<get-schema> rpc calls according to <xref target="RFC6022"/> all
YANG modules need to be retrieved as described in step (4) in the
workflow diagram.</t>
<t><xref target="I-D.lincla-netconf-yang-library-augmentation"/>
extends the YANG Library so that not only the submodule but also the
augmentation list can be obtained.</t>
<t>Figure 9 in Section 4.1 and YANG module in Section 5 of <xref
target="RFC8641"/> defines the payload of YANG-push notifications
where "datastore-contents" or the "value" of a "push-change-update")
is "anydata". <xref target="RFC7950"/> Section 7.10 states that
anydata represents an unknown set of nodes that can be modeled with
YANG, and the model is not known at design time and that the model of
the unknown set of nodes can be signaled through another protocol.
This poses and issue in the schema validation of YANG-Push
notifications and will be further clarified in point number (1) and
(2) in <xref target="Open_Points"/>.</t>
</section>
<section anchor="YANG_Schema_Registry" title="YANG Schema Registry">
<t>The schema registry SHOULD support YANG as the format for defining
schema. For each schema registered into the schema registry, a schema
ID is returned. That schema ID can be used when interacting with the
Message Broker to indicate the schema to use with the
message.”</t>
<t>Confluent Schema Registry is pluggable. Currently Supports AVRO,
JSON Schema and Protobuf. The YANG support is being developed at <xref
target="Yak24"/> as part of this architecture. Enable to register,
obtain and compare <xref target="YSR24"/> YANG Schemas. One YANG
Schema with all its augmentations is being registered per YANG-Push
subscription ID. for each YANG Schema a locally significant Schema ID
is being issued as described in step (7) in the workflow diagram.</t>
<figure anchor="YSR_post_ietf-interfaces"
title="Register ietf-interfaces.yang into YANG Schema Registry">
<artwork><![CDATA[
curl -X POST -H "Content Type: application/vnd.schemaregistry.v1+json"
http://localhost:8081/subjects/ietf-interfaces/
]]></artwork>
</figure>
<figure anchor="YSR_list_all_subjects"
title="List all subjects YANG Schema Registry">
<artwork align="left"><![CDATA[
curl http://localhost:8081/subjects/ subjects/ | jq
]]></artwork>
</figure>
<figure anchor="YSR_list_versions_of_a_subject"
title="List versions of a given subject in YANG Schema Registry">
<artwork><![CDATA[
curl http://localhost:8081/subjects/ietf-interfaces/versions
]]></artwork>
</figure>
<figure anchor="YSR_retrieve_schema_of_subject_version"
title="Retrieve schema of a specific subject and version in YANG Schema Registry">
<artwork><![CDATA[
curl http://localhost:8081/subjects/ietf-interfaces/versions/1
]]></artwork>
</figure>
</section>
<section anchor="YANG_Message_Broker_Producer"
title="YANG Message Broker Producer">
<t>The previously issued Schema ID is prefixed to the previously in
<xref target="YANG_Push_Receiver"/> described metadata augmented YANG
push push-update message and serialized to a Message Broker topic in
step (8) of the workflow diagram.</t>
</section>
<section anchor="YANG_Message_Broker_Consumer"
title="YANG Message_Broker Consumer">
<t>From the Message Broker topic the message is being consumed and the
prefixed Schema ID is being used in step (10) of the workflow diagram
to retrieve the YANG Schema to validate the Schema integrity of the
message.</t>
<t>In order to valida Schema integrity, the event stream filter of the
subscription ID in the subscription started or modified message is
needed to apply <xref target="I-D.aelhassany-anydata-validation"/> on
the YANG schema tree.</t>
</section>
<section anchor="YANG_Data_Consumer" title="YANG Data Consumer">
<t>The data storage ingestion specifications are being derived with
the in <xref target="YANG_Message_Broker_Consumer"/> already retrieved
Schema ID and YANG-Push push-update messages can be now ingested and
indexed into the data storage table according to their schema in step
(12).</t>
</section>
<section anchor="YANG_Data_Storage" title="YANG Data Storage">
<t>The YANG data is being ingested in step (12)according to the
previously defined ingestion specification and indexed with the
timestamp defined in observation timestamp as defined in <xref
target="I-D.tgraf-netconf-yang-push-observation-time"/>. A network
operator is now able to query the previously subscribed YANG data.</t>
</section>
</section>
<section anchor="Implementation" title="Implementation Status">
<t>Note to the RFC-Editor: Please remove this section before
publishing.</t>
<t>This section records the status of known implementations of the
protocol defined by this specification at the time of posting of this
Internet-Draft, and is based on a proposal described in <xref
target="RFC7942"/>. The description of implementations in this section
is intended to assist the IETF in its decision processes in progressing
drafts to RFCs. Please note that the listing of any individual
implementation here does not imply endorsement by the IETF. Furthermore,
no effort has been spent to verify the information presented here that
was supplied by IETF contributors. This is not intended as, and must not
be construed to be, a catalog of available implementations or their
features. Readers are advised to note that other implementations may
exist.</t>
<t>According to <xref target="RFC7942"/>, "this will allow reviewers and
working groups to assign due consideration to documents that have the
benefit of running code, which may serve as evidence of valuable
experimentation and feedback that have made the implemented protocols
more mature. It is up to the individual working groups to use this
information as they see fit".</t>
<section anchor="YANG_Schema_Registry_Extension"
title="YANG Schema Registry Extension">
<t>Ahmed Elhassany is developing a YANG Schema Extension in Confluent
Schema Registry.</t>
<t>The source code can be obtained here: <xref target="YSR24"/>, the
progress report here: <xref target="YSRPR24"/>, and was validated at
the IETF 117 hackathon.</t>
</section>
<section anchor="YANG-Push_Receiver_Parsing_Library"
title="YANG-Push Receiver Parsing Library">
<t>Zhuoyao Lin developed as part of her internship a library to parse
YANG-Push subscription notifications, identify YANG module
dependencises with <xref target="RFC8525">YANG Library</xref> and
obtain with NETCONF <get-schema> rpc calls <xref
target="RFC6022"/> all YANG modules from YANG-Push publisher.</t>
<t>The source code can be obtained here: <xref target="LYP23"/> and
was validated at the IETF 117 hackathon.</t>
</section>
<section anchor="YANG-Library_Augmented-by-Addition"
title="YANG Library Augmented-by Addition">
<t>Zhuoyao Lin implemented <xref
target="I-D.lincla-netconf-yang-library-augmentation"/> in order to
discover augmented-by YANG modules in <xref target="RFC8525">YANG
Library</xref>.</t>
<t>The source code can be obtained here: <xref target="YLA24"/> and
was validated at the IETF 119 hackathon.</t>
</section>
</section>
<section anchor="Security" title="Security Considerations">
<t>TBD</t>
</section>
<section anchor="Acknowledgements" title="Acknowledgements">
<t>The authors would like to thank Yannick Buchs, Benoit Claise, Mohamed
Boucadair, Dhruv Dhody, Qin Wu, Andy Bierman, Feng Chong, Holger Keller,
Kristian Larsson and Ignacio Dominguez Martinez-Casanueva for their
review and valuable comments. Alex Huang Feng, Jean Quilbeuf and huoyao
Lin for review and contributing code and providing examples and inputs
to the open points.</t>
</section>
</middle>
<back>
<references title="Normative References">
<?rfc include='reference.RFC.2119'?>
<?rfc include='reference.RFC.6022'?>
<?rfc include='reference.RFC.7950'?>
<?rfc include='reference.RFC.8174'?>
<?rfc include='reference.RFC.8639'?>
<?rfc include='reference.RFC.8641'?>
<?rfc include='reference.RFC.8792'?>
<?rfc include='reference.RFC.9196'?>
<?rfc include='reference.RFC.9254'?>
<?rfc include='reference.I-D.netana-netconf-notif-envelope'?>
<?rfc include='reference.I-D.tgraf-netconf-yang-push-observation-time'?>
<?rfc include='reference.I-D.ietf-netconf-yang-notifications-versioning'?>
<?rfc include='reference.I-D.netana-netconf-yp-transport-capabilities'?>
<?rfc include='reference.I-D.lincla-netconf-yang-library-augmentation'?>
<?rfc include='reference.I-D.aelhassany-anydata-validation'?>
</references>
<references title="Informative References">
<?rfc include='reference.RFC.3535'?>
<?rfc include='reference.RFC.5277'?>
<?rfc include='reference.RFC.6241'?>
<?rfc include='reference.RFC.6991'?>
<?rfc include='reference.RFC.7942'?>
<?rfc include='reference.RFC.7951'?>
<?rfc include='reference.RFC.8040'?>
<?rfc include='reference.RFC.8525'?>
<?rfc include='reference.RFC.8640'?>
<?rfc include='reference.RFC.9232'?>
<?rfc include='reference.I-D.ietf-netconf-https-notif'?>
<?rfc include='reference.I-D.ietf-netconf-udp-notif'?>
<?rfc include='reference.I-D.ietf-netconf-distributed-notif'?>
<reference anchor="W3C.REC-xml-20081126"
derivedAnchor="W3C.REC-xml-20081126" quoteTitle="true"
target="https://www.w3.org/TR/2008/REC-xml-20081126">
<front>
<title>Extensible Markup Language (XML) 1.0 (Fifth Edition)</title>
<author fullname="Tim Bray" initials="T." surname="Bray">
<organization showOnFrontPage="true"/>
</author>
<author fullname="Jean Paoli" initials="J." surname="Paoli">
<organization showOnFrontPage="true"/>
</author>
<author fullname="Michael Sperberg-McQueen" initials="M."
surname="Sperberg-McQueen">
<organization showOnFrontPage="true"/>
</author>
<author fullname="Eve Maler" initials="E." surname="Maler">
<organization showOnFrontPage="true"/>
</author>
<author fullname="Francois Yergeau" initials="F." surname="Yergeau">
<organization showOnFrontPage="true"/>
</author>
<date month="November" year="2008"/>
</front>
<refcontent>World Wide Web Consortium Recommendation
REC-xml-20081126</refcontent>
</reference>
<reference anchor="Deh22"
target="https://www.oreilly.com/library/view/data-mesh/9781492092384/">
<front>
<title>Data Mesh</title>
<author fullname="Zhamak Dehghani" initials="Z." surname="Dehghani"/>
<date month="March" year="2022"/>
</front>
<seriesInfo name="ISBN" value="9781492092391"/>
<refcontent>O'Reilly Media</refcontent>
</reference>
<reference anchor="Rab07" target="https://rabbitmq.com/">
<front>
<title>RabbitMQ</title>
<author fullname="VMware"/>
<date month="February" year="2007"/>
</front>
<refcontent>Mozilla Public License</refcontent>
</reference>
<reference anchor="Atl15" target="https://atlas.apache.org/">
<front>
<title>Apache Atlas</title>
<author fullname="Hortonworks"/>
<date month="May" year="2015"/>
</front>
<refcontent>Apache Software Foundation</refcontent>
</reference>
<reference anchor="YSR24"
target="https://github.com/confluentinc/schema-registry-yang-format/">
<front>
<title>YANG Schema Registry Extension</title>
<author fullname="Ahmed Elhassany" initials="A." surname="Elhassany"/>
<date month="February" year="2024"/>
</front>
<refcontent>Apache Software Foundation</refcontent>
</reference>
<reference anchor="YSRPR24"
target="https://github.com/network-analytics/draft-daisy-kafka-yang-integration/blob/main/YANG%20Schema%20registry%20integration.pdf">
<front>
<title>YANG Schema Registry Extension Progress Report</title>
<author fullname="Ahmed Elhassany" initials="A." surname="Elhassany"/>
<date month="February" year="2024"/>
</front>
</reference>
<reference anchor="LYP23"
target="https://github.com/network-analytics/libyangpush/">
<front>
<title>libyangpush</title>
<author fullname="Zhuoyao Lin" initials="Z." surname="Lin"/>
<date month="September" year="2023"/>
</front>
<refcontent>Apache Software Foundation</refcontent>
</reference>
<reference anchor="YLA24"
target="https://github.com/Zephyre777/draft-lincla-netconf-yang-library-augmentation/">
<front>
<title>libyangpush</title>
<author fullname="Zhuoyao Lin" initials="Z." surname="Lin"/>
<date month="March" year="2024"/>
</front>
<refcontent>Apache Software Foundation</refcontent>
</reference>
<reference anchor="Yak24"
target="https://github.com/yang-central/yangkit/">
<front>
<title>Yangkit</title>
<author fullname="Frank Feng" initials="F." surname="Feng"/>
<date month="February" year="2024"/>
</front>
<refcontent>Apache Software Foundation</refcontent>
</reference>
<reference anchor="Kaf11" target="https://kafka.apache.org/">
<front>
<title>Apache Kafka</title>
<author fullname="Neha Narkhede" initials="N." surname="Narkhede"/>
<date month="January" year="2011"/>
</front>
<refcontent>Apache Software Foundation</refcontent>
</reference>
<reference anchor="Con18"
target="https://github.com/confluentinc/schema-registry/">
<front>
<title>Confluent Schema Registry</title>
<author fullname="Robert Yokota" initials="R." surname="Yokota"/>
<date month="December" year="2018"/>
</front>