Guidelines for YANG Module Authors (NMDA)
draft-dsdt-nmda-guidelines-01

Document Type Active Internet-Draft (individual)
Last updated 2017-05-09
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)
Network Working Group                                       M. Bjorklund
Internet-Draft                                            Tail-f Systems
Intended status: Informational                          J. Schoenwaelder
Expires: November 10, 2017                             Jacobs University
                                                               P. Shafer
                                                               K. Watsen
                                                        Juniper Networks
                                                               R. Wilton
                                                           Cisco Systems
                                                             May 9, 2017

               Guidelines for YANG Module Authors (NMDA)
                     draft-dsdt-nmda-guidelines-01

Abstract

   The "Network Management Datastore Architecture" (NMDA) adds the
   ability to inspect the current operational values for configuration,
   allowing clients to use identical paths for retrieving the configured
   values and the operational values.  This change will simplify models
   and help modelers, but will create a period of transition as NMDA
   becomes a standard and is widely implemented.  During that interim,
   the guidelines given in this document should help modelers find an
   optimal path forward.

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 November 10, 2017.

Copyright Notice

   Copyright (c) 2017 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Bjorklund, et al.       Expires November 10, 2017               [Page 1]
Internet-Draft                                                  May 2017

   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.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Keywords  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.2.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   2
     1.3.  Executive Summary . . . . . . . . . . . . . . . . . . . .   3
     1.4.  Background  . . . . . . . . . . . . . . . . . . . . . . .   3
     1.5.  Network Management Datastores Architecture  . . . . . . .   5
   2.  Guidelines for YANG Modelers  . . . . . . . . . . . . . . . .   5
   3.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   8
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   8
   5.  Informative References  . . . . . . . . . . . . . . . . . . .   8
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   9

1.  Introduction

   This document provides advice and guidelines to help modelers plan
   for the emerging "Network Management Datastore Architecture" (NMDA)
   [I-D.ietf-netmod-revised-datastores].  This architecture provides an
   architectural framework for datastores as they are used by network
   management protocols such as NETCONF [RFC6241], RESTCONF [RFC8040]
   and the YANG [RFC7950] data modeling language.  Datastores are a
   fundamental concept binding network management data models to network
   management protocols, enabling data models to be written in a network
   management protocol agnostic way.

1.1.  Keywords

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

1.2.  Terminology
Show full document text