This repository has been archived by the owner on Mar 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-tgraf-netconf-yang-notifications-versioning-02.xml
810 lines (692 loc) · 32.4 KB
/
draft-tgraf-netconf-yang-notifications-versioning-02.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
<?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="std"
docName="draft-tgraf-netconf-yang-notifications-versioning-02"
ipr="trust200902">
<front>
<title abbrev="YANG Notifications Versioning">Support of Versioning in
YANG Notifications Subscription</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="Benoit Claise" initials="B" surname="Claise">
<organization>Huawei</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<author fullname="Alex Huang Feng" initials="A." surname="Huang Feng">
<organization>INSA-Lyon</organization>
<address>
<postal>
<street/>
<city>Lyon</city>
<region/>
<code/>
<country>France</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<date day="14" month="January" year="2023"/>
<abstract>
<t>This document extends the YANG notifications subscription mechanism
to specify the YANG module semantic version at the subscription. Then, a
new extension with the revision and the semantic version of the YANG
push subscription state change notification is proposed.</t>
</abstract>
<note title="Requirements Language">
<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>
</note>
</front>
<middle>
<section anchor="Introduction" title="Introduction">
<t>In order to process the received YANG push notification messages
described in section 3.7 of <xref target="RFC8641"/> at the YANG push
receiver, a semantic reference to the YANG module and the XPath or
subtree is needed to determine the data types for each field and which
part of the YANG module the metrics are expose from.</t>
<t>This specification applies to the YANG push configured subscriptions
defined in Section 2.5 of <xref target="RFC8639"/>, where a publisher is
configured to stream notification out of band, as opposed to dynamic
subscriptions defined in Section 2.4 of <xref target="RFC8639"/>, where
the subscriber can initiate and modify the subscription dynamically
in-band. In the latter case, the subscriber knows already all the
subscriber YANG-related information, which it has to know in order to
configure the subscription.</t>
<t>This semantic reference is available when the subscription is being
establish as described in Section 3.6 of <xref target="RFC8641"/> and
being streamed from the publisher to receiver with the subscription
state change notifications described in Section 2.7 of <xref
target="RFC8639"/> where for each subscription a locally unique
subscription ID described in Section 4.3.2 of <xref target="RFC8641"/>
is being issued and streamed as metadata with the notification message
in the YANG push message header.</t>
<t>The semantics can change between different YANG module revisions. The
YANG module version statement is specified in Section 7.1.2 of <xref
target="RFC6020"/> and states that the newer revision needs to be
backward compatible to the previous revision. Section 3.1 of <xref
target="I-D.ietf-netmod-yang-module-versioning"/> specifies that newer
semantic versions introduced in <xref
target="I-D.ietf-netmod-yang-semver"/> MAY not be backward compatible to
the previous version when indicated with non-backwards-compatible
keyword.</t>
<t>The YANG notifications subscription mechanism defined in <xref
target="RFC8641"/> does not allow to specify the YANG module revision.
When a network node is upgraded, the subscribed YANG module revision MAY
have updated and might, consequently, break the data processing pipeline
since the YANG push receiver may not be aware of this change.</t>
<t>This documents extends the current YANG notifications subscription
mechanism to allow to subscribe to a specific revision or latest YANG
module semantic version to which the YANG module version needs to be
backward compatible to. The subscription state change
"subscription-started" and "subscription-modified" notification messages
are also extended to include the revision and semantic version.</t>
</section>
<section anchor="Datastore-Selection"
title="Extend the Datastore Selection">
<t>The YANG notifications subscription OPTIONALLY can be restricted to
the following YANG module revision for future capabilities:</t>
<dl>
<dt>latest:</dt>
<dd>Restricts the subscription to the latest YANG module
revision.</dd>
</dl>
<dl>
<dt>revision:</dt>
<dd>Restricts the subscription to a specific YANG module revision.
Example: "2014-05-08".</dd>
</dl>
<dl>
<dt>latest-compatible-semversion:</dt>
<dd>Restricts the subscription to the latest compatible YANG module
semantic version referenced to. Example: "2.0.0".</dd>
</dl>
<t>If nothing is specified, latest YANG module version is implied.</t>
</section>
<section anchor="Streaming-Update"
title="Extend the Subscription State Change Notifications">
<t>Besides the Subscription ID and the xpath or sub-tree filter
reference as described in Section 2.7 of <xref target="RFC8639"/>, the
following metadata objects are part of a "subscription-started" or
"subscription-modified" subscription state change notification.</t>
<dl>
<dt>revision:</dt>
<dd>Describes the YANG module revision as specified in Section 7.1.9
of <xref target="RFC6020"/> for the related streamed content.</dd>
</dl>
<dl>
<dt>revision-label:</dt>
<dd>Describes the YANG module semantic version as specified in <xref
target="I-D.ietf-netmod-yang-semver"/> for the related streamed
content.</dd>
</dl>
<t><xref target="subscription_modified_example_xml_fig"/> provides an
example of a "subscription-modified" subscription state change
notification message with the YANG revision, revision label and
datastore-xpath-filter for tracking the operational status of a single
Ethernet interface (per <xref target="RFC8343"/>). This subscription
state change notification message is encoded XML <xref
target="W3C.REC-xml-20081126"/> over the Network Configuration Protocol
(NETCONF) as per <xref target="RFC8640"/>.</t>
<figure anchor="subscription_modified_example_xml_fig"
title="XML Push Example for a subscription-modified notification message">
<artwork><![CDATA[
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2023-01-03T10:00:00Z</eventTime>
<subscription-modified
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<id>101</id>
<revision>2014-05-08</revision>
<revision-label>1.0.0</revision-label>
<stream-xpath-filter xmlns:int="urn:ietf:params:xml:ns:yang:ietf-interfaces">
/int:interfaces
</stream-xpath-filter>
<stream>NETCONF</stream>
</subscription-modified>
</notification>
]]></artwork>
</figure>
<t><xref target="subscription_modified_example_json_fig"/> provides an
example of a JSON encoded, <xref target="RFC8259"/>, subscription 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 for the same
subscription.</t>
<figure anchor="subscription_modified_example_json_fig"
title="JSON Push Example for a subscription-modified notification message">
<artwork><![CDATA[
{
"ietf-restconf:notification" : {
"eventTime": "2023-01-03T10:00:00Z",
"ietf-subscribed-notifications:subscription-modified": {
"id": 101,
"revision": "2014-05-08",
"revision-label": "1.0.0",
"stream-xpath-filter": "/ietf-interfaces:interfaces",
"stream": {
"ietf-netconf-subscribed-notifications" : "NETCONF"
}
}
}
}
]]></artwork>
</figure>
</section>
<section anchor="YANG-push-revision-module"
title="The "ietf-yang-push-revision" Module">
<section anchor="YANG-revision-model" title="Data Model Overview">
<t>This YANG module augments the "ietf-yang-push" module with the
revision and revision-label in the "subscription-started" and
"subscription-modified" subscription state change notifications and
the ability to define the "revision" and "revision-label" in the
"establish-subscription" and "modify-subscription" RPCs in the
datastore push subscription.</t>
<section anchor="Tree View" title="Tree View">
<t>The following is the YANG tree diagram <xref target="RFC8340"/>
for the ietf-yang-push-revision YANG module</t>
<t><figure>
<artwork><![CDATA[
module: ietf-yang-push-revision
augment /sn:establish-subscription/sn:input/sn:target:
+--rw revision? rev:revision-date-or-label
+-- revision-label? ysver:version
augment /sn:modify-subscription/sn:input/sn:target:
+--rw revision? rev:revision-date-or-label
+-- revision-label? ysver:version
augment /sn:subscription-started/sn:target:
+--ro revision rev:revision-date-or-label
+-- revision-label? ysver:version
augment /sn:subscription-modified/sn:target:
+--ro revision rev:revision-date-or-label
+-- revision-label? ysver:version
augment /sn:subscriptions/sn:subscription/sn:target:
+--ro revision rev:revision-date-or-label
+--rw revision-label? ysver:version
]]></artwork>
</figure></t>
</section>
<section anchor="Full Tree View" title="Full Tree View">
<t>The following is the YANG tree diagram <xref target="RFC8340"/>
for the ietf-yang-push-revision augmentation within the
ietf-subscribed-notifications, including the RPCs and
notifications.</t>
<t><figure>
<artwork><![CDATA[
pyang -f tree ietf-yang-push-revision.yang ietf-yang-revisions.yang [email protected]
ietf-yang-push-revision.yang:118 (at ietf-yang-push-revision.yang:88): error: cannot augment with mandatory node "revision"
module: ietf-subscribed-notifications
+--ro streams
| +--ro stream* [name]
| +--ro name string
| +--ro description? string
| +--ro replay-support? empty {replay}?
| +--ro replay-log-creation-time yang:date-and-time {replay}?
| +--ro replay-log-aged-time? yang:date-and-time {replay}?
+--rw filters
| +--rw stream-filter* [name]
| +--rw name string
| +--rw (filter-spec)?
| +--:(stream-subtree-filter)
| | +--rw stream-subtree-filter? <anydata> {subtree}?
| +--:(stream-xpath-filter)
| +--rw stream-xpath-filter? yang:xpath1.0 {xpath}?
+--rw subscriptions
+--rw subscription* [id]
+--rw id subscription-id
+--rw (target)
| +--:(stream)
| | +--rw (stream-filter)?
| | | +--:(by-reference)
| | | | +--rw stream-filter-name stream-filter-ref
| | | +--:(within-subscription)
| | | +--rw (filter-spec)?
| | | +--:(stream-subtree-filter)
| | | | +--rw stream-subtree-filter? <anydata> {subtree}?
| | | +--:(stream-xpath-filter)
| | | +--rw stream-xpath-filter? yang:xpath1.0 {xpath}?
| | +--rw stream stream-ref
| | +--ro replay-start-time? yang:date-and-time {replay}?
| | +--rw configured-replay? empty {configured,replay}?
| +--:(ypm:revision)
| | +--ro ypm:revision rev:revision-date-or-label
| +--:(ypm:revision-label)
| +--rw ypm:revision-label? ysver:version
+--rw stop-time? yang:date-and-time
+--rw dscp? inet:dscp {dscp}?
+--rw weighting? uint8 {qos}?
+--rw dependency? subscription-id {qos}?
+--rw transport? transport {configured}?
+--rw encoding? encoding
+--rw purpose? string {configured}?
+--rw (notification-message-origin)? {configured}?
| +--:(interface-originated)
| | +--rw source-interface? if:interface-ref {interface-designation}?
| +--:(address-originated)
| +--rw source-vrf? -> /ni:network-instances/network-instance/name {supports-vrf}?
| +--rw source-address? inet:ip-address-no-zone
+--ro configured-subscription-state? enumeration {configured}?
+--rw receivers
+--rw receiver* [name]
+--rw name string
+--ro sent-event-records? yang:zero-based-counter64
+--ro excluded-event-records? yang:zero-based-counter64
+--ro state enumeration
+---x reset {configured}?
+--ro output
+--ro time yang:date-and-time
rpcs:
+---x establish-subscription
| +---w input
| | +---w (target)
| | | +--:(stream)
| | | | +---w (stream-filter)?
| | | | | +--:(by-reference)
| | | | | | +---w stream-filter-name stream-filter-ref
| | | | | +--:(within-subscription)
| | | | | +---w (filter-spec)?
| | | | | +--:(stream-subtree-filter)
| | | | | | +---w stream-subtree-filter? <anydata> {subtree}?
| | | | | +--:(stream-xpath-filter)
| | | | | +---w stream-xpath-filter? yang:xpath1.0 {xpath}?
| | | | +---w stream stream-ref
| | | | +---w replay-start-time? yang:date-and-time {replay}?
| | | +--:(ypm:revision)
| | | | +---w ypm:revision? rev:revision-date-or-label
| | | +--:(ypm:revision-label)
| | | +---w ypm:revision-label? ysver:version
| | +---w stop-time? yang:date-and-time
| | +---w dscp? inet:dscp {dscp}?
| | +---w weighting? uint8 {qos}?
| | +---w dependency? subscription-id {qos}?
| | +---w encoding? encoding
| +--ro output
| +--ro id subscription-id
| +--ro replay-start-time-revision? yang:date-and-time {replay}?
+---x modify-subscription
| +---w input
| +---w id subscription-id
| +---w (target)
| | +--:(stream)
| | | +---w (stream-filter)?
| | | +--:(by-reference)
| | | | +---w stream-filter-name stream-filter-ref
| | | +--:(within-subscription)
| | | +---w (filter-spec)?
| | | +--:(stream-subtree-filter)
| | | | +---w stream-subtree-filter? <anydata> {subtree}?
| | | +--:(stream-xpath-filter)
| | | +---w stream-xpath-filter? yang:xpath1.0 {xpath}?
| | +--:(ypm:revision)
| | | +---w ypm:revision? rev:revision-date-or-label
| | +--:(ypm:revision-label)
| | +---w ypm:revision-label? ysver:version
| +---w stop-time? yang:date-and-time
+---x delete-subscription
| +---w input
| +---w id subscription-id
+---x kill-subscription
+---w input
+---w id subscription-id
notifications:
+---n replay-completed {replay}?
| +--ro id subscription-id
+---n subscription-completed {configured}?
| +--ro id subscription-id
+---n subscription-modified
| +--ro id subscription-id
| +--ro (target)
| | +--:(stream)
| | | +--ro (stream-filter)?
| | | | +--:(by-reference)
| | | | | +--ro stream-filter-name stream-filter-ref
| | | | +--:(within-subscription)
| | | | +--ro (filter-spec)?
| | | | +--:(stream-subtree-filter)
| | | | | +--ro stream-subtree-filter? <anydata> {subtree}?
| | | | +--:(stream-xpath-filter)
| | | | +--ro stream-xpath-filter? yang:xpath1.0 {xpath}?
| | | +--ro stream stream-ref
| | | +--ro replay-start-time? yang:date-and-time {replay}?
| | +--:(ypm:revision)
| | | +--ro ypm:revision rev:revision-date-or-label
| | +--:(ypm:revision-label)
| | +--ro ypm:revision-label? ysver:version
| +--ro stop-time? yang:date-and-time
| +--ro dscp? inet:dscp {dscp}?
| +--ro weighting? uint8 {qos}?
| +--ro dependency? subscription-id {qos}?
| +--ro transport? transport {configured}?
| +--ro encoding? encoding
| +--ro purpose? string {configured}?
+---n subscription-resumed
| +--ro id subscription-id
+---n subscription-started {configured}?
| +--ro id subscription-id
| +--ro (target)
| | +--:(stream)
| | | +--ro (stream-filter)?
| | | | +--:(by-reference)
| | | | | +--ro stream-filter-name stream-filter-ref
| | | | +--:(within-subscription)
| | | | +--ro (filter-spec)?
| | | | +--:(stream-subtree-filter)
| | | | | +--ro stream-subtree-filter? <anydata> {subtree}?
| | | | +--:(stream-xpath-filter)
| | | | +--ro stream-xpath-filter? yang:xpath1.0 {xpath}?
| | | +--ro stream stream-ref
| | | +--ro replay-start-time? yang:date-and-time {replay}?
| | | +--ro replay-previous-event-time? yang:date-and-time {replay}?
| | +--:(ypm:revision)
| | | +--ro ypm:revision rev:revision-date-or-label
| | +--:(ypm:revision-label)
| | +--ro ypm:revision-label? ysver:version
| +--ro stop-time? yang:date-and-time
| +--ro dscp? inet:dscp {dscp}?
| +--ro weighting? uint8 {qos}?
| +--ro dependency? subscription-id {qos}?
| +--ro transport? transport {configured}?
| +--ro encoding? encoding
| +--ro purpose? string {configured}?
+---n subscription-suspended
| +--ro id subscription-id
| +--ro reason identityref
+---n subscription-terminated
+--ro id subscription-id
+--ro reason identityref
]]></artwork>
</figure></t>
</section>
</section>
<section anchor="YANG-revision-module" title="YANG Module">
<t>The YANG module has two leaves augmenting the model of <xref
target="RFC8639">Subscription to YANG Notifications</xref>.</t>
<t><figure>
<artwork><![CDATA[
<CODE BEGINS> file "[email protected]"
module ietf-yang-revisions {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-yang-revisions";
prefix rev;
organization
"IETF NETMOD (Network Modeling) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:[email protected]>
Author: Joe Clarke
<mailto:[email protected]>
Author: Reshad Rahman
<mailto:[email protected]>
Author: Robert Wilton
<mailto:[email protected]>
Author: Balazs Lengyel
<mailto:[email protected]>
Author: Jason Sterne
<mailto:[email protected]>";
description
"This YANG 1.1 module contains definitions and extensions to
support updated YANG revision handling.
Copyright (c) 2002 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 Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(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.
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 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.";
// RFC Ed.: update the date below with the date of RFC publication
// and remove this note.
// RFC Ed.: replace XXXX (inc above) with actual RFC number and
// remove this note.
revision 2022-11-29 {
rev:label "1.0.0-draft-ietf-netmod-yang-module-versioning-08";
description
"Initial version.";
reference
"XXXX: Updated YANG Module Revision Handling";
}
typedef revision-date {
type string {
pattern '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-1])';
}
description
"A date associated with a YANG revision.
Matches dates formatted as YYYY-MM-DD.";
reference
"RFC 7950: The YANG 1.1 Data Modeling Language";
}
typedef revision-label {
type string {
length "1..255";
pattern '[a-zA-Z0-9,\-_.+]+';
pattern '[0-9]{4}-[0-9]{2}-[0-9]{2}' {
modifier "invert-match";
error-message
"The revision-label must not match a revision-date.";
}
}
description
"A label associated with a YANG revision.
Alphanumeric characters, comma, hyphen, underscore, period
and plus are the only accepted characters. MUST NOT match
revision-date or pattern similar to a date.";
reference
"XXXX: Updated YANG Module Revision Handling;
Section 3.3, Revision label";
}
typedef revision-date-or-label {
type union {
type revision-date;
type revision-label;
}
description
"Represents either a YANG revision date or a revision label";
}
extension non-backwards-compatible {
description
"This statement is used to indicate YANG module revisions that
contain non-backwards-compatible changes.
The statement MUST only be a substatement of the 'revision'
statement. Zero or one 'non-backwards-compatible' statements
per parent statement is allowed. No substatements for this
extension have been standardized.
If a revision of a YANG module contains changes, relative to
the preceding revision in the revision history, that do not
conform to the backwards-compatible module update rules
defined in RFC-XXX, then the 'non-backwards-compatible'
statement MUST be added as a substatement to the revision
statement.
Conversely, if a revision does not contain a
'non-backwards-compatible' statement then all changes,
relative to the preceding revision in the revision history,
MUST be backwards-compatible.
A new module revision that only contains changes that are
backwards-compatible SHOULD NOT include the
'non-backwards-compatible' statement. An example of when an
author might add the 'non-backwards-compatible' statement is
if they believe a change could negatively impact clients even
though the backwards compatibility rules defined in RFC-XXXX
classify it as a backwards-compatible change.
Add, removing, or changing a 'non-backwards-compatible'
statement is a backwards-compatible version change.";
reference
"XXXX: Updated YANG Module Revision Handling;
Section 3.2,
non-backwards-compatible revision extension statement";
}
extension label {
argument revision-label;
description
"The revision label can be used to provide an additional
versioning identifier associated with a module or submodule
revision. One such scheme that could be used is [XXXX:
ietf-netmod-yang-semver].
The format of the revision label argument MUST conform to the
pattern defined for the revision label typedef in this module.
The statement MUST only be a substatement of the revision
statement. Zero or one revision label statements per parent
statement are allowed. No substatements for this extension
have been standardized.
Revision labels MUST be unique amongst all revisions of a
module or submodule.
Adding a revision label is a backwards-compatible version
change. Changing or removing an existing revision label in
the revision history is a non-backwards-compatible version
change, because it could impact any references to that
revision label.";
reference
"XXXX: Updated YANG Module Revision Handling;
Section 3.3, Revision label";
}
extension revision-label-scheme {
argument revision-label-scheme-base;
description
"The revision label scheme specifies which revision label
scheme the module or submodule uses.
The mandatory revision-label-scheme-base argument MUST be an
identity derived from revision-label-scheme-base.
This extension is only valid as a top-level statement, i.e.,
given as as a substatement to 'module' or 'submodule'. No
substatements for this extension have been standardized.
This extension MUST be used if there is a revision label
statement in the module or submodule.
Adding a revision label scheme is a backwards-compatible
version change. Changing a revision label scheme is a
non-backwards-compatible version change, unless the new
revision label scheme is backwards-compatible with the
replaced revision label scheme. Removing a revision label
scheme is a non-backwards-compatible version change.";
reference
"XXXX: Updated YANG Module Revision Handling;
Section 3.3.1, Revision label scheme extension statement";
}
extension recommended-min {
argument revision-date-or-label;
description
"Recommends the revision of the module that may be imported to
one that matches or is derived from the specified
revision-date or revision label.
The argument value MUST conform to the
'revision-date-or-label' defined type.
The statement MUST only be a substatement of the import
statement. Zero, one or more 'recommended-min' statements per
parent statement are allowed. No substatements for this
extension have been standardized.
If specified multiple times, then any module revision that
satisfies at least one of the 'recommended-min' statements is
an acceptable recommended revision for import.
A particular revision of an imported module adheres to an
import's 'recommended-min' extension statement if the imported
module's revision history contains a revision statement with a
matching revision date or revision label.
Adding, removing or updating a 'recommended-min' statement to
an import is a backwards-compatible change.";
reference
"XXXX: Updated YANG Module Revision Handling; Section 4,
Recommending a minimum revision for module imports";
}
identity revision-label-scheme-base {
description
"Base identity from which all revision label schemes are
derived.";
reference
"XXXX: Updated YANG Module Revision Handling;
Section 3.3.1, Revision label scheme extension statement";
}
}
<CODE ENDS>]]></artwork>
</figure></t>
</section>
</section>
<section anchor="Security" title="Security Considerations">
<t>The security considerations for the YANG notifications subscription
mechanism are described in <xref target="RFC8641"/>. This documents adds
no additional security considerations.</t>
</section>
<section anchor="IANA_Considerations" title="IANA Considerations">
<t>This document has no IANA actions.</t>
</section>
<section anchor="Acknowledgements" title="Acknowledgements">
<t>The authors would like to thank xxx for their review and valuable
comments.</t>
</section>
</middle>
<back>
<references title="Normative References">
<?rfc include='reference.RFC.2119'?>
<?rfc include='reference.RFC.6020'?>
<?rfc include='reference.RFC.8174'?>
<?rfc include='reference.RFC.8639'?>
<?rfc include='reference.RFC.8641'?>
<?rfc include='reference.I-D.ietf-netmod-yang-module-versioning'?>
<?rfc include='reference.I-D.ietf-netmod-yang-semver'?>
</references>
<references title="Informative References">
<?rfc include='reference.RFC.8259'?>
<?rfc include='reference.RFC.8340'?>
<?rfc include='reference.RFC.8343'?>
<?rfc include='reference.RFC.8640'?>
<?rfc include='reference.I-D.ietf-netconf-https-notif'?>
<?rfc include='reference.I-D.ietf-netconf-udp-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>
</references>
</back>
</rfc>