<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE rfc [
  <!ENTITY nbsp    "&#160;">
  <!ENTITY zwsp   "&#8203;">
  <!ENTITY nbhy   "&#8209;">
  <!ENTITY wj     "&#8288;">
]>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
<!-- generated by https://github.com/cabo/kramdown-rfc version 1.7.29 (Ruby 3.4.4) -->
<rfc xmlns:xi="http://www.w3.org/2001/XInclude" ipr="trust200902" docName="draft-boucadair-veloce-yang-05" category="std" consensus="true" submissionType="IETF" tocInclude="true" sortRefs="true" symRefs="true" version="3">
  <!-- xml2rfc v2v3 conversion 3.30.2 -->
  <front>
    <title abbrev="VELOCE">YANG deVELpment PrOCEss &amp; maintenance (VELOCE)</title>
    <seriesInfo name="Internet-Draft" value="draft-boucadair-veloce-yang-05"/>
    <author fullname="Mohamed Boucadair">
      <organization>Orange</organization>
      <address>
        <email>mohamed.boucadair@orange.com</email>
      </address>
    </author>
    <date year="2025" month="September" day="18"/>
    <keyword>quick but well YANG modules</keyword>
    <abstract>
      <?line 28?>

<t>This document describes a YANG deVELpment PrOCEss &amp; maintenance (VELOCE) that is more suitable for the development of YANG modules or YANG modules update within the IETF.</t>
    </abstract>
    <note removeInRFC="true">
      <name>Discussion Venues</name>
      <t>Source for this draft and an issue tracker can be found at
    <eref target="https://github.com/boucadair/draft-boucadair-veloce-yang"/>.</t>
    </note>
  </front>
  <middle>
    <?line 32?>

<section anchor="introduction">
      <name>Introduction</name>
      <t>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.</t>
      <t>Guidance for writing YANG modules are discussed in <xref target="I-D.ietf-netmod-rfc8407bis"/>. Guidelines related to code components (<xref section="3.2" sectionFormat="of" target="I-D.ietf-netmod-rfc8407bis"/>) or citations to references listed in the YANG module do not apply for VELOCE.</t>
      <t>This document mainly focuses on IETF modules. Note that <xref target="I-D.ietf-netmod-rfc8407bis"/> includes provisons for IANA-maintained modules to not be included in RFCs:</t>
      <blockquote>
        <t>The authors <bcp14>MUST</bcp14> include a note to the RFC Editor requesting that the appendix be removed before publication as RFC and that RFC IIII is replaced with the RFC number that is assigned to the document. Initial versions of IANA-maintained modules that are published in RFCs may be misused despite the appropriate language to refer to the IANA registry to retrieve the up-to-date module. This is problematic for interoperability, e.g., when values are deprecated or are associated with a new meaning.</t>
      </blockquote>
    </section>
    <section anchor="conventions-and-definitions">
      <name>Conventions and Definitions</name>
      <t>The key words "<bcp14>MUST</bcp14>", "<bcp14>MUST NOT</bcp14>", "<bcp14>REQUIRED</bcp14>", "<bcp14>SHALL</bcp14>", "<bcp14>SHALL
NOT</bcp14>", "<bcp14>SHOULD</bcp14>", "<bcp14>SHOULD NOT</bcp14>", "<bcp14>RECOMMENDED</bcp14>", "<bcp14>NOT RECOMMENDED</bcp14>",
"<bcp14>MAY</bcp14>", and "<bcp14>OPTIONAL</bcp14>" in this document are to be interpreted as
described in BCP 14 <xref target="RFC2119"/> <xref target="RFC8174"/> when, and only when, they
appear in all capitals, as shown here.</t>
      <?line -18?>

