YANG Versioning Potential Solutions
draft-verdt-netmod-yang-solutions-00

Document Type Active Internet-Draft (individual)
Last updated 2018-10-22
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                                          R. Wilton
Internet-Draft                                       Cisco Systems, Inc.
Intended status: Informational                          October 22, 2018
Expires: April 25, 2019

                  YANG Versioning Potential Solutions
                  draft-verdt-netmod-yang-solutions-00

Abstract

   This 'work in progress' document describes and evaluates potential
   solutions to the requirements stated in section 5 of the YANG
   versioning requirements draft.  The aim of this draft is to only
   provide a progress update to the Netmod WG concerning the YANG
   versioning design team discussions on potential solutions, and to
   hopefully provide minimally sufficient information to allow the wider
   Netmod community to provide input into the direction of the YANG
   versioning design team.

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 April 25, 2019.

Copyright Notice

   Copyright (c) 2018 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

Wilton                   Expires April 25, 2019                 [Page 1]
Internet-Draft     YANG Versioning Potential Solutions      October 2018

   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.  Terminology and Conventions . . . . . . . . . . . . . . . . .   2
   2.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Background  . . . . . . . . . . . . . . . . . . . . . . . . .   3
   4.  Summary of requirements . . . . . . . . . . . . . . . . . . .   4
   5.  Potential solutions to core YANG versioning requirements  . .   5
     5.1.  Module level 'major.minor.patch' semantic versioning  . .   6
     5.2.  Module level 'major.minor.patch(x)' modified semantic
           versioning  . . . . . . . . . . . . . . . . . . . . . . .   7
     5.3.  Module level 'release.major.minor.patch' partial semantic
           versioning  . . . . . . . . . . . . . . . . . . . . . . .   9
     5.4.  A tool based approach comparing YANG schema modules/trees  10
     5.5.  Follow existing RFC 7950 rules  . . . . . . . . . . . . .  11
   6.  Solutions to related YANG versioning issues . . . . . . . . .  12
   7.  Open Questions  . . . . . . . . . . . . . . . . . . . . . . .  12
     7.1.  Is YANG module revision date preserved? . . . . . . . . .  13
     7.2.  Do YANG update rules allow for bug fixes? . . . . . . . .  13
     7.3.  Does one size fit all?  . . . . . . . . . . . . . . . . .  13
     7.4.  Should vendors we allowed to version YANG modules as part
           of a release train? . . . . . . . . . . . . . . . . . . .  13
     7.5.  How should versioning apply to submodules?  . . . . . . .  14
     7.6.  Is having a patch version number useful for YANG modules?  14
   8.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . .  14
   9.  Security Considerations . . . . . . . . . . . . . . . . . . .  15
   10. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  15
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  15
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  15
     11.2.  Informative References . . . . . . . . . . . . . . . . .  15
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  15

1.  Terminology and Conventions

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in [RFC2119].

   This document also makes use of the terminology introduced in the
   YANG versioning requirements draft (REF REQUIRED).  In addition, this
   document introduces the following terminology:

   o  bc: Used as an abbreviation for a backwards-compatible change.

Wilton                   Expires April 25, 2019                 [Page 2]
Show full document text