idnits 2.17.1 draft-ietf-core-sid-14.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 (July 04, 2020) is 1384 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 1671, but not defined == Unused Reference: 'I-D.ietf-anima-constrained-voucher' is defined on line 1001, but no explicit reference was found in the text == Outdated reference: A later version (-20) exists of draft-ietf-core-yang-cbor-12 == Outdated reference: A later version (-24) exists of draft-ietf-anima-constrained-voucher-07 == Outdated reference: A later version (-17) exists of draft-ietf-core-comi-09 == Outdated reference: A later version (-03) exists of draft-ietf-core-yang-library-01 -- Obsolete informational reference (is this intentional?): RFC 6536 (Obsoleted by RFC 8341) Summary: 1 error (**), 0 flaws (~~), 10 warnings (==), 2 comments (--). 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: January 5, 2021 I. Petrov, Ed. 6 Acklio 7 July 04, 2020 9 YANG Schema Item iDentifier (YANG SID) 10 draft-ietf-core-sid-14 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 January 5, 2021. 38 Copyright Notice 40 Copyright (c) 2020 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 . . . . . . . . . . . . . . . . . . . . . . 16 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 . . . . . . . . . . . . . . . . . . 19 79 7.6.3. Recursive Allocation of YANG SID Range at Document 80 Adoption . . . . . . . . . . . . . . . . . . . . . . 19 81 7.6.4. Initial contents of the registry . . . . . . . . . . 21 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 . . . . . . . . . . . . . . . . 33 88 Appendix C. ".sid" file lifecycle . . . . . . . . . . . . . . . 34 89 C.1. ".sid" File Creation . . . . . . . . . . . . . . . . . . 34 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) 2020 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."; 380 reference 381 "RFC 7950, The YANG 1.1 Data Modeling Language; 382 Section 6.5: Schema Node Identifier;"; 383 } 385 rc:yang-data sid-file { 386 uses sid-file; 387 } 389 grouping sid-file { 390 description "A grouping that contains a YANG container representing the 391 file structure of a .sid files."; 393 container sid-file { 394 description 395 "A Wrapper container that together with the rc:yang-data extension 396 marks the YANG data structures inside as not being intended to be 397 implemented as part of a configuration datastore or as an operational 398 state within the server."; 399 leaf module-name { 400 type yang:yang-identifier; 401 description 402 "Name of the YANG module associated with this .sid file."; 403 } 405 leaf module-revision { 406 type revision-identifier; 407 description 408 "Revision of the YANG module associated with this .sid file. 409 This leaf is not present if no revision statement is 410 defined in the YANG module."; 411 } 413 leaf sid-file-version { 414 type sid-file-version-identifier; 415 description 416 "Optional leaf that specifies the version number of the .sid file. 417 .sid files and the version sequence are specific to a given YANG 418 module revision. This number starts at zero when there is a new YANG 419 module revision and increases monotonically. This number can 420 distinguish updates to the .sid file which are the result of new 421 processing, or the result of reported errata."; 422 } 424 leaf description { 425 type string; 426 description 427 "Free-form meta information about the generated file. It might 428 include .sid file generation tool and time among other things."; 429 } 431 list dependency-revision { 432 key "module-name"; 434 description 435 "Information about the used revision during the .sid file generation 436 of each YANG module that the module in 'module-name' imported."; 438 leaf module-name { 439 type yang:yang-identifier; 440 mandatory true; 441 description 442 "Name of the YANG module, dependency of 'module-name', for which 443 revision information is provided."; 444 } 445 leaf module-revision { 446 type revision-identifier; 447 mandatory true; 448 description 449 "Revision of the YANG module, dependency of 'module-name', for which 450 revision information is provided."; 451 } 452 } 454 list assigment-ranges { 455 key "entry-point"; 456 description 457 "YANG SID range(s) allocated to the YANG module identified by 458 'module-name' and 'module-revision'. 460 - The YANG SID range first available value is entry-point and the the 461 last available value in the range is (entry-point + size - 1). 462 - The YANG SID ranges specified by all assignment-rages MUST NOT 463 overlap."; 465 leaf entry-point { 466 type sid; 467 mandatory true; 468 description 469 "Lowest YANG SID available for assignment."; 470 } 472 leaf size { 473 type uint64; 474 mandatory true; 475 description 476 "Number of YANG SIDs available for assignment."; 477 } 478 } 480 list items { 481 key "namespace identifier"; 482 description 483 "Each entry within this list defined the mapping between 484 a YANG item string identifier and a YANG SID. This list MUST 485 include a mapping entry for each YANG item defined by 486 the YANG module identified by 'module-name' and 487 'module-revision'."; 489 leaf namespace { 490 type enumeration { 491 enum module { 492 value 0; 493 description 494 "All module and submodule names share the same 495 global module identifier namespace."; 496 } 497 enum identity { 498 value 1; 499 description 500 "All identity names defined in a module and its 501 submodules share the same identity identifier 502 namespace."; 503 } 504 enum feature { 505 value 2; 506 description 507 "All feature names defined in a module and its 508 submodules share the same feature identifier 509 namespace."; 510 } 511 enum data { 512 value 3; 513 description 514 "The namespace for all data nodes, as defined in YANG."; 515 } 516 } 517 description 518 "Namespace of the YANG item for this mapping entry."; 519 } 521 leaf identifier { 522 type union { 523 type yang:yang-identifier; 524 type schema-node-path; 525 } 526 description 527 "String identifier of the YANG item for this mapping entry. 529 If the corresponding 'namespace' field is 'module', 530 'feature', or 'identity', then this field MUST 531 contain a valid YANG identifier string. 533 If the corresponding 'namespace' field is 'data', 534 then this field MUST contain a valid schema node 535 path."; 536 } 538 leaf sid { 539 type sid; 540 mandatory true; 541 description 542 "YANG SID assigned to the YANG item for this mapping entry."; 543 } 544 } 545 } 546 } 547 } 548 550 5. Content-Types 552 The following Content-Type is defined: 554 application/yang-data+cbor; id=sid: This Content-Type represents a 555 CBOR YANG document containing one or multiple data node values. 556 Each data node is identified by its associated SID. 558 FORMAT: CBOR map of SID, instance-value 560 The message payload of Content-Type 'application/yang-data+cbor' 561 is encoded using a CBOR map. Each entry within the CBOR map 562 contains the data node identifier (i.e. SID) and the associated 563 instance-value. Instance-values are encoded using the rules 564 defined in [I-D.ietf-core-yang-cbor] section 4. 566 6. Security Considerations 568 This document defines a new type of identifier used to encode data 569 models defined in YANG [RFC7950]. As such, this identifier does not 570 contribute to any new security issues in addition of those identified 571 for the specific protocols or contexts for which it is used. 573 7. IANA Considerations 575 7.1. YANG Namespace Registration 577 This document registers the following XML namespace URN in the "IETF 578 XML Registry", following the format defined in [RFC3688]: 580 URI: please assign urn:ietf:params:xml:ns:yang:ietf-sid-file 582 Registrant Contact: The IESG. 584 XML: N/A, the requested URI is an XML namespace. 586 Reference: RFC XXXX 588 // RFC Ed.: please replace XXXX with RFC number and remove this note 590 7.2. Register ".sid" File Format Module 592 This document registers one YANG module in the "YANG Module Names" 593 registry [RFC6020]: 595 o name: ietf-sid-file 597 o namespace: urn:ietf:params:xml:ns:yang:ietf-sid-file 599 o prefix: sid 601 o reference: [[THISRFC]] 603 7.3. CoAP Content-Formats Registry 605 This document adds the following Content-Format to the "CoAP Content- 606 Formats", within the "Constrained RESTful Environments (CoRE) 607 Parameters" registry. 609 +---------------------------------+--------------+------+-----------+ 610 | Media Type | Content | ID | Reference | 611 | | Coding | | | 612 +---------------------------------+--------------+------+-----------+ 613 | application/yang-data+cbor; | | TBD1 | RFC XXXX | 614 | id=sid | | | | 615 +---------------------------------+--------------+------+-----------+ 616 // RFC Ed.: replace TBD1 with assigned IDs and remove this note. // 617 RFC Ed.: replace RFC XXXX with this RFC number and remove this note. 619 7.4. Create new IANA Registry: "YANG SID Mega-Range" registry 621 The name of this registry is "YANG SID Mega-Range". This registry is 622 used to record the delegation of the management of a block of SIDs to 623 third parties (such as SDOs or registrars). 625 7.4.1. Structure 627 Each entry in this registry must include: 629 o The entry point (first SID) of the registered SID block. 631 o The size of the registered SID block. The size MUST be one 632 million (1 000 000) SIDs. 634 o The contact information of the requesting organization including: 636 * The policy of SID range allocations: Public, Private or Both. 638 * Organization name 640 * URL 642 The information associated to the Organization name should not be 643 publicly visible in the registry, but should be available. This 644 information includes contact email and phone number and change 645 controller email and phone number. 647 7.4.2. Allocation policy 649 The IANA policy for future additions to this registry is "Expert 650 Review" [RFC8126]. 652 An organization requesting to manage a YANG SID Range (and thus have 653 an entry in the YANG SID Mega-Range Registry), must ensure the 654 following capacities: 656 o The capacity to manage and operate a YANG SID Range Registry. A 657 YANG SID Range Registry MUST provide the following information for 658 all YANG SID Ranges allocated by the Registry: 660 * Entry Point of allocated YANG SID Range 662 * Size of allocated YANG SID Range 663 * Type: Public or Private 665 + Public Ranges MUST include at least a reference to the YANG 666 module and ".sid" files for that YANG SID Range. 668 + Private Ranges MUST be marked as "Private" 670 o A Policy of allocation, which clearly identifies if the YANG SID 671 Range allocations would be Private, Public or Both. 673 o Technical capacity to ensure the sustained operation of the 674 registry for a period of at least 5 years. If Private 675 Registrations are allowed, the period must be of at least 10 676 years. 678 7.4.2.1. First allocation 680 For a first allocation to be provided, the requesting organization 681 must demonstrate a functional registry infrastructure. 683 7.4.2.2. Consecutive allocations 685 On subsequent allocation request(s), the organization must 686 demonstrate the exhaustion of the prior range. These conditions need 687 to be asserted by the assigned expert(s). 689 If that extra-allocation is done within 3 years from the last 690 allocation, the experts need to discuss this request on the CORE 691 working group mailing list and consensus needs to be obtained before 692 allocating a new Mega-Range. 694 7.4.3. Initial contents of the Registry 696 The initial entry in this registry is allocated to IANA: 698 +-------------+---------+------------+-------------------+----------+ 699 | Entry Point | Size | Allocation | Organization name | URL | 700 +-------------+---------+------------+-------------------+----------+ 701 | 0 | 1000000 | Public | IANA | iana.org | 702 +-------------+---------+------------+-------------------+----------+ 704 7.5. Create a new IANA Registry: IETF YANG SID Range Registry (managed 705 by IANA) 707 7.5.1. Structure 709 Each entry in this registry must include: 711 o The SID range entry point. 713 o The SID range size. 715 o The YANG module name. 717 o Document reference. 719 7.5.2. Allocation policy 721 The first million SIDs assigned to IANA is sub-divided as follows: 723 o The range of 0 to 999 (size 1000) is "Reserved" as defined in 724 [RFC8126]. 726 o The range of 1000 to 59,999 (size 59,000) is reserved for YANG 727 modules defined in RFCs. 729 * The IANA policy for additions to this registry is either: 731 + "Expert Review" [RFC8126] in case the ".sid" file comes from 732 a YANG module from an existing RFC, or 734 + "RFC Required" [RFC8126] otherwise. 736 * The Expert MUST verify that the YANG module for which this 737 allocation is made has an RFC (existing RFC) OR is on track to 738 become RFC (early allocation with a request from the WG chairs 739 as defined by [RFC7120]). 741 o The range of 60,000 to 99,999 (size 40,000) is reserved for 742 experimental YANG modules. This range MUST NOT be used in 743 operational deployments since these SIDs are not globally unique 744 which limit their interoperability. The IANA policy for this 745 range is "Experimental use" [RFC8126]. 747 o The range of 100,000 to 999,999 (size 900,000) is "Reserved" as 748 defined in [RFC8126]. 750 +-------------+---------+-------------------------------+ 751 | Entry Point | Size | IANA policy | 752 +-------------+---------+-------------------------------+ 753 | 0 | 1,000 | Reserved | 754 | 1,000 | 59,000 | Expert Review or RFC Required | 755 | 60,000 | 40,000 | Experimental use | 756 | 100,000 | 900,000 | Reserved | 757 +-------------+---------+-------------------------------+ 759 The size of the SID range allocated for a YANG module is recommended 760 to be a multiple of 50 and to be at least 33% above the current 761 number of YANG items. This headroom allows assignment within the 762 same range of new YANG items introduced by subsequent revisions. The 763 maximum SID range size is 1000. A larger size may be requested by 764 the authors if this recommendation is considered insufficient. It is 765 important to note that an additional SID range can be allocated to an 766 existing YANG module if the initial range is exhausted. 768 In case a SID range is allocated for an existing RFC through the 769 "Expert Review" policy, the Document reference field for the given 770 allocation should point to the RFC that the YANG module is defined 771 in. 773 In case a SID range is required before publishing the RFC due to 774 implementations needing stable SID values, early allocation as 775 defined in [RFC7120] can be employed. As specified in section 4.6 of 776 [RFC8126], RFCs and by extension documents that are expected to 777 become an RFC fulfill the requirement for "Specification Required" 778 stated in section 2 of [RFC7120], which allows for the early 779 allocation process to be employed. 781 7.5.3. Initial contents of the registry 783 Initial entries in this registry are as follows: 785 +-------+------+---------------------------+------------------------+ 786 | Entry | Size | Module name | Document reference | 787 | Point | | | | 788 +-------+------+---------------------------+------------------------+ 789 | 1000 | 100 | ietf-coreconf | [I-D.ietf-core-comi] | 790 | 1100 | 50 | ietf-yang-types | [RFC6991] | 791 | 1150 | 50 | ietf-inet-types | [RFC6991] | 792 | 1200 | 50 | iana-crypt-hash | [RFC7317] | 793 | 1250 | 50 | ietf-netconf-acm | [RFC8341] | 794 | 1300 | 50 | ietf-sid-file | RFCXXXX | 795 | 1500 | 100 | ietf-interfaces | [RFC8343] | 796 | 1600 | 100 | ietf-ip | [RFC8344] | 797 | 1700 | 100 | ietf-system | [RFC7317] | 798 | 1800 | 400 | iana-if-type | [RFC7224] | 799 | 2400 | 50 | ietf-voucher | [RFC8366] | 800 | 2450 | 50 | ietf-constrained-voucher | [I-D.ietf-anima-constr | 801 | | | | ained-voucher] | 802 | 2500 | 50 | ietf-constrained-voucher- | [I-D.ietf-anima-constr | 803 | | | request | ained-voucher] | 804 +-------+------+---------------------------+------------------------+ 806 // RFC Ed.: replace XXXX with RFC number assigned to this draft. 808 For allocation, RFC publication of the YANG module is required as per 809 [RFC8126]. The YANG module must be registered in the "YANG module 810 Name" registry according to the rules specified in section 14 of 811 [RFC6020]. 813 7.6. Create new IANA Registry: "IETF YANG SID Registry" 815 The name of this registry is "IETF YANG SID Registry". This registry 816 is used to record the allocation of SIDs for individual YANG module 817 items. 819 7.6.1. Structure 821 Each entry in this registry must include: 823 o The YANG module name. This module name must be present in the 824 "Name" column of the "YANG Module Names" registry. 826 o A link to the associated ".yang" file. This file link must be 827 present in the "File" column of the "YANG Module Names" registry. 829 o The link to the ".sid" file which defines the allocation. The 830 ".sid" file is stored by IANA. 832 o The number of actually allocated SIDs in the ".sid" file. 834 7.6.2. Allocation policy 836 The allocation policy is Expert review. The Expert MUST ensure that 837 the following conditions are met: 839 o The ".sid" file has a valid structure: 841 * The ".sid" file MUST be a valid JSON file following the 842 structure of the module defined in RFCXXXX (RFC Ed: replace XXX 843 with RFC number assigned to this draft). 845 o The ".sid" file allocates individual SIDs ONLY in the YANG SID 846 Ranges for this YANG module (as allocated in the IETF YANG SID 847 Range Registry): 849 * All SIDs in this ".sid" file MUST be within the ranges 850 allocated to this YANG module in the "IETF YANG SID Range 851 Registry". 853 o If another ".sid" file has already allocated SIDs for this YANG 854 module (e.g. for older or newer versions of the YANG module), the 855 YANG items are assigned the same SIDs as in the other ".sid" file. 857 o If there is an older version of the ".sid" file, all allocated 858 SIDs from that version are still present in the current version of 859 the ".sid" file. 861 7.6.3. Recursive Allocation of YANG SID Range at Document Adoption 863 Due to the difficulty in changing SID values during IETF document 864 processing, it is expected that most documents will ask for SID 865 allocations using Early Allocations [RFC7120]. The details of the 866 Early Allocation should be included in any Working Group Adoption 867 call. Prior to Working Group Adoption, an internet draft authors can 868 use the experimental SID range (as per Section 7.5.2) for their SIDs 869 allocations or other values that do not create ambiguity with other 870 SID uses (for example they can use a range that comes from a non-IANA 871 managed "YANG SID Mega-Range" registry). 873 After Working Group Adoption, any modification of a ".sid" file is 874 expected to be discussed on the mailing list of the appropriate 875 Working Groups. Specific attention should be paid to implementers' 876 opinion after Working Group Last Call if a SID value is to change its 877 meaning. In all cases, a ".sid" file and the SIDs associated with it 878 are subject to change before the publication of an internet draft as 879 an RFC. 881 During the early use of SIDs, many existing, previously published 882 YANG modules will not have SID allocations. For an allocation to be 883 useful the included YANG modules may also need to have SID 884 allocations made. 886 The Expert Reviewer who performs the (Early) Allocation analysis will 887 need to go through the list of included YANG modules and perform SID 888 allocations for those modules as well. 890 o If the document is a published RFC, then the allocation of SIDs 891 for its referenced YANG modules is permanent. The Expert Reviewer 892 provides the generated SID file to IANA for registration. This 893 process may be time consuming during a bootstrap period (there are 894 over 100 YANG modules to date, none of which have SID 895 allocations), but should quiet down once needed entries are 896 allocated. 898 o If the document is an unprocessed Internet-Draft adopted in a WG, 899 then an Early Allocation is performed for this document as well. 900 Early Allocations require approval by an IESG Area Director. An 901 early allocation which requires additional allocations will list 902 the other allocations in it's description, and will be cross- 903 posted to the any other working group mailing lists. 905 o A YANG module which references a module in an document which has 906 not yet been adopted by any working group will be unable to 907 perform an Early Allocation for that other document until it is 908 adopted by a working group. As described in [RFC7120], an AD 909 Sponsored document acts as if it had a working group. The 910 approving AD may also exempt a document from this policy by 911 agreeing to AD Sponsor the document. 913 At the end of the IETF process all the dependencies of a given module 914 for which SIDs are assigned, should also have SIDs assigned. Those 915 dependencies' assignments should be permanent (not Early Allocation). 917 A previously SID-allocated YANG module which changes its references 918 to include a YANG module for which there is no SID allocation needs 919 to repeat the Early Allocation process. 921 Early Allocations are made with a one-year period, after which they 922 are expired. [RFC7120] indicates that at most one renewal may be 923 made. For the SID allocation a far more lenient stance is desired. 925 1. An extension of a referencing documents Early Allocation should 926 update any referenced Early Allocations to expire no sooner than 927 the referencing document. 929 2. The [RFC7120] mechanism allows the IESG to provide a second 930 renewal, and such an event may prompt some thought about how the 931 collection of documents are being processed. 933 This is driven by the very generous size of the SID space and the 934 often complex and deep dependencies of YANG modules. Often a core 935 module with many dependencies will undergo extensive review, delaying 936 the publication of other documents. 938 [RFC7120] also says: 940 Note that if a document is submitted for review to the IESG and at 941 the time of submission some early allocations are valid (not 942 expired), these allocations should not be expired while the document 943 is under IESG consideration or waiting in the RFC Editor's queue 944 after approval by the IESG. 946 7.6.4. Initial contents of the registry 948 None. 950 8. Acknowledgments 952 The authors would like to thank Andy Bierman, Carsten Bormann, 953 Michael Richardson, Abhinav Somaraju, Peter van der Stok, Laurent 954 Toutain and Randy Turner for their help during the development of 955 this document and their useful comments during the review process. 957 9. References 959 9.1. Normative References 961 [I-D.ietf-core-yang-cbor] 962 Veillette, M., Petrov, I., and A. Pelov, "CBOR Encoding of 963 Data Modeled with YANG", draft-ietf-core-yang-cbor-12 964 (work in progress), March 2020. 966 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 967 Requirement Levels", BCP 14, RFC 2119, 968 DOI 10.17487/RFC2119, March 1997, 969 . 971 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 972 DOI 10.17487/RFC3688, January 2004, 973 . 975 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 976 RFC 6991, DOI 10.17487/RFC6991, July 2013, 977 . 979 [RFC7120] Cotton, M., "Early IANA Allocation of Standards Track Code 980 Points", BCP 100, RFC 7120, DOI 10.17487/RFC7120, January 981 2014, . 983 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 984 RFC 7950, DOI 10.17487/RFC7950, August 2016, 985 . 987 [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", 988 RFC 7951, DOI 10.17487/RFC7951, August 2016, 989 . 991 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 992 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 993 . 995 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 996 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 997 May 2017, . 999 9.2. Informative References 1001 [I-D.ietf-anima-constrained-voucher] 1002 Richardson, M., Stok, P., and P. Kampanakis, "Constrained 1003 Voucher Artifacts for Bootstrapping Protocols", draft- 1004 ietf-anima-constrained-voucher-07 (work in progress), 1005 January 2020. 1007 [I-D.ietf-core-comi] 1008 Veillette, M., Stok, P., Pelov, A., Bierman, A., and I. 1009 Petrov, "CoAP Management Interface", draft-ietf-core- 1010 comi-09 (work in progress), March 2020. 1012 [I-D.ietf-core-yang-library] 1013 Veillette, M. and I. Petrov, "Constrained YANG Module 1014 Library", draft-ietf-core-yang-library-01 (work in 1015 progress), January 2020. 1017 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 1018 the Network Configuration Protocol (NETCONF)", RFC 6020, 1019 DOI 10.17487/RFC6020, October 2010, 1020 . 1022 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 1023 and A. Bierman, Ed., "Network Configuration Protocol 1024 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 1025 . 1027 [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration 1028 Protocol (NETCONF) Access Control Model", RFC 6536, 1029 DOI 10.17487/RFC6536, March 2012, 1030 . 1032 [RFC7224] Bjorklund, M., "IANA Interface Type YANG Module", 1033 RFC 7224, DOI 10.17487/RFC7224, May 2014, 1034 . 1036 [RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for 1037 System Management", RFC 7317, DOI 10.17487/RFC7317, August 1038 2014, . 1040 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 1041 Writing an IANA Considerations Section in RFCs", BCP 26, 1042 RFC 8126, DOI 10.17487/RFC8126, June 2017, 1043 . 1045 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 1046 Access Control Model", STD 91, RFC 8341, 1047 DOI 10.17487/RFC8341, March 2018, 1048 . 1050 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 1051 Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, 1052 . 1054 [RFC8344] Bjorklund, M., "A YANG Data Model for IP Management", 1055 RFC 8344, DOI 10.17487/RFC8344, March 2018, 1056 . 1058 [RFC8366] Watsen, K., Richardson, M., Pritikin, M., and T. Eckert, 1059 "A Voucher Artifact for Bootstrapping Protocols", 1060 RFC 8366, DOI 10.17487/RFC8366, May 2018, 1061 . 1063 Appendix A. ".sid" file example 1065 The following ".sid" file (ietf-system@2014-08-06.sid) have been 1066 generated using the following yang modules: 1068 o ietf-system@2014-08-06.yang (defined in [RFC7317]) 1069 o ietf-yang-types@2013-07-15.yang (defined in [RFC6991]) 1071 o ietf-inet-types@2013-07-15.yang (defined in [RFC6991]) 1073 o ietf-netconf-acm@2012-02-22.yang (defined in [RFC6536]) 1075 o iana-crypt-hash@2014-04-04.yang (defined in [RFC7317]) 1077 { 1078 "ietf-sid-file:sid-file" : { 1079 "module-name": "ietf-system", 1080 "module-revision": "2020-02-05", 1081 "dependency-revision": [ 1082 { 1083 "module-name": "ietf-yang-types", 1084 "module-revision": "2013-07-15.yang" 1085 }, 1086 { 1087 "module-name": "ietf-inet-types", 1088 "module-revision": "2013-07-15.yang" 1089 }, 1090 { 1091 "module-name": "ietf-netconf-acm", 1092 "module-revision": "2012-02-22.yang" 1093 }, 1094 { 1095 "module-name": "iana-crypt-hash", 1096 "module-revision": "2014-04-04.yang" 1097 } 1098 ], 1099 "description": "Example sid file", 1100 "assignment-ranges": [ 1101 { 1102 "entry-point": 1700, 1103 "size": 100 1104 } 1105 ], 1106 "items": [ 1107 { 1108 "namespace": "module", 1109 "identifier": "ietf-system", 1110 "sid": 1700 1111 }, 1112 { 1113 "namespace": "identity", 1114 "identifier": "authentication-method", 1115 "sid": 1701 1116 }, 1117 { 1118 "namespace": "identity", 1119 "identifier": "local-users", 1120 "sid": 1702 1121 }, 1122 { 1123 "namespace": "identity", 1124 "identifier": "radius", 1125 "sid": 1703 1126 }, 1127 { 1128 "namespace": "identity", 1129 "identifier": "radius-authentication-type", 1130 "sid": 1704 1131 }, 1132 { 1133 "namespace": "identity", 1134 "identifier": "radius-chap", 1135 "sid": 1705 1136 }, 1137 { 1138 "namespace": "identity", 1139 "identifier": "radius-pap", 1140 "sid": 1706 1141 }, 1142 { 1143 "namespace": "feature", 1144 "identifier": "authentication", 1145 "sid": 1707 1146 }, 1147 { 1148 "namespace": "feature", 1149 "identifier": "dns-udp-tcp-port", 1150 "sid": 1708 1151 }, 1152 { 1153 "namespace": "feature", 1154 "identifier": "local-users", 1155 "sid": 1709 1156 }, 1157 { 1158 "namespace": "feature", 1159 "identifier": "ntp", 1160 "sid": 1710 1161 }, 1162 { 1163 "namespace": "feature", 1164 "identifier": "ntp-udp-port", 1165 "sid": 1711 1166 }, 1167 { 1168 "namespace": "feature", 1169 "identifier": "radius", 1170 "sid": 1712 1171 }, 1172 { 1173 "namespace": "feature", 1174 "identifier": "radius-authentication", 1175 "sid": 1713 1176 }, 1177 { 1178 "namespace": "feature", 1179 "identifier": "timezone-name", 1180 "sid": 1714 1181 }, 1182 { 1183 "namespace": "data", 1184 "identifier": "/ietf-system:set-current-datetime", 1185 "sid": 1715 1186 }, 1187 { 1188 "namespace": "data", 1189 "identifier": "/ietf-system:set-current-datetime/ 1190 current-datetime", 1191 "sid": 1716 1192 }, 1193 { 1194 "namespace": "data", 1195 "identifier": "/ietf-system:system", 1196 "sid": 1717 1197 }, 1198 { 1199 "namespace": "data", 1200 "identifier": "/ietf-system:system-restart", 1201 "sid": 1718 1202 }, 1203 { 1204 "namespace": "data", 1205 "identifier": "/ietf-system:system-shutdown", 1206 "sid": 1719 1207 }, 1208 { 1209 "namespace": "data", 1210 "identifier": "/ietf-system:system-state", 1211 "sid": 1720 1212 }, 1213 { 1214 "namespace": "data", 1215 "identifier": "/ietf-system:system-state/clock", 1216 "sid": 1721 1217 }, 1218 { 1219 "namespace": "data", 1220 "identifier": "/ietf-system:system-state/clock/boot-datetime", 1221 "sid": 1722 1222 }, 1223 { 1224 "namespace": "data", 1225 "identifier": "/ietf-system:system-state/clock/ 1226 current-datetime", 1227 "sid": 1723 1228 }, 1229 { 1230 "namespace": "data", 1231 "identifier": "/ietf-system:system-state/platform", 1232 "sid": 1724 1233 }, 1234 { 1235 "namespace": "data", 1236 "identifier": "/ietf-system:system-state/platform/machine", 1237 "sid": 1725 1238 }, 1239 { 1240 "namespace": "data", 1241 "identifier": "/ietf-system:system-state/platform/os-name", 1242 "sid": 1726 1243 }, 1244 { 1245 "namespace": "data", 1246 "identifier": "/ietf-system:system-state/platform/os-release", 1247 "sid": 1727 1248 }, 1249 { 1250 "namespace": "data", 1251 "identifier": "/ietf-system:system-state/platform/os-version", 1252 "sid": 1728 1253 }, 1254 { 1255 "namespace": "data", 1256 "identifier": "/ietf-system:system/authentication", 1257 "sid": 1729 1258 }, 1259 { 1260 "namespace": "data", 1261 "identifier": "/ietf-system:system/authentication/user", 1262 "sid": 1730 1263 }, 1264 { 1265 "namespace": "data", 1266 "identifier": "/ietf-system:system/authentication/ 1267 user-authentication-order", 1268 "sid": 1731 1269 }, 1270 { 1271 "namespace": "data", 1272 "identifier": "/ietf-system:system/authentication/user/ 1273 authorized-key", 1274 "sid": 1732 1275 }, 1276 { 1277 "namespace": "data", 1278 "identifier": "/ietf-system:system/authentication/user/ 1279 authorized-key/algorithm", 1280 "sid": 1733 1281 }, 1282 { 1283 "namespace": "data", 1284 "identifier": "/ietf-system:system/authentication/user/ 1285 authorized-key/key-data", 1286 "sid": 1734 1287 }, 1288 { 1289 "namespace": "data", 1290 "identifier": "/ietf-system:system/authentication/user/ 1291 authorized-key/name", 1292 "sid": 1735 1293 }, 1294 { 1295 "namespace": "data", 1296 "identifier": "/ietf-system:system/authentication/user/ 1297 name", 1298 "sid": 1736 1299 }, 1300 { 1301 "namespace": "data", 1302 "identifier": "/ietf-system:system/authentication/user/ 1303 password", 1304 "sid": 1737 1305 }, 1306 { 1307 "namespace": "data", 1308 "identifier": "/ietf-system:system/clock", 1309 "sid": 1738 1310 }, 1311 { 1312 "namespace": "data", 1313 "identifier": "/ietf-system:system/clock/timezone-name", 1314 "sid": 1739 1315 }, 1316 { 1317 "namespace": "data", 1318 "identifier": "/ietf-system:system/clock/timezone-utc-offset", 1319 "sid": 1740 1320 }, 1321 { 1322 "namespace": "data", 1323 "identifier": "/ietf-system:system/contact", 1324 "sid": 1741 1325 }, 1326 { 1327 "namespace": "data", 1328 "identifier": "/ietf-system:system/dns-resolver", 1329 "sid": 1742 1330 }, 1331 { 1332 "namespace": "data", 1333 "identifier": "/ietf-system:system/dns-resolver/options", 1334 "sid": 1743 1335 }, 1336 { 1337 "namespace": "data", 1338 "identifier": "/ietf-system:system/dns-resolver/options/ 1339 attempts", 1340 "sid": 1744 1341 }, 1342 { 1343 "namespace": "data", 1344 "identifier": "/ietf-system:system/dns-resolver/options/ 1345 timeout", 1346 "sid": 1745 1347 }, 1348 { 1349 "namespace": "data", 1350 "identifier": "/ietf-system:system/dns-resolver/search", 1351 "sid": 1746 1352 }, 1353 { 1354 "namespace": "data", 1355 "identifier": "/ietf-system:system/dns-resolver/server", 1356 "sid": 1747 1358 }, 1359 { 1360 "namespace": "data", 1361 "identifier": "/ietf-system:system/dns-resolver/server/name", 1362 "sid": 1748 1363 }, 1364 { 1365 "namespace": "data", 1366 "identifier": "/ietf-system:system/dns-resolver/server/ 1367 udp-and-tcp", 1368 "sid": 1749 1369 }, 1370 { 1371 "namespace": "data", 1372 "identifier": "/ietf-system:system/dns-resolver/server/ 1373 udp-and-tcp/address", 1374 "sid": 1750 1375 }, 1376 { 1377 "namespace": "data", 1378 "identifier": "/ietf-system:system/dns-resolver/server/ 1379 udp-and-tcp/port", 1380 "sid": 1751 1381 }, 1382 { 1383 "namespace": "data", 1384 "identifier": "/ietf-system:system/hostname", 1385 "sid": 1752 1386 }, 1387 { 1388 "namespace": "data", 1389 "identifier": "/ietf-system:system/location", 1390 "sid": 1753 1391 }, 1392 { 1393 "namespace": "data", 1394 "identifier": "/ietf-system:system/ntp", 1395 "sid": 1754 1396 }, 1397 { 1398 "namespace": "data", 1399 "identifier": "/ietf-system:system/ntp/enabled", 1400 "sid": 1755 1401 }, 1402 { 1403 "namespace": "data", 1404 "identifier": "/ietf-system:system/ntp/server", 1405 "sid": 1756 1407 }, 1408 { 1409 "namespace": "data", 1410 "identifier": "/ietf-system:system/ntp/server/ 1411 association-type", 1412 "sid": 1757 1413 }, 1414 { 1415 "namespace": "data", 1416 "identifier": "/ietf-system:system/ntp/server/iburst", 1417 "sid": 1758 1418 }, 1419 { 1420 "namespace": "data", 1421 "identifier": "/ietf-system:system/ntp/server/name", 1422 "sid": 1759 1423 }, 1424 { 1425 "namespace": "data", 1426 "identifier": "/ietf-system:system/ntp/server/prefer", 1427 "sid": 1760 1428 }, 1429 { 1430 "namespace": "data", 1431 "identifier": "/ietf-system:system/ntp/server/udp", 1432 "sid": 1761 1433 }, 1434 { 1435 "namespace": "data", 1436 "identifier": "/ietf-system:system/ntp/server/udp/address", 1437 "sid": 1762 1438 }, 1439 { 1440 "namespace": "data", 1441 "identifier": "/ietf-system:system/ntp/server/udp/port", 1442 "sid": 1763 1443 }, 1444 { 1445 "namespace": "data", 1446 "identifier": "/ietf-system:system/radius", 1447 "sid": 1764 1448 }, 1449 { 1450 "namespace": "data", 1451 "identifier": "/ietf-system:system/radius/options", 1452 "sid": 1765 1453 }, 1454 { 1455 "namespace": "data", 1456 "identifier": "/ietf-system:system/radius/options/attempts", 1457 "sid": 1766 1458 }, 1459 { 1460 "namespace": "data", 1461 "identifier": "/ietf-system:system/radius/options/timeout", 1462 "sid": 1767 1463 }, 1464 { 1465 "namespace": "data", 1466 "identifier": "/ietf-system:system/radius/server", 1467 "sid": 1768 1468 }, 1469 { 1470 "namespace": "data", 1471 "identifier": "/ietf-system:system/radius/server/ 1472 authentication-type", 1473 "sid": 1769 1474 }, 1475 { 1476 "namespace": "data", 1477 "identifier": "/ietf-system:system/radius/server/name", 1478 "sid": 1770 1479 }, 1480 { 1481 "namespace": "data", 1482 "identifier": "/ietf-system:system/radius/server/udp", 1483 "sid": 1771 1484 }, 1485 { 1486 "namespace": "data", 1487 "identifier": "/ietf-system:system/radius/server/udp/ 1488 address", 1489 "sid": 1772 1490 }, 1491 { 1492 "namespace": "data", 1493 "identifier": "/ietf-system:system/radius/server/udp/ 1494 authentication-port", 1495 "sid": 1773 1496 }, 1497 { 1498 "namespace": "data", 1499 "identifier": "/ietf-system:system/radius/server/udp/ 1500 shared-secret", 1501 "sid": 1774 1502 } 1504 ] 1505 } 1506 } 1508 Appendix B. SID auto generation 1510 Assignment of SIDs to YANG items can be automated, the recommended 1511 process to assign SIDs is as follows: 1513 1. A tool extracts the different items defined for a specific YANG 1514 module. 1516 2. The list of items is sorted in alphabetical order, 'namespace' in 1517 descending order, 'identifier' in ascending order. The 1518 'namespace' and 'identifier' formats are described in the YANG 1519 module 'ietf-sid-file' defined in Section 4. 1521 3. SIDs are assigned sequentially from the entry point up to the 1522 size of the registered SID range. This approach is recommended 1523 to minimize the serialization overhead, especially when delta 1524 between a reference SID and the current SID is used by protocols 1525 aiming to reduce message size. 1527 4. If the number of items exceeds the SID range(s) allocated to a 1528 YANG module, an extra range is added for subsequent assignments. 1530 5. The "dependency-revision" should reflect the revision numbers of 1531 each YANG module that the YANG module imports at the moment of 1532 the generation. 1534 In case of an update to an existing ".sid" file, an additional step 1535 is needed that increments the ".sid" file version number. If there 1536 was no version number in the previous version of the ".sid" file, 0 1537 is assumed as the version number of the old version of the ".sid" 1538 file and the version number is 1 for the new ".sid" file. Apart from 1539 that, changes of ".sid" files can also be automated using the same 1540 method described above, only unassigned YANG items are processed at 1541 step #3. Already existing items in the ".sid" file should not be 1542 given new SIDs. 1544 Note that ".sid" file versions are specific to a YANG module 1545 revision. For each new YANG module or each new revision of an 1546 existing YANG module, the version number of the initial ".sid" file 1547 should either be 0 or should not be present. 1549 Note also that RPC or action "input" and "output" data nodes MUST 1550 always be assigned SID even if they don't contain data nodes. The 1551 reason for this requirement is that other modules can augment the 1552 given module and those SIDs might be necessary. 1554 Appendix C. ".sid" file lifecycle 1556 Before assigning SIDs to their YANG modules, YANG module authors must 1557 acquire a SID range from a "YANG SID Range Registry". If the YANG 1558 module is part of an IETF draft or RFC, the SID range need to be 1559 acquired from the "IETF YANG SID Range Registry" as defined in 1560 Section 7.5. For the other YANG modules, the authors can acquire a 1561 SID range from any "YANG SID Range Registry" of their choice. 1563 Once the SID range is acquired, the owner can use it to generate 1564 ".sid" file/s for his YANG module/s. It is recommended to leave some 1565 unallocated SIDs following the allocated range in each ".sid" file in 1566 order to allow better evolution of the YANG module in the future. 1567 Generation of ".sid" files should be performed using an automated 1568 tool. Note that ".sid" files can only be generated for YANG modules 1569 and not for submodules. 1571 C.1. ".sid" File Creation 1573 The following activity diagram summarizes the creation of a YANG 1574 module and its associated ".sid" file. 1576 +---------------+ 1577 O | Creation of a | 1578 -|- ->| YANG module | 1579 / \ +---------------+ 1580 | 1581 V 1582 /-------------\ 1583 / Standardized \ yes 1584 \ YANG module ? /-------------+ 1585 \-------------/ | 1586 | no | 1587 V V 1588 /-------------\ +---------------+ 1589 / Constrained \ yes | SID range | 1590 +-->\ application ? /---->| registration |<----------+ 1591 | \-------------/ +---------------+ | 1592 | | no | | 1593 | V V | 1594 | +---------------+ +---------------+ | 1595 +---| YANG module | | SID sub-range | | 1596 | update | | assignment |<----------+ 1597 +---------------+ +---------------+ | 1598 | | 1599 V | 1600 +---------------+ +-------------+ 1601 | ".sid" file | | Rework YANG | 1602 | generation | | model | 1603 +---------------+ +-------------+ 1604 | ^ 1605 V | 1606 /----------\ yes | 1607 / Work in \ -----------+ 1608 \ progress / 1609 \----------/ 1610 | no 1611 V 1612 /-------------\ /-------------\ 1613 / RFC \ no / Open \ no 1614 \ publication? /---->\ specification?/---+ 1615 \-------------/ \-------------/ | 1616 | yes | yes | 1617 | +---------------+ | 1618 V V V 1619 +---------------+ +---------------+ 1620 | IANA | | Third party | 1621 | registration | | registration | 1622 +-------+-------+ +-------+-------+ 1623 | | 1624 +---------------------------------+ 1625 V 1626 [DONE] 1628 Figure 1: SID Lifecycle 1630 C.2. ".sid" File Update 1632 The following Activity diagram summarizes the update of a YANG module 1633 and its associated ".sid" file. 1635 +---------------+ 1636 O | Update of the | 1637 -|- ->| YANG module | 1638 / \ | or include(s) | 1639 | or import(s) | 1640 +---------------+ 1641 | 1642 V 1643 /-------------\ 1644 / New items \ yes 1645 \ created ? /------+ 1646 \-------------/ | 1647 | no V 1648 | /-------------\ +----------------+ 1649 | / SID range \ yes | Extra sub-range| 1650 | \ exhausted ? /---->| assignment | 1651 | \-------------/ +----------------+ 1652 | | no | 1653 | +---------------------+ 1654 | | 1655 | V 1656 | +---------------+ 1657 | | ".sid" file | 1658 | | update based | 1659 | | on previous | 1660 | | ".sid" file | 1661 | +---------------+ 1662 | | 1663 | V 1664 | /-------------\ +---------------+ 1665 | / Publicly \ yes | YANG module | 1666 | \ available ? /---->| registration | 1667 | \-------------/ +---------------+ 1668 | | no | 1669 +--------------+---------------------+ 1670 | 1671 [DONE] 1673 Figure 2: YANG and ".sid" file update 1675 Authors' Addresses 1676 Michel Veillette (editor) 1677 Trilliant Networks Inc. 1678 610 Rue du Luxembourg 1679 Granby, Quebec J2J 2V2 1680 Canada 1682 Phone: +14503750556 1683 Email: michel.veillette@trilliant.com 1685 Alexander Pelov (editor) 1686 Acklio 1687 1137A avenue des Champs Blancs 1688 Cesson-Sevigne, Bretagne 35510 1689 France 1691 Email: a@ackl.io 1693 Ivaylo Petrov (editor) 1694 Acklio 1695 1137A avenue des Champs Blancs 1696 Cesson-Sevigne, Bretagne 35510 1697 France 1699 Email: ivaylo@ackl.io