< draft-ietf-core-sid-12.txt   draft-ietf-core-sid-13.txt >
Internet Engineering Task Force M. Veillette, Ed. Internet Engineering Task Force M. Veillette, Ed.
Internet-Draft Trilliant Networks Inc. Internet-Draft Trilliant Networks Inc.
Intended status: Standards Track A. Pelov, Ed. Intended status: Standards Track A. Pelov, Ed.
Expires: September 28, 2020 I. Petrov, Ed. Expires: December 6, 2020 I. Petrov, Ed.
Acklio Acklio
March 27, 2020 June 04, 2020
YANG Schema Item iDentifier (SID) YANG Schema Item iDentifier (SID)
draft-ietf-core-sid-12 draft-ietf-core-sid-13
Abstract Abstract
YANG Schema Item iDentifiers (SID) are globally unique 63-bit YANG Schema Item iDentifiers (SID) are globally unique 63-bit
unsigned integers used to identify YANG items. This document defines unsigned integers used to identify YANG items. This document defines
the semantics, the registration, and assignment processes of SIDs. the semantics, the registration, and assignment processes of SIDs.
To enable the implementation of these processes, this document also To enable the implementation of these processes, this document also
defines a file format used to persist and publish assigned SIDs. defines a file format used to persist and publish assigned SIDs.
Status of This Memo Status of This Memo
skipping to change at page 1, line 36 skipping to change at page 1, line 36
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 28, 2020. This Internet-Draft will expire on December 6, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology and Notation . . . . . . . . . . . . . . . . . . 3 2. Terminology and Notation . . . . . . . . . . . . . . . . . . 4
3. ".sid" file lifecycle . . . . . . . . . . . . . . . . . . . . 4 3. ".sid" file lifecycle . . . . . . . . . . . . . . . . . . . . 5
4. ".sid" file format . . . . . . . . . . . . . . . . . . . . . 5 4. ".sid" file format . . . . . . . . . . . . . . . . . . . . . 5
5. Security Considerations . . . . . . . . . . . . . . . . . . . 12 5. Security Considerations . . . . . . . . . . . . . . . . . . . 12
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
6.1. Register SID File Format Module . . . . . . . . . . . . . 12 6.1. YANG Namespace Registration . . . . . . . . . . . . . . . 12
6.2. Create new IANA Registry: "SID Mega-Range" registry . . . 12 6.2. Register ".sid" File Format Module . . . . . . . . . . . 12
6.2.1. Structure . . . . . . . . . . . . . . . . . . . . . . 12 6.3. Create new IANA Registry: "SID Mega-Range" registry . . . 13
6.2.2. Allocation policy . . . . . . . . . . . . . . . . . . 13 6.3.1. Structure . . . . . . . . . . . . . . . . . . . . . . 13
6.2.2.1. First allocation . . . . . . . . . . . . . . . . 13 6.3.2. Allocation policy . . . . . . . . . . . . . . . . . . 13
6.2.2.2. Consecutive allocations . . . . . . . . . . . . . 13 6.3.2.1. First allocation . . . . . . . . . . . . . . . . 14
6.2.3. Initial contents of the Registry . . . . . . . . . . 14 6.3.2.2. Consecutive allocations . . . . . . . . . . . . . 14
6.3. Create a new IANA Registry: IETF SID Range Registry 6.3.3. Initial contents of the Registry . . . . . . . . . . 14
6.4. Create a new IANA Registry: IETF SID Range Registry
(managed by IANA) . . . . . . . . . . . . . . . . . . . . 14 (managed by IANA) . . . . . . . . . . . . . . . . . . . . 14
6.3.1. Structure . . . . . . . . . . . . . . . . . . . . . . 14 6.4.1. Structure . . . . . . . . . . . . . . . . . . . . . . 15
6.3.2. Allocation policy . . . . . . . . . . . . . . . . . . 14 6.4.2. Allocation policy . . . . . . . . . . . . . . . . . . 15
6.3.3. Initial contents of the registry . . . . . . . . . . 15 6.4.3. Initial contents of the registry . . . . . . . . . . 16
6.4. Create new IANA Registry: "IETF SID Registry" . . . . . . 16 6.5. Create new IANA Registry: "IETF SID Registry" . . . . . . 17
6.4.1. Structure . . . . . . . . . . . . . . . . . . . . . . 17 6.5.1. Structure . . . . . . . . . . . . . . . . . . . . . . 17
6.4.2. Allocation policy . . . . . . . . . . . . . . . . . . 17 6.5.2. Allocation policy . . . . . . . . . . . . . . . . . . 18
6.4.3. Recursive Allocation of SID Range at Document 6.5.3. Recursive Allocation of SID Range at Document
Adoption . . . . . . . . . . . . . . . . . . . . . . 17 Adoption . . . . . . . . . . . . . . . . . . . . . . 18
6.4.4. Initial contents of the registry . . . . . . . . . . 19 6.5.4. Initial contents of the registry . . . . . . . . . . 20
7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 19 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 20
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 19 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 20
8.1. Normative References . . . . . . . . . . . . . . . . . . 19 8.1. Normative References . . . . . . . . . . . . . . . . . . 20
8.2. Informative References . . . . . . . . . . . . . . . . . 20 8.2. Informative References . . . . . . . . . . . . . . . . . 21
Appendix A. ".sid" file example . . . . . . . . . . . . . . . . 21 Appendix A. ".sid" file example . . . . . . . . . . . . . . . . 22
Appendix B. SID auto generation . . . . . . . . . . . . . . . . 30 Appendix B. SID auto generation . . . . . . . . . . . . . . . . 31
Appendix C. ".sid" file lifecycle . . . . . . . . . . . . . . . 31 Appendix C. ".sid" file lifecycle . . . . . . . . . . . . . . . 32
C.1. SID File Creation . . . . . . . . . . . . . . . . . . . . 32 C.1. ".sid" File Creation . . . . . . . . . . . . . . . . . . 33
C.2. SID File Update . . . . . . . . . . . . . . . . . . . . . 33 C.2. ".sid" File Update . . . . . . . . . . . . . . . . . . . 34
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 35
1. Introduction 1. Introduction
Some of the items defined in YANG [RFC7950] require the use of a Some of the items defined in YANG [RFC7950] require the use of a
unique identifier. In both NETCONF [RFC6241] and RESTCONF [RFC8040], unique identifier. In both NETCONF [RFC6241] and RESTCONF [RFC8040],
these identifiers are implemented using names. To allow the these identifiers are implemented using names. To allow the
implementation of data models defined in YANG in constrained devices implementation of data models defined in YANG in constrained devices
and constrained networks, a more compact method to identify YANG and constrained networks, a more compact method to identify YANG
items is required. This compact identifier, called SID, is encoded items is required. This compact identifier, called SID, is encoded
using a 63-bit unsigned integer. The limitation to 63-bit unsigned using a 63-bit unsigned integer. The limitation to 63-bit unsigned
integers allows SIDs to be manipulated more easily on platforms that integers allows SIDs to be manipulated more easily on platforms that
might otherwise lack native 64-bit unsigned arithmetic. The loss of might otherwise lack native 64-bit unsigned arithmetic. The loss of
a single bit of range is not significant given the size of the a single bit of range is not significant given the size of the
remaining space. remaining space.
The following items are identified using SIDs: The following items are identified using SIDs:
o identities o identities
o data nodes (Note: including those parts of a YANG template as o data nodes (Note: including those nodes defined by the 'yang-data'
defined by the 'yang-data' extension.) extension.)
o RPCs and associated input(s) and output(s) o RPCs and associated input(s) and output(s)
o actions and associated input(s) and output(s) o actions and associated input(s) and output(s)
o notifications and associated information o notifications and associated information
o YANG modules, submodules and features o YANG modules, submodules and features
It is possible that some protocols use only a subset of the assigned It is possible that some protocols use only a subset of the assigned
skipping to change at page 3, line 40 skipping to change at page 3, line 41
Constrained YANG Module Library [I-D.ietf-core-yang-library]. Constrained YANG Module Library [I-D.ietf-core-yang-library].
SIDs are globally unique integers, a registration system is used in SIDs are globally unique integers, a registration system is used in
order to guarantee their uniqueness. SIDs are registered in blocks order to guarantee their uniqueness. SIDs are registered in blocks
called "SID ranges". called "SID ranges".
Assignment of SIDs to YANG items can be automated. For more details Assignment of SIDs to YANG items can be automated. For more details
how this could be achieved, please consult Appendix B. how this could be achieved, please consult Appendix B.
SIDs are assigned permanently, items introduced by a new revision of SIDs are assigned permanently, items introduced by a new revision of
a YANG module are added to the list of SIDs already assigned. a YANG module are added to the list of SIDs already assigned. If the
meaning of an item changes, for example as a result from a non-
backward compatible update of the YANG module, a new SID should be
assigned to it.
Section 3 provides more details about the registration process of Section 3 provides more details about the registration process of
YANG modules and associated SIDs. To enable the implementation of YANG modules and associated SIDs. To enable the implementation of
this registry, Section 4 defines a standard file format used to store this registry, Section 4 defines a standard file format used to store
and publish SIDs. and publish SIDs.
2. Terminology and Notation 2. Terminology and Notation
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
skipping to change at page 4, line 35 skipping to change at page 4, line 41
The following term is defined in [RFC8040]: The following term is defined in [RFC8040]:
o yang-data extension o yang-data extension
This specification also makes use of the following terminology: This specification also makes use of the following terminology:
o item: A schema node, an identity, a module, a submodule or a o item: A schema node, an identity, a module, a submodule or a
feature defined using the YANG modeling language. feature defined using the YANG modeling language.
o path: A path is a string that identifies a schema node within the o path: A path is a string that identifies a schema node within the
schema tree. A path consists of the list of schema node schema tree. A path consists of the list of consecutive schema
identifier(s) separated by slashes ("/"). Schema node node identifier(s) separated by slashes ("/"). Schema node
identifier(s) are always listed from the top-level schema node up identifier(s) are always listed from the top-level schema node up
to the targeted schema node. (e.g. "/ietf-system:system- to the targeted schema node and could contain namespace
state/clock/current-datetime") information. (e.g. "/ietf-system:system-state/clock/current-
datetime")
o YANG Schema Item iDentifier (SID): Unsigned integer used to o YANG Schema Item iDentifier (SID): Unsigned integer used to
identify different YANG items. identify different YANG items.
3. ".sid" file lifecycle 3. ".sid" file lifecycle
YANG is a language designed to model data accessed using one of the YANG is a language designed to model data accessed using one of the
compatible protocols (e.g. NETCONF [RFC6241], RESCONF [RFC8040] and compatible protocols (e.g. NETCONF [RFC6241], RESTCONF [RFC8040] and
CoRECONF [I-D.ietf-core-comi]). A YANG module defines hierarchies of CoMI [I-D.ietf-core-comi]). A YANG module defines hierarchies of
data, including configuration, state data, RPCs, actions and data, including configuration, state data, RPCs, actions and
notifications. notifications.
Many YANG modules are not created in the context of constrained Many YANG modules are not created in the context of constrained
applications. YANG modules can be implemented using NETCONF applications. YANG modules can be implemented using NETCONF
[RFC6241] or RESTCONF [RFC8040] without the need to assign SIDs. [RFC6241] or RESTCONF [RFC8040] without the need to assign SIDs.
As needed, authors of YANG modules can assign SIDs to their YANG As needed, authors of YANG modules can assign SIDs to their YANG
modules. In order to do that, they should first obtain a SID range modules. In order to do that, they should first obtain a SID range
from a registry and use that range to assign or generate SIDs to from a registry and use that range to assign or generate SIDs to
items of their YANG module. The assignments can then be stored in a items of their YANG module. The assignments can then be stored in a
".sid" file. For example how this could be achieved, please refer to ".sid" file. For example on how this could be achieved, please refer
Appendix C. to Appendix C.
Registration of the ".sid" file associated to a YANG module is Registration of the ".sid" file associated to a YANG module is
optional but recommended to promote interoperability between devices optional but recommended to promote interoperability between devices
and to avoid duplicate allocation of SIDs to a single YANG module. and to avoid duplicate allocation of SIDs to a single YANG module.
Different registries might have different requirements for the Different registries might have different requirements for the
registration and publication of the ".sid" files. For diagram of one registration and publication of the ".sid" files. For a diagram of
of the possibilities, please refer to the activity diagram on one of the possibilities, please refer to the activity diagram on
Figure 1 in Appendix C. Figure 1 in Appendix C.
Each time a YANG module or one of its imported module(s) or included Each time a YANG module or one of its imported module(s) or included
sub-module(s) is updated, a new ".sid" file MAY need to be created. sub-module(s) is updated, a new ".sid" file MAY need to be created.
All the SIDs present in the previous version of the ".sid" file MUST All the SIDs present in the previous version of the ".sid" file MUST
be present in the new version as well. The creation of this new be present in the new version as well. The creation of this new
version of the ".sid" file SHOULD be performed using an automated version of the ".sid" file SHOULD be performed using an automated
tool. tool.
If a new revision requires more SIDs than initially allocated, a new If a new revision requires more SIDs than initially allocated, a new
skipping to change at page 6, line 22 skipping to change at page 6, line 22
| +--rw module-revision revision-identifier | +--rw module-revision revision-identifier
+--rw assigment-ranges* [entry-point] +--rw assigment-ranges* [entry-point]
| +--rw entry-point sid | +--rw entry-point sid
| +--rw size uint64 | +--rw size uint64
+--rw items* [namespace identifier] +--rw items* [namespace identifier]
+--rw namespace enumeration +--rw namespace enumeration
+--rw identifier union +--rw identifier union
+--rw sid sid +--rw sid sid
The following YANG module defined the structure of this file, The following YANG module defined the structure of this file,
encoding is performed using the rules defined in [RFC7951]. encoding is performed using the rules defined in [RFC7951]. It
references ietf-yang-types defined in [RFC6991] and ietf-restconf
defined in [RFC8040].
RFC Ed.: please update the date of the module and Copyright if needed
and remove this note.
<CODE BEGINS> file "ietf-sid-file@2020-02-05.yang" <CODE BEGINS> file "ietf-sid-file@2020-02-05.yang"
module ietf-sid-file { module ietf-sid-file {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-sid-file"; namespace "urn:ietf:params:xml:ns:yang:ietf-sid-file";
prefix sid; prefix sid;
import ietf-yang-types { import ietf-yang-types {
prefix yang; prefix yang;
reference "RFC 6991: Common YANG Data Types.";
} }
import ietf-restconf { import ietf-restconf {
prefix rc; prefix rc;
reference "RFC 8040: RESTCONF Protocol.";
} }
organization organization
"IETF Core Working Group"; "IETF Core Working Group";
contact contact
"Michel Veillette "WG Web: <http://datatracker.ietf.org/wg/core/>
<mailto:michel.veillette@trilliant.com>
Andy Bierman WG List: <mailto:core@ietf.org>
<mailto:andy@yumaworks.com>
Alexander Pelov Editor: Michel Veillette
<mailto:a@ackl.io> <mailto:michel.veillette@trilliant.com>
Ivaylo Petrov Editor: Andy Bierman
<mailto:ivaylo@ackl.io>"; <mailto:andy@yumaworks.com>
Editor: Alexander Pelov
<mailto:a@ackl.io>
Editor: Ivaylo Petrov
<mailto:ivaylo@ackl.io>";
description description
"Copyright (c) 2020 IETF Trust and the persons identified as "Copyright (c) 2020 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
skipping to change at page 7, line 48 skipping to change at page 8, line 13
type string { type string {
pattern '\d{4}-\d{2}-\d{2}'; pattern '\d{4}-\d{2}-\d{2}';
} }
description description
"Represents a date in YYYY-MM-DD format."; "Represents a date in YYYY-MM-DD format.";
} }
typedef sid-file-version-identifier { typedef sid-file-version-identifier {
type uint64; type uint64;
description description
"Optional attribute that gives information about the .sid file "Represents the version of a .sid file.";
version.";
} }
typedef sid { typedef sid {
type uint64; type uint64 {
range "0..9223372036854775807";
}
description description
"YANG Schema Item iDentifier"; "YANG Schema Item iDentifier";
reference reference
"[I-D.ietf-core-sid] YANG Schema Item iDentifier (SID)"; "[I-D.ietf-core-sid] YANG Schema Item iDentifier (SID)";
} }
typedef schema-node-path { typedef schema-node-path {
type string { type string {
pattern pattern
'/[a-zA-Z_][a-zA-Z0-9\-_.]*:[a-zA-Z_][a-zA-Z0-9\-_.]*' + '/[a-zA-Z_][a-zA-Z0-9\-_.]*:[a-zA-Z_][a-zA-Z0-9\-_.]*' +
'(/[a-zA-Z_][a-zA-Z0-9\-_.]*(:[a-zA-Z_][a-zA-Z0-9\-_.]*)?)*'; '(/[a-zA-Z_][a-zA-Z0-9\-_.]*(:[a-zA-Z_][a-zA-Z0-9\-_.]*)?)*';
} }
description description
"Identifies a schema-node path string for use in the "A schema-node path string for use in the
SID registry. This string format follows the rules SID registry. This string format follows the rules
for an instance-identifier, as defined in RFC 7959, for an instance-identifier, as defined in RFC 7951,
except that no predicates are allowed. except that no predicates are allowed.
This format is intended to support the YANG 1.1 ABNF This format is intended to support the YANG 1.1 ABNF
for a schema node identifier, except module names for a schema node identifier, except module names
are used instead of prefixes, as specified in RFC 7951."; are used instead of prefixes, as specified in RFC 7951.";
reference reference
"RFC 7950, The YANG 1.1 Data Modeling Language; "RFC 7950, The YANG 1.1 Data Modeling Language;
Section 6.5: Schema Node Identifier; Section 6.5: Schema Node Identifier;
RFC 7951, JSON Encoding of YANG Data; RFC 7951, JSON Encoding of YANG Data;
Section 6.11: The instance-identifier type"; Section 6.11: The instance-identifier type";
skipping to change at page 8, line 37 skipping to change at page 9, line 4
reference reference
"RFC 7950, The YANG 1.1 Data Modeling Language; "RFC 7950, The YANG 1.1 Data Modeling Language;
Section 6.5: Schema Node Identifier; Section 6.5: Schema Node Identifier;
RFC 7951, JSON Encoding of YANG Data; RFC 7951, JSON Encoding of YANG Data;
Section 6.11: The instance-identifier type"; Section 6.11: The instance-identifier type";
} }
rc:yang-data sid-file { rc:yang-data sid-file {
uses sid-file; uses sid-file;
} }
grouping sid-file { grouping sid-file {
description "A grouping that contains a YANG container representing the description "A grouping that contains a YANG container representing the
file structure of a sid files."; file structure of a .sid files.";
container sid-file { container sid-file {
description description
"A Wrapper container that together with the rc:yang-data extension "A Wrapper container that together with the rc:yang-data extension
marks the YANG data structures inside as not being intended to be marks the YANG data structures inside as not being intended to be
implemented as part of a configuration datastore or as an operational implemented as part of a configuration datastore or as an operational
state within the server."; state within the server.";
leaf module-name { leaf module-name {
type yang:yang-identifier; type yang:yang-identifier;
description description
skipping to change at page 9, line 4 skipping to change at page 9, line 18
container sid-file { container sid-file {
description description
"A Wrapper container that together with the rc:yang-data extension "A Wrapper container that together with the rc:yang-data extension
marks the YANG data structures inside as not being intended to be marks the YANG data structures inside as not being intended to be
implemented as part of a configuration datastore or as an operational implemented as part of a configuration datastore or as an operational
state within the server."; state within the server.";
leaf module-name { leaf module-name {
type yang:yang-identifier; type yang:yang-identifier;
description description
"Name of the YANG module associated with this .sid file."; "Name of the YANG module associated with this .sid file.";
} }
leaf module-revision { leaf module-revision {
type revision-identifier; type revision-identifier;
description description
"Revision of the YANG module associated with this .sid file. "Revision of the YANG module associated with this .sid file.
This leaf is not present if no revision statement is This leaf is not present if no revision statement is
defined in the YANG module."; defined in the YANG module.";
} }
leaf sid-file-version { leaf sid-file-version {
type sid-file-version-identifier; type sid-file-version-identifier;
description description
"The version number of the .sid file. .sid files and the version "Optional leaf that specifies the version number of the .sid file.
sequence are specific to a given YANG module revision. .sid files and the version sequence are specific to a given YANG
This number starts at zero when there is a YANG module update. module revision. This number starts at zero when there is a new YANG
This number can distinguish updates to the SID file which are the result of module revision and increases monotonically. This number can
new processing, or the result of reported errata."; distinguish updates to the .sid file which are the result of new
processing, or the result of reported errata.";
} }
leaf description { leaf description {
type string; type string;
description description
"Free-form meta information about the generated file. It might "Free-form meta information about the generated file. It might
include sid file generation tool and time among other things."; include .sid file generation tool and time among other things.";
} }
list dependency-revision { list dependency-revision {
key "module-name"; key "module-name";
description description
"Information about the revision of each YANG module that the module in "Information about the used revision during the .sid file generation
'module-name' includes used during the .sid file generation."; of each YANG module that the module in 'module-name' imported.";
leaf module-name { leaf module-name {
type yang:yang-identifier; type yang:yang-identifier;
mandatory true; mandatory true;
description description
"Name of the YANG module, dependency of 'module-name', for which "Name of the YANG module, dependency of 'module-name', for which
revision information is provided."; revision information is provided.";
} }
leaf module-revision { leaf module-revision {
type revision-identifier; type revision-identifier;
skipping to change at page 12, line 4 skipping to change at page 12, line 18
type sid; type sid;
mandatory true; mandatory true;
description description
"SID assigned to the YANG item for this mapping entry."; "SID assigned to the YANG item for this mapping entry.";
} }
} }
} }
} }
} }
<CODE ENDS> <CODE ENDS>
5. Security Considerations 5. Security Considerations
This document defines a new type of identifier used to encode data This document defines a new type of identifier used to encode data
models defined in YANG [RFC7950]. As such, this identifier does not models defined in YANG [RFC7950]. As such, this identifier does not
contribute to any new security issues in addition of those identified contribute to any new security issues in addition of those identified
for the specific protocols or contexts for which it is used. for the specific protocols or contexts for which it is used.
6. IANA Considerations 6. IANA Considerations
6.1. Register SID File Format Module 6.1. YANG Namespace Registration
This document registers the following XML namespace URN in the "IETF
XML Registry", following the format defined in [RFC3688]:
URI: please assign urn:ietf:params:xml:ns:yang:ietf-sid-file
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
Reference: RFC XXXX
// RFC Ed.: please replace XXXX with RFC number and remove this note
6.2. Register ".sid" File Format Module
This document registers one YANG module in the "YANG Module Names" This document registers one YANG module in the "YANG Module Names"
registry [RFC6020]: registry [RFC6020]:
o name: ietf-sid-file o name: ietf-sid-file
o namespace: urn:ietf:params:xml:ns:yang:ietf-sid-file o namespace: urn:ietf:params:xml:ns:yang:ietf-sid-file
o prefix: sid o prefix: sid
o reference: [[THISRFC]] o reference: [[THISRFC]]
6.2. Create new IANA Registry: "SID Mega-Range" registry 6.3. Create new IANA Registry: "SID Mega-Range" registry
The name of this registry is "SID Mega-Range". This registry is used The name of this registry is "SID Mega-Range". This registry is used
to record the delegation of the management of a block of SIDs to to record the delegation of the management of a block of SIDs to
third parties (such as SDOs or registrars). third parties (such as SDOs or registrars).
6.2.1. Structure 6.3.1. Structure
Each entry in this registry must include: Each entry in this registry must include:
o The entry point (first SID) of the registered SID block. o The entry point (first SID) of the registered SID block.
o The size of the registered SID block. The size MUST be one o The size of the registered SID block. The size MUST be one
million (1 000 000) SIDs. million (1 000 000) SIDs.
o The contact information of the requesting organization including: o The contact information of the requesting organization including:
skipping to change at page 13, line 7 skipping to change at page 13, line 36
* Organization name * Organization name
* URL * URL
The information associated to the Organization name should not be The information associated to the Organization name should not be
publicly visible in the registry, but should be available. This publicly visible in the registry, but should be available. This
information includes contact email and phone number and change information includes contact email and phone number and change
controller email and phone number. controller email and phone number.
6.2.2. Allocation policy 6.3.2. Allocation policy
The IANA policy for future additions to this registry is "Expert The IANA policy for future additions to this registry is "Expert
Review" [RFC8126]. Review" [RFC8126].
An organization requesting to manage a SID Range (and thus have an An organization requesting to manage a SID Range (and thus have an
entry in the SID Mega-Range Registry), must ensure the following entry in the SID Mega-Range Registry), must ensure the following
capacities: capacities:
o The capacity to manage and operate a SID Range Registry. A SID o The capacity to manage and operate a SID Range Registry. A SID
Range Registry MUST provide the following information for all SID Range Registry MUST provide the following information for all SID
skipping to change at page 13, line 23 skipping to change at page 14, line 4
entry in the SID Mega-Range Registry), must ensure the following entry in the SID Mega-Range Registry), must ensure the following
capacities: capacities:
o The capacity to manage and operate a SID Range Registry. A SID o The capacity to manage and operate a SID Range Registry. A SID
Range Registry MUST provide the following information for all SID Range Registry MUST provide the following information for all SID
Ranges allocated by the Registry: Ranges allocated by the Registry:
* Entry Point of allocated SID Range * Entry Point of allocated SID Range
* Size of allocated SID Range * Size of allocated SID Range
* Type: Public or Private * Type: Public or Private
+ Public Ranges MUST include at least a reference to the YANG + Public Ranges MUST include at least a reference to the YANG
module and ".sid" files for that SID Range. module and ".sid" files for that SID Range.
+ Private Ranges MUST be marked as "Private" + Private Ranges MUST be marked as "Private"
o A Policy of allocation, which clearly identifies if the SID Range o A Policy of allocation, which clearly identifies if the SID Range
allocations would be Private, Public or Both. allocations would be Private, Public or Both.
o Technical capacity to ensure the sustained operation of the o Technical capacity to ensure the sustained operation of the
registry for a period of at least 5 years. If Private registry for a period of at least 5 years. If Private
Registrations are allowed, the period must be of at least 10 Registrations are allowed, the period must be of at least 10
years. years.
6.2.2.1. First allocation 6.3.2.1. First allocation
For a first allocation to be provided, the requesting organization For a first allocation to be provided, the requesting organization
must demonstrate a functional registry infrastructure. must demonstrate a functional registry infrastructure.
6.2.2.2. Consecutive allocations 6.3.2.2. Consecutive allocations
On subsequent allocation request(s), the organization must On subsequent allocation request(s), the organization must
demonstrate the exhaustion of the prior range. These conditions need demonstrate the exhaustion of the prior range. These conditions need
to be asserted by the assigned expert(s). to be asserted by the assigned expert(s).
If that extra-allocation is done within 3 years from the last If that extra-allocation is done within 3 years from the last
allocation, the experts need to discuss this request on the CORE allocation, the experts need to discuss this request on the CORE
working group mailing list and consensus needs to be obtained before working group mailing list and consensus needs to be obtained before
allocating a new Mega-Range. allocating a new Mega-Range.
6.2.3. Initial contents of the Registry 6.3.3. Initial contents of the Registry
The initial entry in this registry is allocated to IANA: The initial entry in this registry is allocated to IANA:
+-------------+---------+------------+-------------------+----------+ +-------------+---------+------------+-------------------+----------+
| Entry Point | Size | Allocation | Organization name | URL | | Entry Point | Size | Allocation | Organization name | URL |
+-------------+---------+------------+-------------------+----------+ +-------------+---------+------------+-------------------+----------+
| 0 | 1000000 | Public | IANA | iana.org | | 0 | 1000000 | Public | IANA | iana.org |
+-------------+---------+------------+-------------------+----------+ +-------------+---------+------------+-------------------+----------+
6.3. Create a new IANA Registry: IETF SID Range Registry (managed by 6.4. Create a new IANA Registry: IETF SID Range Registry (managed by
IANA) IANA)
6.3.1. Structure 6.4.1. Structure
Each entry in this registry must include: Each entry in this registry must include:
o The SID range entry point. o The SID range entry point.
o The SID range size. o The SID range size.
o The YANG module name. o The YANG module name.
o Document reference. o Document reference.
6.3.2. Allocation policy 6.4.2. Allocation policy
The first million SIDs assigned to IANA is sub-divided as follows: The first million SIDs assigned to IANA is sub-divided as follows:
o The range of 0 to 999 (size 1000) is "Reserved" as defined in o The range of 0 to 999 (size 1000) is "Reserved" as defined in
[RFC8126]. [RFC8126].
o The range of 1000 to 59,999 (size 59,000) is reserved for YANG o The range of 1000 to 59,999 (size 59,000) is reserved for YANG
modules defined in RFCs. The IANA policy for additions to this modules defined in RFCs.
registry is "Expert Review" [RFC8126].
* The IANA policy for additions to this registry is either:
+ "Expert Review" [RFC8126] in case the ".sid" file comes from
a YANG module from an existing RFC, or
+ "RFC Required" [RFC8126] otherwise.
* The Expert MUST verify that the YANG module for which this * The Expert MUST verify that the YANG module for which this
allocation is made has an RFC (existing RFC) OR is on track to allocation is made has an RFC (existing RFC) OR is on track to
become RFC (early allocation with a request from the WG chairs become RFC (early allocation with a request from the WG chairs
as defined by [RFC7120]). as defined by [RFC7120]).
o The SID range allocated for a YANG module can follow in one of the o The range of 60,000 to 99,999 (size 40,000) is reserved for
four categories:
* SMALL (50 SIDs)
* MEDIUM (100 SIDs)
* LARGE (250 SIDs)
* CUSTOM (requested by the YANG module author, with a maximum of
1000 SIDs). In all cases, the size of a SID range assigned to
a YANG module should be at least 33% above the current number
of YANG items. This headroom allows assignment within the same
range of new YANG items introduced by subsequent revisions. A
larger SID range size may be requested by the authors if this
recommendation is considered insufficient. It is important to
note that an additional SID range can be allocated to an
existing YANG module if the initial range is exhausted.
o The range of 60,000 to 99,999 (size 40,000)is reserved for
experimental YANG modules. This range MUST NOT be used in experimental YANG modules. This range MUST NOT be used in
operational deployments since these SIDs are not globally unique operational deployments since these SIDs are not globally unique
which limit their interoperability. The IANA policy for this which limit their interoperability. The IANA policy for this
range is "Experimental use" [RFC8126]. range is "Experimental use" [RFC8126].
o The range of 100,000 to 999,999 (size 900,000) is "Reserved" as o The range of 100,000 to 999,999 (size 900,000) is "Reserved" as
defined in [RFC8126]. defined in [RFC8126].
+-------------+---------+------------------+ +-------------+---------+-------------------------------+
| Entry Point | Size | IANA policy | | Entry Point | Size | IANA policy |
+-------------+---------+------------------+ +-------------+---------+-------------------------------+
| 0 | 1,000 | Reserved | | 0 | 1,000 | Reserved |
| 1,000 | 59,000 | Expert Review | | 1,000 | 59,000 | Expert Review or RFC Required |
| 60,000 | 40,000 | Experimental use | | 60,000 | 40,000 | Experimental use |
| 100,000 | 900,000 | Reserved | | 100,000 | 900,000 | Reserved |
+-------------+---------+------------------+ +-------------+---------+-------------------------------+
6.3.3. Initial contents of the registry The size of the SID range allocated for a YANG module is recommended
to be a multiple of 50 and to be at least 33% above the current
number of YANG items. This headroom allows assignment within the
same range of new YANG items introduced by subsequent revisions. The
maximum SID range size is 1000. A larger size may be requested by
the authors if this recommendation is considered insufficient. It is
important to note that an additional SID range can be allocated to an
existing YANG module if the initial range is exhausted.
In case a SID range is allocated for an existing RFC through the
"Expert Review" policy, the Document reference field for the given
allocation should point to the RFC that the YANG module is defined
in.
In case a SID range is required before publishing the RFC due to
implementations needing stable SID values, early allocation as
defined in [RFC7120] can be employed. As specified in section 4.6 of
[RFC8126], RFCs and by extension documents that are expected to
become an RFC fulfill the requirement for "Specification Required"
stated in section 2 of [RFC7120], which allows for the early
allocation process to be employed.
6.4.3. Initial contents of the registry
Initial entries in this registry are as follows: Initial entries in this registry are as follows:
+-----+-----+--------------------------+----------------------------+ +-------+------+---------------------------+------------------------+
| Ent | Siz | Module name | Document reference | | Entry | Size | Module name | Document reference |
| ry | e | | | | Point | | | |
| Poi | | | | +-------+------+---------------------------+------------------------+
| nt | | | | | 1000 | 100 | ietf-comi | [I-D.ietf-core-comi] |
+-----+-----+--------------------------+----------------------------+ | 1100 | 50 | ietf-yang-types | [RFC6991] |
| 100 | 100 | ietf-comi | [I-D.ietf-core-comi] | | 1150 | 50 | ietf-inet-types | [RFC6991] |
| 0 | | | | | 1200 | 50 | iana-crypt-hash | [RFC7317] |
| 110 | 50 | ietf-yang-types | [RFC6991] | | 1250 | 50 | ietf-netconf-acm | [RFC8341] |
| 0 | | | | | 1300 | 50 | ietf-sid-file | RFCXXXX |
| 115 | 50 | ietf-inet-types | [RFC6991] | | 1500 | 100 | ietf-interfaces | [RFC8343] |
| 0 | | | | | 1600 | 100 | ietf-ip | [RFC8344] |
| 120 | 50 | iana-crypt-hash | [RFC7317] | | 1700 | 100 | ietf-system | [RFC7317] |
| 0 | | | | | 1800 | 400 | iana-if-type | [RFC7224] |
| 125 | 50 | ietf-netconf-acm | [RFC8341] | | 2400 | 50 | ietf-voucher | [RFC8366] |
| 0 | | | | | 2450 | 50 | ietf-constrained-voucher | [I-D.ietf-anima-constr |
| 130 | 50 | ietf-sid-file | RFCXXXX | | | | | ained-voucher] |
| 0 | | | | | 2500 | 50 | ietf-constrained-voucher- | [I-D.ietf-anima-constr |
| 150 | 100 | ietf-interfaces | [RFC8343] | | | | request | ained-voucher] |
| 0 | | | | +-------+------+---------------------------+------------------------+
| 160 | 100 | ietf-ip | [RFC8344] |
| 0 | | | |
| 170 | 100 | ietf-system | [RFC7317] |
| 0 | | | |
| 180 | 400 | iana-if-type | [RFC7224] |
| 0 | | | |
| 240 | 50 | ietf-voucher | [RFC8366] |
| 0 | | | |
| 245 | 50 | ietf-constrained-voucher | [I-D.ietf-anima-constraine |
| 0 | | | d-voucher] |
| 250 | 50 | ietf-constrained- | [I-D.ietf-anima-constraine |
| 0 | | voucher-request | d-voucher] |
+-----+-----+--------------------------+----------------------------+
// RFC Ed.: replace XXXX with RFC number assigned to this draft. // RFC Ed.: replace XXXX with RFC number assigned to this draft.
For allocation, RFC publication of the YANG module is required as per For allocation, RFC publication of the YANG module is required as per
[RFC8126]. The YANG module must be registered in the "YANG module [RFC8126]. The YANG module must be registered in the "YANG module
Name" registry according to the rules specified in section 14 of Name" registry according to the rules specified in section 14 of
[RFC6020]. [RFC6020].
6.4. Create new IANA Registry: "IETF SID Registry" 6.5. Create new IANA Registry: "IETF SID Registry"
The name of this registry is "IETF SID Registry". This registry is The name of this registry is "IETF SID Registry". This registry is
used to record the allocation of SIDs for individual YANG module used to record the allocation of SIDs for individual YANG module
items. items.
6.4.1. Structure 6.5.1. Structure
Each entry in this registry must include: Each entry in this registry must include:
o The YANG module name. This module name must be present in the o The YANG module name. This module name must be present in the
"Name" column of the "YANG Module Names" registry. "Name" column of the "YANG Module Names" registry.
o A link to the associated ".yang" file. This file link must be o A link to the associated ".yang" file. This file link must be
present in the "File" column of the "YANG Module Names" registry. present in the "File" column of the "YANG Module Names" registry.
o The link to the ".sid" file which defines the allocation. The o The link to the ".sid" file which defines the allocation. The
".sid" file is stored by IANA. ".sid" file is stored by IANA.
o The number of actually allocated SIDs in the ".sid" file. o The number of actually allocated SIDs in the ".sid" file.
6.4.2. Allocation policy 6.5.2. Allocation policy
The allocation policy is Expert review. The Expert MUST ensure that The allocation policy is Expert review. The Expert MUST ensure that
the following conditions are met: the following conditions are met:
o The ".sid" file has a valid structure: o The ".sid" file has a valid structure:
* The ".sid" file MUST be a valid JSON file following the * The ".sid" file MUST be a valid JSON file following the
structure of the module defined in RFCXXXX (RFC Ed: replace XXX structure of the module defined in RFCXXXX (RFC Ed: replace XXX
with RFC number assigned to this draft). with RFC number assigned to this draft).
skipping to change at page 17, line 46 skipping to change at page 18, line 31
allocated to this YANG module in the "IETF SID Range Registry". allocated to this YANG module in the "IETF SID Range Registry".
o If another ".sid" file has already allocated SIDs for this YANG o If another ".sid" file has already allocated SIDs for this YANG
module (e.g. for older or newer versions of the YANG module), the module (e.g. for older or newer versions of the YANG module), the
YANG items are assigned the same SIDs as in the other ".sid" file. YANG items are assigned the same SIDs as in the other ".sid" file.
o If there is an older version of the ".sid" file, all allocated o If there is an older version of the ".sid" file, all allocated
SIDs from that version are still present in the current version of SIDs from that version are still present in the current version of
the ".sid" file. the ".sid" file.
6.4.3. Recursive Allocation of SID Range at Document Adoption 6.5.3. Recursive Allocation of SID Range at Document Adoption
Due to the difficulty in changing SID values during IETF document Due to the difficulty in changing SID values during IETF document
processing, it is expected that most documents will ask for SID processing, it is expected that most documents will ask for SID
allocations using Early Allocations [RFC7120]. The details of the allocations using Early Allocations [RFC7120]. The details of the
Early Allocation should be included in any Working Group Adoption Early Allocation should be included in any Working Group Adoption
call. Prior to Working Group Adoption, an internet draft authors can call. Prior to Working Group Adoption, an internet draft authors can
use the experimental SID range (as per Section 6.3.2) for their SIDs use the experimental SID range (as per Section 6.4.2) for their SIDs
allocations or other values that do not create ambiguity with other allocations or other values that do not create ambiguity with other
SID uses (for example they can use a range that comes from a non-IANA SID uses (for example they can use a range that comes from a non-IANA
managed "SID Mega-Range" registry). managed "SID Mega-Range" registry).
After Working Group Adoption, any modification of a ".sid" file is After Working Group Adoption, any modification of a ".sid" file is
expected to be discussed on the mailing list of the appropriate expected to be discussed on the mailing list of the appropriate
Working Groups. Specific attention should be paid to implementers' Working Groups. Specific attention should be paid to implementers'
opinion after Working Group Last Call if a SID value is to change its opinion after Working Group Last Call if a SID value is to change its
meaning. In all cases, a ".sid" file and the SIDs associated with it meaning. In all cases, a ".sid" file and the SIDs associated with it
are subject to change before the publication of an internet draft as are subject to change before the publication of an internet draft as
skipping to change at page 19, line 26 skipping to change at page 20, line 14
2. The [RFC7120] mechanism allows the IESG to provide a second 2. The [RFC7120] mechanism allows the IESG to provide a second
renewal, and such an event may prompt some thought about how the renewal, and such an event may prompt some thought about how the
collection of documents are being processed. collection of documents are being processed.
This is driven by the very generous size of the SID space and the This is driven by the very generous size of the SID space and the
often complex and deep dependencies of YANG modules. Often a core often complex and deep dependencies of YANG modules. Often a core
module with many dependencies will undergo extensive review, delaying module with many dependencies will undergo extensive review, delaying
the publication of other documents. the publication of other documents.
[RFC7120] also says [RFC7120] also says:
Note that if a document is submitted for review to the IESG and at Note that if a document is submitted for review to the IESG and at
the time of submission some early allocations are valid (not the time of submission some early allocations are valid (not
expired), these allocations should not be expired while the document expired), these allocations should not be expired while the document
is under IESG consideration or waiting in the RFC Editor's queue is under IESG consideration or waiting in the RFC Editor's queue
after approval by the IESG. after approval by the IESG.
6.4.4. Initial contents of the registry 6.5.4. Initial contents of the registry
None. None.
7. Acknowledgments 7. Acknowledgments
The authors would like to thank Andy Bierman, Carsten Bormann, The authors would like to thank Andy Bierman, Carsten Bormann,
Michael Richardson, Abhinav Somaraju, Peter van der Stok, Laurent Michael Richardson, Abhinav Somaraju, Peter van der Stok, Laurent
Toutain and Randy Turner for their help during the development of Toutain and Randy Turner for their help during the development of
this document and their useful comments during the review process. this document and their useful comments during the review process.
8. References 8. References
8.1. Normative References 8.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7120] Cotton, M., "Early IANA Allocation of Standards Track Code [RFC7120] Cotton, M., "Early IANA Allocation of Standards Track Code
Points", BCP 100, RFC 7120, DOI 10.17487/RFC7120, January Points", BCP 100, RFC 7120, DOI 10.17487/RFC7120, January
2014, <https://www.rfc-editor.org/info/rfc7120>. 2014, <https://www.rfc-editor.org/info/rfc7120>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG",
RFC 7951, DOI 10.17487/RFC7951, August 2016, RFC 7951, DOI 10.17487/RFC7951, August 2016,
<https://www.rfc-editor.org/info/rfc7951>. <https://www.rfc-editor.org/info/rfc7951>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
8.2. Informative References 8.2. Informative References
[I-D.ietf-anima-constrained-voucher] [I-D.ietf-anima-constrained-voucher]
Richardson, M., Stok, P., and P. Kampanakis, "Constrained Richardson, M., Stok, P., and P. Kampanakis, "Constrained
Voucher Artifacts for Bootstrapping Protocols", draft- Voucher Artifacts for Bootstrapping Protocols", draft-
ietf-anima-constrained-voucher-07 (work in progress), ietf-anima-constrained-voucher-07 (work in progress),
skipping to change at page 20, line 49 skipping to change at page 21, line 49
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010, DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>. <https://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
RFC 6991, DOI 10.17487/RFC6991, July 2013, Protocol (NETCONF) Access Control Model", RFC 6536,
<https://www.rfc-editor.org/info/rfc6991>. DOI 10.17487/RFC6536, March 2012,
<https://www.rfc-editor.org/info/rfc6536>.
[RFC7224] Bjorklund, M., "IANA Interface Type YANG Module", [RFC7224] Bjorklund, M., "IANA Interface Type YANG Module",
RFC 7224, DOI 10.17487/RFC7224, May 2014, RFC 7224, DOI 10.17487/RFC7224, May 2014,
<https://www.rfc-editor.org/info/rfc7224>. <https://www.rfc-editor.org/info/rfc7224>.
[RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for [RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for
System Management", RFC 7317, DOI 10.17487/RFC7317, August System Management", RFC 7317, DOI 10.17487/RFC7317, August
2014, <https://www.rfc-editor.org/info/rfc7317>. 2014, <https://www.rfc-editor.org/info/rfc7317>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26, Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017, RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/info/rfc8126>. <https://www.rfc-editor.org/info/rfc8126>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018, DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
skipping to change at page 21, line 45 skipping to change at page 22, line 41
[RFC8366] Watsen, K., Richardson, M., Pritikin, M., and T. Eckert, [RFC8366] Watsen, K., Richardson, M., Pritikin, M., and T. Eckert,
"A Voucher Artifact for Bootstrapping Protocols", "A Voucher Artifact for Bootstrapping Protocols",
RFC 8366, DOI 10.17487/RFC8366, May 2018, RFC 8366, DOI 10.17487/RFC8366, May 2018,
<https://www.rfc-editor.org/info/rfc8366>. <https://www.rfc-editor.org/info/rfc8366>.
Appendix A. ".sid" file example Appendix A. ".sid" file example
The following ".sid" file (ietf-system@2014-08-06.sid) have been The following ".sid" file (ietf-system@2014-08-06.sid) have been
generated using the following yang modules: generated using the following yang modules:
o ietf-system@2014-08-06.yang o ietf-system@2014-08-06.yang (defined in [RFC7317])
o ietf-yang-types@2013-07-15.yang o ietf-yang-types@2013-07-15.yang (defined in [RFC6991])
o ietf-inet-types@2013-07-15.yang o ietf-inet-types@2013-07-15.yang (defined in [RFC6991])
o ietf-netconf-acm@2012-02-22.yang o ietf-netconf-acm@2012-02-22.yang (defined in [RFC6536])
o iana-crypt-hash@2014-04-04.yang
o iana-crypt-hash@2014-04-04.yang (defined in [RFC7317])
{ {
"ietf-sid-file:sid-file" : { "ietf-sid-file:sid-file" : {
"module-name": "ietf-system", "module-name": "ietf-system",
"module-revision": "2020-02-05", "module-revision": "2020-02-05",
"dependency-revision": [
{
"module-name": "ietf-yang-types",
"module-revision": "2013-07-15.yang"
},
{
"module-name": "ietf-inet-types",
"module-revision": "2013-07-15.yang"
},
{
"module-name": "ietf-netconf-acm",
"module-revision": "2012-02-22.yang"
},
{
"module-name": "iana-crypt-hash",
"module-revision": "2014-04-04.yang"
}
],
"description": "Example sid file", "description": "Example sid file",
"assignment-ranges": [ "assignment-ranges": [
{ {
"entry-point": 1700, "entry-point": 1700,
"size": 100 "size": 100
} }
], ],
"items": [ "items": [
{ {
"namespace": "module", "namespace": "module",
skipping to change at page 31, line 17 skipping to change at page 32, line 31
5. The "dependency-revision" should reflect the revision numbers of 5. The "dependency-revision" should reflect the revision numbers of
each YANG module that the YANG module imports at the moment of each YANG module that the YANG module imports at the moment of
the generation. the generation.
In case of an update to an existing ".sid" file, an additional step In case of an update to an existing ".sid" file, an additional step
is needed that increments the ".sid" file version number. If there is needed that increments the ".sid" file version number. If there
was no version number in the previous version of the ".sid" file, 0 was no version number in the previous version of the ".sid" file, 0
is assumed as the version number of the old version of the ".sid" is assumed as the version number of the old version of the ".sid"
file and the version number is 1 for the new ".sid" file. Apart from file and the version number is 1 for the new ".sid" file. Apart from
that, changes of SID files can also be automated using the same that, changes of ".sid" files can also be automated using the same
method described above, only unassigned YANG items are processed at method described above, only unassigned YANG items are processed at
step #3. Already existing items in the SID file should not be given step #3. Already existing items in the ".sid" file should not be
new SIDs. given new SIDs.
Note that ".sid" file versions are specific to a YANG module Note that ".sid" file versions are specific to a YANG module
revision. For each new YANG module or each new revision of an revision. For each new YANG module or each new revision of an
existing YANG module, the version number of the initial ".sid" file existing YANG module, the version number of the initial ".sid" file
should either be 0 or should not be present. should either be 0 or should not be present.
Note also that RPC or action "input" and "output" data nodes MUST Note also that RPC or action "input" and "output" data nodes MUST
always be assigned SID even if they don't contain data nodes. The always be assigned SID even if they don't contain data nodes. The
reason for this requirement is that other modules can augment the reason for this requirement is that other modules can augment the
given module and those SIDs might be necessary. given module and those SIDs might be necessary.
Appendix C. ".sid" file lifecycle Appendix C. ".sid" file lifecycle
Before assigning SIDs to their YANG modules, YANG module authors must Before assigning SIDs to their YANG modules, YANG module authors must
acquire a SID range from a "SID Range Registry". If the YANG module acquire a SID range from a "SID Range Registry". If the YANG module
is part of an IETF draft or RFC, the SID range need to be acquired is part of an IETF draft or RFC, the SID range need to be acquired
from the "IETF SID Range Registry" as defined in Section 6.3. For from the "IETF SID Range Registry" as defined in Section 6.4. For
the other YANG modules, the authors can acquire a SID range from any the other YANG modules, the authors can acquire a SID range from any
"SID Range Registry" of their choice. "SID Range Registry" of their choice.
Once the SID range is acquired, the owner can use it to generate Once the SID range is acquired, the owner can use it to generate
".sid" file/s for his YANG module/s. It is recommended to leave some ".sid" file/s for his YANG module/s. It is recommended to leave some
unallocated SIDs following the allocated range in each ".sid" file in unallocated SIDs following the allocated range in each ".sid" file in
order to allow better evolution of the YANG module in the future. order to allow better evolution of the YANG module in the future.
Generation of ".sid" files should be performed using an automated Generation of ".sid" files should be performed using an automated
tool. Note that ".sid" files can only be generated for YANG modules tool. Note that ".sid" files can only be generated for YANG modules
and not for submodules. and not for submodules.
C.1. SID File Creation C.1. ".sid" File Creation
The following activity diagram summarizes the creation of a YANG The following activity diagram summarizes the creation of a YANG
module and its associated ".sid" file. module and its associated ".sid" file.
+---------------+ +---------------+
O | Creation of a | O | Creation of a |
-|- ->| YANG module | -|- ->| YANG module |
/ \ +---------------+ / \ +---------------+
| |
V V
skipping to change at page 33, line 4 skipping to change at page 34, line 15
\----------/ \----------/
| no | no
V V
/-------------\ /-------------\ /-------------\ /-------------\
/ RFC \ no / Open \ no / RFC \ no / Open \ no
\ publication? /---->\ specification?/---+ \ publication? /---->\ specification?/---+
\-------------/ \-------------/ | \-------------/ \-------------/ |
| yes | yes | | yes | yes |
| +---------------+ | | +---------------+ |
V V V V V V
+---------------+ +---------------+ +---------------+ +---------------+
| IANA | | Third party | | IANA | | Third party |
| registration | | registration | | registration | | registration |
+-------+-------+ +-------+-------+ +-------+-------+ +-------+-------+
| | | |
+---------------------------------+ +---------------------------------+
V V
[DONE] [DONE]
Figure 1: SID Lifecycle Figure 1: SID Lifecycle
C.2. SID File Update C.2. ".sid" File Update
The following Activity diagram summarizes the update of a YANG module The following Activity diagram summarizes the update of a YANG module
and its associated ".sid" file. and its associated ".sid" file.
+---------------+ +---------------+
O | Update of the | O | Update of the |
-|- ->| YANG module | -|- ->| YANG module |
/ \ | or include(s) | / \ | or include(s) |
| or import(s) | | or import(s) |
+---------------+ +---------------+
skipping to change at page 34, line 43 skipping to change at page 35, line 43
| V | V
| /-------------\ +---------------+ | /-------------\ +---------------+
| / Publicly \ yes | YANG module | | / Publicly \ yes | YANG module |
| \ available ? /---->| registration | | \ available ? /---->| registration |
| \-------------/ +---------------+ | \-------------/ +---------------+
| | no | | | no |
+--------------+---------------------+ +--------------+---------------------+
| |
[DONE] [DONE]
Figure 2: YANG and SID file update Figure 2: YANG and ".sid" file update
Authors' Addresses Authors' Addresses
Michel Veillette (editor) Michel Veillette (editor)
Trilliant Networks Inc. Trilliant Networks Inc.
610 Rue du Luxembourg 610 Rue du Luxembourg
Granby, Quebec J2J 2V2 Granby, Quebec J2J 2V2
Canada Canada
Phone: +14503750556 Phone: +14503750556
Email: michel.veillette@trilliant.com Email: michel.veillette@trilliant.com
 End of changes. 74 change blocks. 
173 lines changed or deleted 229 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/