YANG Tree Diagrams
draft-ietf-netmod-yang-tree-diagrams-05

The information below is for an old version of the document
Document Type Active Internet-Draft (netmod WG)
Authors Martin Björklund  , Lou Berger 
Last updated 2018-02-08 (latest revision 2018-01-22)
Replaces draft-bjorklund-netmod-yang-tree-diagrams
Stream Internent Engineering Task Force (IETF)
Formats pdf htmlized (tools) htmlized bibtex
Reviews
Stream WG state Submitted to IESG for Publication
Document shepherd Joel Jaeggli
Shepherd write-up Show (last changed 2018-01-23)
IESG IESG state Waiting for AD Go-Ahead
Consensus Boilerplate Yes
Telechat date
Needs 6 more YES or NO OBJECTION positions to pass.
Responsible AD Benoît Claise
IESG note RFC EDITOR NOTE (on draft version 5):
In this intro section:
Today's common practice is to include the definition of the syntax
used to represent a YANG module in every document that provides a
tree diagram. This practice has several disadvantages and the
purpose of the document is to provide a single location for this
OLD:
"the document"
NEW:
"this document"
Send notices to Joel Jaeggli <joelja@gmail.com>
IANA IANA review state IANA OK - No Actions Needed
Network Working Group                                       M. Bjorklund
Internet-Draft                                            Tail-f Systems
Intended status: Best Current Practice                    L. Berger, Ed.
Expires: July 27, 2018                           LabN Consulting, L.L.C.
                                                        January 23, 2018

                           YANG Tree Diagrams
                draft-ietf-netmod-yang-tree-diagrams-05

Abstract

   This document captures the current syntax used in YANG module Tree
   Diagrams.  The purpose of the document is to provide a single
   location for this definition.  This syntax may be updated from time
   to time based on the evolution of the YANG language.

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 27, 2018.

Copyright Notice

   Copyright (c) 2018 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
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Bjorklund & Berger        Expires July 27, 2018                 [Page 1]
Internet-Draft             YANG Tree Diagrams               January 2018

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Tree Diagram Syntax . . . . . . . . . . . . . . . . . . . . .   3
     2.1.  Submodules  . . . . . . . . . . . . . . . . . . . . . . .   6
     2.2.  Groupings . . . . . . . . . . . . . . . . . . . . . . . .   6
     2.3.  yang-data . . . . . . . . . . . . . . . . . . . . . . . .   6
     2.4.  Collapsed Node Representation . . . . . . . . . . . . . .   6
     2.5.  Comments  . . . . . . . . . . . . . . . . . . . . . . . .   7
     2.6.  Node Representation . . . . . . . . . . . . . . . . . . .   7
   3.  Usage Guidelines For RFCs . . . . . . . . . . . . . . . . . .   8
     3.1.  Wrapping Long Lines . . . . . . . . . . . . . . . . . . .   8
     3.2.  Groupings . . . . . . . . . . . . . . . . . . . . . . . .   9
     3.3.  Long Diagrams . . . . . . . . . . . . . . . . . . . . . .   9
   4.  YANG Schema Mount Tree Diagrams . . . . . . . . . . . . . . .  10
     4.1.  Representation of Mounted Schema Trees  . . . . . . . . .  10
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  12
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .  12
   7.  Informative References  . . . . . . . . . . . . . . . . . . .  12
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  13

1.  Introduction

   YANG Tree Diagrams were first published in [RFC6536].  Such diagrams
   are used to provided a simplified graphical representation of a data
   model and can be automatically generated via tools such as "pyang".
   (See <https://github.com/mbj4668/pyang>).  This document describes
   the syntax used in YANG Tree Diagrams.  It is expected that this
   document will be updated or replaced as changes to the YANG language,
   see [RFC7950], necessitate.

   Today's common practice is to include the definition of the syntax
   used to represent a YANG module in every document that provides a
   tree diagram.  This practice has several disadvantages and the
   purpose of the document is to provide a single location for this
   definition.  It is not the intent of this document to restrict future
   changes, but rather to ensure such changes are easily identified and
   suitably agreed upon.

   An example tree diagram can be found in [RFC7223] Section 3.  A
   portion of which follows:

Bjorklund & Berger        Expires July 27, 2018                 [Page 2]
Internet-Draft             YANG Tree Diagrams               January 2018

     +--rw interfaces
     |  +--rw interface* [name]
     |     +--rw name                        string
     |     +--rw description?                string
     |     +--rw type                        identityref
Show full document text