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

Document Type Active Internet-Draft (netmod WG)
Last updated 2018-01-01 (latest revision 2017-12-21)
Replaces draft-bjorklund-netmod-yang-tree-diagrams
Stream IETF
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream WG state In WG Last Call
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                       M. Bjorklund
Internet-Draft                                            Tail-f Systems
Intended status: Best Current Practice                    L. Berger, Ed.
Expires: June 24, 2018                           LabN Consulting, L.L.C.
                                                       December 21, 2017

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

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 June 24, 2018.

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

Bjorklund & Berger        Expires June 24, 2018                 [Page 1]
Internet-Draft             YANG Tree Diagrams              December 2017

Table of Contents

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

1.  Introduction

   YANG Tree Diagrams were first published in [RFC6536].  Such diagrams
   are commonly 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
   provides 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 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 June 24, 2018                 [Page 2]
Internet-Draft             YANG Tree Diagrams              December 2017

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