Updated YANG Module Revision Handling
draft-ietf-netmod-yang-module-versioning-11

Network Working Group                                     R. Wilton, Ed.
Internet-Draft                                       Cisco Systems, Inc.
Updates: 6020, 7950, 8407, 8525 (if approved)             R. Rahman, Ed.
Intended status: Standards Track                                 Equinix
Expires: 2 September 2024                                B. Lengyel, Ed.
                                                                Ericsson
                                                               J. Clarke
                                                     Cisco Systems, Inc.
                                                               J. Sterne
                                                                   Nokia
                                                            1 March 2024

                 Updated YANG Module Revision Handling
              draft-ietf-netmod-yang-module-versioning-11

Abstract

   This document refines the RFC 7950 module update rules.  It 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 a minimum
   revision suggestion to help document inter-module dependencies.  It
   provides guidelines for managing the lifecycle of YANG modules and
   individual schema nodes.  This document updates RFC 7950, RFC 6020,
   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 2 September 2024.

Copyright Notice

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

Wilton, et al.          Expires 2 September 2024                [Page 1]
Internet-Draft    Updated YANG Module Revision Handling       March 2024

   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 Revised BSD License text as
   described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Revised 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  . . . . . . .   6
       3.1.1.  Backwards-compatible rules  . . . . . . . . . . . . .   7
       3.1.2.  Non-backwards-compatible changes  . . . . . . . . . .   8
     3.2.  non-backwards-compatible extension statement  . . . . . .   8
     3.3.  Removing revisions from the revision history  . . . . . .   8
     3.4.  Examples for updating the YANG module revision history  .   9
   4.  Guidance for revision selection on imports  . . . . . . . . .  12
     4.1.  Recommending a minimum revision for module imports  . . .  13
       4.1.1.  Module import examples  . . . . . . . . . . . . . . .  14
   5.  New ietf-yang-status-conformance YANG module  . . . . . . . .  15
     5.1.  Reporting how deprecated and obsolete nodes are
           handled . . . . . . . . . . . . . . . . . . . . . . . . .  15
   6.  Guidelines for using the YANG module update rules . . . . . .  16
     6.1.  Guidelines for YANG module authors  . . . . . . . . . . .  16
       6.1.1.  Making non-backwards-compatible changes to a YANG
               module  . . . . . . . . . . . . . . . . . . . . . . .  17
     6.2.  Versioning Considerations for Clients . . . . . . . . . .  18
   7.  Module Versioning Extension YANG Modules  . . . . . . . . . .  18
   8.  Security considerations . . . . . . . . . . . . . . . . . . .  24
     8.1.  Security considerations for module revisions  . . . . . .  24
     8.2.  Security considerations for the modules defined in this
           document  . . . . . . . . . . . . . . . . . . . . . . . .  25
   9.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  25
     9.1.  YANG Module Registrations . . . . . . . . . . . . . . . .  25