YANG Versioning Solution Overview
draft-verdt-netmod-yang-solutions-01

Document Type Active Internet-Draft (individual)
Last updated 2019-07-03
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf htmlized 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, Ed.
Internet-Draft                                       Cisco Systems, Inc.
Intended status: Informational                              July 3, 2019
Expires: January 4, 2020

                   YANG Versioning Solution Overview
                  draft-verdt-netmod-yang-solutions-01

Abstract

   This temporary document gives a brief overview of the different
   drafts that comprise a full solution to the YANG versioning
   requirements draft.  The purpose of this draft is to help readers
   understand how the discrete parts of the YANG versioning solution fit
   together during working group development of the solution drafts.

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 January 4, 2020.

Copyright Notice

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

Wilton                   Expires January 4, 2020                [Page 1]
Internet-Draft      YANG Versioning Solution Overview          July 2019

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Summary of requirements . . . . . . . . . . . . . . . . . . .   2
   3.  Solution Drafts . . . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  Updated YANG Module Revision Handling . . . . . . . . . .   4
     3.2.  Module semantic version number scheme . . . . . . . . . .   5
     3.3.  Versioned YANG packages . . . . . . . . . . . . . . . . .   5
     3.4.  Protocol operations for package version selection . . . .   6
     3.5.  YANG schema comparison tooling  . . . . . . . . . . . . .   6
   4.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . .   7
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   7
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   8
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   8
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .   8
     7.2.  Informative References  . . . . . . . . . . . . . . . . .   8
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   9

1.  Introduction

   [I-D.ietf-netmod-yang-versioning-reqs] documents the requirements for
   any solution to the YANG versioning problem.  Chapter 5 lists the
   formal requirements that a complete solution requires.

   The aim of this draft is to help readers understand how the different
   solution drafts fit together, and also which drafts contribute
   solutions to particular individual requirements.  The overall
   solution comprises five individual drafts:

   1.  [I-D.verdt-netmod-yang-module-versioning]

   2.  Module semantic version number scheme (not yet published)

   3.  [I-D.rwilton-netmod-yang-packages]

   4.  [I-D.wilton-netmod-yang-ver-selection]

   5.  YANG schema comparison tooling (not yet published)

   Open issues, across all of the solution drafts are tracked at
   <https://github.com/netmod-wg/yang-ver-dt/issues>.

2.  Summary of requirements

   The requirements are formally documented in section 5 of
   [I-D.ietf-netmod-yang-versioning-reqs].  A shortened, non normative,
   summary of each of the requirements (using the same requirement

Wilton                   Expires January 4, 2020                [Page 2]
Internet-Draft      YANG Versioning Solution Overview          July 2019

   numbers) is provided below to help understand how the solutions
   drafts address the particular requirements.

      Req 1.1 - MUST allow nbc updates to a module without breaking
      imports.

      Req 1.2 - MUST allow nbc updates to a module without affecting
      existing client code using only unchanged data nodes.

      Req 1.3 - MUST support import statement restricted to only some
Show full document text