Guidelines for Authors and Reviewers of YANG Data Model Documents
draft-ietf-netmod-rfc6087bis-18
| The information below is for an old version of the document | |||
|---|---|---|---|
| Document | Type | Active Internet-Draft (netmod WG) | |
| Author | Andy Bierman | ||
| Last updated | 2018-03-08 (latest revision 2018-02-20) | ||
| Replaces | draft-bierman-netmod-rfc6087bis | ||
| Stream | IETF | ||
| Intended RFC status | Best Current Practice | ||
| Formats | pdf htmlized (tools) htmlized bibtex | ||
| Reviews | |||
| Stream | WG state | Submitted to IESG for Publication | |
| Document shepherd | Kent Watsen | ||
| Shepherd write-up | Show (last changed 2018-01-20) | ||
| IESG | IESG state | IESG Evaluation::AD Followup | |
| Consensus Boilerplate | Yes | ||
| Telechat date |
Needs 6 more YES or NO OBJECTION positions to pass. |
||
| Responsible AD | Benoît Claise | ||
| Send notices to | (None) | ||
| IANA | IANA review state | IANA OK - Actions Needed | |
Network Working Group A. Bierman
Internet-Draft YumaWorks
Obsoletes: 6087 (if approved) February 20, 2018
Intended status: BCP
Expires: August 24, 2018
Guidelines for Authors and Reviewers of YANG Data Model Documents
draft-ietf-netmod-rfc6087bis-18
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) and RESTCONF protocol
implementations that utilize YANG data model modules. This document
obsoletes RFC 6087.
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 August 24, 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
Bierman Expires August 24, 2018 [Page 1]
Internet-Draft Guidelines for YANG Documents February 2018
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 . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1. Changes Since RFC 6087 . . . . . . . . . . . . . . . . . . 5
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.1. Requirements Notation . . . . . . . . . . . . . . . . . . 8
2.2. NETCONF Terms . . . . . . . . . . . . . . . . . . . . . . 8
2.3. YANG Terms . . . . . . . . . . . . . . . . . . . . . . . . 8
2.4. NMDA Terms . . . . . . . . . . . . . . . . . . . . . . . . 9
2.5. Terms . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3. General Documentation Guidelines . . . . . . . . . . . . . . . 10
3.1. Module Copyright . . . . . . . . . . . . . . . . . . . . . 10
3.2. Code Components . . . . . . . . . . . . . . . . . . . . . 10
3.2.1. Example Modules . . . . . . . . . . . . . . . . . . . 11
3.3. Terminology Section . . . . . . . . . . . . . . . . . . . 11
3.4. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 11
3.5. Narrative Sections . . . . . . . . . . . . . . . . . . . . 12
3.6. Definitions Section . . . . . . . . . . . . . . . . . . . 12
3.7. Security Considerations Section . . . . . . . . . . . . . 13
3.7.1. Security Considerations Section Template . . . . . . . 13
3.8. IANA Considerations Section . . . . . . . . . . . . . . . 15
3.8.1. Documents that Create a New Namespace . . . . . . . . 15
3.8.2. Documents that Extend an Existing Namespace . . . . . 15
3.9. Reference Sections . . . . . . . . . . . . . . . . . . . . 15
3.10. Validation Tools . . . . . . . . . . . . . . . . . . . . . 16
3.11. Module Extraction Tools . . . . . . . . . . . . . . . . . 16
3.12. Module Usage Examples . . . . . . . . . . . . . . . . . . 17
4. YANG Usage Guidelines . . . . . . . . . . . . . . . . . . . . 18
4.1. Module Naming Conventions . . . . . . . . . . . . . . . . 18
4.2. Prefixes . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.3. Identifiers . . . . . . . . . . . . . . . . . . . . . . . 20
4.3.1. Identifier Naming Conventions . . . . . . . . . . . . 20
4.4. Defaults . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.5. Conditional Statements . . . . . . . . . . . . . . . . . . 21
4.6. XPath Usage . . . . . . . . . . . . . . . . . . . . . . . 22
4.6.1. XPath Evaluation Contexts . . . . . . . . . . . . . . 22
4.6.2. Function Library . . . . . . . . . . . . . . . . . . . 23
Show full document text