YANG Data Node Self Explanation Tags
draft-tao-netmod-yang-node-tags-02

Document Type Active Internet-Draft (individual)
Last updated 2020-06-01
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf htmlized (tools) htmlized bibtex
Yang Validation 0 errors, 1 warnings.
Additional URLs
- Yang catalog entry for ietf-self-explanation-node-tags@2019-05-03.yang
- Yang impact analysis for draft-tao-netmod-yang-node-tags
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)
NETMOD Working Group                                              R. Tao
Internet-Draft                                                     Q. Wu
Intended status: Standards Track                                  Huawei
Expires: December 3, 2020                                      B. Claise
                                                                   Cisco
                                                                 L. Geng
                                                                   Z. Du
                                                            China Mobile
                                                            June 1, 2020

                  YANG Data Node Self Explanation Tags
                   draft-tao-netmod-yang-node-tags-02

Abstract

   This document defines a method to tag data node associated with
   telemetry data in YANG Modules.  This YANG data node tagging method
   can be used to provide input, instruction, indication to selection
   filter and filter queries of operational state on a server during a
   "pub/sub" service for YANG datastore updates and provide multiple
   dimensional network visibility analysis when the state of all
   subscriptions of a particular Subscriber to be fetched is huge, so
   that the amount of data to be streamed out to the destination can be
   greatly reduced and only targeted to the characteristics data.

   An extension statement to be used to indicate YANG data node self
   explanation tags that SHOULD be added by the module implementation
   automatically (i.e., outside of configuration).

   A YANG module [RFC7950] is defined, which augments Module tag model
   and provides a list of data node entries to allow for adding or
   removing of data node self explanation tags as well as viewing the
   set of self explanation tags associated with a YANG module.

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 https://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

Tao, et al.             Expires December 3, 2020                [Page 1]
Internet-Draft            Self Explanation Tags                June 2020

   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 3, 2020.

Copyright Notice

   Copyright (c) 2020 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
   (https://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  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Data Node tags Use Cases  . . . . . . . . . . . . . . . .   4
       1.1.1.  Multiple Dimensional Performance Measurement
               Information Tagging . . . . . . . . . . . . . . . . .   4
       1.1.2.  Correlated Information Tagging  . . . . . . . . . . .   7
     1.2.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   8
   2.  Data Node Tag Values  . . . . . . . . . . . . . . . . . . . .   8
     2.1.  IETF Tags Prefix  . . . . . . . . . . . . . . . . . . . .   8
     2.2.  Vendor Tags Prefix  . . . . . . . . . . . . . . . . . . .   8
     2.3.  User Tags Prefix  . . . . . . . . . . . . . . . . . . . .   8
     2.4.  Reserved Tags Prefix  . . . . . . . . . . . . . . . . . .   8
   3.  Data Node Tag Management  . . . . . . . . . . . . . . . . . .   9
     3.1.  Module Design Tagging . . . . . . . . . . . . . . . . . .   9
     3.2.  Implementation Tagging  . . . . . . . . . . . . . . . . .   9
     3.3.  User Tagging  . . . . . . . . . . . . . . . . . . . . . .   9
   4.  Tags Module Structure . . . . . . . . . . . . . . . . . . . .   9
     4.1.  Tags Module Tree  . . . . . . . . . . . . . . . . . . . .   9
   5.  YANG Module . . . . . . . . . . . . . . . . . . . . . . . . .  10
   6.  Guidelines to Model Writers . . . . . . . . . . . . . . . . .  18
     6.1.  Define Standard Tags  . . . . . . . . . . . . . . . . . .  18
   7.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  19
     7.1.  YANG Data Node Tag Prefixes Registry  . . . . . . . . . .  19
Show full document text