</section>
    <section anchor="veloce-procedure">
      <name>VELOCE Procedure</name>
      <t>The following procedure is followed when a WG adopts a new YANG module or update to an existing YANG module:</t>
      <ul spacing="normal">
        <li>
          <t>A new repository (<xref target="sec-rep"/>) <bcp14>MUST</bcp14> be created by the WG Chairs following the procedure in <xref section="3.2" sectionFormat="of" target="RFC8874"/> to maintain the YANG Module, with the
appropriate CI/CD YANG validation in place.
          </t>
          <ul spacing="normal">
            <li>
              <t>The same procedure for managing WG documents (e.g., assign editors) applies for managing YANG modules (<xref section="6.1" sectionFormat="of" target="RFC2418"/>).</t>
            </li>
            <li>
              <t>Refer also to <xref section="3.3" sectionFormat="of" target="RFC8874"/> for considerations related to granting WG participants write and administrators right.</t>
            </li>
            <li>
              <t>Other administrative policies are defined in <xref target="RFC8875"/>.</t>
            </li>
            <li>
              <t>A release tagging mechanism should be defined to track the intermediate versions referenced by WG I-Ds and by the RFC, once published.</t>
            </li>
          </ul>
        </li>
        <li>
          <t>Contributing methods to YANG module (including issues handling and merge procedure) are similar to those defined in <xref section="4" sectionFormat="of" target="RFC8874"/>. A procedure to assessing
consensus is discussed in <xref section="7" sectionFormat="of" target="RFC8874"/>.</t>
        </li>
        <li>
          <t>The WG (WG Chairs) <bcp14>MUST</bcp14> 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" <xref target="RFC3688"/> and the YANG module in the "YANG Module Names" subregistry <xref target="RFC6020"/>
within the "YANG Parameters" registry.  </t>
          <ul empty="true">
            <li>
              <t>Unless we update these rules as well, the publication of the initial RFC is required per <xref section="14" sectionFormat="of" target="RFC6020"/>, especially the following:</t>
              <t>"There are no initial assignments.</t>
              <t>For allocation, RFC publication is required"</t>
            </li>
          </ul>
        </li>
        <li>
          <t>The YANG module <bcp14>MUST NOT</bcp14> be inserted in the document; instead a link to the above repository <bcp14>MUST</bcp14> be included.</t>
        </li>
        <li>
          <t>Bis versions of the initial RFC <bcp14>MAY</bcp14> be considered to document major changes and their rationale. Such a decision is left to the WG. The RFC update is scoped to the
