| Internet-Draft | Procedure for YANG SID Allocation | November 2024 |
| Pelov | Expires 9 May 2025 | [Page] |
This document defines a standardized procedure for the allocation of YANG SID Ranges (YANG Schema Item iDentifier ranges) and the subsequent assignment of SIDs for IETF RFCs with YANG files.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 9 May 2025.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document defines a standardized procedure for the allocation of YANG SID Ranges (YANG Schema Item iDentifier ranges) and the subsequent assignment of SIDs for IETF RFCs with YANG files.¶
In the vast majority of cases this is a straightforward process which can be fully automated. However, as YANG SIDs are immutable, this document provides a formal procedure to follow to make sure that the WG that has created the YANG file would have the chance to review the proposed SID allocation.¶
The process involves collaboration among authors, working group (WG) chairs, and WG members to agree on SID ranges, request allocations from IANA, propose and review SID files, and validate these files through WG consensus. Once validated, the SID files are submitted to IANA for publication, ensuring a coordinated and transparent approach to SID management within the IETF framework.¶
This is an outline of the procedure.¶
+-------------------------------------------------------------+
| Procedure Overview |
+-------------------------------------------------------------+
| |
| Step 0: Agreement on SID Range |
| - Authors, Chairs, WG discuss and agree on SID range |
| - Validate range via ML discussion and interim meeting |
| |
+----------------------------+--------------------------------+
|
v
<Wait for WG consensus>
|
v
+----------------------------+--------------------------------+
| |
| Step 1: Request SID Range Allocation from IANA |
| - Authors request allocation from IETF YANG SID Range |
| registry |
| - Continue WG process while awaiting IANA allocation |
| |
+----------------------------+--------------------------------+
|
v
+----------------------------+--------------------------------+
| |
| Step 2: Propose Allocation Principles |
| - Authors propose SID allocation principles (e.g., PYANG) |
| |
+----------------------------+--------------------------------+
|
v
+----------------------------+--------------------------------+
| |
| Step 3: Propose SID Files |
| - Authors propose SID files based on allocated range |
| - Send SID files to WG mailing list for review |
| |
+----------------------------+--------------------------------+
| ^
<Wait for IANA allocation of IETF YANG SID Range> |
| |
<SID Range allocated as requested?> >---- no ---+
|
v
+----------------------------+--------------------------------+
| |
| Step 4: WGLC on SID File Allocation |
| - Chairs initiate WGLC |
| - Step 4.1: Validate PYANG allocation if no objections |
| - Step 4.2: Validate manual allocation with WG consensus |
| |
+----------------------------+--------------------------------+
|
<Wait for validation>
|
v
+----------------------------+--------------------------------+
| |
| Step 5: Submission to IANA |
| - Authors send validated SID file to IANA for publication |
| - Indicate validation by WG |
| |
+-------------------------------------------------------------+
Authors, chairs, and the WG agree on the SID range to be requested for the existing RFCs with YANG files. This can be accomplished through a discussion on the mailing list (ML) followed by a vote in an interim meeting. A simple show of hands is sufficient for validation of this range.¶
The chairs initiate a WGLC on the SID file allocation.¶
If the default SID allocation with PYANG is used and no objections are raised on the mailing list, the SID allocation is validated.¶
If a manual or non-PYANG allocation is used, there must be rough consensus in the WG for the SID allocation to be validated.¶
Once the SID allocation is validated, the authors send the SID file to IANA for publication, indicating that the SID file has been validated by the WG.¶
The IETF documents referred to here are [RFC8724] and [I-D.ietf-core-sid].¶
No security considerations.¶
This document describes a procedure, which manages the process of requesting YANG SID Ranges and YANG SID files from IANA.¶
It may be taken in consideration by the expert reviewing the allocation requests.¶