YANG Schema Comparison
draft-verdt-netmod-yang-schema-comparison-00

Document Type Active Internet-Draft (individual)
Last updated 2019-11-16
Stream (None)
Intended RFC status (None)
Formats plain text pdf htmlized bibtex
Yang Validation 0 errors, 0 warnings.
Additional URLs
- Yang catalog entry for ietf-yang-rev-annotations@2019-11-11.yang
- Yang impact analysis for draft-verdt-netmod-yang-schema-comparison
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: Standards Track                       November 16, 2019
Expires: May 19, 2020

                         YANG Schema Comparison
              draft-verdt-netmod-yang-schema-comparison-00

Abstract

   This document specifies an algorithm for comparing two revisions of a
   YANG schema to determine the scope of changes, and a list of changes,
   between the revisions.  The output of the algorithm can be used to
   help select an appropriate revision-label or YANG semantic version
   number for a new revision.  This document defines a YANG extension
   that provides YANG annotations to help the tool accurately determine
   the scope of changes between two revisions.

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 May 19, 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

Wilton                    Expires May 19, 2020                  [Page 1]
Internet-Draft           YANG Schema Comparison            November 2019

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology and Conventions . . . . . . . . . . . . . . . . .   4
   3.  Generic YANG schema tree comparison algorithm . . . . . . . .   4
     3.1.  YANG module revision scope extension annotations  . . . .   5
   4.  YANG module comparison algorithm  . . . . . . . . . . . . . .   5
   5.  YANG schema comparison algorithms . . . . . . . . . . . . . .   6
     5.1.  Standard YANG schema comparison algorithm . . . . . . . .   6
     5.2.  Filtered YANG schema comparison algorithm . . . . . . . .   6
   6.  Comparison tooling  . . . . . . . . . . . . . . . . . . . . .   7
   7.  Module Versioning Extension YANG Modules  . . . . . . . . . .   7
   8.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . .  10
   9.  Security Considerations . . . . . . . . . . . . . . . . . . .  11
   10. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  11
     10.1.  YANG Module Registrations  . . . . . . . . . . . . . . .  11
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  11
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  11
     11.2.  Informative References . . . . . . . . . . . . . . . . .  12
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  13

1.  Introduction

   Warning, this is an early (-00) draft with the intention of scoping
   the outline of the solution, hopefully for the WG to back the
   direction of the solution.  Refinement of the solution details is
   expected, if this approach is accepted by the WG.

   This document defines a solution to Requirement 2.2 in
   [I-D.verdt-netmod-yang-versioning-reqs].  Complementary documents
   provide a complete solution to the YANG versioning requirements, with
   the overall relationship of the solution drafts described in
   [I-D.verdt-netmod-yang-solutions].

   YANG module 'revision-labels'
   [I-D.verdt-netmod-yang-module-versioning] and the use of YANG
   semantic version numbers [I-D.verdt-netmod-yang-semver] can be used
   to help manage and report changes between revisions of individual
   YANG modules.

   YANG packages [I-D.rwilton-netmod-yang-packages] along with YANG
   semantic version numbers can be used to help manage and report
   changes between revisions of YANG schema.

Wilton                    Expires May 19, 2020                  [Page 2]
Internet-Draft           YANG Schema Comparison            November 2019

   [I-D.verdt-netmod-yang-module-versioning] and
   [I-D.rwilton-netmod-yang-packages] define how to classify changes
Show full document text