idnits 2.17.00 (12 Aug 2021) /tmp/idnits57555/draft-ietf-core-sid-15.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 31 instances of too long lines in the document, the longest one being 9 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 253 has weird spacing: '...evision rev...' == Line 255 has weird spacing: '...y-point sid...' == Line 259 has weird spacing: '...ntifier uni...' -- The document date (January 17, 2021) is 488 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 1670, but not defined == Unused Reference: 'I-D.ietf-anima-constrained-voucher' is defined on line 1003, but no explicit reference was found in the text == Outdated reference: A later version (-20) exists of draft-ietf-core-yang-cbor-13 == Outdated reference: A later version (-17) exists of draft-ietf-anima-constrained-voucher-09 == Outdated reference: A later version (-11) exists of draft-ietf-core-comi-10 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: July 21, 2021 I. Petrov, Ed. 6 Acklio 7 January 17, 2021 9 YANG Schema Item iDentifier (YANG SID) 10 draft-ietf-core-sid-15 12 Abstract 14 YANG Schema Item iDentifiers (YANG 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 YANG 17 SIDs. To enable the implementation of these processes, this document 18 also defines a file format used to persist and publish assigned YANG 19 SIDs. 21 Status of This Memo 23 This Internet-Draft is submitted in full conformance with the 24 provisions of BCP 78 and BCP 79. 26 Internet-Drafts are working documents of the Internet Engineering 27 Task Force (IETF). Note that other groups may also distribute 28 working documents as Internet-Drafts. The list of current Internet- 29 Drafts is at https://datatracker.ietf.org/drafts/current/. 31 Internet-Drafts are draft documents valid for a maximum of six months 32 and may be updated, replaced, or obsoleted by other documents at any 33 time. It is inappropriate to use Internet-Drafts as reference 34 material or to cite them other than as "work in progress." 36 This Internet-Draft will expire on July 21, 2021. 38 Copyright Notice 40 Copyright (c) 2021 IETF Trust and the persons identified as the 41 document authors. All rights reserved. 43 This document is subject to BCP 78 and the IETF Trust's Legal 44 Provisions Relating to IETF Documents 45 (https://trustee.ietf.org/license-info) in effect on the date of 46 publication of this document. Please review these documents 47 carefully, as they describe your rights and restrictions with respect 48 to this document. Code Components extracted from this document must 49 include Simplified BSD License text as described in Section 4.e of 50 the Trust Legal Provisions and are provided without warranty as 51 described in the Simplified BSD License. 53 Table of Contents 55 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 56 2. Terminology and Notation . . . . . . . . . . . . . . . . . . 4 57 3. ".sid" file lifecycle . . . . . . . . . . . . . . . . . . . . 5 58 4. ".sid" file format . . . . . . . . . . . . . . . . . . . . . 6 59 5. Content-Types . . . . . . . . . . . . . . . . . . . . . . . . 12 60 6. Security Considerations . . . . . . . . . . . . . . . . . . . 12 61 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13 62 7.1. YANG Namespace Registration . . . . . . . . . . . . . . . 13 63 7.2. Register ".sid" File Format Module . . . . . . . . . . . 13 64 7.3. CoAP Content-Formats Registry . . . . . . . . . . . . . . 13 65 7.4. Create new IANA Registry: "YANG SID Mega-Range" registry 14 66 7.4.1. Structure . . . . . . . . . . . . . . . . . . . . . . 14 67 7.4.2. Allocation policy . . . . . . . . . . . . . . . . . . 14 68 7.4.2.1. First allocation . . . . . . . . . . . . . . . . 15 69 7.4.2.2. Consecutive allocations . . . . . . . . . . . . . 15 70 7.4.3. Initial contents of the Registry . . . . . . . . . . 15 71 7.5. Create a new IANA Registry: IETF YANG SID Range Registry 72 (managed by IANA) . . . . . . . . . . . . . . . . . . . . 15 73 7.5.1. Structure . . . . . . . . . . . . . . . . . . . . . . 15 74 7.5.2. Allocation policy . . . . . . . . . . . . . . . . . . 16 75 7.5.3. Initial contents of the registry . . . . . . . . . . 17 76 7.6. Create new IANA Registry: "IETF YANG SID Registry" . . . 18 77 7.6.1. Structure . . . . . . . . . . . . . . . . . . . . . . 18 78 7.6.2. Allocation policy . . . . . . . . . . . . . . . . . . 18 79 7.6.3. Recursive Allocation of YANG SID Range at Document 80 Adoption . . . . . . . . . . . . . . . . . . . . . . 19 81 7.6.4. Initial contents of the registry . . . . . . . . . . 20 82 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 21 83 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 21 84 9.1. Normative References . . . . . . . . . . . . . . . . . . 21 85 9.2. Informative References . . . . . . . . . . . . . . . . . 22 86 Appendix A. ".sid" file example . . . . . . . . . . . . . . . . 23 87 Appendix B. SID auto generation . . . . . . . . . . . . . . . . 32 88 Appendix C. ".sid" file lifecycle . . . . . . . . . . . . . . . 33 89 C.1. ".sid" File Creation . . . . . . . . . . . . . . . . . . 33 90 C.2. ".sid" File Update . . . . . . . . . . . . . . . . . . . 35 91 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 36 93 1. Introduction 95 Some of the items defined in YANG [RFC7950] require the use of a 96 unique identifier. In both NETCONF [RFC6241] and RESTCONF [RFC8040], 97 these identifiers are implemented using names. To allow the 98 implementation of data models defined in YANG in constrained devices 99 and constrained networks, a more compact method to identify YANG 100 items is required. This compact identifier, called YANG SID or 101 simply SID in this document and when the context is clear, is encoded 102 using a 63-bit unsigned integer. The limitation to 63-bit unsigned 103 integers allows SIDs to be manipulated more easily on platforms that 104 might otherwise lack native 64-bit unsigned arithmetic. The loss of 105 a single bit of range is not significant given the size of the 106 remaining space. 108 The following items are identified using SIDs: 110 o identities 112 o data nodes (Note: including those nodes defined by the 'yang-data' 113 extension.) 115 o RPCs and associated input(s) and output(s) 117 o actions and associated input(s) and output(s) 119 o notifications and associated information 121 o YANG modules, submodules and features 123 It is possible that some protocols use only a subset of the assigned 124 SIDs, for example, for protocols equivalent to NETCONF [RFC6241] like 125 [I-D.ietf-core-comi] the transportation of YANG modules SIDs might be 126 unnecessary. Others protocols might need to be able to transport 127 this information, for example protocols related to discovery such as 128 Constrained YANG Module Library [I-D.ietf-core-yang-library]. 130 SIDs are globally unique integers, a registration system is used in 131 order to guarantee their uniqueness. SIDs are registered in blocks 132 called "SID ranges". 134 Assignment of SIDs to YANG items can be automated. For more details 135 how this could be achieved, please consult Appendix B. 137 SIDs are assigned permanently, items introduced by a new revision of 138 a YANG module are added to the list of SIDs already assigned. If the 139 meaning of an item changes, for example as a result from a non- 140 backward compatible update of the YANG module, a new SID should be 141 assigned to it. 143 Section 3 provides more details about the registration process of 144 YANG modules and associated SIDs. To enable the implementation of 145 this registry, Section 4 defines a standard file format used to store 146 and publish SIDs. 148 2. Terminology and Notation 150 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 151 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 152 "OPTIONAL" in this document are to be interpreted as described in BCP 153 14 [RFC2119] [RFC8174] when, and only when, they appear in all 154 capitals, as shown here. 156 The following terms are defined in [RFC7950]: 158 o action 160 o feature 162 o module 164 o notification 166 o RPC 168 o schema node 170 o schema tree 172 o submodule 174 The following term is defined in [RFC8040]: 176 o yang-data extension 178 This specification also makes use of the following terminology: 180 o item: A schema node, an identity, a module, a submodule or a 181 feature defined using the YANG modeling language. 183 o schema-node path: A schema-node path is a string that identifies a 184 schema node within the schema tree. A path consists of the list 185 of consecutive schema node identifier(s) separated by slashes 186 ("/"). Schema node identifier(s) are always listed from the top- 187 level schema node up to the targeted schema node and could contain 188 namespace information. (e.g. "/ietf-system:system-state/clock/ 189 current-datetime") 191 o Namespace-qualified form - a schema node identifier is prefixed 192 with the name of the module in which the schema node is defined, 193 separated from the schema node identifier by the colon character 194 (":"). 196 o YANG Schema Item iDentifier (YANG SID or simply SID): Unsigned 197 integer used to identify different YANG items. 199 3. ".sid" file lifecycle 201 YANG is a language designed to model data accessed using one of the 202 compatible protocols (e.g. NETCONF [RFC6241], RESTCONF [RFC8040] and 203 CORECONF [I-D.ietf-core-comi]). A YANG module defines hierarchies of 204 data, including configuration, state data, RPCs, actions and 205 notifications. 207 Many YANG modules are not created in the context of constrained 208 applications. YANG modules can be implemented using NETCONF 209 [RFC6241] or RESTCONF [RFC8040] without the need to assign SIDs. 211 As needed, authors of YANG modules can assign SIDs to their YANG 212 modules. In order to do that, they should first obtain a SID range 213 from a registry and use that range to assign or generate SIDs to 214 items of their YANG module. The assignments can then be stored in a 215 ".sid" file. For example on how this could be achieved, please refer 216 to Appendix C. 218 Registration of the ".sid" file associated to a YANG module is 219 optional but recommended to promote interoperability between devices 220 and to avoid duplicate allocation of SIDs to a single YANG module. 221 Different registries might have different requirements for the 222 registration and publication of the ".sid" files. For a diagram of 223 one of the possibilities, please refer to the activity diagram on 224 Figure 1 in Appendix C. 226 Each time a YANG module or one of its imported module(s) or included 227 sub-module(s) is updated, a new ".sid" file MAY need to be created. 228 All the SIDs present in the previous version of the ".sid" file MUST 229 be present in the new version as well. The creation of this new 230 version of the ".sid" file SHOULD be performed using an automated 231 tool. 233 If a new revision requires more SIDs than initially allocated, a new 234 SID range MUST be added to the 'assignment-ranges' as defined in 235 Section 4. These extra SIDs are used for subsequent assignments. 237 For an example of this update process, see activity diagram Figure 2 238 in Appendix C. 240 4. ".sid" file format 242 ".sid" files are used to persist and publish SIDs assigned to the 243 different YANG items of a specific YANG module. It has the following 244 structure. 246 module: ietf-sid-file 247 +--rw module-name? yang:yang-identifier 248 +--rw module-revision? revision-identifier 249 +--rw sid-file-version? sid-file-version-identifier 250 +--rw description? string 251 +--rw dependency-revision* [module-name] 252 | +--rw module-name yang:yang-identifier 253 | +--rw module-revision revision-identifier 254 +--rw assigment-ranges* [entry-point] 255 | +--rw entry-point sid 256 | +--rw size uint64 257 +--rw items* [namespace identifier] 258 +--rw namespace enumeration 259 +--rw identifier union 260 +--rw sid sid 262 The following YANG module defined the structure of this file, 263 encoding is performed using the rules defined in [RFC7951]. It 264 references ietf-yang-types defined in [RFC6991] and ietf-restconf 265 defined in [RFC8040]. 267 RFC Ed.: please update the date of the module and Copyright if needed 268 and remove this note. 270 file "ietf-sid-file@2020-02-05.yang" 271 module ietf-sid-file { 272 yang-version 1.1; 273 namespace "urn:ietf:params:xml:ns:yang:ietf-sid-file"; 274 prefix sid; 276 import ietf-yang-types { 277 prefix yang; 278 reference "RFC 6991: Common YANG Data Types."; 279 } 280 import ietf-restconf { 281 prefix rc; 282 reference "RFC 8040: RESTCONF Protocol."; 283 } 284 organization 285 "IETF Core Working Group"; 287 contact 288 "WG Web: 290 WG List: 292 Editor: Michel Veillette 293 295 Editor: Andy Bierman 296 298 Editor: Alexander Pelov 299 301 Editor: Ivaylo Petrov 302 "; 304 description 305 "Copyright (c) 2021 IETF Trust and the persons identified as 306 authors of the code. All rights reserved. 308 Redistribution and use in source and binary forms, with or 309 without modification, is permitted pursuant to, and subject to 310 the license terms contained in, the Simplified BSD License set 311 forth in Section 4.c of the IETF Trust's Legal Provisions 312 Relating to IETF Documents 313 (https://trustee.ietf.org/license-info). 315 This version of this YANG module is part of RFC XXXX 316 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself 317 for full legal notices. 319 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 320 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 321 'MAY', and 'OPTIONAL' in this document are to be interpreted as 322 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 323 they appear in all capitals, as shown here. 325 This module defines the structure of the .sid files. 327 Each .sid file contains the mapping between the different 328 string identifiers defined by a YANG module and a 329 corresponding numeric value called YANG SID."; 331 revision 2020-02-05 { 332 description 333 "Initial revision."; 334 reference 335 "[I-D.ietf-core-sid] YANG Schema Item iDentifier (YANG SID)"; 336 } 338 typedef revision-identifier { 339 type string { 340 pattern '\d{4}-\d{2}-\d{2}'; 341 } 342 description 343 "Represents a date in YYYY-MM-DD format."; 344 } 346 typedef sid-file-version-identifier { 347 type uint64; 348 description 349 "Represents the version of a .sid file."; 350 } 352 typedef sid { 353 type uint64 { 354 range "0..9223372036854775807"; 355 } 356 description 357 "YANG Schema Item iDentifier"; 358 reference 359 "[I-D.ietf-core-sid] YANG Schema Item iDentifier (YANG SID)"; 360 } 362 typedef schema-node-path { 363 type string { 364 pattern 365 '/[a-zA-Z_][a-zA-Z0-9\-_.]*:[a-zA-Z_][a-zA-Z0-9\-_.]*' + 366 '(/[a-zA-Z_][a-zA-Z0-9\-_.]*(:[a-zA-Z_][a-zA-Z0-9\-_.]*)?)*'; 367 } 368 description 369 "A schema-node path is an absolute YANG schema node identifier as 370 defined by the YANG ABNF rule absolute-schema-nodeid, except 371 that module names are used instead of prefixes. 373 This string additionally follows the following rules: 375 o The leftmost (top-level) data node name is always in the 376 namespace-qualified form. 377 o Any subsequent schema node name is in the namespace-qualified form 378 if the node is defined in a module other than its parent node, and 379 the simple form is used otherwise. No predicates are allowed."; 381 reference 382 "RFC 7950, The YANG 1.1 Data Modeling Language; 383 Section 6.5: Schema Node Identifier;"; 384 } 386 rc:yang-data sid-file { 387 uses sid-file; 388 } 390 grouping sid-file { 391 description "A grouping that contains a YANG container representing the 392 file structure of a .sid files."; 394 container sid-file { 395 description 396 "A Wrapper container that together with the rc:yang-data extension 397 marks the YANG data structures inside as not being intended to be 398 implemented as part of a configuration datastore or as an operational 399 state within the server."; 400 leaf module-name { 401 type yang:yang-identifier; 402 description 403 "Name of the YANG module associated with this .sid file."; 404 } 406 leaf module-revision { 407 type revision-identifier; 408 description 409 "Revision of the YANG module associated with this .sid file. 410 This leaf is not present if no revision statement is 411 defined in the YANG module."; 412 } 414 leaf sid-file-version { 415 type sid-file-version-identifier; 416 description 417 "Optional leaf that specifies the version number of the .sid file. 418 .sid files and the version sequence are specific to a given YANG 419 module revision. This number starts at zero when there is a new YANG 420 module revision and increases monotonically. This number can 421 distinguish updates to the .sid file which are the result of new 422 processing, or the result of reported errata."; 423 } 425 leaf description { 426 type string; 427 description 428 "Free-form meta information about the generated file. It might 429 include .sid file generation tool and time among other things."; 430 } 432 list dependency-revision { 433 key "module-name"; 435 description 436 "Information about the used revision during the .sid file generation 437 of each YANG module that the module in 'module-name' imported."; 439 leaf module-name { 440 type yang:yang-identifier; 441 mandatory true; 442 description 443 "Name of the YANG module, dependency of 'module-name', for which 444 revision information is provided."; 445 } 446 leaf module-revision { 447 type revision-identifier; 448 mandatory true; 449 description 450 "Revision of the YANG module, dependency of 'module-name', for which 451 revision information is provided."; 452 } 453 } 455 list assigment-ranges { 456 key "entry-point"; 457 description 458 "YANG SID range(s) allocated to the YANG module identified by 459 'module-name' and 'module-revision'. 461 - The YANG SID range first available value is entry-point and the the 462 last available value in the range is (entry-point + size - 1). 463 - The YANG SID ranges specified by all assignment-rages MUST NOT 464 overlap."; 466 leaf entry-point { 467 type sid; 468 mandatory true; 469 description 470 "Lowest YANG SID available for assignment."; 471 } 473 leaf size { 474 type uint64; 475 mandatory true; 476 description 477 "Number of YANG SIDs available for assignment."; 478 } 479 } 481 list items { 482 key "namespace identifier"; 483 description 484 "Each entry within this list defined the mapping between 485 a YANG item string identifier and a YANG SID. This list MUST 486 include a mapping entry for each YANG item defined by 487 the YANG module identified by 'module-name' and 488 'module-revision'."; 490 leaf namespace { 491 type enumeration { 492 enum module { 493 value 0; 494 description 495 "All module and submodule names share the same 496 global module identifier namespace."; 497 } 498 enum identity { 499 value 1; 500 description 501 "All identity names defined in a module and its 502 submodules share the same identity identifier 503 namespace."; 504 } 505 enum feature { 506 value 2; 507 description 508 "All feature names defined in a module and its 509 submodules share the same feature identifier 510 namespace."; 511 } 512 enum data { 513 value 3; 514 description 515 "The namespace for all data nodes, as defined in YANG."; 516 } 517 } 518 description 519 "Namespace of the YANG item for this mapping entry."; 520 } 522 leaf identifier { 523 type union { 524 type yang:yang-identifier; 525 type schema-node-path; 526 } 527 description 528 "String identifier of the YANG item for this mapping entry. 530 If the corresponding 'namespace' field is 'module', 531 'feature', or 'identity', then this field MUST 532 contain a valid YANG identifier string. 534 If the corresponding 'namespace' field is 'data', 535 then this field MUST contain a valid schema node 536 path."; 537 } 539 leaf sid { 540 type sid; 541 mandatory true; 542 description 543 "YANG SID assigned to the YANG item for this mapping entry."; 544 } 545 } 546 } 547 } 548 } 549 551 5. Content-Types 553 The following Content-Type is defined: 555 application/yang-data+cbor; id=sid: This Content-Type represents a 556 CBOR YANG document containing one or multiple data node values. 557 Each data node is identified by its associated SID. 559 FORMAT: CBOR map of SID, instance-value 561 The message payload of Content-Type 'application/yang-data+cbor' 562 is encoded using a CBOR map. Each entry within the CBOR map 563 contains the data node identifier (i.e. SID) and the associated 564 instance-value. Instance-values are encoded using the rules 565 defined in [I-D.ietf-core-yang-cbor] section 4. 567 6. Security Considerations 569 This document defines a new type of identifier used to encode data 570 models defined in YANG [RFC7950]. As such, this identifier does not 571 contribute to any new security issues in addition of those identified 572 for the specific protocols or contexts for which it is used. 574 7. IANA Considerations 576 7.1. YANG Namespace Registration 578 This document registers the following XML namespace URN in the "IETF 579 XML Registry", following the format defined in [RFC3688]: 581 URI: please assign urn:ietf:params:xml:ns:yang:ietf-sid-file 583 Registrant Contact: The IESG. 585 XML: N/A, the requested URI is an XML namespace. 587 Reference: RFC XXXX 589 // RFC Ed.: please replace XXXX with RFC number and remove this note 591 7.2. Register ".sid" File Format Module 593 This document registers one YANG module in the "YANG Module Names" 594 registry [RFC6020]: 596 o name: ietf-sid-file 598 o namespace: urn:ietf:params:xml:ns:yang:ietf-sid-file 600 o prefix: sid 602 o reference: [[THISRFC]] 604 7.3. CoAP Content-Formats Registry 606 This document adds the following Content-Format to the "CoAP Content- 607 Formats", within the "Constrained RESTful Environments (CoRE) 608 Parameters" registry. 610 +---------------------------------+--------------+------+-----------+ 611 | Media Type | Content | ID | Reference | 612 | | Coding | | | 613 +---------------------------------+--------------+------+-----------+ 614 | application/yang-data+cbor; | | TBD1 | RFC XXXX | 615 | id=sid | | | | 616 +---------------------------------+--------------+------+-----------+ 618 // RFC Ed.: replace TBD1 with assigned IDs and remove this note. // 619 RFC Ed.: replace RFC XXXX with this RFC number and remove this note. 621 7.4. Create new IANA Registry: "YANG SID Mega-Range" registry 623 The name of this registry is "YANG SID Mega-Range". This registry is 624 used to record the delegation of the management of a block of SIDs to 625 third parties (such as SDOs or registrars). 627 7.4.1. Structure 629 Each entry in this registry must include: 631 o The entry point (first SID) of the registered SID block. 633 o The size of the registered SID block. The size MUST be one 634 million (1 000 000) SIDs. 636 o The contact information of the requesting organization including: 638 * The policy of SID range allocations: Public, Private or Both. 640 * Organization name 642 * URL 644 The information associated to the Organization name should not be 645 publicly visible in the registry, but should be available. This 646 information includes contact email and phone number and change 647 controller email and phone number. 649 7.4.2. Allocation policy 651 The IANA policy for future additions to this registry is "Expert 652 Review" [RFC8126]. 654 An organization requesting to manage a YANG SID Range (and thus have 655 an entry in the YANG SID Mega-Range Registry), must ensure the 656 following capacities: 658 o The capacity to manage and operate a YANG SID Range Registry. A 659 YANG SID Range Registry MUST provide the following information for 660 all YANG SID Ranges allocated by the Registry: 662 * Entry Point of allocated YANG SID Range 664 * Size of allocated YANG SID Range 666 * Type: Public or Private 667 + Public Ranges MUST include at least a reference to the YANG 668 module and ".sid" files for that YANG SID Range. 670 + Private Ranges MUST be marked as "Private" 672 o A Policy of allocation, which clearly identifies if the YANG SID 673 Range allocations would be Private, Public or Both. 675 o Technical capacity to ensure the sustained operation of the 676 registry for a period of at least 5 years. If Private 677 Registrations are allowed, the period must be of at least 10 678 years. 680 7.4.2.1. First allocation 682 For a first allocation to be provided, the requesting organization 683 must demonstrate a functional registry infrastructure. 685 7.4.2.2. Consecutive allocations 687 On subsequent allocation request(s), the organization must 688 demonstrate the exhaustion of the prior range. These conditions need 689 to be asserted by the assigned expert(s). 691 If that extra-allocation is done within 3 years from the last 692 allocation, the experts need to discuss this request on the CORE 693 working group mailing list and consensus needs to be obtained before 694 allocating a new Mega-Range. 696 7.4.3. Initial contents of the Registry 698 The initial entry in this registry is allocated to IANA: 700 +-------------+---------+------------+-------------------+----------+ 701 | Entry Point | Size | Allocation | Organization name | URL | 702 +-------------+---------+------------+-------------------+----------+ 703 | 0 | 1000000 | Public | IANA | iana.org | 704 +-------------+---------+------------+-------------------+----------+ 706 7.5. Create a new IANA Registry: IETF YANG SID Range Registry (managed 707 by IANA) 709 7.5.1. Structure 711 Each entry in this registry must include: 713 o The SID range entry point. 715 o The SID range size. 717 o The YANG module name. 719 o Document reference. 721 7.5.2. Allocation policy 723 The first million SIDs assigned to IANA is sub-divided as follows: 725 o The range of 0 to 999 (size 1000) is "Reserved" as defined in 726 [RFC8126]. 728 o The range of 1000 to 59,999 (size 59,000) is reserved for YANG 729 modules defined in RFCs. 731 * The IANA policy for additions to this registry is either: 733 + "Expert Review" [RFC8126] in case the ".sid" file comes from 734 a YANG module from an existing RFC, or 736 + "RFC Required" [RFC8126] otherwise. 738 * The Expert MUST verify that the YANG module for which this 739 allocation is made has an RFC (existing RFC) OR is on track to 740 become RFC (early allocation with a request from the WG chairs 741 as defined by [RFC7120]). 743 o The range of 60,000 to 99,999 (size 40,000) is reserved for 744 experimental YANG modules. This range MUST NOT be used in 745 operational deployments since these SIDs are not globally unique 746 which limit their interoperability. The IANA policy for this 747 range is "Experimental use" [RFC8126]. 749 o The range of 100,000 to 999,999 (size 900,000) is "Reserved" as 750 defined in [RFC8126]. 752 +-------------+---------+-------------------------------+ 753 | Entry Point | Size | IANA policy | 754 +-------------+---------+-------------------------------+ 755 | 0 | 1,000 | Reserved | 756 | 1,000 | 59,000 | Expert Review or RFC Required | 757 | 60,000 | 40,000 | Experimental use | 758 | 100,000 | 900,000 | Reserved | 759 +-------------+---------+-------------------------------+ 761 The size of the SID range allocated for a YANG module is recommended 762 to be a multiple of 50 and to be at least 33% above the current 763 number of YANG items. This headroom allows assignment within the 764 same range of new YANG items introduced by subsequent revisions. The 765 maximum SID range size is 1000. A larger size may be requested by 766 the authors if this recommendation is considered insufficient. It is 767 important to note that an additional SID range can be allocated to an 768 existing YANG module if the initial range is exhausted. 770 In case a SID range is allocated for an existing RFC through the 771 "Expert Review" policy, the Document reference field for the given 772 allocation should point to the RFC that the YANG module is defined 773 in. 775 In case a SID range is required before publishing the RFC due to 776 implementations needing stable SID values, early allocation as 777 defined in [RFC7120] can be employed. As specified in section 4.6 of 778 [RFC8126], RFCs and by extension documents that are expected to 779 become an RFC fulfill the requirement for "Specification Required" 780 stated in section 2 of [RFC7120], which allows for the early 781 allocation process to be employed. 783 7.5.3. Initial contents of the registry 785 Initial entries in this registry are as follows: 787 +-------+------+---------------------------+------------------------+ 788 | Entry | Size | Module name | Document reference | 789 | Point | | | | 790 +-------+------+---------------------------+------------------------+ 791 | 1000 | 100 | ietf-coreconf | [I-D.ietf-core-comi] | 792 | 1100 | 50 | ietf-yang-types | [RFC6991] | 793 | 1150 | 50 | ietf-inet-types | [RFC6991] | 794 | 1200 | 50 | iana-crypt-hash | [RFC7317] | 795 | 1250 | 50 | ietf-netconf-acm | [RFC8341] | 796 | 1300 | 50 | ietf-sid-file | RFCXXXX | 797 | 1500 | 100 | ietf-interfaces | [RFC8343] | 798 | 1600 | 100 | ietf-ip | [RFC8344] | 799 | 1700 | 100 | ietf-system | [RFC7317] | 800 | 1800 | 400 | iana-if-type | [RFC7224] | 801 | 2400 | 50 | ietf-voucher | [RFC8366] | 802 | 2450 | 50 | ietf-constrained-voucher | [I-D.ietf-anima-constr | 803 | | | | ained-voucher] | 804 | 2500 | 50 | ietf-constrained-voucher- | [I-D.ietf-anima-constr | 805 | | | request | ained-voucher] | 806 +-------+------+---------------------------+------------------------+ 808 // RFC Ed.: replace XXXX with RFC number assigned to this draft. 810 For allocation, RFC publication of the YANG module is required as per 811 [RFC8126]. The YANG module must be registered in the "YANG module 812 Name" registry according to the rules specified in section 14 of 813 [RFC6020]. 815 7.6. Create new IANA Registry: "IETF YANG SID Registry" 817 The name of this registry is "IETF YANG SID Registry". This registry 818 is used to record the allocation of SIDs for individual YANG module 819 items. 821 7.6.1. Structure 823 Each entry in this registry must include: 825 o The YANG module name. This module name must be present in the 826 "Name" column of the "YANG Module Names" registry. 828 o A link to the associated ".yang" file. This file link must be 829 present in the "File" column of the "YANG Module Names" registry. 831 o The link to the ".sid" file which defines the allocation. The 832 ".sid" file is stored by IANA. 834 o The number of actually allocated SIDs in the ".sid" file. 836 7.6.2. Allocation policy 838 The allocation policy is Expert review. The Expert MUST ensure that 839 the following conditions are met: 841 o The ".sid" file has a valid structure: 843 * The ".sid" file MUST be a valid JSON file following the 844 structure of the module defined in RFCXXXX (RFC Ed: replace XXX 845 with RFC number assigned to this draft). 847 o The ".sid" file allocates individual SIDs ONLY in the YANG SID 848 Ranges for this YANG module (as allocated in the IETF YANG SID 849 Range Registry): 851 * All SIDs in this ".sid" file MUST be within the ranges 852 allocated to this YANG module in the "IETF YANG SID Range 853 Registry". 855 o If another ".sid" file has already allocated SIDs for this YANG 856 module (e.g. for older or newer versions of the YANG module), the 857 YANG items are assigned the same SIDs as in the other ".sid" file. 859 o If there is an older version of the ".sid" file, all allocated 860 SIDs from that version are still present in the current version of 861 the ".sid" file. 863 7.6.3. Recursive Allocation of YANG SID Range at Document Adoption 865 Due to the difficulty in changing SID values during IETF document 866 processing, it is expected that most documents will ask for SID 867 allocations using Early Allocations [RFC7120]. The details of the 868 Early Allocation should be included in any Working Group Adoption 869 call. Prior to Working Group Adoption, an internet draft authors can 870 use the experimental SID range (as per Section 7.5.2) for their SIDs 871 allocations or other values that do not create ambiguity with other 872 SID uses (for example they can use a range that comes from a non-IANA 873 managed "YANG SID Mega-Range" registry). 875 After Working Group Adoption, any modification of a ".sid" file is 876 expected to be discussed on the mailing list of the appropriate 877 Working Groups. Specific attention should be paid to implementers' 878 opinion after Working Group Last Call if a SID value is to change its 879 meaning. In all cases, a ".sid" file and the SIDs associated with it 880 are subject to change before the publication of an internet draft as 881 an RFC. 883 During the early use of SIDs, many existing, previously published 884 YANG modules will not have SID allocations. For an allocation to be 885 useful the included YANG modules may also need to have SID 886 allocations made. 888 The Expert Reviewer who performs the (Early) Allocation analysis will 889 need to go through the list of included YANG modules and perform SID 890 allocations for those modules as well. 892 o If the document is a published RFC, then the allocation of SIDs 893 for its referenced YANG modules is permanent. The Expert Reviewer 894 provides the generated SID file to IANA for registration. This 895 process may be time consuming during a bootstrap period (there are 896 over 100 YANG modules to date, none of which have SID 897 allocations), but should quiet down once needed entries are 898 allocated. 900 o If the document is an unprocessed Internet-Draft adopted in a WG, 901 then an Early Allocation is performed for this document as well. 902 Early Allocations require approval by an IESG Area Director. An 903 early allocation which requires additional allocations will list 904 the other allocations in it's description, and will be cross- 905 posted to the any other working group mailing lists. 907 o A YANG module which references a module in an document which has 908 not yet been adopted by any working group will be unable to 909 perform an Early Allocation for that other document until it is 910 adopted by a working group. As described in [RFC7120], an AD 911 Sponsored document acts as if it had a working group. The 912 approving AD may also exempt a document from this policy by 913 agreeing to AD Sponsor the document. 915 At the end of the IETF process all the dependencies of a given module 916 for which SIDs are assigned, should also have SIDs assigned. Those 917 dependencies' assignments should be permanent (not Early Allocation). 919 A previously SID-allocated YANG module which changes its references 920 to include a YANG module for which there is no SID allocation needs 921 to repeat the Early Allocation process. 923 Early Allocations are made with a one-year period, after which they 924 are expired. [RFC7120] indicates that at most one renewal may be 925 made. For the SID allocation a far more lenient stance is desired. 927 1. An extension of a referencing documents Early Allocation should 928 update any referenced Early Allocations to expire no sooner than 929 the referencing document. 931 2. The [RFC7120] mechanism allows the IESG to provide a second 932 renewal, and such an event may prompt some thought about how the 933 collection of documents are being processed. 935 This is driven by the very generous size of the SID space and the 936 often complex and deep dependencies of YANG modules. Often a core 937 module with many dependencies will undergo extensive review, delaying 938 the publication of other documents. 940 [RFC7120] also says: 942 Note that if a document is submitted for review to the IESG and at 943 the time of submission some early allocations are valid (not 944 expired), these allocations should not be expired while the document 945 is under IESG consideration or waiting in the RFC Editor's queue 946 after approval by the IESG. 948 7.6.4. Initial contents of the registry 950 None. 952 8. Acknowledgments 954 The authors would like to thank Andy Bierman, Carsten Bormann, 955 Michael Richardson, Abhinav Somaraju, Peter van der Stok, Laurent 956 Toutain and Randy Turner for their help during the development of 957 this document and their useful comments during the review process. 959 9. References 961 9.1. Normative References 963 [I-D.ietf-core-yang-cbor] 964 Veillette, M., Petrov, I., and A. Pelov, "CBOR Encoding of 965 Data Modeled with YANG", draft-ietf-core-yang-cbor-13 966 (work in progress), July 2020. 968 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 969 Requirement Levels", BCP 14, RFC 2119, 970 DOI 10.17487/RFC2119, March 1997, 971 . 973 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 974 DOI 10.17487/RFC3688, January 2004, 975 . 977 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 978 RFC 6991, DOI 10.17487/RFC6991, July 2013, 979 . 981 [RFC7120] Cotton, M., "Early IANA Allocation of Standards Track Code 982 Points", BCP 100, RFC 7120, DOI 10.17487/RFC7120, January 983 2014, . 985 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 986 RFC 7950, DOI 10.17487/RFC7950, August 2016, 987 . 989 [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", 990 RFC 7951, DOI 10.17487/RFC7951, August 2016, 991 . 993 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 994 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 995 . 997 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 998 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 999 May 2017, . 1001 9.2. Informative References 1003 [I-D.ietf-anima-constrained-voucher] 1004 Richardson, M., Stok, P., and P. Kampanakis, "Constrained 1005 Voucher Artifacts for Bootstrapping Protocols", draft- 1006 ietf-anima-constrained-voucher-09 (work in progress), 1007 November 2020. 1009 [I-D.ietf-core-comi] 1010 Veillette, M., Stok, P., Pelov, A., Bierman, A., and I. 1011 Petrov, "CoAP Management Interface (CORECONF)", draft- 1012 ietf-core-comi-10 (work in progress), July 2020. 1014 [I-D.ietf-core-yang-library] 1015 Veillette, M. and I. Petrov, "Constrained YANG Module 1016 Library", draft-ietf-core-yang-library-03 (work in 1017 progress), January 2021. 1019 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 1020 the Network Configuration Protocol (NETCONF)", RFC 6020, 1021 DOI 10.17487/RFC6020, October 2010, 1022 . 1024 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 1025 and A. Bierman, Ed., "Network Configuration Protocol 1026 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 1027 . 1029 [RFC7224] Bjorklund, M., "IANA Interface Type YANG Module", 1030 RFC 7224, DOI 10.17487/RFC7224, May 2014, 1031 . 1033 [RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for 1034 System Management", RFC 7317, DOI 10.17487/RFC7317, August 1035 2014, . 1037 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 1038 Writing an IANA Considerations Section in RFCs", BCP 26, 1039 RFC 8126, DOI 10.17487/RFC8126, June 2017, 1040 . 1042 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 1043 Access Control Model", STD 91, RFC 8341, 1044 DOI 10.17487/RFC8341, March 2018, 1045 . 1047 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 1048 Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, 1049 . 1051 [RFC8344] Bjorklund, M., "A YANG Data Model for IP Management", 1052 RFC 8344, DOI 10.17487/RFC8344, March 2018, 1053 . 1055 [RFC8366] Watsen, K., Richardson, M., Pritikin, M., and T. Eckert, 1056 "A Voucher Artifact for Bootstrapping Protocols", 1057 RFC 8366, DOI 10.17487/RFC8366, May 2018, 1058 . 1060 Appendix A. ".sid" file example 1062 The following ".sid" file (ietf-system@2014-08-06.sid) have been 1063 generated using the following yang modules: 1065 o ietf-system@2014-08-06.yang (defined in [RFC7317]) 1067 o ietf-yang-types@2013-07-15.yang (defined in [RFC6991]) 1069 o ietf-inet-types@2013-07-15.yang (defined in [RFC6991]) 1071 o ietf-netconf-acm@2018-02-14.yang (defined in [RFC8341]) 1073 o iana-crypt-hash@2014-04-04.yang (defined in [RFC7317]) 1075 { 1076 "ietf-sid-file:sid-file" : { 1077 "module-name": "ietf-system", 1078 "module-revision": "2020-02-05", 1079 "dependency-revision": [ 1080 { 1081 "module-name": "ietf-yang-types", 1082 "module-revision": "2013-07-15.yang" 1083 }, 1084 { 1085 "module-name": "ietf-inet-types", 1086 "module-revision": "2013-07-15.yang" 1087 }, 1088 { 1089 "module-name": "ietf-netconf-acm", 1090 "module-revision": "2018-02-14.yang" 1091 }, 1092 { 1093 "module-name": "iana-crypt-hash", 1094 "module-revision": "2014-04-04.yang" 1096 } 1097 ], 1098 "description": "Example sid file", 1099 "assignment-ranges": [ 1100 { 1101 "entry-point": 1700, 1102 "size": 100 1103 } 1104 ], 1105 "items": [ 1106 { 1107 "namespace": "module", 1108 "identifier": "ietf-system", 1109 "sid": 1700 1110 }, 1111 { 1112 "namespace": "identity", 1113 "identifier": "authentication-method", 1114 "sid": 1701 1115 }, 1116 { 1117 "namespace": "identity", 1118 "identifier": "local-users", 1119 "sid": 1702 1120 }, 1121 { 1122 "namespace": "identity", 1123 "identifier": "radius", 1124 "sid": 1703 1125 }, 1126 { 1127 "namespace": "identity", 1128 "identifier": "radius-authentication-type", 1129 "sid": 1704 1130 }, 1131 { 1132 "namespace": "identity", 1133 "identifier": "radius-chap", 1134 "sid": 1705 1135 }, 1136 { 1137 "namespace": "identity", 1138 "identifier": "radius-pap", 1139 "sid": 1706 1140 }, 1141 { 1142 "namespace": "feature", 1143 "identifier": "authentication", 1144 "sid": 1707 1145 }, 1146 { 1147 "namespace": "feature", 1148 "identifier": "dns-udp-tcp-port", 1149 "sid": 1708 1150 }, 1151 { 1152 "namespace": "feature", 1153 "identifier": "local-users", 1154 "sid": 1709 1155 }, 1156 { 1157 "namespace": "feature", 1158 "identifier": "ntp", 1159 "sid": 1710 1160 }, 1161 { 1162 "namespace": "feature", 1163 "identifier": "ntp-udp-port", 1164 "sid": 1711 1165 }, 1166 { 1167 "namespace": "feature", 1168 "identifier": "radius", 1169 "sid": 1712 1170 }, 1171 { 1172 "namespace": "feature", 1173 "identifier": "radius-authentication", 1174 "sid": 1713 1175 }, 1176 { 1177 "namespace": "feature", 1178 "identifier": "timezone-name", 1179 "sid": 1714 1180 }, 1181 { 1182 "namespace": "data", 1183 "identifier": "/ietf-system:set-current-datetime", 1184 "sid": 1715 1185 }, 1186 { 1187 "namespace": "data", 1188 "identifier": "/ietf-system:set-current-datetime/ 1189 current-datetime", 1190 "sid": 1716 1191 }, 1192 { 1193 "namespace": "data", 1194 "identifier": "/ietf-system:system", 1195 "sid": 1717 1196 }, 1197 { 1198 "namespace": "data", 1199 "identifier": "/ietf-system:system-restart", 1200 "sid": 1718 1201 }, 1202 { 1203 "namespace": "data", 1204 "identifier": "/ietf-system:system-shutdown", 1205 "sid": 1719 1206 }, 1207 { 1208 "namespace": "data", 1209 "identifier": "/ietf-system:system-state", 1210 "sid": 1720 1211 }, 1212 { 1213 "namespace": "data", 1214 "identifier": "/ietf-system:system-state/clock", 1215 "sid": 1721 1216 }, 1217 { 1218 "namespace": "data", 1219 "identifier": "/ietf-system:system-state/clock/boot-datetime", 1220 "sid": 1722 1221 }, 1222 { 1223 "namespace": "data", 1224 "identifier": "/ietf-system:system-state/clock/ 1225 current-datetime", 1226 "sid": 1723 1227 }, 1228 { 1229 "namespace": "data", 1230 "identifier": "/ietf-system:system-state/platform", 1231 "sid": 1724 1232 }, 1233 { 1234 "namespace": "data", 1235 "identifier": "/ietf-system:system-state/platform/machine", 1236 "sid": 1725 1237 }, 1238 { 1239 "namespace": "data", 1240 "identifier": "/ietf-system:system-state/platform/os-name", 1241 "sid": 1726 1242 }, 1243 { 1244 "namespace": "data", 1245 "identifier": "/ietf-system:system-state/platform/os-release", 1246 "sid": 1727 1247 }, 1248 { 1249 "namespace": "data", 1250 "identifier": "/ietf-system:system-state/platform/os-version", 1251 "sid": 1728 1252 }, 1253 { 1254 "namespace": "data", 1255 "identifier": "/ietf-system:system/authentication", 1256 "sid": 1729 1257 }, 1258 { 1259 "namespace": "data", 1260 "identifier": "/ietf-system:system/authentication/user", 1261 "sid": 1730 1262 }, 1263 { 1264 "namespace": "data", 1265 "identifier": "/ietf-system:system/authentication/ 1266 user-authentication-order", 1267 "sid": 1731 1268 }, 1269 { 1270 "namespace": "data", 1271 "identifier": "/ietf-system:system/authentication/user/ 1272 authorized-key", 1273 "sid": 1732 1274 }, 1275 { 1276 "namespace": "data", 1277 "identifier": "/ietf-system:system/authentication/user/ 1278 authorized-key/algorithm", 1279 "sid": 1733 1280 }, 1281 { 1282 "namespace": "data", 1283 "identifier": "/ietf-system:system/authentication/user/ 1284 authorized-key/key-data", 1285 "sid": 1734 1286 }, 1287 { 1288 "namespace": "data", 1289 "identifier": "/ietf-system:system/authentication/user/ 1290 authorized-key/name", 1291 "sid": 1735 1292 }, 1293 { 1294 "namespace": "data", 1295 "identifier": "/ietf-system:system/authentication/user/ 1296 name", 1297 "sid": 1736 1298 }, 1299 { 1300 "namespace": "data", 1301 "identifier": "/ietf-system:system/authentication/user/ 1302 password", 1303 "sid": 1737 1304 }, 1305 { 1306 "namespace": "data", 1307 "identifier": "/ietf-system:system/clock", 1308 "sid": 1738 1309 }, 1310 { 1311 "namespace": "data", 1312 "identifier": "/ietf-system:system/clock/timezone-name", 1313 "sid": 1739 1314 }, 1315 { 1316 "namespace": "data", 1317 "identifier": "/ietf-system:system/clock/timezone-utc-offset", 1318 "sid": 1740 1319 }, 1320 { 1321 "namespace": "data", 1322 "identifier": "/ietf-system:system/contact", 1323 "sid": 1741 1324 }, 1325 { 1326 "namespace": "data", 1327 "identifier": "/ietf-system:system/dns-resolver", 1328 "sid": 1742 1329 }, 1330 { 1331 "namespace": "data", 1332 "identifier": "/ietf-system:system/dns-resolver/options", 1333 "sid": 1743 1334 }, 1335 { 1336 "namespace": "data", 1337 "identifier": "/ietf-system:system/dns-resolver/options/ 1338 attempts", 1339 "sid": 1744 1340 }, 1341 { 1342 "namespace": "data", 1343 "identifier": "/ietf-system:system/dns-resolver/options/ 1344 timeout", 1345 "sid": 1745 1346 }, 1347 { 1348 "namespace": "data", 1349 "identifier": "/ietf-system:system/dns-resolver/search", 1350 "sid": 1746 1351 }, 1352 { 1353 "namespace": "data", 1354 "identifier": "/ietf-system:system/dns-resolver/server", 1355 "sid": 1747 1356 }, 1357 { 1358 "namespace": "data", 1359 "identifier": "/ietf-system:system/dns-resolver/server/name", 1360 "sid": 1748 1361 }, 1362 { 1363 "namespace": "data", 1364 "identifier": "/ietf-system:system/dns-resolver/server/ 1365 udp-and-tcp", 1366 "sid": 1749 1367 }, 1368 { 1369 "namespace": "data", 1370 "identifier": "/ietf-system:system/dns-resolver/server/ 1371 udp-and-tcp/address", 1372 "sid": 1750 1373 }, 1374 { 1375 "namespace": "data", 1376 "identifier": "/ietf-system:system/dns-resolver/server/ 1377 udp-and-tcp/port", 1378 "sid": 1751 1379 }, 1380 { 1381 "namespace": "data", 1382 "identifier": "/ietf-system:system/hostname", 1383 "sid": 1752 1385 }, 1386 { 1387 "namespace": "data", 1388 "identifier": "/ietf-system:system/location", 1389 "sid": 1753 1390 }, 1391 { 1392 "namespace": "data", 1393 "identifier": "/ietf-system:system/ntp", 1394 "sid": 1754 1395 }, 1396 { 1397 "namespace": "data", 1398 "identifier": "/ietf-system:system/ntp/enabled", 1399 "sid": 1755 1400 }, 1401 { 1402 "namespace": "data", 1403 "identifier": "/ietf-system:system/ntp/server", 1404 "sid": 1756 1405 }, 1406 { 1407 "namespace": "data", 1408 "identifier": "/ietf-system:system/ntp/server/ 1409 association-type", 1410 "sid": 1757 1411 }, 1412 { 1413 "namespace": "data", 1414 "identifier": "/ietf-system:system/ntp/server/iburst", 1415 "sid": 1758 1416 }, 1417 { 1418 "namespace": "data", 1419 "identifier": "/ietf-system:system/ntp/server/name", 1420 "sid": 1759 1421 }, 1422 { 1423 "namespace": "data", 1424 "identifier": "/ietf-system:system/ntp/server/prefer", 1425 "sid": 1760 1426 }, 1427 { 1428 "namespace": "data", 1429 "identifier": "/ietf-system:system/ntp/server/udp", 1430 "sid": 1761 1431 }, 1432 { 1433 "namespace": "data", 1434 "identifier": "/ietf-system:system/ntp/server/udp/address", 1435 "sid": 1762 1436 }, 1437 { 1438 "namespace": "data", 1439 "identifier": "/ietf-system:system/ntp/server/udp/port", 1440 "sid": 1763 1441 }, 1442 { 1443 "namespace": "data", 1444 "identifier": "/ietf-system:system/radius", 1445 "sid": 1764 1446 }, 1447 { 1448 "namespace": "data", 1449 "identifier": "/ietf-system:system/radius/options", 1450 "sid": 1765 1451 }, 1452 { 1453 "namespace": "data", 1454 "identifier": "/ietf-system:system/radius/options/attempts", 1455 "sid": 1766 1456 }, 1457 { 1458 "namespace": "data", 1459 "identifier": "/ietf-system:system/radius/options/timeout", 1460 "sid": 1767 1461 }, 1462 { 1463 "namespace": "data", 1464 "identifier": "/ietf-system:system/radius/server", 1465 "sid": 1768 1466 }, 1467 { 1468 "namespace": "data", 1469 "identifier": "/ietf-system:system/radius/server/ 1470 authentication-type", 1471 "sid": 1769 1472 }, 1473 { 1474 "namespace": "data", 1475 "identifier": "/ietf-system:system/radius/server/name", 1476 "sid": 1770 1477 }, 1478 { 1479 "namespace": "data", 1480 "identifier": "/ietf-system:system/radius/server/udp", 1481 "sid": 1771 1482 }, 1483 { 1484 "namespace": "data", 1485 "identifier": "/ietf-system:system/radius/server/udp/ 1486 address", 1487 "sid": 1772 1488 }, 1489 { 1490 "namespace": "data", 1491 "identifier": "/ietf-system:system/radius/server/udp/ 1492 authentication-port", 1493 "sid": 1773 1494 }, 1495 { 1496 "namespace": "data", 1497 "identifier": "/ietf-system:system/radius/server/udp/ 1498 shared-secret", 1499 "sid": 1774 1500 } 1501 ] 1502 } 1503 } 1505 Appendix B. SID auto generation 1507 Assignment of SIDs to YANG items can be automated, the recommended 1508 process to assign SIDs is as follows: 1510 1. A tool extracts the different items defined for a specific YANG 1511 module. 1513 2. The list of items is sorted in alphabetical order, 'namespace' in 1514 descending order, 'identifier' in ascending order. The 1515 'namespace' and 'identifier' formats are described in the YANG 1516 module 'ietf-sid-file' defined in Section 4. 1518 3. SIDs are assigned sequentially from the entry point up to the 1519 size of the registered SID range. This approach is recommended 1520 to minimize the serialization overhead, especially when delta 1521 between a reference SID and the current SID is used by protocols 1522 aiming to reduce message size. 1524 4. If the number of items exceeds the SID range(s) allocated to a 1525 YANG module, an extra range is added for subsequent assignments. 1527 5. The "dependency-revision" should reflect the revision numbers of 1528 each YANG module that the YANG module imports at the moment of 1529 the generation. 1531 In case of an update to an existing ".sid" file, an additional step 1532 is needed that increments the ".sid" file version number. If there 1533 was no version number in the previous version of the ".sid" file, 0 1534 is assumed as the version number of the old version of the ".sid" 1535 file and the version number is 1 for the new ".sid" file. Apart from 1536 that, changes of ".sid" files can also be automated using the same 1537 method described above, only unassigned YANG items are processed at 1538 step #3. Already existing items in the ".sid" file should not be 1539 given new SIDs. 1541 Note that ".sid" file versions are specific to a YANG module 1542 revision. For each new YANG module or each new revision of an 1543 existing YANG module, the version number of the initial ".sid" file 1544 should either be 0 or should not be present. 1546 Note also that RPC or action "input" and "output" data nodes MUST 1547 always be assigned SID even if they don't contain data nodes. The 1548 reason for this requirement is that other modules can augment the 1549 given module and those SIDs might be necessary. 1551 Appendix C. ".sid" file lifecycle 1553 Before assigning SIDs to their YANG modules, YANG module authors must 1554 acquire a SID range from a "YANG SID Range Registry". If the YANG 1555 module is part of an IETF draft or RFC, the SID range need to be 1556 acquired from the "IETF YANG SID Range Registry" as defined in 1557 Section 7.5. For the other YANG modules, the authors can acquire a 1558 SID range from any "YANG SID Range Registry" of their choice. 1560 Once the SID range is acquired, the owner can use it to generate 1561 ".sid" file/s for his YANG module/s. It is recommended to leave some 1562 unallocated SIDs following the allocated range in each ".sid" file in 1563 order to allow better evolution of the YANG module in the future. 1564 Generation of ".sid" files should be performed using an automated 1565 tool. Note that ".sid" files can only be generated for YANG modules 1566 and not for submodules. 1568 C.1. ".sid" File Creation 1570 The following activity diagram summarizes the creation of a YANG 1571 module and its associated ".sid" file. 1573 +---------------+ 1574 O | Creation of a | 1576 -|- ->| YANG module | 1577 / \ +---------------+ 1578 | 1579 V 1580 /-------------\ 1581 / Standardized \ yes 1582 \ YANG module ? /-------------+ 1583 \-------------/ | 1584 | no | 1585 V V 1586 /-------------\ +---------------+ 1587 / Constrained \ yes | SID range | 1588 +-->\ application ? /---->| registration |<----------+ 1589 | \-------------/ +---------------+ | 1590 | | no | | 1591 | V V | 1592 | +---------------+ +---------------+ | 1593 +---| YANG module | | SID sub-range | | 1594 | update | | assignment |<----------+ 1595 +---------------+ +---------------+ | 1596 | | 1597 V | 1598 +---------------+ +-------------+ 1599 | ".sid" file | | Rework YANG | 1600 | generation | | model | 1601 +---------------+ +-------------+ 1602 | ^ 1603 V | 1604 /----------\ yes | 1605 / Work in \ -----------+ 1606 \ progress / 1607 \----------/ 1608 | no 1609 V 1610 /-------------\ /-------------\ 1611 / RFC \ no / Open \ no 1612 \ publication? /---->\ specification?/---+ 1613 \-------------/ \-------------/ | 1614 | yes | yes | 1615 | +---------------+ | 1616 V V V 1617 +---------------+ +---------------+ 1618 | IANA | | Third party | 1619 | registration | | registration | 1620 +-------+-------+ +-------+-------+ 1621 | | 1622 +---------------------------------+ 1623 V 1625 [DONE] 1627 Figure 1: SID Lifecycle 1629 C.2. ".sid" File Update 1631 The following Activity diagram summarizes the update of a YANG module 1632 and its associated ".sid" file. 1634 +---------------+ 1635 O | Update of the | 1636 -|- ->| YANG module | 1637 / \ | or include(s) | 1638 | or import(s) | 1639 +---------------+ 1640 | 1641 V 1642 /-------------\ 1643 / New items \ yes 1644 \ created ? /------+ 1645 \-------------/ | 1646 | no V 1647 | /-------------\ +----------------+ 1648 | / SID range \ yes | Extra sub-range| 1649 | \ exhausted ? /---->| assignment | 1650 | \-------------/ +----------------+ 1651 | | no | 1652 | +---------------------+ 1653 | | 1654 | V 1655 | +---------------+ 1656 | | ".sid" file | 1657 | | update based | 1658 | | on previous | 1659 | | ".sid" file | 1660 | +---------------+ 1661 | | 1662 | V 1663 | /-------------\ +---------------+ 1664 | / Publicly \ yes | YANG module | 1665 | \ available ? /---->| registration | 1666 | \-------------/ +---------------+ 1667 | | no | 1668 +--------------+---------------------+ 1669 | 1670 [DONE] 1672 Figure 2: YANG and ".sid" file update 1674 Authors' Addresses 1675 Michel Veillette (editor) 1676 Trilliant Networks Inc. 1677 610 Rue du Luxembourg 1678 Granby, Quebec J2J 2V2 1679 Canada 1681 Phone: +14503750556 1682 Email: michel.veillette@trilliant.com 1684 Alexander Pelov (editor) 1685 Acklio 1686 1137A avenue des Champs Blancs 1687 Cesson-Sevigne, Bretagne 35510 1688 France 1690 Email: a@ackl.io 1692 Ivaylo Petrov (editor) 1693 Acklio 1694 1137A avenue des Champs Blancs 1695 Cesson-Sevigne, Bretagne 35510 1696 France 1698 Email: ivaylo@ackl.io