A YANG Data Model for module revision management
draft-wang-netmod-module-revision-management-01

Document Type Active Internet-Draft (individual)
Last updated 2018-09-19
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)
NETMOD Working Group                                             M. Wang
Internet-Draft                                                     Q. Wu
Intended status: Standards Track                                  Huawei
Expires: March 22, 2019                                          A. Wang
                                                           China Telecom
                                                      September 18, 2018

            A YANG Data Model for module revision management
            draft-wang-netmod-module-revision-management-01

Abstract

   This document defines a YANG Data Model for module revision change
   management.  It is intended this model be used by vendors who support
   multiple revisions of the same YANG module in their systems but
   implement only one revision of a module.  In addition, this document
   introduces a new generic mechanism based on RPC, denoted as module-
   revision-change, that allow datanode backwards compatibility
   detection and provide a report on change type and change details of a
   YANG module with two or multiple revisions that is defined in design
   time., e.g.,identifies a place in the node hierarchy where data node
   gets changed or new data gets inserted and indicate whether the
   change to the data node is backward compatible.

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 March 22, 2019.

Copyright Notice

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

Wang, et al.             Expires March 22, 2019                 [Page 1]
Internet-Draft         Module Revision Management         September 2018

   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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminologies . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Design of YANG data model for module revision management  . .   4
     3.1.  yang-modules  . . . . . . . . . . . . . . . . . . . . . .   6
       3.1.1.  yang-modules/module . . . . . . . . . . . . . . . . .   6
       3.1.2.  yang-modules/change-log . . . . . . . . . . . . . . .   6
     3.2.  RPC definition for module revision change . . . . . . . .   6
       3.2.1.  Usage Example . . . . . . . . . . . . . . . . . . . .   6
   4.  YANG Extension for Purpose Marking  . . . . . . . . . . . . .   8
     4.1.  Usage Example: Add New Function . . . . . . . . . . . . .   8
     4.2.  Usage example: Bug Fix  . . . . . . . . . . . . . . . . .  10
   5.  Library Augmentation  . . . . . . . . . . . . . . . . . . . .  12
   6.  Multiple revisions module management  . . . . . . . . . . . .  13
   7.  Yang Data Model Definition  . . . . . . . . . . . . . . . . .  13
   8.  Security Considerations . . . . . . . . . . . . . . . . . . .  21
   9.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  21
   10. Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  22
   11. Normative References  . . . . . . . . . . . . . . . . . . . .  22
   Appendix A.  Example of Module Revision Management  . . . . . . .  23
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  25

1.  Introduction

   The revised Network Management Datastore Architecture (NMDA) defines
   a set of new datastores that each hold YANG-defined data [RFC7950]
   and represent a different "viewpoint" on the data that is maintained
   by a server.  To support the NMDA, many modules may need to be
   updated or restructured especially for some published non-NMDA
   modules, the model should be republished with an NMDA-compatible
   structure, deprecating non-NMDA constructs
   [I-D.ietf-netmod-rfc6087bis].  Therefore, how to support hackward-
   compatible and indicate the module's changes is an issue.

   As described in [RFC7950] , a module name MUST NOT be changed when
Show full document text