Schema Annotation for YANG Models
draft-lengyel-netmod-schema-annotation-00

Document Type Active Internet-Draft (individual)
Last updated 2017-01-25
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                                                        B. Lengyel
Internet-Draft                                                  Ericsson
Intended status: Standards Track                        January 24, 2017
Expires: July 28, 2017

                   Schema Annotation for YANG Models
               draft-lengyel-netmod-schema-annotation-00

Abstract

   In some cases there is a need to qualify other YANG models or some
   schema nodes in other models with additional properties (a.k.a.
   annotations).  This document defines a method to add annotations in
   the form of YANG extension statements to YANG modules.  The
   annotations are defined in separate files without modifying the text
   of the original YANG module.

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 http://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 July 28, 2017.

Copyright Notice

   Copyright (c) 2017 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
   (http://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

Lengyel                   Expires July 28, 2017                 [Page 1]
Internet-Draft           Yang Schema Annotation             January 2017

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

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Use Case - Yangpush . . . . . . . . . . . . . . . . . . .   3
     1.2.  Use Case - Vendor Annotation of a Standard Model  . . . .   3
   2.  Possible solutions  . . . . . . . . . . . . . . . . . . . . .   3
     2.1.  Instance Data based Solution  . . . . . . . . . . . . . .   4
     2.2.  Extension based Solution  . . . . . . . . . . . . . . . .   5
     2.3.  Deviation based Solution  . . . . . . . . . . . . . . . .   6
     2.4.  Pros and Cons . . . . . . . . . . . . . . . . . . . . . .   6
   3.  How is this different from RFC7952 "Defining and Using
       Metadata with YANG?"  . . . . . . . . . . . . . . . . . . . .   7
   4.  Open Issues . . . . . . . . . . . . . . . . . . . . . . . . .   7
   5.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   8
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   8
   7.  Security Considerations . . . . . . . . . . . . . . . . . . .   8
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   8
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .   8
     8.2.  Informative References  . . . . . . . . . . . . . . . . .   8
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   9

1.  Introduction

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in [RFC2119].

   In some cases there is a need to qualify other YANG models or some
   schema nodes in other models with additional properties (a.k.a.
   annotations).  This document defines a method to add annotations in
   the form of YANG [RFC7950] extension statements to YANG modules.  The
   annotations are defined in separate files without modifying the text
   of the original YANG module.

   Annotations are often specific to the model and/or implementation so
   they are possible to define in design time.  System integrators,
   people defining configuration ahead of time and others need this
   information (without reading any data from a live node).

   Often the basic YANG model and the extra properties are defined
   separately, possibly by different organizations.  Vendors may qualify
   standard models with extra properties, or even a vendor defined base
Show full document text