]> Cisco Systems

per.ietf@ionio.se

OPS Area NETMOD Working Group This document presents YANG module file name convention. The convention extends the current YANG module file name using revision‑date, with the YANG semantic version extension. The YANG semantic version extension allows for an informative version to be associated with a particular YANG module revision. Editorial note (To be removed by the RFC Editor) In the YANG module versionining work it was previously defined in that file names could use the revision label (YANG Semantic version extension) instead of the revision date, which is standardized in . This work was removed in an attempt to progress the module versioning work, but the YANG versioning design team was tasked to address it by the NETMOD WG. This draft extends YANG module file names conformity with the possibility to use revision label instead of revision date.

Introduction This document defines the YANG module file convention. It extends the current convention defined in , which uses revision-date, with the YANG semantic version extension defined in .

Motivation The motivation for using YANG semantic version instead of revision date is that it carries information to the user. A revision date only tells the user that it has been updated, while, for instance, a YANG Semver version can tell the user about the modules compatibility level at a glance. Having this information available as early as possible, i.e. in the module file name, makes it possible to quickly identify the module revision; compared to searching in the file contents and checking the revisions. Having the YANG semantic version visible in the file name will make it easier to handle large sets of YANG modules. The YANG module file name schema described in this draft is already deployed in the industry. Now is the time to standardize before several proprietary solutions emerges. It is relatively easy to update tooling to handle YANG semantic version in the YANG module file name according to this draft. However, it is recognized that the migration of all tooling within the industry will take time.

Module file names This section updates , , and . If a revision has an associated YANG semantic version (ys:version) then it is RECOMMENDED that the YANG semantic version is used instead of the revision date in the file name of a YANG file, where it takes the form: E.g., acme-router-module@2024-05-15.yang or acme-router-module#2.0.3.yang. YANG module (or submodule) files MAY be identified using either revision-date or YANG semantic version (ys:version). Typically, only one file name SHOULD exist for the same module (or submodule) revision. Two file names, one with the revision date and another with the YANG semantic version, MAY exist for the same module (or submodule) revision, e.g., when migrating from one scheme to the other.

Coexistence with YANG Semver As can be seen above, all valid identifiers for YANG semantic version are valid in the filename as well. The following example is a valid YANG module file name One consequence of this is that there might exist two child modules of version 2.0.0 with the same X.Y.Z digits (2.0.1) but different version labels:

Security Considerations There are no security considerations for this draft.

References Normative References 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. 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] YANG is a data modeling language used to model configuration data, state data, Remote Procedure Calls, and notifications for network management protocols. This document describes the syntax and semantics of version 1.1 of the YANG language. YANG version 1.1 is a maintenance release of the YANG language, addressing ambiguities and defects in the original specification. There are a small number of backward incompatibilities from YANG version 1. This document also specifies the YANG mappings to the Network Configuration Protocol (NETCONF). This memo provides guidelines for authors and reviewers of specifications containing YANG 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 6087. 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. Informative References