Updated YANG Module Revision Handling
draft-verdt-netmod-yang-module-versioning-01

Document Type Active Internet-Draft (individual)
Last updated 2019-10-15
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                                          B. Claise
Internet-Draft                                                 J. Clarke
Updates: 7950 (if approved)                                    R. Rahman
Intended status: Standards Track                          R. Wilton, Ed.
Expires: April 17, 2020                              Cisco Systems, Inc.
                                                              B. Lengyel
                                                                Ericsson
                                                               J. Sterne
                                                                   Nokia
                                                              K. D'Souza
                                                                    AT&T
                                                        October 15, 2019

                 Updated YANG Module Revision Handling
              draft-verdt-netmod-yang-module-versioning-01

Abstract

   This document specifies a new YANG module update procedure that can
   document when non-backwards-compatible changes have occurred during
   the evolution of a YANG module.  It extends the YANG import statement
   with an earliest revision filter to better represent inter-module
   dependencies.  It provides help and guidelines for managing the
   lifecycle of YANG modules and individual schema nodes.  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 April 17, 2020.

Claise, et al.           Expires April 17, 2020                 [Page 1]
Internet-Draft    Updated YANG Module Revision Handling     October 2019

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.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Updates to YANG RFCs  . . . . . . . . . . . . . . . . . .   4
   2.  Terminology and Conventions . . . . . . . . . . . . . . . . .   4
   3.  Refinements to YANG revision handling . . . . . . . . . . . .   5
     3.1.  Updating a YANG module with a new revision  . . . . . . .   5
       3.1.1.  Backwards-compatible changes  . . . . . . . . . . . .   5
       3.1.2.  Non-backwards-compatible changes  . . . . . . . . . .   6
     3.2.  nbc-changes revision extension statement  . . . . . . . .   6
     3.3.  Revision label  . . . . . . . . . . . . . . . . . . . . .   6
     3.4.  YANG status description extension statement . . . . . . .   7
     3.5.  Examples for updating the YANG module revision history  .   7
   4.  Import by derived revision  . . . . . . . . . . . . . . . . .  10
     4.1.  Module import examples  . . . . . . . . . . . . . . . . .  11
   5.  Updates to ietf-yang-library  . . . . . . . . . . . . . . . .  13
     5.1.  Resolving ambiguous module imports  . . . . . . . . . . .  13
     5.2.  YANG library versioning augmentations . . . . . . . . . .  14
       5.2.1.  Advertising revision-label  . . . . . . . . . . . . .  14
       5.2.2.  Reporting how deprecated and obsolete nodes are
               handled . . . . . . . . . . . . . . . . . . . . . . .  14
   6.  Versioning of YANG instance data  . . . . . . . . . . . . . .  15
   7.  Guidelines for using the YANG module update rules . . . . . .  15
     7.1.  Guidelines for YANG module authors  . . . . . . . . . . .  15
       7.1.1.  Making non-backwards-compatible changes to a YANG
               module  . . . . . . . . . . . . . . . . . . . . . . .  16
     7.2.  Versioning Considerations for Clients . . . . . . . . . .  17
   8.  Module Versioning Extension YANG Modules  . . . . . . . . . .  18
   9.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . .  25
Show full document text