narrative part describing the updates. WGs may decide to  maintain an adopted YANG module in the IETF repository but never seek for an RFC publication of major module revisions.</t>
        </li>
        <li>
          <t>Bis versions of the initial RFC should be developed by the same WG which was responsible for producing the intial RFC. If the responsible WG concluded, the alternative WG should be consulted with the ADs.</t>
        </li>
        <li>
          <t>All adopted IETF modules are also mirrored in a common IETF repository.</t>
        </li>
      </ul>
    </section>
    <section anchor="sec-rep">
      <name>IETF-hosted Repository</name>
      <t>It is <bcp14>RECOMMENDED</bcp14> that IETF self-hosted repositories are used. Integration using third-party hosted repositories <bcp14>MAY</bcp14> be used for experimentation purposes.</t>
      <ul empty="true">
        <li>
          <t>DISCUSSION: Include a recommendation about the hosting. IANA or some IETF gitlab are examples of self-hosting. Example of third-part hosted facility is GitHub.</t>
        </li>
      </ul>
    </section>
    <section anchor="operational-considerations">
      <name>Operational Considerations</name>
      <t>The VELOCE approach is meant to address some of operational issues encountered using current YANG development approach within the IETF. Specification, VELOCE ambitions to:</t>
      <ul spacing="normal">
        <li>
          <t>Ease integration for operators by providing readily-available YANG code in a well-identified location.</t>
        </li>
        <li>
          <t>Encourage an iterative approach that would fit most of operators needs, rather than waiting for a "perfect" version that solves every deployment case.</t>
        </li>
        <li>
          <t>Catalyst to produce fully-validated modules in a timely manner.</t>
        </li>
        <li>
          <t>Ease reuse/leveraging by other organizations and hopefully avoid redundant efforts.</t>
        </li>
        <li>
          <t>Welcome contributors from the operators community who are more familiar with software development, not only with specification development.</t>
        </li>
      </ul>
    </section>
    <section anchor="security-considerations">
      <name>Security Considerations</name>
      <t>The same considerations discussed in <xref section="10" sectionFormat="of" target="RFC8874"/> apply here.</t>
    </section>
    <section anchor="iana-considerations">
      <name>IANA Considerations</name>
      <t>This document has no IANA actions.</t>
    </section>
  </middle>
  <back>
    <references anchor="sec-combined-references">
      <name>References</name>
      <references anchor="sec-normative-references">
        <name>Normative References</name>
        <reference anchor="I-D.ietf-netmod-rfc8407bis">
          <front>
            <title>Guidelines for Authors and Reviewers of Documents Containing YANG Data Models</title>
            <author fullname="Andy Bierman" initials="A." surname="Bierman">
              <organization>YumaWorks</organization>
            </author>
            <author fullname="Mohamed Boucadair" initials="M." surname="Boucadair">
              <organization>Orange</organization>
            </author>
            <author fullname="Qin Wu" initials="Q." surname="Wu">
              <organization>Huawei</organization>
            </author>
            <date day="5" month="June" year="2025"/>
            <abstract>
              <t>   This document provides guidelines for authors and reviewers of
   specifications containing YANG data models, including IANA-maintained
   modules.  Recommendations and procedures are defined, which are
   intended to increase interoperability and usability of Network
   Configuration Protocol (NETCONF) and RESTCONF Protocol
   implementations that utilize YANG modules.  This document obsoletes
   RFC 8407.

   Also, this document updates RFC 8126 by providing additional
   guidelines for writing the IANA considerations for RFCs that specify
   IANA-maintained modules.

              </t>
            </abstract>
          </front>
          <seriesInfo name="Internet-Draft" value="draft-ietf-netmod-rfc8407bis-28"/>
        </reference>
        <reference anchor="RFC2119">
          <front>
            <title>Key words for use in RFCs to Indicate Requirement Levels</title>
            <author fullname="S. Bradner" initials="S." surname="Bradner"/>
            <date month="March" year="1997"/>
            <abstract>
              <t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
            </abstract>
          </front>
          <seriesInfo name="BCP" value="14"/>
          <seriesInfo name="RFC" value="2119"/>
          <seriesInfo name="DOI" value="10.17487/RFC2119"/>
        </reference>
        <reference anchor="RFC8174">
          <front>
            <title>Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words</title>
            <author fullname="B. Leiba" initials="B." surname="Leiba"/>
            <date month="May" year="2017"/>
            <abstract>
              <t>RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings.</t>
            </abstract>
          </front>
          <seriesInfo name="BCP" value="14"/>
          <seriesInfo name="RFC" value="8174"/>
          <seriesInfo name="DOI" value="10.17487/RFC8174"/>
        </reference>
        <reference anchor="RFC8874">
          <front>
            <title>Working Group GitHub Usage Guidance</title>
            <author fullname="M. Thomson" initials="M." surname="Thomson"/>
            <author fullname="B. Stark" initials="B." surname="Stark"/>
            <date month="August" year="2020"/>
            <abstract>
              <t>This document provides a set of guidelines for working groups that choose to use GitHub for their work.</t>
            </abstract>
          </front>
          <seriesInfo name="RFC" value="8874"/>
          <seriesInfo name="DOI" value="10.17487/RFC8874"/>
        </reference>
        <reference anchor="RFC2418">
          <front>
            <title>IETF Working Group Guidelines and Procedures</title>
            <author fullname="S. Bradner" initials="S." surname="Bradner"/>
            <date month="September" year="1998"/>
            <abstract>
              <t>This document describes the guidelines and procedures for formation and operation of IETF working groups. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
            </abstract>
          </front>
          <seriesInfo name="BCP" value="25"/>
          <seriesInfo name="RFC" value="2418"/>
          <seriesInfo name="DOI" value="10.17487/RFC2418"/>
        </reference>
        <reference anchor="RFC8875">
          <front>
            <title>Working Group GitHub Administration</title>
            <author fullname="A. Cooper" initials="A." surname="Cooper"/>
            <author fullname="P. Hoffman" initials="P." surname="Hoffman"/>
            <date month="August" year="2020"/>
            <abstract>
              <t>The use of GitHub in IETF working group processes is increasing. This document describes uses and conventions for working groups that are considering starting to use GitHub. It does not mandate any processes and does not require changes to the processes used by current and future working groups not using GitHub.</t>
            </abstract>
          </front>
          <seriesInfo name="RFC" value="8875"/>
          <seriesInfo name="DOI" value="10.17487/RFC8875"/>
        </reference>
        <reference anchor="RFC6020">
          <front>
            <title>YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)</title>
            <author fullname="M. Bjorklund" initials="M." role="editor" surname="Bjorklund"/>
            <date month="October" year="2010"/>
            <abstract>
              <t>YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS-TRACK]</t>
            </abstract>
          </front>
          <seriesInfo name="RFC" value="6020"/>
          <seriesInfo name="DOI" value="10.17487/RFC6020"/>
        </reference>
      </references>
      <references anchor="sec-informative-references">
        <name>Informative References</name>
        <reference anchor="RFC3688">
          <front>
            <title>The IETF XML Registry</title>
            <author fullname="M. Mealling" initials="M." surname="Mealling"/>
            <date month="January" year="2004"/>
            <abstract>
              <t>This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas.</t>
            </abstract>
          </front>
          <seriesInfo name="BCP" value="81"/>
          <seriesInfo name="RFC" value="3688"/>
          <seriesInfo name="DOI" value="10.17487/RFC3688"/>
        </reference>
      </references>
    </references>
    <?line 119?>

