idnits 2.17.1 draft-ietf-core-sid-11.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 21 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 238 has weird spacing: '...evision rev...' == Line 240 has weird spacing: '...y-point sid...' == Line 244 has weird spacing: '...ntifier uni...' -- The document date (March 04, 2020) is 1507 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 1547, but not defined == Unused Reference: 'I-D.ietf-anima-constrained-voucher' is defined on line 892, 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-08 == 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 5, 2020 I. Petrov, Ed. 6 Acklio 7 March 04, 2020 9 YANG Schema Item iDentifier (SID) 10 draft-ietf-core-sid-11 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 5, 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 . . . . . . . . . . . . . . . . . . . 11 59 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11 60 6.1. Register SID File Format Module . . . . . . . . . . . . . 11 61 6.2. Create new IANA Registry: "SID Mega-Range" registry . . . 12 62 6.2.1. Structure . . . . . . . . . . . . . . . . . . . . . . 12 63 6.2.2. Allocation policy . . . . . . . . . . . . . . . . . . 12 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 . . . . . . . . . . 13 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 . . . . . . . . . . . . . . . . . . . . 31 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 dependency-revision* [module-name] 237 | +--rw module-name yang:yang-identifier 238 | +--rw module-revision revision-identifier 239 +--rw assigment-ranges* [entry-point] 240 | +--rw entry-point sid 241 | +--rw size uint64 242 +--rw items* [namespace identifier] 243 +--rw namespace enumeration 244 +--rw identifier union 245 +--rw sid sid 247 The following YANG module defined the structure of this file, 248 encoding is performed using the rules defined in [RFC7951]. 250 file "ietf-sid-file@2020-02-05.yang" 251 module ietf-sid-file { 252 namespace "urn:ietf:params:xml:ns:yang:ietf-sid-file"; 253 prefix sid; 255 import ietf-yang-types { 256 prefix yang; 257 } 258 import ietf-restconf { 259 prefix rc; 260 } 262 organization 263 "IETF Core Working Group"; 265 contact 266 "Michel Veillette 267 269 Andy Bierman 270 272 Alexander Pelov 273 "; 275 description 276 "Copyright (c) 2020 IETF Trust and the persons identified as 277 authors of the code. All rights reserved. 279 Redistribution and use in source and binary forms, with or 280 without modification, is permitted pursuant to, and subject to 281 the license terms contained in, the Simplified BSD License set 282 forth in Section 4.c of the IETF Trust's Legal Provisions 283 Relating to IETF Documents 284 (https://trustee.ietf.org/license-info). 286 This version of this YANG module is part of RFC XXXX 287 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself 288 for full legal notices. 290 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 291 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 292 'MAY', and 'OPTIONAL' in this document are to be interpreted as 293 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 294 they appear in all capitals, as shown here. 296 This module defines the structure of the .sid files. 298 Each .sid file contains the mapping between the different 299 string identifiers defined by a YANG module and a 300 corresponding numeric value called SID."; 302 revision 2020-02-05 { 303 description 304 "Initial revision."; 305 reference 306 "[I-D.ietf-core-sid] YANG Schema Item iDentifier (SID)"; 307 } 309 typedef revision-identifier { 310 type string { 311 pattern '\d{4}-\d{2}-\d{2}'; 312 } 313 description 314 "Represents a date in YYYY-MM-DD format."; 315 } 317 typedef sid-file-version-identifier { 318 type uint64; 319 description 320 "Optional attribute that gives information about the .sid file 321 version."; 322 } 324 typedef sid { 325 type uint64; 326 description 327 "YANG Schema Item iDentifier"; 328 reference 329 "[I-D.ietf-core-sid] YANG Schema Item iDentifier (SID)"; 330 } 332 typedef schema-node-path { 333 type string { 334 pattern 335 '/[a-zA-Z_][a-zA-Z0-9\-_.]*:[a-zA-Z_][a-zA-Z0-9\-_.]*' + 336 '(/[a-zA-Z_][a-zA-Z0-9\-_.]*(:[a-zA-Z_][a-zA-Z0-9\-_.]*)?)*'; 337 } 338 description 339 "Identifies a schema-node path string for use in the 340 SID registry. This string format follows the rules 341 for an instance-identifier, as defined in RFC 7959, 342 except that no predicates are allowed. 344 This format is intended to support the YANG 1.1 ABNF 345 for a schema node identifier, except module names 346 are used instead of prefixes, as specified in RFC 7951."; 347 reference 348 "RFC 7950, The YANG 1.1 Data Modeling Language; 349 Section 6.5: Schema Node Identifier; 350 RFC 7951, JSON Encoding of YANG Data; 351 Section 6.11: The instance-identifier type"; 352 } 354 rc:yang-data sid-file { 355 container content { 356 description 357 "A Wrapper container that together with the rc:yang-data extension 358 marks the YANG data structures inside as not being intended to be 359 implemented as part of a configuration datastore or as an operational 360 state within the server."; 361 leaf module-name { 362 type yang:yang-identifier; 363 description 364 "Name of the YANG module associated with this .sid file."; 365 } 367 leaf module-revision { 368 type revision-identifier; 369 description 370 "Revision of the YANG module associated with this .sid file. 371 This leaf is not present if no revision statement is 372 defined in the YANG module."; 373 } 374 leaf sid-file-version { 375 type sid-file-version-identifier; 376 description 377 "The version number of the .sid file. .sid files and the version 378 sequence are specific to a given YANG module revision. 379 This number starts at zero when there is a YANG module update. 380 This number can distinguish updates to the SID file which are the result of 381 new processing, or the result of reported errata."; 382 } 384 list dependency-revision { 385 key "module-name"; 387 description 388 "Information about the revision of each YANG module that the module in 389 'module-name' includes used during the .sid file generation."; 391 leaf module-name { 392 type yang:yang-identifier; 393 mandatory true; 394 description 395 "Name of the YANG module, dependency of 'module-name', for which 396 revision information is provided."; 397 } 398 leaf module-revision { 399 type revision-identifier; 400 mandatory true; 401 description 402 "Revision of the YANG module, dependency of 'module-name', for which 403 revision information is provided."; 404 } 405 } 407 list assigment-ranges { 408 key "entry-point"; 409 description 410 "SID range(s) allocated to the YANG module identified by 411 'module-name' and 'module-revision'. 413 - The SID range first available value is entry-point and the the last 414 available value in the range is (entry-point + size - 1). 415 - The SID ranges specified by all assignment-rages MUST NOT overlap."; 417 leaf entry-point { 418 type sid; 419 mandatory true; 420 description 421 "Lowest SID available for assignment."; 423 } 425 leaf size { 426 type uint64; 427 mandatory true; 428 description 429 "Number of SIDs available for assignment."; 430 } 431 } 433 list items { 434 key "namespace identifier"; 435 description 436 "Each entry within this list defined the mapping between 437 a YANG item string identifier and a SID. This list MUST 438 include a mapping entry for each YANG item defined by 439 the YANG module identified by 'module-name' and 440 'module-revision'."; 442 leaf namespace { 443 type enumeration { 444 enum module { 445 value 0; 446 description 447 "All module and submodule names share the same 448 global module identifier namespace."; 449 } 450 enum identity { 451 value 1; 452 description 453 "All identity names defined in a module and its 454 submodules share the same identity identifier 455 namespace."; 456 } 457 enum feature { 458 value 2; 459 description 460 "All feature names defined in a module and its 461 submodules share the same feature identifier 462 namespace."; 463 } 464 enum data { 465 value 3; 466 description 467 "The namespace for all data nodes, as defined in YANG."; 468 } 469 } 470 description 471 "Namespace of the YANG item for this mapping entry."; 472 } 474 leaf identifier { 475 type union { 476 type yang:yang-identifier; 477 type schema-node-path; 478 } 479 description 480 "String identifier of the YANG item for this mapping entry. 482 If the corresponding 'namespace' field is 'module', 483 'feature', or 'identity', then this field MUST 484 contain a valid YANG identifier string. 486 If the corresponding 'namespace' field is 'data', 487 then this field MUST contain a valid schema node 488 path."; 489 } 491 leaf sid { 492 type sid; 493 mandatory true; 494 description 495 "SID assigned to the YANG item for this mapping entry."; 496 } 497 } 498 } 499 } 500 } 501 503 5. Security Considerations 505 This document defines a new type of identifier used to encode data 506 models defined in YANG [RFC7950]. As such, this identifier does not 507 contribute to any new security issues in addition of those identified 508 for the specific protocols or contexts for which it is used. 510 6. IANA Considerations 512 6.1. Register SID File Format Module 514 This document registers one YANG module in the "YANG Module Names" 515 registry [RFC6020]: 517 o name: ietf-sid-file 518 o namespace: urn:ietf:params:xml:ns:yang:ietf-sid-file 520 o prefix: sid 522 o reference: [[THISRFC]] 524 6.2. Create new IANA Registry: "SID Mega-Range" registry 526 The name of this registry is "SID Mega-Range". This registry is used 527 to record the delegation of the management of a block of SIDs to 528 third parties (such as SDOs or registrars). 530 6.2.1. Structure 532 Each entry in this registry must include: 534 o The entry point (first SID) of the registered SID block. 536 o The size of the registered SID block. The size MUST be one 537 million (1 000 000) SIDs. 539 o The contact information of the requesting organization including: 541 * The policy of SID range allocations: Public, Private or Both. 543 * Organization name 545 * URL 547 The information associated to the Organization name should not be 548 publicly visible in the registry, but should be available. This 549 information includes contact email and phone number and change 550 controller email and phone number. 552 6.2.2. Allocation policy 554 The IANA policy for future additions to this registry is "Expert 555 Review" [RFC8126]. 557 An organization requesting to manage a SID Range (and thus have an 558 entry in the SID Mega-Range Registry), must ensure the following 559 capacities: 561 o The capacity to manage and operate a SID Range Registry. A SID 562 Range Registry MUST provide the following information for all SID 563 Ranges allocated by the Registry: 565 * Entry Point of allocated SID Range 566 * Size of allocated SID Range 568 * Type: Public or Private 570 + Public Ranges MUST include at least a reference to the YANG 571 module and ".sid" files for that SID Range. 573 + Private Ranges MUST be marked as "Private" 575 o A Policy of allocation, which clearly identifies if the SID Range 576 allocations would be Private, Public or Both. 578 o Technical capacity to ensure the sustained operation of the 579 registry for a period of at least 5 years. If Private 580 Registrations are allowed, the period must be of at least 10 581 years. 583 6.2.2.1. First allocation 585 For a first allocation to be provided, the requesting organization 586 must demonstrate a functional registry infrastructure. 588 6.2.2.2. Consecutive allocations 590 On subsequent allocation request(s), the organization must 591 demonstrate the exhaustion of the prior range. These conditions need 592 to be asserted by the assigned expert(s). 594 If that extra-allocation is done within 3 years from the last 595 allocation, the experts need to discuss this request on the CORE 596 working group mailing list and consensus needs to be obtained before 597 allocating a new Mega-Range. 599 6.2.3. Initial contents of the Registry 601 The initial entry in this registry is allocated to IANA: 603 +-------------+---------+------------+-------------------+----------+ 604 | Entry Point | Size | Allocation | Organization name | URL | 605 +-------------+---------+------------+-------------------+----------+ 606 | 0 | 1000000 | Public | IANA | iana.org | 607 +-------------+---------+------------+-------------------+----------+ 609 6.3. Create a new IANA Registry: IETF SID Range Registry (managed by 610 IANA) 612 6.3.1. Structure 614 Each entry in this registry must include: 616 o The SID range entry point. 618 o The SID range size. 620 o The YANG module name. 622 o Document reference. 624 6.3.2. Allocation policy 626 The first million SIDs assigned to IANA is sub-divided as follows: 628 o The range of 0 to 999 (size 1000) is "Reserved" as defined in 629 [RFC8126]. 631 o The range of 1000 to 59,999 (size 59,000) is reserved for YANG 632 modules defined in RFCs. The IANA policy for additions to this 633 registry is "Expert Review" [RFC8126]. 635 * The Expert MUST verify that the YANG module for which this 636 allocation is made has an RFC (existing RFC) OR is on track to 637 become RFC (early allocation with a request from the WG chairs 638 as defined by [RFC7120]). 640 o The SID range allocated for a YANG module can follow in one of the 641 four categories: 643 * SMALL (50 SIDs) 645 * MEDIUM (100 SIDs) 647 * LARGE (250 SIDs) 649 * CUSTOM (requested by the YANG module author, with a maximum of 650 1000 SIDs). In all cases, the size of a SID range assigned to 651 a YANG module should be at least 33% above the current number 652 of YANG items. This headroom allows assignment within the same 653 range of new YANG items introduced by subsequent revisions. A 654 larger SID range size may be requested by the authors if this 655 recommendation is considered insufficient. It is important to 656 note that an additional SID range can be allocated to an 657 existing YANG module if the initial range is exhausted. 659 o The range of 60,000 to 99,999 (size 40,000)is reserved for 660 experimental YANG modules. This range MUST NOT be used in 661 operational deployments since these SIDs are not globally unique 662 which limit their interoperability. The IANA policy for this 663 range is "Experimental use" [RFC8126]. 665 o The range of 100,000 to 999,999 (size 900,000) is "Reserved" as 666 defined in [RFC8126]. 668 +-------------+---------+------------------+ 669 | Entry Point | Size | IANA policy | 670 +-------------+---------+------------------+ 671 | 0 | 1,000 | Reserved | 672 | 1,000 | 59,000 | Expert Review | 673 | 60,000 | 40,000 | Experimental use | 674 | 100,000 | 900,000 | Reserved | 675 +-------------+---------+------------------+ 677 6.3.3. Initial contents of the registry 679 Initial entries in this registry are as follows: 681 +-----+-----+--------------------------+----------------------------+ 682 | Ent | Siz | Module name | Document reference | 683 | ry | e | | | 684 | Poi | | | | 685 | nt | | | | 686 +-----+-----+--------------------------+----------------------------+ 687 | 100 | 100 | ietf-comi | [I-D.ietf-core-comi] | 688 | 0 | | | | 689 | 110 | 50 | ietf-yang-types | [RFC6991] | 690 | 0 | | | | 691 | 115 | 50 | ietf-inet-types | [RFC6991] | 692 | 0 | | | | 693 | 120 | 50 | iana-crypt-hash | [RFC7317] | 694 | 0 | | | | 695 | 125 | 50 | ietf-netconf-acm | [RFC8341] | 696 | 0 | | | | 697 | 130 | 50 | ietf-sid-file | RFCXXXX | 698 | 0 | | | | 699 | 150 | 100 | ietf-interfaces | [RFC8343] | 700 | 0 | | | | 701 | 160 | 100 | ietf-ip | [RFC8344] | 702 | 0 | | | | 703 | 170 | 100 | ietf-system | [RFC7317] | 704 | 0 | | | | 705 | 180 | 400 | iana-if-type | [RFC7224] | 706 | 0 | | | | 707 | 240 | 50 | ietf-voucher | [RFC8366] | 708 | 0 | | | | 709 | 245 | 50 | ietf-constrained-voucher | [I-D.ietf-anima-constraine | 710 | 0 | | | d-voucher] | 711 | 250 | 50 | ietf-constrained- | [I-D.ietf-anima-constraine | 712 | 0 | | voucher-request | d-voucher] | 713 +-----+-----+--------------------------+----------------------------+ 715 // RFC Ed.: replace XXXX with RFC number assigned to this draft. 717 For allocation, RFC publication of the YANG module is required as per 718 [RFC8126]. The YANG module must be registered in the "YANG module 719 Name" registry according to the rules specified in section 14 of 720 [RFC6020]. 722 6.4. Create new IANA Registry: "IETF SID Registry" 724 The name of this registry is "IETF SID Registry". This registry is 725 used to record the allocation of SIDs for individual YANG module 726 items. 728 6.4.1. Structure 730 Each entry in this registry must include: 732 o The YANG module name. This module name must be present in the 733 "Name" column of the "YANG Module Names" registry. 735 o A link to the associated ".yang" file. This file link must be 736 present in the "File" column of the "YANG Module Names" registry. 738 o The link to the ".sid" file which defines the allocation. The 739 ".sid" file is stored by IANA. 741 o The number of actually allocated SIDs in the ".sid" file. 743 6.4.2. Allocation policy 745 The allocation policy is Expert review. The Expert MUST ensure that 746 the following conditions are met: 748 o The ".sid" file has a valid structure: 750 * The ".sid" file MUST be a valid JSON file following the 751 structure of the module defined in RFCXXXX (RFC Ed: replace XXX 752 with RFC number assigned to this draft). 754 o The ".sid" file allocates individual SIDs ONLY in the SID Ranges 755 for this YANG module (as allocated in the IETF SID Range 756 Registry): 758 * All SIDs in this ".sid" file MUST be within the ranges 759 allocated to this YANG module in the "IETF SID Range Registry". 761 o If another ".sid" file has already allocated SIDs for this YANG 762 module (e.g. for older or newer versions of the YANG module), the 763 YANG items are assigned the same SIDs as in the other ".sid" file. 765 o If there is an older version of the ".sid" file, all allocated 766 SIDs from that version are still present in the current version of 767 the ".sid" file. 769 6.4.3. Recursive Allocation of SID Range at Document Adoption 771 Due to the difficulty in changing SID values during IETF document 772 processing, it is expected that most documents will ask for SID 773 allocations using Early Allocations [RFC7120]. The details of the 774 Early Allocation should be included in any Working Group Adoption 775 call. Prior to Working Group Adoption, an internet draft authors can 776 use the experimental SID range (as per Section 6.3.2) for their SIDs 777 allocations or other values that do not create ambiguity with other 778 SID uses (for example they can use a range that comes from a non-IANA 779 managed "SID Mega-Range" registry). 781 After Working Group Adoption, any modification of a ".sid" file is 782 expected to be discussed on the mailing list of the appropriate 783 Working Groups. Specific attention should be paid to implementers' 784 opinion after Working Group Last Call if a SID value is to change its 785 meaning. In all cases, a ".sid" file and the SIDs associated with it 786 are subject to change before the publication of an internet draft as 787 an RFC. 789 During the early use of SIDs, many existing, previously published 790 YANG modules will not have SID allocations. For an allocation to be 791 useful the included YANG modules may also need to have SID 792 allocations made. 794 The Expert Reviewer who performs the (Early) Allocation analysis will 795 need to go through the list of included YANG modules and perform SID 796 allocations for those modules as well. 798 o If the document is a published RFC, then the allocation of SIDs 799 for its referenced YANG modules is permanent. The Expert Reviewer 800 provides the generated SID file to IANA for registration. This 801 process may be time consuming during a bootstrap period (there are 802 over 100 YANG modules to date, none of which have SID 803 allocations), but should quiet down once needed entries are 804 allocated. 806 o If the document is an unprocessed Internet-Draft adopted in a WG, 807 then an Early Allocation is performed for this document as well. 808 Early Allocations require approval by an IESG Area Director. An 809 early allocation which requires additional allocations will list 810 the other allocations in it's description, and will be cross- 811 posted to the any other working group mailing lists. 813 o A YANG module which references a module in an document which has 814 not yet been adopted by any working group will be unable to 815 perform an Early Allocation for that other document until it is 816 adopted by a working group. As described in [RFC7120], an AD 817 Sponsored document acts as if it had a working group. The 818 approving AD may also exempt a document from this policy by 819 agreeing to AD Sponsor the document. 821 At the end of the IETF process all the dependencies of a given module 822 for which SIDs are assigned, should also have SIDs assigned. Those 823 dependencies' assignments should be permanent (not Early Allocation). 825 A previously SID-allocated YANG module which changes its references 826 to include a YANG module for which there is no SID allocation needs 827 to repeat the Early Allocation process. 829 Early Allocations are made with a one-year period, after which they 830 are expired. [RFC7120] indicates that at most one renewal may be 831 made. For the SID allocation a far more lenient stance is desired. 833 1. An extension of a referencing documents Early Allocation should 834 update any referenced Early Allocations to expire no sooner than 835 the referencing document. 837 2. The [RFC7120] mechanism allows the IESG to provide a second 838 renewal, and such an event may prompt some thought about how the 839 collection of documents are being processed. 841 This is driven by the very generous size of the SID space and the 842 often complex and deep dependencies of YANG modules. Often a core 843 module with many dependencies will undergo extensive review, delaying 844 the publication of other documents. 846 [RFC7120] also says 848 Note that if a document is submitted for review to the IESG and at 849 the time of submission some early allocations are valid (not 850 expired), these allocations should not be expired while the document 851 is under IESG consideration or waiting in the RFC Editor's queue 852 after approval by the IESG. 854 6.4.4. Initial contents of the registry 856 None. 858 7. Acknowledgments 860 The authors would like to thank Andy Bierman, Carsten Bormann, 861 Michael Richardson, Abhinav Somaraju, Peter van der Stok, Laurent 862 Toutain and Randy Turner for their help during the development of 863 this document and their useful comments during the review process. 865 8. References 867 8.1. Normative References 869 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 870 Requirement Levels", BCP 14, RFC 2119, 871 DOI 10.17487/RFC2119, March 1997, 872 . 874 [RFC7120] Cotton, M., "Early IANA Allocation of Standards Track Code 875 Points", BCP 100, RFC 7120, DOI 10.17487/RFC7120, January 876 2014, . 878 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 879 RFC 7950, DOI 10.17487/RFC7950, August 2016, 880 . 882 [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", 883 RFC 7951, DOI 10.17487/RFC7951, August 2016, 884 . 886 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 887 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 888 May 2017, . 890 8.2. Informative References 892 [I-D.ietf-anima-constrained-voucher] 893 Richardson, M., Stok, P., and P. Kampanakis, "Constrained 894 Voucher Artifacts for Bootstrapping Protocols", draft- 895 ietf-anima-constrained-voucher-07 (work in progress), 896 January 2020. 898 [I-D.ietf-core-comi] 899 Veillette, M., Stok, P., Pelov, A., Bierman, A., and I. 900 Petrov, "CoAP Management Interface", draft-ietf-core- 901 comi-08 (work in progress), September 2019. 903 [I-D.ietf-core-yang-library] 904 Veillette, M. and I. Petrov, "Constrained YANG Module 905 Library", draft-ietf-core-yang-library-01 (work in 906 progress), January 2020. 908 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 909 the Network Configuration Protocol (NETCONF)", RFC 6020, 910 DOI 10.17487/RFC6020, October 2010, 911 . 913 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 914 and A. Bierman, Ed., "Network Configuration Protocol 915 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 916 . 918 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 919 RFC 6991, DOI 10.17487/RFC6991, July 2013, 920 . 922 [RFC7224] Bjorklund, M., "IANA Interface Type YANG Module", 923 RFC 7224, DOI 10.17487/RFC7224, May 2014, 924 . 926 [RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for 927 System Management", RFC 7317, DOI 10.17487/RFC7317, August 928 2014, . 930 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 931 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 932 . 934 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 935 Writing an IANA Considerations Section in RFCs", BCP 26, 936 RFC 8126, DOI 10.17487/RFC8126, June 2017, 937 . 939 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 940 Access Control Model", STD 91, RFC 8341, 941 DOI 10.17487/RFC8341, March 2018, 942 . 944 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 945 Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, 946 . 948 [RFC8344] Bjorklund, M., "A YANG Data Model for IP Management", 949 RFC 8344, DOI 10.17487/RFC8344, March 2018, 950 . 952 [RFC8366] Watsen, K., Richardson, M., Pritikin, M., and T. Eckert, 953 "A Voucher Artifact for Bootstrapping Protocols", 954 RFC 8366, DOI 10.17487/RFC8366, May 2018, 955 . 957 Appendix A. ".sid" file example 959 The following ".sid" file (ietf-system@2014-08-06.sid) have been 960 generated using the following yang modules: 962 o ietf-system@2014-08-06.yang 964 o ietf-yang-types@2013-07-15.yang 966 o ietf-inet-types@2013-07-15.yang 968 o ietf-netconf-acm@2012-02-22.yang 969 o iana-crypt-hash@2014-04-04.yang 971 { 972 "assignment-ranges": [ 973 { 974 "entry-point": 1700, 975 "size": 100 976 } 977 ], 978 "module-name": "ietf-system", 979 "module-revision": "2014-08-06", 980 "items": [ 981 { 982 "namespace": "module", 983 "identifier": "ietf-system", 984 "sid": 1700 985 }, 986 { 987 "namespace": "identity", 988 "identifier": "authentication-method", 989 "sid": 1701 990 }, 991 { 992 "namespace": "identity", 993 "identifier": "local-users", 994 "sid": 1702 995 }, 996 { 997 "namespace": "identity", 998 "identifier": "radius", 999 "sid": 1703 1000 }, 1001 { 1002 "namespace": "identity", 1003 "identifier": "radius-authentication-type", 1004 "sid": 1704 1005 }, 1006 { 1007 "namespace": "identity", 1008 "identifier": "radius-chap", 1009 "sid": 1705 1010 }, 1011 { 1012 "namespace": "identity", 1013 "identifier": "radius-pap", 1014 "sid": 1706 1015 }, 1016 { 1017 "namespace": "feature", 1018 "identifier": "authentication", 1019 "sid": 1707 1020 }, 1021 { 1022 "namespace": "feature", 1023 "identifier": "dns-udp-tcp-port", 1024 "sid": 1708 1025 }, 1026 { 1027 "namespace": "feature", 1028 "identifier": "local-users", 1029 "sid": 1709 1030 }, 1031 { 1032 "namespace": "feature", 1033 "identifier": "ntp", 1034 "sid": 1710 1035 }, 1036 { 1037 "namespace": "feature", 1038 "identifier": "ntp-udp-port", 1039 "sid": 1711 1040 }, 1041 { 1042 "namespace": "feature", 1043 "identifier": "radius", 1044 "sid": 1712 1045 }, 1046 { 1047 "namespace": "feature", 1048 "identifier": "radius-authentication", 1049 "sid": 1713 1050 }, 1051 { 1052 "namespace": "feature", 1053 "identifier": "timezone-name", 1054 "sid": 1714 1055 }, 1056 { 1057 "namespace": "data", 1058 "identifier": "/ietf-system:set-current-datetime", 1059 "sid": 1715 1060 }, 1061 { 1062 "namespace": "data", 1063 "identifier": "/ietf-system:set-current-datetime/ 1064 current-datetime", 1066 "sid": 1716 1067 }, 1068 { 1069 "namespace": "data", 1070 "identifier": "/ietf-system:system", 1071 "sid": 1717 1072 }, 1073 { 1074 "namespace": "data", 1075 "identifier": "/ietf-system:system-restart", 1076 "sid": 1718 1077 }, 1078 { 1079 "namespace": "data", 1080 "identifier": "/ietf-system:system-shutdown", 1081 "sid": 1719 1082 }, 1083 { 1084 "namespace": "data", 1085 "identifier": "/ietf-system:system-state", 1086 "sid": 1720 1087 }, 1088 { 1089 "namespace": "data", 1090 "identifier": "/ietf-system:system-state/clock", 1091 "sid": 1721 1092 }, 1093 { 1094 "namespace": "data", 1095 "identifier": "/ietf-system:system-state/clock/boot-datetime", 1096 "sid": 1722 1097 }, 1098 { 1099 "namespace": "data", 1100 "identifier": "/ietf-system:system-state/clock/ 1101 current-datetime", 1102 "sid": 1723 1103 }, 1104 { 1105 "namespace": "data", 1106 "identifier": "/ietf-system:system-state/platform", 1107 "sid": 1724 1108 }, 1109 { 1110 "namespace": "data", 1111 "identifier": "/ietf-system:system-state/platform/machine", 1112 "sid": 1725 1113 }, 1114 { 1115 "namespace": "data", 1116 "identifier": "/ietf-system:system-state/platform/os-name", 1117 "sid": 1726 1118 }, 1119 { 1120 "namespace": "data", 1121 "identifier": "/ietf-system:system-state/platform/os-release", 1122 "sid": 1727 1123 }, 1124 { 1125 "namespace": "data", 1126 "identifier": "/ietf-system:system-state/platform/os-version", 1127 "sid": 1728 1128 }, 1129 { 1130 "namespace": "data", 1131 "identifier": "/ietf-system:system/authentication", 1132 "sid": 1729 1133 }, 1134 { 1135 "namespace": "data", 1136 "identifier": "/ietf-system:system/authentication/user", 1137 "sid": 1730 1138 }, 1139 { 1140 "namespace": "data", 1141 "identifier": "/ietf-system:system/authentication/ 1142 user-authentication-order", 1143 "sid": 1731 1144 }, 1145 { 1146 "namespace": "data", 1147 "identifier": "/ietf-system:system/authentication/user/ 1148 authorized-key", 1149 "sid": 1732 1150 }, 1151 { 1152 "namespace": "data", 1153 "identifier": "/ietf-system:system/authentication/user/ 1154 authorized-key/algorithm", 1155 "sid": 1733 1156 }, 1157 { 1158 "namespace": "data", 1159 "identifier": "/ietf-system:system/authentication/user/ 1160 authorized-key/key-data", 1161 "sid": 1734 1163 }, 1164 { 1165 "namespace": "data", 1166 "identifier": "/ietf-system:system/authentication/user/ 1167 authorized-key/name", 1168 "sid": 1735 1169 }, 1170 { 1171 "namespace": "data", 1172 "identifier": "/ietf-system:system/authentication/user/ 1173 name", 1174 "sid": 1736 1175 }, 1176 { 1177 "namespace": "data", 1178 "identifier": "/ietf-system:system/authentication/user/ 1179 password", 1180 "sid": 1737 1181 }, 1182 { 1183 "namespace": "data", 1184 "identifier": "/ietf-system:system/clock", 1185 "sid": 1738 1186 }, 1187 { 1188 "namespace": "data", 1189 "identifier": "/ietf-system:system/clock/timezone-name", 1190 "sid": 1739 1191 }, 1192 { 1193 "namespace": "data", 1194 "identifier": "/ietf-system:system/clock/timezone-utc-offset", 1195 "sid": 1740 1196 }, 1197 { 1198 "namespace": "data", 1199 "identifier": "/ietf-system:system/contact", 1200 "sid": 1741 1201 }, 1202 { 1203 "namespace": "data", 1204 "identifier": "/ietf-system:system/dns-resolver", 1205 "sid": 1742 1206 }, 1207 { 1208 "namespace": "data", 1209 "identifier": "/ietf-system:system/dns-resolver/options", 1210 "sid": 1743 1212 }, 1213 { 1214 "namespace": "data", 1215 "identifier": "/ietf-system:system/dns-resolver/options/ 1216 attempts", 1217 "sid": 1744 1218 }, 1219 { 1220 "namespace": "data", 1221 "identifier": "/ietf-system:system/dns-resolver/options/ 1222 timeout", 1223 "sid": 1745 1224 }, 1225 { 1226 "namespace": "data", 1227 "identifier": "/ietf-system:system/dns-resolver/search", 1228 "sid": 1746 1229 }, 1230 { 1231 "namespace": "data", 1232 "identifier": "/ietf-system:system/dns-resolver/server", 1233 "sid": 1747 1234 }, 1235 { 1236 "namespace": "data", 1237 "identifier": "/ietf-system:system/dns-resolver/server/name", 1238 "sid": 1748 1239 }, 1240 { 1241 "namespace": "data", 1242 "identifier": "/ietf-system:system/dns-resolver/server/ 1243 udp-and-tcp", 1244 "sid": 1749 1245 }, 1246 { 1247 "namespace": "data", 1248 "identifier": "/ietf-system:system/dns-resolver/server/ 1249 udp-and-tcp/address", 1250 "sid": 1750 1251 }, 1252 { 1253 "namespace": "data", 1254 "identifier": "/ietf-system:system/dns-resolver/server/ 1255 udp-and-tcp/port", 1256 "sid": 1751 1257 }, 1258 { 1259 "namespace": "data", 1260 "identifier": "/ietf-system:system/hostname", 1261 "sid": 1752 1262 }, 1263 { 1264 "namespace": "data", 1265 "identifier": "/ietf-system:system/location", 1266 "sid": 1753 1267 }, 1268 { 1269 "namespace": "data", 1270 "identifier": "/ietf-system:system/ntp", 1271 "sid": 1754 1272 }, 1273 { 1274 "namespace": "data", 1275 "identifier": "/ietf-system:system/ntp/enabled", 1276 "sid": 1755 1277 }, 1278 { 1279 "namespace": "data", 1280 "identifier": "/ietf-system:system/ntp/server", 1281 "sid": 1756 1282 }, 1283 { 1284 "namespace": "data", 1285 "identifier": "/ietf-system:system/ntp/server/ 1286 association-type", 1287 "sid": 1757 1288 }, 1289 { 1290 "namespace": "data", 1291 "identifier": "/ietf-system:system/ntp/server/iburst", 1292 "sid": 1758 1293 }, 1294 { 1295 "namespace": "data", 1296 "identifier": "/ietf-system:system/ntp/server/name", 1297 "sid": 1759 1298 }, 1299 { 1300 "namespace": "data", 1301 "identifier": "/ietf-system:system/ntp/server/prefer", 1302 "sid": 1760 1303 }, 1304 { 1305 "namespace": "data", 1306 "identifier": "/ietf-system:system/ntp/server/udp", 1307 "sid": 1761 1309 }, 1310 { 1311 "namespace": "data", 1312 "identifier": "/ietf-system:system/ntp/server/udp/address", 1313 "sid": 1762 1314 }, 1315 { 1316 "namespace": "data", 1317 "identifier": "/ietf-system:system/ntp/server/udp/port", 1318 "sid": 1763 1319 }, 1320 { 1321 "namespace": "data", 1322 "identifier": "/ietf-system:system/radius", 1323 "sid": 1764 1324 }, 1325 { 1326 "namespace": "data", 1327 "identifier": "/ietf-system:system/radius/options", 1328 "sid": 1765 1329 }, 1330 { 1331 "namespace": "data", 1332 "identifier": "/ietf-system:system/radius/options/attempts", 1333 "sid": 1766 1334 }, 1335 { 1336 "namespace": "data", 1337 "identifier": "/ietf-system:system/radius/options/timeout", 1338 "sid": 1767 1339 }, 1340 { 1341 "namespace": "data", 1342 "identifier": "/ietf-system:system/radius/server", 1343 "sid": 1768 1344 }, 1345 { 1346 "namespace": "data", 1347 "identifier": "/ietf-system:system/radius/server/ 1348 authentication-type", 1349 "sid": 1769 1350 }, 1351 { 1352 "namespace": "data", 1353 "identifier": "/ietf-system:system/radius/server/name", 1354 "sid": 1770 1355 }, 1356 { 1357 "namespace": "data", 1358 "identifier": "/ietf-system:system/radius/server/udp", 1359 "sid": 1771 1360 }, 1361 { 1362 "namespace": "data", 1363 "identifier": "/ietf-system:system/radius/server/udp/ 1364 address", 1365 "sid": 1772 1366 }, 1367 { 1368 "namespace": "data", 1369 "identifier": "/ietf-system:system/radius/server/udp/ 1370 authentication-port", 1371 "sid": 1773 1372 }, 1373 { 1374 "namespace": "data", 1375 "identifier": "/ietf-system:system/radius/server/udp/ 1376 shared-secret", 1377 "sid": 1774 1378 } 1379 ] 1380 } 1382 Appendix B. SID auto generation 1384 Assignment of SIDs to YANG items can be automated, the recommended 1385 process to assign SIDs is as follows: 1387 1. A tool extracts the different items defined for a specific YANG 1388 module. 1390 2. The list of items is sorted in alphabetical order, 'namespace' in 1391 descending order, 'identifier' in ascending order. The 1392 'namespace' and 'identifier' formats are described in the YANG 1393 module 'ietf-sid-file' defined in Section 4. 1395 3. SIDs are assigned sequentially from the entry point up to the 1396 size of the registered SID range. This approach is recommended 1397 to minimize the serialization overhead, especially when delta 1398 between a reference SID and the current SID is used by protocols 1399 aiming to reduce message size. 1401 4. If the number of items exceeds the SID range(s) allocated to a 1402 YANG module, an extra range is added for subsequent assignments. 1404 5. The "dependency-revision" should reflect the revision numbers of 1405 each YANG module that the YANG module imports at the moment of 1406 the generation. 1408 In case of an update to an existing ".sid" file, an additional step 1409 is needed that increments the ".sid" file version number. If there 1410 was no version number in the previous version of the ".sid" file, 0 1411 is assumed as the version number of the old version of the ".sid" 1412 file and the version number is 1 for the new ".sid" file. Apart from 1413 that, changes of SID files can also be automated using the same 1414 method described above, only unassigned YANG items are processed at 1415 step #3. Already existing items in the SID file should not be given 1416 new SIDs. 1418 Note that ".sid" file versions are specific to a YANG module 1419 revision. For each new YANG module or each new revision of an 1420 existing YANG module, the version number of the initial ".sid" file 1421 should either be 0 or should not be present. 1423 Note also that RPC or action "input" and "output" data nodes MUST 1424 always be assigned SID even if they don't contain data nodes. The 1425 reason for this requirement is that other modules can augment the 1426 given module and those SIDs might be necessary. 1428 Appendix C. ".sid" file lifecycle 1430 Before assigning SIDs to their YANG modules, YANG module authors must 1431 acquire a SID range from a "SID Range Registry". If the YANG module 1432 is part of an IETF draft or RFC, the SID range need to be acquired 1433 from the "IETF SID Range Registry" as defined in Section 6.3. For 1434 the other YANG modules, the authors can acquire a SID range from any 1435 "SID Range Registry" of their choice. 1437 Once the SID range is acquired, the owner can use it to generate 1438 ".sid" file/s for his YANG module/s. It is recommended to leave some 1439 unallocated SIDs following the allocated range in each ".sid" file in 1440 order to allow better evolution of the YANG module in the future. 1441 Generation of ".sid" files should be performed using an automated 1442 tool. Note that ".sid" files can only be generated for YANG modules 1443 and not for submodules. 1445 C.1. SID File Creation 1447 The following activity diagram summarizes the creation of a YANG 1448 module and its associated ".sid" file. 1450 +---------------+ 1451 O | Creation of a | 1453 -|- ->| YANG module | 1454 / \ +---------------+ 1455 | 1456 V 1457 /-------------\ 1458 / Standardized \ yes 1459 \ YANG module ? /-------------+ 1460 \-------------/ | 1461 | no | 1462 V V 1463 /-------------\ +---------------+ 1464 / Constrained \ yes | SID range | 1465 +-->\ application ? /---->| registration |<----------+ 1466 | \-------------/ +---------------+ | 1467 | | no | | 1468 | V V | 1469 | +---------------+ +---------------+ | 1470 +---| YANG module | | SID sub-range | | 1471 | update | | assignment |<----------+ 1472 +---------------+ +---------------+ | 1473 | | 1474 V | 1475 +---------------+ +-------------+ 1476 | ".sid" file | | Rework YANG | 1477 | generation | | model | 1478 +---------------+ +-------------+ 1479 | ^ 1480 V | 1481 /----------\ yes | 1482 / Work in \ -----------+ 1483 \ progress / 1484 \----------/ 1485 | no 1486 V 1487 /-------------\ /-------------\ 1488 / RFC \ no / Open \ no 1489 \ publication? /---->\ specification?/---+ 1490 \-------------/ \-------------/ | 1491 | yes | yes | 1492 | +---------------+ | 1493 V V V 1494 +---------------+ +---------------+ 1495 | IANA | | Third party | 1496 | registration | | registration | 1497 +-------+-------+ +-------+-------+ 1498 | | 1499 +---------------------------------+ 1500 V 1502 [DONE] 1504 Figure 1: SID Lifecycle 1506 C.2. SID File Update 1508 The following Activity diagram summarizes the update of a YANG module 1509 and its associated ".sid" file. 1511 +---------------+ 1512 O | Update of the | 1513 -|- ->| YANG module | 1514 / \ | or include(s) | 1515 | or import(s) | 1516 +---------------+ 1517 | 1518 V 1519 /-------------\ 1520 / New items \ yes 1521 \ created ? /------+ 1522 \-------------/ | 1523 | no V 1524 | /-------------\ +----------------+ 1525 | / SID range \ yes | Extra sub-range| 1526 | \ exhausted ? /---->| assignment | 1527 | \-------------/ +----------------+ 1528 | | no | 1529 | +---------------------+ 1530 | | 1531 | V 1532 | +---------------+ 1533 | | ".sid" file | 1534 | | update based | 1535 | | on previous | 1536 | | ".sid" file | 1537 | +---------------+ 1538 | | 1539 | V 1540 | /-------------\ +---------------+ 1541 | / Publicly \ yes | YANG module | 1542 | \ available ? /---->| registration | 1543 | \-------------/ +---------------+ 1544 | | no | 1545 +--------------+---------------------+ 1546 | 1547 [DONE] 1549 Figure 2: YANG and SID file update 1551 Authors' Addresses 1552 Michel Veillette (editor) 1553 Trilliant Networks Inc. 1554 610 Rue du Luxembourg 1555 Granby, Quebec J2J 2V2 1556 Canada 1558 Phone: +14503750556 1559 Email: michel.veillette@trilliant.com 1561 Alexander Pelov (editor) 1562 Acklio 1563 1137A avenue des Champs Blancs 1564 Cesson-Sevigne, Bretagne 35510 1565 France 1567 Email: a@ackl.io 1569 Ivaylo Petrov (editor) 1570 Acklio 1571 1137A avenue des Champs Blancs 1572 Cesson-Sevigne, Bretagne 35510 1573 France 1575 Email: ivaylo@ackl.io