Guidelines for Authors and Reviewers of YANG Data Model Documents
draft-ietf-netmod-rfc6087bis-00

The information below is for an old version of the document
Document Type Active Internet-Draft (netmod WG)
Author Andy Bierman 
Last updated 2014-07-11 (latest revision 2014-06-16)
Replaces draft-bierman-netmod-rfc6087bis
Stream IETF
Intended RFC status (None)
Formats pdf htmlized (tools) htmlized bibtex
Reviews
Stream WG state WG Document
Document shepherd None
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                         A. Bierman
Internet-Draft                                                 YumaWorks
Intended status: Standards Track                           June 16, 2014
Expires: December 18, 2014

   Guidelines for Authors and Reviewers of YANG Data Model Documents
                    draft-ietf-netmod-rfc6087bis-00

Abstract

   This memo provides guidelines for authors and reviewers of Standards
   Track specifications containing YANG data model modules.  Applicable
   portions may be used as a basis for reviews of other YANG data model
   documents.  Recommendations and procedures are defined, which are
   intended to increase interoperability and usability of Network
   Configuration Protocol (NETCONF) implementations that utilize YANG
   data model modules.

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 December 18, 2014.

Copyright Notice

   Copyright (c) 2014 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

Bierman                 Expires December 18, 2014               [Page 1]
Internet-Draft        Guidelines for YANG Documents            June 2014

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

Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  4
   2.  Terminology  . . . . . . . . . . . . . . . . . . . . . . . . .  5
     2.1.  Requirements Notation  . . . . . . . . . . . . . . . . . .  5
     2.2.  NETCONF Terms  . . . . . . . . . . . . . . . . . . . . . .  5
     2.3.  YANG Terms . . . . . . . . . . . . . . . . . . . . . . . .  5
     2.4.  Terms  . . . . . . . . . . . . . . . . . . . . . . . . . .  6
   3.  General Documentation Guidelines . . . . . . . . . . . . . . .  7
     3.1.  Module Copyright . . . . . . . . . . . . . . . . . . . . .  7
     3.2.  Terminology Section  . . . . . . . . . . . . . . . . . . .  8
     3.3.  Tree Diagrams  . . . . . . . . . . . . . . . . . . . . . .  8
     3.4.  Narrative Sections . . . . . . . . . . . . . . . . . . . .  9
     3.5.  Definitions Section  . . . . . . . . . . . . . . . . . . .  9
     3.6.  Security Considerations Section  . . . . . . . . . . . . .  9
     3.7.  IANA Considerations Section  . . . . . . . . . . . . . . . 10
       3.7.1.  Documents that Create a New Namespace  . . . . . . . . 10
       3.7.2.  Documents that Extend an Existing Namespace  . . . . . 10
     3.8.  Reference Sections . . . . . . . . . . . . . . . . . . . . 10
   4.  YANG Usage Guidelines  . . . . . . . . . . . . . . . . . . . . 12
     4.1.  Module Naming Conventions  . . . . . . . . . . . . . . . . 12
     4.2.  Identifiers  . . . . . . . . . . . . . . . . . . . . . . . 12
     4.3.  Defaults . . . . . . . . . . . . . . . . . . . . . . . . . 12
     4.4.  Conditional Statements . . . . . . . . . . . . . . . . . . 13
     4.5.  XPath Usage  . . . . . . . . . . . . . . . . . . . . . . . 13
     4.6.  Lifecycle Management . . . . . . . . . . . . . . . . . . . 15
     4.7.  Module Header, Meta, and Revision Statements . . . . . . . 15
     4.8.  Namespace Assignments  . . . . . . . . . . . . . . . . . . 16
     4.9.  Top-Level Data Definitions . . . . . . . . . . . . . . . . 17
     4.10. Data Types . . . . . . . . . . . . . . . . . . . . . . . . 18
     4.11. Reusable Type Definitions  . . . . . . . . . . . . . . . . 18
     4.12. Data Definitions . . . . . . . . . . . . . . . . . . . . . 19
     4.13. Operation Definitions  . . . . . . . . . . . . . . . . . . 20
     4.14. Notification Definitions . . . . . . . . . . . . . . . . . 20
   5.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . . 21
   6.  Security Considerations  . . . . . . . . . . . . . . . . . . . 22
     6.1.  Security Considerations Section Template . . . . . . . . . 22
   7.  Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 24
Show full document text