Skip to main content

Procedure for YANG SID Allocation
draft-pelov-sid-procedure-00

Document Type Active Internet-Draft (individual)
Author Alexander Pelov
Last updated 2024-11-05
RFC stream (None)
Intended RFC status (None)
Formats
Stream Stream state (No stream defined)
Consensus boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date (None)
Responsible AD (None)
Send notices to (None)
draft-pelov-sid-procedure-00
Network Working Group                                           A. Pelov
Internet-Draft                                            IMT Atlantique
Intended status: Informational                           5 November 2024
Expires: 9 May 2025

                   Procedure for YANG SID Allocation
                      draft-pelov-sid-procedure-00

Abstract

   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.

Status of This Memo

   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 Notice

   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.

Pelov                      Expires 9 May 2025                   [Page 1]
Internet-Draft      Procedure for YANG SID Allocation      November 2024

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Procedure . . . . . . . . . . . . . . . . . . . . . . . . . .   2
     2.1.  Agreement on SID Range  . . . . . . . . . . . . . . . . .   4
     2.2.  Authors Request SID Range Allocation from IANA  . . . . .   4
     2.3.  Authors Propose Allocation Principles . . . . . . . . . .   4
     2.4.  Authors Propose SID Files . . . . . . . . . . . . . . . .   4
     2.5.  Working Group Last Call (WGLC) on SID File Allocation . .   5
       2.5.1.  Default PYANG Allocation  . . . . . . . . . . . . . .   5
       2.5.2.  Manual/Non-PYANG Allocation . . . . . . . . . . . . .   5
     2.6.  Submission to IANA  . . . . . . . . . . . . . . . . . . .   5
   3.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   5
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   5
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   5
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   5
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   6

1.  Introduction

   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.

2.  Procedure

   This is an outline of the procedure.

Pelov                      Expires 9 May 2025                   [Page 2]
Internet-Draft      Procedure for YANG SID Allocation      November 2024

   +-------------------------------------------------------------+
   |                        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                         |

Pelov                      Expires 9 May 2025                   [Page 3]
Internet-Draft      Procedure for YANG SID Allocation      November 2024

   |   - 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                               |
   |                                                             |
   +-------------------------------------------------------------+

                            Figure 1: Procedure.

2.1.  Agreement on SID Range

   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.

2.2.  Authors Request SID Range Allocation from IANA

   Authors request the allocation of the agreed SID ranges from the IETF
   YANG SID Range registry maintained by IANA.

   *Nota*: The WG process can continue while waiting for the allocation.
   It is important to consider that IANA may allocate a different range,
   and all discussions regarding the exact SID values should be
   considered provisional.

2.3.  Authors Propose Allocation Principles

   The authors propose the principles for SID allocation.  This could
   involve a default SID allocation using PYANG, or a manual one.

2.4.  Authors Propose SID Files

   The authors of the RFCs propose SID files based on the allocated
   range and send them to the WG mailing list for review.

Pelov                      Expires 9 May 2025                   [Page 4]
Internet-Draft      Procedure for YANG SID Allocation      November 2024

2.5.  Working Group Last Call (WGLC) on SID File Allocation

   The chairs initiate a WGLC on the SID file allocation.

2.5.1.  Default PYANG Allocation

   If the default SID allocation with PYANG is used and no objections
   are raised on the mailing list, the SID allocation is validated.

2.5.2.  Manual/Non-PYANG Allocation

   If a manual or non-PYANG allocation is used, there must be rough
   consensus in the WG for the SID allocation to be validated.

2.6.  Submission to IANA

   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.

3.  References

   The IETF documents referred to here are [RFC8724] and
   [I-D.ietf-core-sid].

4.  Security Considerations

   No security considerations.

5.  IANA 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.

6.  References

6.1.  Normative References

   [I-D.ietf-core-sid]
              Veillette, M., Pelov, A., Petrov, I., Bormann, C., and M.
              Richardson, "YANG Schema Item iDentifier (YANG SID)", Work
              in Progress, Internet-Draft, draft-ietf-core-sid-24, 22
              December 2023, <https://datatracker.ietf.org/doc/html/
              draft-ietf-core-sid-24>.

Pelov                      Expires 9 May 2025                   [Page 5]
Internet-Draft      Procedure for YANG SID Allocation      November 2024

6.2.  Informative References

   [RFC8724]  Minaburo, A., Toutain, L., Gomez, C., Barthel, D., and JC.
              Zuniga, "SCHC: Generic Framework for Static Context Header
              Compression and Fragmentation", RFC 8724,
              DOI 10.17487/RFC8724, April 2020,
              <https://www.rfc-editor.org/info/rfc8724>.

Author's Address

   Alexander Pelov
   IMT Atlantique
   2bis rue de la Chataigneraie
   35536 Cesson-Sévigné
   France
   Email: alexander.pelov@imt-atlantique.fr

Pelov                      Expires 9 May 2025                   [Page 6]