YANG Semantic Versioning for Modules
draft-verdt-netmod-yang-semver-00

Document Type Active Internet-Draft (individual)
Last updated 2019-03-13 (latest revision 2019-03-11)
Replaces draft-clacla-netmod-yang-model-update
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                          B. Claise
Internet-Draft                                                 J. Clarke
Updates: 7950 (if approved)                                    R. Rahman
Intended status: Standards Track                          R. Wilton, Ed.
Expires: September 12, 2019                          Cisco Systems, Inc.
                                                              B. Lengyel
                                                                Ericsson
                                                               J. Sterne
                                                                   Nokia
                                                              K. D'Souza
                                                                    AT&T
                                                          March 11, 2019

                  YANG Semantic Versioning for Modules
                   draft-verdt-netmod-yang-semver-00

Abstract

   This document specifies a new YANG module update procedure using
   semantic version numbers, to allow for limited non-backwards-
   compatible changes, as an alternative proposal to module update rules
   in the YANG 1.1 specifications.  This document updates RFC 7950, RFC
   8407 and RFC 8525.

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 September 12, 2019.

Copyright Notice

   Copyright (c) 2019 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Claise, et al.         Expires September 12, 2019               [Page 1]
Internet-Draft           YANG Module Versioning               March 2019

   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 Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Updates to YANG RFCs  . . . . . . . . . . . . . . . . . .   4
       1.1.1.  Updates to RFC7950  . . . . . . . . . . . . . . . . .   4
       1.1.2.  Updates to RFC8525  . . . . . . . . . . . . . . . . .   4
       1.1.3.  Updates to RFC8407  . . . . . . . . . . . . . . . . .   5
     1.2.  Complementary solutions for the other requirements  . . .   5
   2.  YANG Semantic Versioning  . . . . . . . . . . . . . . . . . .   6
     2.1.  Classification of changes between module revisions  . . .   6
     2.2.  YANG Semantic Versioning Scheme for Modules . . . . . . .   7
       2.2.1.  Examples for YANG semantic version numbers  . . . . .   8
     2.3.  YANG Semantic Version Update Rules  . . . . . . . . . . .  10
     2.4.  YANG Module Semver Extension  . . . . . . . . . . . . . .  11
   3.  Import by Semantic Version  . . . . . . . . . . . . . . . . .  13
     3.1.  Module import examples  . . . . . . . . . . . . . . . . .  15
   4.  Classifying changes in YANG modules . . . . . . . . . . . . .  16
     4.1.  Editorial changes . . . . . . . . . . . . . . . . . . . .  16
     4.2.  Backwards-compatible changes  . . . . . . . . . . . . . .  16
     4.3.  Non-backwards-compatible changes  . . . . . . . . . . . .  17
   5.  Updates to ietf-yang-library  . . . . . . . . . . . . . . . .  17
     5.1.  Advertising module version number . . . . . . . . . . . .  17
     5.2.  Resolving ambiguous module imports  . . . . . . . . . . .  17
     5.3.  Reporting how deprecated and obsolete nodes are handled .  18
   6.  YANG status description extension . . . . . . . . . . . . . .  19
   7.  Semantic versioning of YANG instance data . . . . . . . . . .  19
   8.  Guidelines  . . . . . . . . . . . . . . . . . . . . . . . . .  20
     8.1.  Guidelines to YANG model authors  . . . . . . . . . . . .  20
       8.1.1.  Use of YANG semantic versioning . . . . . . . . . . .  20
       8.1.2.  Making non-backwards-compatible changes to a YANG
               module  . . . . . . . . . . . . . . . . . . . . . . .  21
Show full document text