Network Working Group                                       M. Boucadair
Internet-Draft                                                    Orange
Intended status: Informational                          12 December 2024
Expires: 15 June 2025


             YANG deVELpment PrOCEss & maintenance (VELOCE)
                     draft-boucadair-veloce-yang-02

Abstract

   This document describes a YANG deVELpment PrOCEss & maintenance
   (VELOCE) that is more suitable for the development of YANG modules
   within the IETF.

Discussion Venues

   This note is to be removed before publishing as an RFC.

   Source for this draft and an issue tracker can be found at
   https://github.com/boucadair/draft-boucadair-veloce-yang.

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



Boucadair                 Expires 15 June 2025                  [Page 1]

Internet-Draft                   VELOCE                    December 2024


   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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Conventions and Definitions . . . . . . . . . . . . . . . . .   2
   3.  VELOCE Procedure  . . . . . . . . . . . . . . . . . . . . . .   3
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   4
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   4
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   4
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   4
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   4
   Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . .   5
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   5

1.  Introduction

   RFCs are not suited for documenting and maintaining 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].  Guidelines related to code components
   (Section 3.2 of [I-D.ietf-netmod-rfc8407bis]) or citations to
   references listed in the YANG module do not apply for VELOCE.

   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.




Boucadair                 Expires 15 June 2025                  [Page 2]

Internet-Draft                   VELOCE                    December 2024


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 appropriate CI/CD YANG validation in place.

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

      -  Other administrative policies are defined in [RFC8875].

   *  Contributing methods to YANG module (including issues handling
      andd merge procedure) are similar to those defined in Section 4 of
      [RFC8874].  A procedure to assessing consensus is discussed in
      Section 7 of [RFC8874].

   *  The WG (WG Chairs) MUST seek in a timely manner after the adoption
      of the YANG module 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.

         Unless we update these rules as well, the publication of the
         initial RFC is required per Section 14 of [RFC6020], especially
         the following:

         "There are no initial assignments.

         For allocation, RFC publication is required"

   *  The YANG module MUST NOT be inserted in the document; instead a
      link to the above repository MUST be included.

   *  Bis versions of the initial RFC MAY be considered to document
      major changes and/or their rationale.  Such a decision is left to
      the WG.







Boucadair                 Expires 15 June 2025                  [Page 3]

Internet-Draft                   VELOCE                    December 2024


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

6.1.  Normative References

   [I-D.ietf-netmod-rfc8407bis]
              Bierman, A., Boucadair, M., and Q. Wu, "Guidelines for
              Authors and Reviewers of Documents Containing YANG Data
              Models", Work in Progress, Internet-Draft, draft-ietf-
              netmod-rfc8407bis-21, 13 November 2024,
              <https://datatracker.ietf.org/doc/html/draft-ietf-netmod-
              rfc8407bis-21>.

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119,
              DOI 10.17487/RFC2119, March 1997,
              <https://www.rfc-editor.org/rfc/rfc2119>.

   [RFC2418]  Bradner, S., "IETF Working Group Guidelines and
              Procedures", BCP 25, RFC 2418, DOI 10.17487/RFC2418,
              September 1998, <https://www.rfc-editor.org/rfc/rfc2418>.

   [RFC6020]  Bjorklund, M., Ed., "YANG - A Data Modeling Language for
              the Network Configuration Protocol (NETCONF)", RFC 6020,
              DOI 10.17487/RFC6020, October 2010,
              <https://www.rfc-editor.org/rfc/rfc6020>.

   [RFC8174]  Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
              2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
              May 2017, <https://www.rfc-editor.org/rfc/rfc8174>.

   [RFC8874]  Thomson, M. and B. Stark, "Working Group GitHub Usage
              Guidance", RFC 8874, DOI 10.17487/RFC8874, August 2020,
              <https://www.rfc-editor.org/rfc/rfc8874>.

   [RFC8875]  Cooper, A. and P. Hoffman, "Working Group GitHub
              Administration", RFC 8875, DOI 10.17487/RFC8875, August
              2020, <https://www.rfc-editor.org/rfc/rfc8875>.

6.2.  Informative References



Boucadair                 Expires 15 June 2025                  [Page 4]

Internet-Draft                   VELOCE                    December 2024


   [RFC3688]  Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
              DOI 10.17487/RFC3688, January 2004,
              <https://www.rfc-editor.org/rfc/rfc3688>.

Acknowledgments

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

   Thanks to Kristian Larsson for the comments.

Author's Address

   Mohamed Boucadair
   Orange
   Email: mohamed.boucadair@orange.com




































Boucadair                 Expires 15 June 2025                  [Page 5]