idnits 2.17.1 draft-ietf-core-sid-12.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There are 23 instances of too long lines in the document, the longest one being 13 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 239 has weird spacing: '...evision rev...' == Line 241 has weird spacing: '...y-point sid...' == Line 245 has weird spacing: '...ntifier uni...' -- The document date (March 27, 2020) is 1481 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'DONE' is mentioned on line 1566, but not defined == Unused Reference: 'I-D.ietf-anima-constrained-voucher' is defined on line 911, but no explicit reference was found in the text == Outdated reference: A later version (-24) exists of draft-ietf-anima-constrained-voucher-07 == Outdated reference: A later version (-17) exists of draft-ietf-core-comi-09 == Outdated reference: A later version (-03) exists of draft-ietf-core-yang-library-01 Summary: 1 error (**), 0 flaws (~~), 9 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force M. Veillette, Ed. 3 Internet-Draft Trilliant Networks Inc. 4 Intended status: Standards Track A. Pelov, Ed. 5 Expires: September 28, 2020 I. Petrov, Ed. 6 Acklio 7 March 27, 2020 9 YANG Schema Item iDentifier (SID) 10 draft-ietf-core-sid-12 12 Abstract 14 YANG Schema Item iDentifiers (SID) are globally unique 63-bit 15 unsigned integers used to identify YANG items. This document defines 16 the semantics, the registration, and assignment processes of SIDs. 17 To enable the implementation of these processes, this document also 18 defines a file format used to persist and publish assigned SIDs. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at https://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on September 28, 2020. 37 Copyright Notice 39 Copyright (c) 2020 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (https://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 55 2. Terminology and Notation . . . . . . . . . . . . . . . . . . 3 56 3. ".sid" file lifecycle . . . . . . . . . . . . . . . . . . . . 4 57 4. ".sid" file format . . . . . . . . . . . . . . . . . . . . . 5 58 5. Security Considerations . . . . . . . . . . . . . . . . . . . 12 59 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 60 6.1. Register SID File Format Module . . . . . . . . . . . . . 12 61 6.2. Create new IANA Registry: "SID Mega-Range" registry . . . 12 62 6.2.1. Structure . . . . . . . . . . . . . . . . . . . . . . 12 63 6.2.2. Allocation policy . . . . . . . . . . . . . . . . . . 13 64 6.2.2.1. First allocation . . . . . . . . . . . . . . . . 13 65 6.2.2.2. Consecutive allocations . . . . . . . . . . . . . 13 66 6.2.3. Initial contents of the Registry . . . . . . . . . . 14 67 6.3. Create a new IANA Registry: IETF SID Range Registry 68 (managed by IANA) . . . . . . . . . . . . . . . . . . . . 14 69 6.3.1. Structure . . . . . . . . . . . . . . . . . . . . . . 14 70 6.3.2. Allocation policy . . . . . . . . . . . . . . . . . . 14 71 6.3.3. Initial contents of the registry . . . . . . . . . . 15 72 6.4. Create new IANA Registry: "IETF SID Registry" . . . . . . 16 73 6.4.1. Structure . . . . . . . . . . . . . . . . . . . . . . 17 74 6.4.2. Allocation policy . . . . . . . . . . . . . . . . . . 17 75 6.4.3. Recursive Allocation of SID Range at Document 76 Adoption . . . . . . . . . . . . . . . . . . . . . . 17 77 6.4.4. Initial contents of the registry . . . . . . . . . . 19 78 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 19 79 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 19 80 8.1. Normative References . . . . . . . . . . . . . . . . . . 19 81 8.2. Informative References . . . . . . . . . . . . . . . . . 20 82 Appendix A. ".sid" file example . . . . . . . . . . . . . . . . 21 83 Appendix B. SID auto generation . . . . . . . . . . . . . . . . 30 84 Appendix C. ".sid" file lifecycle . . . . . . . . . . . . . . . 31 85 C.1. SID File Creation . . . . . . . . . . . . . . . . . . . . 32 86 C.2. SID File Update . . . . . . . . . . . . . . . . . . . . . 33 87 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 89 1. Introduction 91 Some of the items defined in YANG [RFC7950] require the use of a 92 unique identifier. In both NETCONF [RFC6241] and RESTCONF [RFC8040], 93 these identifiers are implemented using names. To allow the 94 implementation of data models defined in YANG in constrained devices 95 and constrained networks, a more compact method to identify YANG 96 items is required. This compact identifier, called SID, is encoded 97 using a 63-bit unsigned integer. The limitation to 63-bit unsigned 98 integers allows SIDs to be manipulated more easily on platforms that 99 might otherwise lack native 64-bit unsigned arithmetic. The loss of 100 a single bit of range is not significant given the size of the 101 remaining space. 103 The following items are identified using SIDs: 105 o identities 107 o data nodes (Note: including those parts of a YANG template as 108 defined by the 'yang-data' extension.) 110 o RPCs and associated input(s) and output(s) 112 o actions and associated input(s) and output(s) 114 o notifications and associated information 116 o YANG modules, submodules and features 118 It is possible that some protocols use only a subset of the assigned 119 SIDs, for example, for protocols equivalent to NETCONF [RFC6241] like 120 [I-D.ietf-core-comi] the transportation of YANG modules SIDs might be 121 unnecessary. Others protocols might need to be able to transport 122 this information, for example protocols related to discovery such as 123 Constrained YANG Module Library [I-D.ietf-core-yang-library]. 125 SIDs are globally unique integers, a registration system is used in 126 order to guarantee their uniqueness. SIDs are registered in blocks 127 called "SID ranges". 129 Assignment of SIDs to YANG items can be automated. For more details 130 how this could be achieved, please consult Appendix B. 132 SIDs are assigned permanently, items introduced by a new revision of 133 a YANG module are added to the list of SIDs already assigned. 135 Section 3 provides more details about the registration process of 136 YANG modules and associated SIDs. To enable the implementation of 137 this registry, Section 4 defines a standard file format used to store 138 and publish SIDs. 140 2. Terminology and Notation 142 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 143 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 144 "OPTIONAL" in this document are to be interpreted as described in BCP 145 14 [RFC2119] [RFC8174] when, and only when, they appear in all 146 capitals, as shown here. 148 The following terms are defined in [RFC7950]: 150 o action 152 o feature 154 o module 156 o notification 158 o RPC 160 o schema node 162 o schema tree 164 o submodule 166 The following term is defined in [RFC8040]: 168 o yang-data extension 170 This specification also makes use of the following terminology: 172 o item: A schema node, an identity, a module, a submodule or a 173 feature defined using the YANG modeling language. 175 o path: A path is a string that identifies a schema node within the 176 schema tree. A path consists of the list of schema node 177 identifier(s) separated by slashes ("/"). Schema node 178 identifier(s) are always listed from the top-level schema node up 179 to the targeted schema node. (e.g. "/ietf-system:system- 180 state/clock/current-datetime") 182 o YANG Schema Item iDentifier (SID): Unsigned integer used to 183 identify different YANG items. 185 3. ".sid" file lifecycle 187 YANG is a language designed to model data accessed using one of the 188 compatible protocols (e.g. NETCONF [RFC6241], RESCONF [RFC8040] and 189 CoRECONF [I-D.ietf-core-comi]). A YANG module defines hierarchies of 190 data, including configuration, state data, RPCs, actions and 191 notifications. 193 Many YANG modules are not created in the context of constrained 194 applications. YANG modules can be implemented using NETCONF 195 [RFC6241] or RESTCONF [RFC8040] without the need to assign SIDs. 197 As needed, authors of YANG modules can assign SIDs to their YANG 198 modules. In order to do that, they should first obtain a SID range 199 from a registry and use that range to assign or generate SIDs to 200 items of their YANG module. The assignments can then be stored in a 201 ".sid" file. For example how this could be achieved, please refer to 202 Appendix C. 204 Registration of the ".sid" file associated to a YANG module is 205 optional but recommended to promote interoperability between devices 206 and to avoid duplicate allocation of SIDs to a single YANG module. 207 Different registries might have different requirements for the 208 registration and publication of the ".sid" files. For diagram of one 209 of the possibilities, please refer to the activity diagram on 210 Figure 1 in Appendix C. 212 Each time a YANG module or one of its imported module(s) or included 213 sub-module(s) is updated, a new ".sid" file MAY need to be created. 214 All the SIDs present in the previous version of the ".sid" file MUST 215 be present in the new version as well. The creation of this new 216 version of the ".sid" file SHOULD be performed using an automated 217 tool. 219 If a new revision requires more SIDs than initially allocated, a new 220 SID range MUST be added to the 'assignment-ranges' as defined in 221 Section 4. These extra SIDs are used for subsequent assignments. 223 For an example of this update process, see activity diagram Figure 2 224 in Appendix C. 226 4. ".sid" file format 228 ".sid" files are used to persist and publish SIDs assigned to the 229 different YANG items of a specific YANG module. It has the following 230 structure. 232 module: ietf-sid-file 233 +--rw module-name? yang:yang-identifier 234 +--rw module-revision? revision-identifier 235 +--rw sid-file-version? sid-file-version-identifier 236 +--rw description? string 237 +--rw dependency-revision* [module-name] 238 | +--rw module-name yang:yang-identifier 239 | +--rw module-revision revision-identifier 240 +--rw assigment-ranges* [entry-point] 241 | +--rw entry-point sid 242 | +--rw size uint64 243 +--rw items* [namespace identifier] 244 +--rw namespace enumeration 245 +--rw identifier union 246 +--rw sid sid 248 The following YANG module defined the structure of this file, 249 encoding is performed using the rules defined in [RFC7951]. 251 file "ietf-sid-file@2020-02-05.yang" 252 module ietf-sid-file { 253 namespace "urn:ietf:params:xml:ns:yang:ietf-sid-file"; 254 prefix sid; 256 import ietf-yang-types { 257 prefix yang; 258 } 259 import ietf-restconf { 260 prefix rc; 261 } 263 organization 264 "IETF Core Working Group"; 266 contact 267 "Michel Veillette 268 270 Andy Bierman 271 273 Alexander Pelov 274 276 Ivaylo Petrov 277 "; 279 description 280 "Copyright (c) 2020 IETF Trust and the persons identified as 281 authors of the code. All rights reserved. 283 Redistribution and use in source and binary forms, with or 284 without modification, is permitted pursuant to, and subject to 285 the license terms contained in, the Simplified BSD License set 286 forth in Section 4.c of the IETF Trust's Legal Provisions 287 Relating to IETF Documents 288 (https://trustee.ietf.org/license-info). 290 This version of this YANG module is part of RFC XXXX 291 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself 292 for full legal notices. 294 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 295 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 296 'MAY', and 'OPTIONAL' in this document are to be interpreted as 297 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 298 they appear in all capitals, as shown here. 300 This module defines the structure of the .sid files. 302 Each .sid file contains the mapping between the different 303 string identifiers defined by a YANG module and a 304 corresponding numeric value called SID."; 306 revision 2020-02-05 { 307 description 308 "Initial revision."; 309 reference 310 "[I-D.ietf-core-sid] YANG Schema Item iDentifier (SID)"; 311 } 313 typedef revision-identifier { 314 type string { 315 pattern '\d{4}-\d{2}-\d{2}'; 316 } 317 description 318 "Represents a date in YYYY-MM-DD format."; 319 } 321 typedef sid-file-version-identifier { 322 type uint64; 323 description 324 "Optional attribute that gives information about the .sid file 325 version."; 326 } 327 typedef sid { 328 type uint64; 329 description 330 "YANG Schema Item iDentifier"; 331 reference 332 "[I-D.ietf-core-sid] YANG Schema Item iDentifier (SID)"; 333 } 335 typedef schema-node-path { 336 type string { 337 pattern 338 '/[a-zA-Z_][a-zA-Z0-9\-_.]*:[a-zA-Z_][a-zA-Z0-9\-_.]*' + 339 '(/[a-zA-Z_][a-zA-Z0-9\-_.]*(:[a-zA-Z_][a-zA-Z0-9\-_.]*)?)*'; 340 } 341 description 342 "Identifies a schema-node path string for use in the 343 SID registry. This string format follows the rules 344 for an instance-identifier, as defined in RFC 7959, 345 except that no predicates are allowed. 347 This format is intended to support the YANG 1.1 ABNF 348 for a schema node identifier, except module names 349 are used instead of prefixes, as specified in RFC 7951."; 350 reference 351 "RFC 7950, The YANG 1.1 Data Modeling Language; 352 Section 6.5: Schema Node Identifier; 353 RFC 7951, JSON Encoding of YANG Data; 354 Section 6.11: The instance-identifier type"; 355 } 357 rc:yang-data sid-file { 358 uses sid-file; 359 } 361 grouping sid-file { 362 description "A grouping that contains a YANG container representing the 363 file structure of a sid files."; 365 container sid-file { 366 description 367 "A Wrapper container that together with the rc:yang-data extension 368 marks the YANG data structures inside as not being intended to be 369 implemented as part of a configuration datastore or as an operational 370 state within the server."; 371 leaf module-name { 372 type yang:yang-identifier; 373 description 374 "Name of the YANG module associated with this .sid file."; 376 } 378 leaf module-revision { 379 type revision-identifier; 380 description 381 "Revision of the YANG module associated with this .sid file. 382 This leaf is not present if no revision statement is 383 defined in the YANG module."; 384 } 386 leaf sid-file-version { 387 type sid-file-version-identifier; 388 description 389 "The version number of the .sid file. .sid files and the version 390 sequence are specific to a given YANG module revision. 391 This number starts at zero when there is a YANG module update. 392 This number can distinguish updates to the SID file which are the result of 393 new processing, or the result of reported errata."; 394 } 396 leaf description { 397 type string; 398 description 399 "Free-form meta information about the generated file. It might 400 include sid file generation tool and time among other things."; 401 } 403 list dependency-revision { 404 key "module-name"; 406 description 407 "Information about the revision of each YANG module that the module in 408 'module-name' includes used during the .sid file generation."; 410 leaf module-name { 411 type yang:yang-identifier; 412 mandatory true; 413 description 414 "Name of the YANG module, dependency of 'module-name', for which 415 revision information is provided."; 416 } 417 leaf module-revision { 418 type revision-identifier; 419 mandatory true; 420 description 421 "Revision of the YANG module, dependency of 'module-name', for which 422 revision information is provided."; 423 } 425 } 427 list assigment-ranges { 428 key "entry-point"; 429 description 430 "SID range(s) allocated to the YANG module identified by 431 'module-name' and 'module-revision'. 433 - The SID range first available value is entry-point and the the last 434 available value in the range is (entry-point + size - 1). 435 - The SID ranges specified by all assignment-rages MUST NOT overlap."; 437 leaf entry-point { 438 type sid; 439 mandatory true; 440 description 441 "Lowest SID available for assignment."; 442 } 444 leaf size { 445 type uint64; 446 mandatory true; 447 description 448 "Number of SIDs available for assignment."; 449 } 450 } 452 list items { 453 key "namespace identifier"; 454 description 455 "Each entry within this list defined the mapping between 456 a YANG item string identifier and a SID. This list MUST 457 include a mapping entry for each YANG item defined by 458 the YANG module identified by 'module-name' and 459 'module-revision'."; 461 leaf namespace { 462 type enumeration { 463 enum module { 464 value 0; 465 description 466 "All module and submodule names share the same 467 global module identifier namespace."; 468 } 469 enum identity { 470 value 1; 471 description 472 "All identity names defined in a module and its 473 submodules share the same identity identifier 474 namespace."; 475 } 476 enum feature { 477 value 2; 478 description 479 "All feature names defined in a module and its 480 submodules share the same feature identifier 481 namespace."; 482 } 483 enum data { 484 value 3; 485 description 486 "The namespace for all data nodes, as defined in YANG."; 487 } 488 } 489 description 490 "Namespace of the YANG item for this mapping entry."; 491 } 493 leaf identifier { 494 type union { 495 type yang:yang-identifier; 496 type schema-node-path; 497 } 498 description 499 "String identifier of the YANG item for this mapping entry. 501 If the corresponding 'namespace' field is 'module', 502 'feature', or 'identity', then this field MUST 503 contain a valid YANG identifier string. 505 If the corresponding 'namespace' field is 'data', 506 then this field MUST contain a valid schema node 507 path."; 508 } 510 leaf sid { 511 type sid; 512 mandatory true; 513 description 514 "SID assigned to the YANG item for this mapping entry."; 515 } 516 } 517 } 518 } 519 } 520 521 5. Security Considerations 523 This document defines a new type of identifier used to encode data 524 models defined in YANG [RFC7950]. As such, this identifier does not 525 contribute to any new security issues in addition of those identified 526 for the specific protocols or contexts for which it is used. 528 6. IANA Considerations 530 6.1. Register SID File Format Module 532 This document registers one YANG module in the "YANG Module Names" 533 registry [RFC6020]: 535 o name: ietf-sid-file 537 o namespace: urn:ietf:params:xml:ns:yang:ietf-sid-file 539 o prefix: sid 541 o reference: [[THISRFC]] 543 6.2. Create new IANA Registry: "SID Mega-Range" registry 545 The name of this registry is "SID Mega-Range". This registry is used 546 to record the delegation of the management of a block of SIDs to 547 third parties (such as SDOs or registrars). 549 6.2.1. Structure 551 Each entry in this registry must include: 553 o The entry point (first SID) of the registered SID block. 555 o The size of the registered SID block. The size MUST be one 556 million (1 000 000) SIDs. 558 o The contact information of the requesting organization including: 560 * The policy of SID range allocations: Public, Private or Both. 562 * Organization name 564 * URL 566 The information associated to the Organization name should not be 567 publicly visible in the registry, but should be available. This 568 information includes contact email and phone number and change 569 controller email and phone number. 571 6.2.2. Allocation policy 573 The IANA policy for future additions to this registry is "Expert 574 Review" [RFC8126]. 576 An organization requesting to manage a SID Range (and thus have an 577 entry in the SID Mega-Range Registry), must ensure the following 578 capacities: 580 o The capacity to manage and operate a SID Range Registry. A SID 581 Range Registry MUST provide the following information for all SID 582 Ranges allocated by the Registry: 584 * Entry Point of allocated SID Range 586 * Size of allocated SID Range 588 * Type: Public or Private 590 + Public Ranges MUST include at least a reference to the YANG 591 module and ".sid" files for that SID Range. 593 + Private Ranges MUST be marked as "Private" 595 o A Policy of allocation, which clearly identifies if the SID Range 596 allocations would be Private, Public or Both. 598 o Technical capacity to ensure the sustained operation of the 599 registry for a period of at least 5 years. If Private 600 Registrations are allowed, the period must be of at least 10 601 years. 603 6.2.2.1. First allocation 605 For a first allocation to be provided, the requesting organization 606 must demonstrate a functional registry infrastructure. 608 6.2.2.2. Consecutive allocations 610 On subsequent allocation request(s), the organization must 611 demonstrate the exhaustion of the prior range. These conditions need 612 to be asserted by the assigned expert(s). 614 If that extra-allocation is done within 3 years from the last 615 allocation, the experts need to discuss this request on the CORE 616 working group mailing list and consensus needs to be obtained before 617 allocating a new Mega-Range. 619 6.2.3. Initial contents of the Registry 621 The initial entry in this registry is allocated to IANA: 623 +-------------+---------+------------+-------------------+----------+ 624 | Entry Point | Size | Allocation | Organization name | URL | 625 +-------------+---------+------------+-------------------+----------+ 626 | 0 | 1000000 | Public | IANA | iana.org | 627 +-------------+---------+------------+-------------------+----------+ 629 6.3. Create a new IANA Registry: IETF SID Range Registry (managed by 630 IANA) 632 6.3.1. Structure 634 Each entry in this registry must include: 636 o The SID range entry point. 638 o The SID range size. 640 o The YANG module name. 642 o Document reference. 644 6.3.2. Allocation policy 646 The first million SIDs assigned to IANA is sub-divided as follows: 648 o The range of 0 to 999 (size 1000) is "Reserved" as defined in 649 [RFC8126]. 651 o The range of 1000 to 59,999 (size 59,000) is reserved for YANG 652 modules defined in RFCs. The IANA policy for additions to this 653 registry is "Expert Review" [RFC8126]. 655 * The Expert MUST verify that the YANG module for which this 656 allocation is made has an RFC (existing RFC) OR is on track to 657 become RFC (early allocation with a request from the WG chairs 658 as defined by [RFC7120]). 660 o The SID range allocated for a YANG module can follow in one of the 661 four categories: 663 * SMALL (50 SIDs) 664 * MEDIUM (100 SIDs) 666 * LARGE (250 SIDs) 668 * CUSTOM (requested by the YANG module author, with a maximum of 669 1000 SIDs). In all cases, the size of a SID range assigned to 670 a YANG module should be at least 33% above the current number 671 of YANG items. This headroom allows assignment within the same 672 range of new YANG items introduced by subsequent revisions. A 673 larger SID range size may be requested by the authors if this 674 recommendation is considered insufficient. It is important to 675 note that an additional SID range can be allocated to an 676 existing YANG module if the initial range is exhausted. 678 o The range of 60,000 to 99,999 (size 40,000)is reserved for 679 experimental YANG modules. This range MUST NOT be used in 680 operational deployments since these SIDs are not globally unique 681 which limit their interoperability. The IANA policy for this 682 range is "Experimental use" [RFC8126]. 684 o The range of 100,000 to 999,999 (size 900,000) is "Reserved" as 685 defined in [RFC8126]. 687 +-------------+---------+------------------+ 688 | Entry Point | Size | IANA policy | 689 +-------------+---------+------------------+ 690 | 0 | 1,000 | Reserved | 691 | 1,000 | 59,000 | Expert Review | 692 | 60,000 | 40,000 | Experimental use | 693 | 100,000 | 900,000 | Reserved | 694 +-------------+---------+------------------+ 696 6.3.3. Initial contents of the registry 698 Initial entries in this registry are as follows: 700 +-----+-----+--------------------------+----------------------------+ 701 | Ent | Siz | Module name | Document reference | 702 | ry | e | | | 703 | Poi | | | | 704 | nt | | | | 705 +-----+-----+--------------------------+----------------------------+ 706 | 100 | 100 | ietf-comi | [I-D.ietf-core-comi] | 707 | 0 | | | | 708 | 110 | 50 | ietf-yang-types | [RFC6991] | 709 | 0 | | | | 710 | 115 | 50 | ietf-inet-types | [RFC6991] | 711 | 0 | | | | 712 | 120 | 50 | iana-crypt-hash | [RFC7317] | 713 | 0 | | | | 714 | 125 | 50 | ietf-netconf-acm | [RFC8341] | 715 | 0 | | | | 716 | 130 | 50 | ietf-sid-file | RFCXXXX | 717 | 0 | | | | 718 | 150 | 100 | ietf-interfaces | [RFC8343] | 719 | 0 | | | | 720 | 160 | 100 | ietf-ip | [RFC8344] | 721 | 0 | | | | 722 | 170 | 100 | ietf-system | [RFC7317] | 723 | 0 | | | | 724 | 180 | 400 | iana-if-type | [RFC7224] | 725 | 0 | | | | 726 | 240 | 50 | ietf-voucher | [RFC8366] | 727 | 0 | | | | 728 | 245 | 50 | ietf-constrained-voucher | [I-D.ietf-anima-constraine | 729 | 0 | | | d-voucher] | 730 | 250 | 50 | ietf-constrained- | [I-D.ietf-anima-constraine | 731 | 0 | | voucher-request | d-voucher] | 732 +-----+-----+--------------------------+----------------------------+ 734 // RFC Ed.: replace XXXX with RFC number assigned to this draft. 736 For allocation, RFC publication of the YANG module is required as per 737 [RFC8126]. The YANG module must be registered in the "YANG module 738 Name" registry according to the rules specified in section 14 of 739 [RFC6020]. 741 6.4. Create new IANA Registry: "IETF SID Registry" 743 The name of this registry is "IETF SID Registry". This registry is 744 used to record the allocation of SIDs for individual YANG module 745 items. 747 6.4.1. Structure 749 Each entry in this registry must include: 751 o The YANG module name. This module name must be present in the 752 "Name" column of the "YANG Module Names" registry. 754 o A link to the associated ".yang" file. This file link must be 755 present in the "File" column of the "YANG Module Names" registry. 757 o The link to the ".sid" file which defines the allocation. The 758 ".sid" file is stored by IANA. 760 o The number of actually allocated SIDs in the ".sid" file. 762 6.4.2. Allocation policy 764 The allocation policy is Expert review. The Expert MUST ensure that 765 the following conditions are met: 767 o The ".sid" file has a valid structure: 769 * The ".sid" file MUST be a valid JSON file following the 770 structure of the module defined in RFCXXXX (RFC Ed: replace XXX 771 with RFC number assigned to this draft). 773 o The ".sid" file allocates individual SIDs ONLY in the SID Ranges 774 for this YANG module (as allocated in the IETF SID Range 775 Registry): 777 * All SIDs in this ".sid" file MUST be within the ranges 778 allocated to this YANG module in the "IETF SID Range Registry". 780 o If another ".sid" file has already allocated SIDs for this YANG 781 module (e.g. for older or newer versions of the YANG module), the 782 YANG items are assigned the same SIDs as in the other ".sid" file. 784 o If there is an older version of the ".sid" file, all allocated 785 SIDs from that version are still present in the current version of 786 the ".sid" file. 788 6.4.3. Recursive Allocation of SID Range at Document Adoption 790 Due to the difficulty in changing SID values during IETF document 791 processing, it is expected that most documents will ask for SID 792 allocations using Early Allocations [RFC7120]. The details of the 793 Early Allocation should be included in any Working Group Adoption 794 call. Prior to Working Group Adoption, an internet draft authors can 795 use the experimental SID range (as per Section 6.3.2) for their SIDs 796 allocations or other values that do not create ambiguity with other 797 SID uses (for example they can use a range that comes from a non-IANA 798 managed "SID Mega-Range" registry). 800 After Working Group Adoption, any modification of a ".sid" file is 801 expected to be discussed on the mailing list of the appropriate 802 Working Groups. Specific attention should be paid to implementers' 803 opinion after Working Group Last Call if a SID value is to change its 804 meaning. In all cases, a ".sid" file and the SIDs associated with it 805 are subject to change before the publication of an internet draft as 806 an RFC. 808 During the early use of SIDs, many existing, previously published 809 YANG modules will not have SID allocations. For an allocation to be 810 useful the included YANG modules may also need to have SID 811 allocations made. 813 The Expert Reviewer who performs the (Early) Allocation analysis will 814 need to go through the list of included YANG modules and perform SID 815 allocations for those modules as well. 817 o If the document is a published RFC, then the allocation of SIDs 818 for its referenced YANG modules is permanent. The Expert Reviewer 819 provides the generated SID file to IANA for registration. This 820 process may be time consuming during a bootstrap period (there are 821 over 100 YANG modules to date, none of which have SID 822 allocations), but should quiet down once needed entries are 823 allocated. 825 o If the document is an unprocessed Internet-Draft adopted in a WG, 826 then an Early Allocation is performed for this document as well. 827 Early Allocations require approval by an IESG Area Director. An 828 early allocation which requires additional allocations will list 829 the other allocations in it's description, and will be cross- 830 posted to the any other working group mailing lists. 832 o A YANG module which references a module in an document which has 833 not yet been adopted by any working group will be unable to 834 perform an Early Allocation for that other document until it is 835 adopted by a working group. As described in [RFC7120], an AD 836 Sponsored document acts as if it had a working group. The 837 approving AD may also exempt a document from this policy by 838 agreeing to AD Sponsor the document. 840 At the end of the IETF process all the dependencies of a given module 841 for which SIDs are assigned, should also have SIDs assigned. Those 842 dependencies' assignments should be permanent (not Early Allocation). 844 A previously SID-allocated YANG module which changes its references 845 to include a YANG module for which there is no SID allocation needs 846 to repeat the Early Allocation process. 848 Early Allocations are made with a one-year period, after which they 849 are expired. [RFC7120] indicates that at most one renewal may be 850 made. For the SID allocation a far more lenient stance is desired. 852 1. An extension of a referencing documents Early Allocation should 853 update any referenced Early Allocations to expire no sooner than 854 the referencing document. 856 2. The [RFC7120] mechanism allows the IESG to provide a second 857 renewal, and such an event may prompt some thought about how the 858 collection of documents are being processed. 860 This is driven by the very generous size of the SID space and the 861 often complex and deep dependencies of YANG modules. Often a core 862 module with many dependencies will undergo extensive review, delaying 863 the publication of other documents. 865 [RFC7120] also says 867 Note that if a document is submitted for review to the IESG and at 868 the time of submission some early allocations are valid (not 869 expired), these allocations should not be expired while the document 870 is under IESG consideration or waiting in the RFC Editor's queue 871 after approval by the IESG. 873 6.4.4. Initial contents of the registry 875 None. 877 7. Acknowledgments 879 The authors would like to thank Andy Bierman, Carsten Bormann, 880 Michael Richardson, Abhinav Somaraju, Peter van der Stok, Laurent 881 Toutain and Randy Turner for their help during the development of 882 this document and their useful comments during the review process. 884 8. References 886 8.1. Normative References 888 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 889 Requirement Levels", BCP 14, RFC 2119, 890 DOI 10.17487/RFC2119, March 1997, 891 . 893 [RFC7120] Cotton, M., "Early IANA Allocation of Standards Track Code 894 Points", BCP 100, RFC 7120, DOI 10.17487/RFC7120, January 895 2014, . 897 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 898 RFC 7950, DOI 10.17487/RFC7950, August 2016, 899 . 901 [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", 902 RFC 7951, DOI 10.17487/RFC7951, August 2016, 903 . 905 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 906 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 907 May 2017, . 909 8.2. Informative References 911 [I-D.ietf-anima-constrained-voucher] 912 Richardson, M., Stok, P., and P. Kampanakis, "Constrained 913 Voucher Artifacts for Bootstrapping Protocols", draft- 914 ietf-anima-constrained-voucher-07 (work in progress), 915 January 2020. 917 [I-D.ietf-core-comi] 918 Veillette, M., Stok, P., Pelov, A., Bierman, A., and I. 919 Petrov, "CoAP Management Interface", draft-ietf-core- 920 comi-09 (work in progress), March 2020. 922 [I-D.ietf-core-yang-library] 923 Veillette, M. and I. Petrov, "Constrained YANG Module 924 Library", draft-ietf-core-yang-library-01 (work in 925 progress), January 2020. 927 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 928 the Network Configuration Protocol (NETCONF)", RFC 6020, 929 DOI 10.17487/RFC6020, October 2010, 930 . 932 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 933 and A. Bierman, Ed., "Network Configuration Protocol 934 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 935 . 937 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 938 RFC 6991, DOI 10.17487/RFC6991, July 2013, 939 . 941 [RFC7224] Bjorklund, M., "IANA Interface Type YANG Module", 942 RFC 7224, DOI 10.17487/RFC7224, May 2014, 943 . 945 [RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for 946 System Management", RFC 7317, DOI 10.17487/RFC7317, August 947 2014, . 949 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 950 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 951 . 953 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 954 Writing an IANA Considerations Section in RFCs", BCP 26, 955 RFC 8126, DOI 10.17487/RFC8126, June 2017, 956 . 958 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 959 Access Control Model", STD 91, RFC 8341, 960 DOI 10.17487/RFC8341, March 2018, 961 . 963 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 964 Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, 965 . 967 [RFC8344] Bjorklund, M., "A YANG Data Model for IP Management", 968 RFC 8344, DOI 10.17487/RFC8344, March 2018, 969 . 971 [RFC8366] Watsen, K., Richardson, M., Pritikin, M., and T. Eckert, 972 "A Voucher Artifact for Bootstrapping Protocols", 973 RFC 8366, DOI 10.17487/RFC8366, May 2018, 974 . 976 Appendix A. ".sid" file example 978 The following ".sid" file (ietf-system@2014-08-06.sid) have been 979 generated using the following yang modules: 981 o ietf-system@2014-08-06.yang 983 o ietf-yang-types@2013-07-15.yang 985 o ietf-inet-types@2013-07-15.yang 987 o ietf-netconf-acm@2012-02-22.yang 988 o iana-crypt-hash@2014-04-04.yang 990 { 991 "ietf-sid-file:sid-file" : { 992 "module-name": "ietf-system", 993 "module-revision": "2020-02-05", 994 "description": "Example sid file", 995 "assignment-ranges": [ 996 { 997 "entry-point": 1700, 998 "size": 100 999 } 1000 ], 1001 "items": [ 1002 { 1003 "namespace": "module", 1004 "identifier": "ietf-system", 1005 "sid": 1700 1006 }, 1007 { 1008 "namespace": "identity", 1009 "identifier": "authentication-method", 1010 "sid": 1701 1011 }, 1012 { 1013 "namespace": "identity", 1014 "identifier": "local-users", 1015 "sid": 1702 1016 }, 1017 { 1018 "namespace": "identity", 1019 "identifier": "radius", 1020 "sid": 1703 1021 }, 1022 { 1023 "namespace": "identity", 1024 "identifier": "radius-authentication-type", 1025 "sid": 1704 1026 }, 1027 { 1028 "namespace": "identity", 1029 "identifier": "radius-chap", 1030 "sid": 1705 1031 }, 1032 { 1033 "namespace": "identity", 1034 "identifier": "radius-pap", 1035 "sid": 1706 1037 }, 1038 { 1039 "namespace": "feature", 1040 "identifier": "authentication", 1041 "sid": 1707 1042 }, 1043 { 1044 "namespace": "feature", 1045 "identifier": "dns-udp-tcp-port", 1046 "sid": 1708 1047 }, 1048 { 1049 "namespace": "feature", 1050 "identifier": "local-users", 1051 "sid": 1709 1052 }, 1053 { 1054 "namespace": "feature", 1055 "identifier": "ntp", 1056 "sid": 1710 1057 }, 1058 { 1059 "namespace": "feature", 1060 "identifier": "ntp-udp-port", 1061 "sid": 1711 1062 }, 1063 { 1064 "namespace": "feature", 1065 "identifier": "radius", 1066 "sid": 1712 1067 }, 1068 { 1069 "namespace": "feature", 1070 "identifier": "radius-authentication", 1071 "sid": 1713 1072 }, 1073 { 1074 "namespace": "feature", 1075 "identifier": "timezone-name", 1076 "sid": 1714 1077 }, 1078 { 1079 "namespace": "data", 1080 "identifier": "/ietf-system:set-current-datetime", 1081 "sid": 1715 1082 }, 1083 { 1084 "namespace": "data", 1085 "identifier": "/ietf-system:set-current-datetime/ 1086 current-datetime", 1087 "sid": 1716 1088 }, 1089 { 1090 "namespace": "data", 1091 "identifier": "/ietf-system:system", 1092 "sid": 1717 1093 }, 1094 { 1095 "namespace": "data", 1096 "identifier": "/ietf-system:system-restart", 1097 "sid": 1718 1098 }, 1099 { 1100 "namespace": "data", 1101 "identifier": "/ietf-system:system-shutdown", 1102 "sid": 1719 1103 }, 1104 { 1105 "namespace": "data", 1106 "identifier": "/ietf-system:system-state", 1107 "sid": 1720 1108 }, 1109 { 1110 "namespace": "data", 1111 "identifier": "/ietf-system:system-state/clock", 1112 "sid": 1721 1113 }, 1114 { 1115 "namespace": "data", 1116 "identifier": "/ietf-system:system-state/clock/boot-datetime", 1117 "sid": 1722 1118 }, 1119 { 1120 "namespace": "data", 1121 "identifier": "/ietf-system:system-state/clock/ 1122 current-datetime", 1123 "sid": 1723 1124 }, 1125 { 1126 "namespace": "data", 1127 "identifier": "/ietf-system:system-state/platform", 1128 "sid": 1724 1129 }, 1130 { 1131 "namespace": "data", 1132 "identifier": "/ietf-system:system-state/platform/machine", 1133 "sid": 1725 1134 }, 1135 { 1136 "namespace": "data", 1137 "identifier": "/ietf-system:system-state/platform/os-name", 1138 "sid": 1726 1139 }, 1140 { 1141 "namespace": "data", 1142 "identifier": "/ietf-system:system-state/platform/os-release", 1143 "sid": 1727 1144 }, 1145 { 1146 "namespace": "data", 1147 "identifier": "/ietf-system:system-state/platform/os-version", 1148 "sid": 1728 1149 }, 1150 { 1151 "namespace": "data", 1152 "identifier": "/ietf-system:system/authentication", 1153 "sid": 1729 1154 }, 1155 { 1156 "namespace": "data", 1157 "identifier": "/ietf-system:system/authentication/user", 1158 "sid": 1730 1159 }, 1160 { 1161 "namespace": "data", 1162 "identifier": "/ietf-system:system/authentication/ 1163 user-authentication-order", 1164 "sid": 1731 1165 }, 1166 { 1167 "namespace": "data", 1168 "identifier": "/ietf-system:system/authentication/user/ 1169 authorized-key", 1170 "sid": 1732 1171 }, 1172 { 1173 "namespace": "data", 1174 "identifier": "/ietf-system:system/authentication/user/ 1175 authorized-key/algorithm", 1176 "sid": 1733 1177 }, 1178 { 1179 "namespace": "data", 1180 "identifier": "/ietf-system:system/authentication/user/ 1181 authorized-key/key-data", 1182 "sid": 1734 1183 }, 1184 { 1185 "namespace": "data", 1186 "identifier": "/ietf-system:system/authentication/user/ 1187 authorized-key/name", 1188 "sid": 1735 1189 }, 1190 { 1191 "namespace": "data", 1192 "identifier": "/ietf-system:system/authentication/user/ 1193 name", 1194 "sid": 1736 1195 }, 1196 { 1197 "namespace": "data", 1198 "identifier": "/ietf-system:system/authentication/user/ 1199 password", 1200 "sid": 1737 1201 }, 1202 { 1203 "namespace": "data", 1204 "identifier": "/ietf-system:system/clock", 1205 "sid": 1738 1206 }, 1207 { 1208 "namespace": "data", 1209 "identifier": "/ietf-system:system/clock/timezone-name", 1210 "sid": 1739 1211 }, 1212 { 1213 "namespace": "data", 1214 "identifier": "/ietf-system:system/clock/timezone-utc-offset", 1215 "sid": 1740 1216 }, 1217 { 1218 "namespace": "data", 1219 "identifier": "/ietf-system:system/contact", 1220 "sid": 1741 1221 }, 1222 { 1223 "namespace": "data", 1224 "identifier": "/ietf-system:system/dns-resolver", 1225 "sid": 1742 1226 }, 1227 { 1228 "namespace": "data", 1229 "identifier": "/ietf-system:system/dns-resolver/options", 1230 "sid": 1743 1231 }, 1232 { 1233 "namespace": "data", 1234 "identifier": "/ietf-system:system/dns-resolver/options/ 1235 attempts", 1236 "sid": 1744 1237 }, 1238 { 1239 "namespace": "data", 1240 "identifier": "/ietf-system:system/dns-resolver/options/ 1241 timeout", 1242 "sid": 1745 1243 }, 1244 { 1245 "namespace": "data", 1246 "identifier": "/ietf-system:system/dns-resolver/search", 1247 "sid": 1746 1248 }, 1249 { 1250 "namespace": "data", 1251 "identifier": "/ietf-system:system/dns-resolver/server", 1252 "sid": 1747 1253 }, 1254 { 1255 "namespace": "data", 1256 "identifier": "/ietf-system:system/dns-resolver/server/name", 1257 "sid": 1748 1258 }, 1259 { 1260 "namespace": "data", 1261 "identifier": "/ietf-system:system/dns-resolver/server/ 1262 udp-and-tcp", 1263 "sid": 1749 1264 }, 1265 { 1266 "namespace": "data", 1267 "identifier": "/ietf-system:system/dns-resolver/server/ 1268 udp-and-tcp/address", 1269 "sid": 1750 1270 }, 1271 { 1272 "namespace": "data", 1273 "identifier": "/ietf-system:system/dns-resolver/server/ 1274 udp-and-tcp/port", 1275 "sid": 1751 1276 }, 1277 { 1278 "namespace": "data", 1279 "identifier": "/ietf-system:system/hostname", 1280 "sid": 1752 1281 }, 1282 { 1283 "namespace": "data", 1284 "identifier": "/ietf-system:system/location", 1285 "sid": 1753 1286 }, 1287 { 1288 "namespace": "data", 1289 "identifier": "/ietf-system:system/ntp", 1290 "sid": 1754 1291 }, 1292 { 1293 "namespace": "data", 1294 "identifier": "/ietf-system:system/ntp/enabled", 1295 "sid": 1755 1296 }, 1297 { 1298 "namespace": "data", 1299 "identifier": "/ietf-system:system/ntp/server", 1300 "sid": 1756 1301 }, 1302 { 1303 "namespace": "data", 1304 "identifier": "/ietf-system:system/ntp/server/ 1305 association-type", 1306 "sid": 1757 1307 }, 1308 { 1309 "namespace": "data", 1310 "identifier": "/ietf-system:system/ntp/server/iburst", 1311 "sid": 1758 1312 }, 1313 { 1314 "namespace": "data", 1315 "identifier": "/ietf-system:system/ntp/server/name", 1316 "sid": 1759 1317 }, 1318 { 1319 "namespace": "data", 1320 "identifier": "/ietf-system:system/ntp/server/prefer", 1321 "sid": 1760 1322 }, 1323 { 1324 "namespace": "data", 1325 "identifier": "/ietf-system:system/ntp/server/udp", 1326 "sid": 1761 1327 }, 1328 { 1329 "namespace": "data", 1330 "identifier": "/ietf-system:system/ntp/server/udp/address", 1331 "sid": 1762 1332 }, 1333 { 1334 "namespace": "data", 1335 "identifier": "/ietf-system:system/ntp/server/udp/port", 1336 "sid": 1763 1337 }, 1338 { 1339 "namespace": "data", 1340 "identifier": "/ietf-system:system/radius", 1341 "sid": 1764 1342 }, 1343 { 1344 "namespace": "data", 1345 "identifier": "/ietf-system:system/radius/options", 1346 "sid": 1765 1347 }, 1348 { 1349 "namespace": "data", 1350 "identifier": "/ietf-system:system/radius/options/attempts", 1351 "sid": 1766 1352 }, 1353 { 1354 "namespace": "data", 1355 "identifier": "/ietf-system:system/radius/options/timeout", 1356 "sid": 1767 1357 }, 1358 { 1359 "namespace": "data", 1360 "identifier": "/ietf-system:system/radius/server", 1361 "sid": 1768 1362 }, 1363 { 1364 "namespace": "data", 1365 "identifier": "/ietf-system:system/radius/server/ 1366 authentication-type", 1367 "sid": 1769 1368 }, 1369 { 1370 "namespace": "data", 1371 "identifier": "/ietf-system:system/radius/server/name", 1372 "sid": 1770 1374 }, 1375 { 1376 "namespace": "data", 1377 "identifier": "/ietf-system:system/radius/server/udp", 1378 "sid": 1771 1379 }, 1380 { 1381 "namespace": "data", 1382 "identifier": "/ietf-system:system/radius/server/udp/ 1383 address", 1384 "sid": 1772 1385 }, 1386 { 1387 "namespace": "data", 1388 "identifier": "/ietf-system:system/radius/server/udp/ 1389 authentication-port", 1390 "sid": 1773 1391 }, 1392 { 1393 "namespace": "data", 1394 "identifier": "/ietf-system:system/radius/server/udp/ 1395 shared-secret", 1396 "sid": 1774 1397 } 1398 ] 1399 } 1400 } 1402 Appendix B. SID auto generation 1404 Assignment of SIDs to YANG items can be automated, the recommended 1405 process to assign SIDs is as follows: 1407 1. A tool extracts the different items defined for a specific YANG 1408 module. 1410 2. The list of items is sorted in alphabetical order, 'namespace' in 1411 descending order, 'identifier' in ascending order. The 1412 'namespace' and 'identifier' formats are described in the YANG 1413 module 'ietf-sid-file' defined in Section 4. 1415 3. SIDs are assigned sequentially from the entry point up to the 1416 size of the registered SID range. This approach is recommended 1417 to minimize the serialization overhead, especially when delta 1418 between a reference SID and the current SID is used by protocols 1419 aiming to reduce message size. 1421 4. If the number of items exceeds the SID range(s) allocated to a 1422 YANG module, an extra range is added for subsequent assignments. 1424 5. The "dependency-revision" should reflect the revision numbers of 1425 each YANG module that the YANG module imports at the moment of 1426 the generation. 1428 In case of an update to an existing ".sid" file, an additional step 1429 is needed that increments the ".sid" file version number. If there 1430 was no version number in the previous version of the ".sid" file, 0 1431 is assumed as the version number of the old version of the ".sid" 1432 file and the version number is 1 for the new ".sid" file. Apart from 1433 that, changes of SID files can also be automated using the same 1434 method described above, only unassigned YANG items are processed at 1435 step #3. Already existing items in the SID file should not be given 1436 new SIDs. 1438 Note that ".sid" file versions are specific to a YANG module 1439 revision. For each new YANG module or each new revision of an 1440 existing YANG module, the version number of the initial ".sid" file 1441 should either be 0 or should not be present. 1443 Note also that RPC or action "input" and "output" data nodes MUST 1444 always be assigned SID even if they don't contain data nodes. The 1445 reason for this requirement is that other modules can augment the 1446 given module and those SIDs might be necessary. 1448 Appendix C. ".sid" file lifecycle 1450 Before assigning SIDs to their YANG modules, YANG module authors must 1451 acquire a SID range from a "SID Range Registry". If the YANG module 1452 is part of an IETF draft or RFC, the SID range need to be acquired 1453 from the "IETF SID Range Registry" as defined in Section 6.3. For 1454 the other YANG modules, the authors can acquire a SID range from any 1455 "SID Range Registry" of their choice. 1457 Once the SID range is acquired, the owner can use it to generate 1458 ".sid" file/s for his YANG module/s. It is recommended to leave some 1459 unallocated SIDs following the allocated range in each ".sid" file in 1460 order to allow better evolution of the YANG module in the future. 1461 Generation of ".sid" files should be performed using an automated 1462 tool. Note that ".sid" files can only be generated for YANG modules 1463 and not for submodules. 1465 C.1. SID File Creation 1467 The following activity diagram summarizes the creation of a YANG 1468 module and its associated ".sid" file. 1470 +---------------+ 1471 O | Creation of a | 1472 -|- ->| YANG module | 1473 / \ +---------------+ 1474 | 1475 V 1476 /-------------\ 1477 / Standardized \ yes 1478 \ YANG module ? /-------------+ 1479 \-------------/ | 1480 | no | 1481 V V 1482 /-------------\ +---------------+ 1483 / Constrained \ yes | SID range | 1484 +-->\ application ? /---->| registration |<----------+ 1485 | \-------------/ +---------------+ | 1486 | | no | | 1487 | V V | 1488 | +---------------+ +---------------+ | 1489 +---| YANG module | | SID sub-range | | 1490 | update | | assignment |<----------+ 1491 +---------------+ +---------------+ | 1492 | | 1493 V | 1494 +---------------+ +-------------+ 1495 | ".sid" file | | Rework YANG | 1496 | generation | | model | 1497 +---------------+ +-------------+ 1498 | ^ 1499 V | 1500 /----------\ yes | 1501 / Work in \ -----------+ 1502 \ progress / 1503 \----------/ 1504 | no 1505 V 1506 /-------------\ /-------------\ 1507 / RFC \ no / Open \ no 1508 \ publication? /---->\ specification?/---+ 1509 \-------------/ \-------------/ | 1510 | yes | yes | 1511 | +---------------+ | 1512 V V V 1514 +---------------+ +---------------+ 1515 | IANA | | Third party | 1516 | registration | | registration | 1517 +-------+-------+ +-------+-------+ 1518 | | 1519 +---------------------------------+ 1520 V 1521 [DONE] 1523 Figure 1: SID Lifecycle 1525 C.2. SID File Update 1527 The following Activity diagram summarizes the update of a YANG module 1528 and its associated ".sid" file. 1530 +---------------+ 1531 O | Update of the | 1532 -|- ->| YANG module | 1533 / \ | or include(s) | 1534 | or import(s) | 1535 +---------------+ 1536 | 1537 V 1538 /-------------\ 1539 / New items \ yes 1540 \ created ? /------+ 1541 \-------------/ | 1542 | no V 1543 | /-------------\ +----------------+ 1544 | / SID range \ yes | Extra sub-range| 1545 | \ exhausted ? /---->| assignment | 1546 | \-------------/ +----------------+ 1547 | | no | 1548 | +---------------------+ 1549 | | 1550 | V 1551 | +---------------+ 1552 | | ".sid" file | 1553 | | update based | 1554 | | on previous | 1555 | | ".sid" file | 1556 | +---------------+ 1557 | | 1558 | V 1559 | /-------------\ +---------------+ 1560 | / Publicly \ yes | YANG module | 1561 | \ available ? /---->| registration | 1562 | \-------------/ +---------------+ 1563 | | no | 1564 +--------------+---------------------+ 1565 | 1566 [DONE] 1568 Figure 2: YANG and SID file update 1570 Authors' Addresses 1571 Michel Veillette (editor) 1572 Trilliant Networks Inc. 1573 610 Rue du Luxembourg 1574 Granby, Quebec J2J 2V2 1575 Canada 1577 Phone: +14503750556 1578 Email: michel.veillette@trilliant.com 1580 Alexander Pelov (editor) 1581 Acklio 1582 1137A avenue des Champs Blancs 1583 Cesson-Sevigne, Bretagne 35510 1584 France 1586 Email: a@ackl.io 1588 Ivaylo Petrov (editor) 1589 Acklio 1590 1137A avenue des Champs Blancs 1591 Cesson-Sevigne, Bretagne 35510 1592 France 1594 Email: ivaylo@ackl.io