YANG deVELpment PrOCEss & maintenance (VELOCE)

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 June 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.¶

Table of Contents

1. Introduction

RFCs are not be suited for documenting YANG modules. However, implementers/vendors are looking for reference models and sufficiently stable models to refer to. To that aim, this document proposes a new approach for documenting IETF-endorsed YANG modules.¶

Guidance for writing YANG modules are discussed in [I-D.ietf-netmod-rfc8407bis]. All these guidelines apply expect those related to narrative text.¶

This document mainly focuses on IETF modules. Note that [I-D.ietf-netmod-rfc8407bis] includes provisons for IANA-maintained modules to not be included in RFCs:¶

Designers of IANA-maintained modules MAY supply the full initial version of the module in a specification document that registers the module or only a script to be used (including by IANA) for generating the module (e.g., an XSLT stylesheet as in Appendix A of [RFC9108]).¶

2. Conventions and Definitions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶

3. VELOCE Procedure

The following procedure is followed when a WG adopts a YANG module:¶

• A new repository MUST be created by the WG Chairs following the procedure in Section 3.2 of [RFC8874] to maintain the YANG Module, with the apprpriate CI/CD YANG validation in place. Other administrative polices are defined in [RFC8875]. The same procedure for managing WG documents (e.g., assign editors) applies for managing YANG modules (Section 6.1 of [RFC2418]). Refer also to Section 3.3 of [RFC8874] for considerations related to granting WG participants write and administrators right.¶

• Contributing methods to YANG module (including issues handling andd merge procedure) are similar to those defined in Section 4 of [RFC8874].¶

• The WG Chairs MUST seek in a timely manner after the adoption of the document for the publication of an RFC that describes the initial module objectives and, more importantly, registers the URI in the "ns" subregistry within the "IETF XML Registry" [RFC3688] and the YANG module in the "YANG Module Names" subregistry [RFC6020] within the "YANG Parameters" registry.¶

• The YANG module MUST NOT be inserted in the document; instead a link to the Github repository MUST be included.¶

• Bis versions of the initial RFC MAY be considered to document major changes or their rationale. Such a decision is left to the WG Chairs.¶

4. Security Considerations

The same considerations discussed in Section 10 of [RFC8874] apply here.¶

5. IANA Considerations

This document has no IANA actions.¶

6. References

Acknowledgments

This draft is triggered by the discussion in NEMOPS IAB workshop.¶

Author's Address