<section numbered="false" anchor="acknowledgments">
      <name>Acknowledgments</name>
      <t>This draft is triggered by the discussion in NEMOPS IAB workshop.</t>
      <t>Thanks to Kristian Larsson, Italo Busi, Michael Richardson, and Qin Wu for the comments.</t>
    </section>
  </back>
  <!-- ##markdown-source:
H4sIAAAAAAAAA5VY63LbuBX+z6dAlZlOsisqceJNXHWb1LEdR1Pf1pemmU5/
gCQoYU0SXICUonr8Ln2WPtl+54CgKCW702Zm1yJIHJzrd76DOI6jRjeFmorR
58OLU5Gpv5+c1aWqGnFlL49OnBN/FKXUVaMqWaVKPMV7rD8bRTJJrFpio18Z
Rals1NzY9VS4JouizKSVLCE5szJv4sS0qcyktvFSFSZV8VpW8/jFD5Frk1I7
p03VrGt8Pju5/RBVbZkoO40yyJxGqamcqlzrpqKxrYpw6qvoiZBWyam4vLrB
75Wx93Nr2noqvD7RvVpjMZtGIha/tDq9F0nbiJUqCsGmliZrC+WiSLbNwlj6
LhL4l7dF4RU/Nwv8zcT7oDq/N3YuK/1v2UBjnG5hhuIXCn4qppDLuya9wX81
/M0kNWUUVcaW2LqEVZGu8sFTFMexkIlrrEybKLpdaCfgw5aDkSmXWp0oJ6T4
/wIlmoVsBGSVxirhWt3IpFACJ+ONghwKhxdk8i3PwNLt57amcIiVbha64t0U
q4nXvNRZVqgIoZhVjcWOlBwURdcfjhxFSlSm4ePhUDo8mKaruZBV5nXHf/Q8
PHUiPpoVlLRjocu6ULRHWfd8qarMWC+6MOae9pFcq3JlFXkAAlThWLhr81yn
GluLNbKTPdC9bozfgh8TcWu8u6Qux/g1jEBtTW0cB6BSKyFrLMh08ZUt5JLY
6wZLtyyJotNWZxwd2rWyutm1ls3JtEtbR9vh5oeHP8zi44lWTR5XqsF3sc3T
g/0XbxLtHh8ngmSqQlfYbFUhyb+wKYV1+F9ZmwqKOfH04eFGcUjEq8lLCvXv
in1GwU+RK7Rj4yTyqxOFdo1XjnJgoD4cwWGGc+BnstEn4WQ3nSnY/AXspESr
2G2bkF8Y5BlH4uHh99SEDmnRojgoPEvtSFc6dnZ4cRiHjIKqwbuN1y9RYSNb
QSmKAnyYAidw8GP0VohbWOaBwYnzu5vbsIHCz8oZNh5bxUmmG068X1rlOKKs
Ob2GI5AK+gudaFVpljgwUTlVYt0mhU7Zv0I6FkSZylvpYYZ/VLZW1YVMsY/K
rj/T42Nf2xL4Oa985LmqO0dPUIxIMlkIFJDjUCLyv+kdTv2gm1tsvIOArckG
AHVLeQmP15pDpHwl1FYTNBQAulbO1bCqPFDgSKzMkTl27d82VqOs+W1bx42J
GVy8LqhEyhfNcUWxEkimHFkCOBynrEx0oZv1WKjJfDIWq4WqxFIWbaghVVuV
cjVgF63ARybVvMKu9HVcKkmQMyHgOjLVkqqY3ESxOFa5JvfhmRJYCbQUajSZ
EyPKidHY/xUXl/z7+uSnu9n1yTH9vvl4eHbW/4i6L24+Xt6dHW9+bXYeXZ6f
n1wc+81YFVtL0ej88DPekFajy6vb2eXF4dnIV+CwrshOOJfzG36CC8hc6aLQ
Pzii74+u/vufvX2CFgT35d7en1BJ/uFg780+Hsib/jRDdeofEal1RBktKQxC
opGmEmkgCzemFHYLs6rEAigBb373T/LMv6bixySt9/bfdgtk8NZi8NnWIvvs
65WvNnsnfmPpG8f03txa3/H0tr6Hn7eeg98Hiz++I+AV8d7Bu7cRpZDHO7Rk
MJystcrnTW6KwqwIGerwgnLbL1M+UvJK8elUyMzUTegxQ2RFEnftF/GVlVBf
tNvtHsCw78QhbwVqGEewtCbkdyqNsUKwzkFAfqTgTpQbyZorEEcfLcBV3EBX
Wh/oS61ot4VQxhxwxkCrgCibrnDOao176AJNGqLF0ez50bH/EpWLzsiyIYAR
b0Kk6nsGYgdCNVCFcKCUlZyTltA8pD+6nAcDD4dCMTC7Z9yPtHLbG7fa7qA9
vp7sBdte7u8dwGmdJtcMaMh2Q9YOnfFqxxl0DnFWNGbbddBBa56DDjad6rW0
QDZdS9KeCIHiqpNZCeQhKkgGCKvni6bT4hJ+tMMPwB5FbQqiNwH6coZ1Tx68
Vj+AKfj9BMOFkg6JJOfsiFKlC4CgK6mC24I6VC+D4Bt89J5jypgCasvB6xtK
Tww4mWATGrbHzy63oMEYOJIO+soEiQq0RQsAJ/c6oNVm3KCHWf/Ud136AiMC
YTs0zYqeMyo7HyTGMzbf6VIXsus8YGzb/ghB298O2QR+2SQYlRj4F7KomsNr
/fhBRbtDzoK8NzvyYOCtr6unfW111eeUumcAFY0uFeAVKVlRTPNGeVLOKEBS
IXOXYgXiPuQP+Exyo/YtfDMs+Kh5BhCAJPmZVF4qjtGYxwLYCG5tbCOJII+7
Ro0As4C761ngeqPKjUCmk76TD2aBEVO4f5yfoVD82xH88w5avXp9gDLq6M22
NWHvAC7EBap95xgv5/WLly8eH6Hs8FTeeSUtNpHGo55loAnRVCbeirsKJY7y
Uj2ELhTywnrC7XgmHH/LqUP3kXeZjmGWtIg+KMgg/Ht9PnklQUtcrUA3isIX
QQ+r006roJwY3VLL7Eak/jgPYYxqk90d4gNRGsjzmo5Zt6HqAz1HUZeJQ6+H
TuyJglN2QOcDmP6Z3jRKAoxA+Kv7wORkAhY77C+howRGTan/HhoMGeeuI9Fa
uQl1GOmBZjAd/EwAuqCp2YW00WDYbJ0kenjTpsTgMrjYdRYXKm+Ckp9OJ2w0
ndXFHF+4FMQxcGR4s5I24CdgOJRNaH1+H4aRT6ee/9JhGYPDptWh7LhYt0c9
MRiPh66iC4iKZlmPAVTKXd3uJJ73QCfMqiUb6f4Xzw4hnCf7TY/nLgowWi00
nLeSlCSuphCEC4Ga5/bgAJjYScUY4U8aboAkxM/H3FePLFCBlfco3m5UoTi3
RTMcYg6P2ZxDkMjgwOEI6Bk7tdpSW2usz09JE20ZpsWNY5m98+ANwCdR1xuf
PzwJ7CeKZjwsDfiex0uW5lSRh+295NBSaeihWapRc5+EWPFu0jaLKXvW4lt7
uzznmYkcrL4ANjQluZdSt5YvFWDAW3E8uzm6u7kBx5ziqDBtYoqBzZgiu1Ex
Ma2fLek8mlz8bAXhzpRdys11U8iENVdfJN2acK70JvK2E//GJ1EwI1iRy5TH
K/LXqW4+tgn7+LJWoQipfw8Ijie6Hf3tL0fo2gkDFtelzDJLMMxq4lAzkNU1
d7AI0xLJgAbewWlrLUFCd+e1uavqj9i9jRI3hLu5DtgYVCoTHe4ymCefEAXS
g4hSfLxORLlQM3ylwNwDXDnTxTqWSwlqQcnP+vAdC6cldZAYzkDF5BrKB2im
FD8hoywNxah1ELwOcnoDOAVXXCq5BvghABv3kCqVUhkmLDwt/MhfoXj91REj
iBjh0xyNaBSQwct0pqAuT3hD4FUXZs2uS2E5EzCJ0W3tODi+8hVffq7jjo0P
rga+piuT4EOrkN7PCzrGE2u4zrCqw5tSj+MLWMVHCLk0moola5HZUErlsKVh
TPikipRyJA0EkZyQW1NykDd+obpoK0rS1cJwsvMVZy7B/zQIIGONM3mz8qy4
T54xXwL5yZa/GWbM8EPOebT41tIp30p4xtQdqv8bDHHvxc6U4G/Junn5iS/j
r88YjvcLYDY4An8pWarrbl8TcHQScpjeV2ZVqGzO1CF6mPqbIpX9ZZQDT9Xo
MQilW3kqUPh4PueS6/pEp383i12cnF9e3eDM93zHDlCv+TpPVvdM1/9maRBF
Tp5J6xxV3AxpZcR7FPBYnKPVSIUmQn9txu8pEX6C5E9tT2Y9xFH4fwVHe264
khgAAA==

-->

</rfc>
