Self Describing Data Object Tags
draft-ietf-netmod-node-tags-01
|
Document |
Type |
|
Active Internet-Draft (netmod WG)
|
|
Authors |
|
Qin Wu
,
Benoît Claise
,
Peng Liu
,
Zongpeng Du
,
Mohamed Boucadair
|
|
Last updated |
|
2021-02-19
|
|
Replaces |
|
draft-tao-netmod-yang-node-tags
|
|
Stream |
|
Internet Engineering Task Force (IETF)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
xml
pdf
htmlized (tools)
htmlized
bibtex
|
|
Yang Validation |
|
☯
0 errors, 2 warnings.
draft-ietf-netmod-node-tags-01.txt:
xym 0.5:
Extracting 'ietf-data-object-tags@2019-05-03.yang'
Removed 0 empty lines
Extracting 'example-module-A'
Getting YANG file name from module name: example-module-A.yang
Extracting 'ietf-data-object-tags-state@2019-05-03.yang'
Removed 0 empty lines
ietf-data-object-tags-state@2019-05-03.yang:
pyang 2.4.0: pyang --verbose --ietf -p {libs} {model}:
# module search path: a/www/ietf-ftp/yang/rfcmod/:/a/www/ietf-ftp/yang/draftmod/:/a/www/ietf-ftp/yang/ianamod/:/a/www/ietf-ftp/yang/catalogmod/:.:/var/lib/wwwrun/yang/modules:/a/www/ietf-datatracker/7.27.0/env/share/yang/modules
# read ietf-data-object-tags-state@2019-05-03.yang (CL)
# read /a/www/ietf-datatracker/7.27.0/env/share/yang/modules/ietf/ietf-netconf-acm.yang
# read /a/www/ietf-ftp/yang/rfcmod/ietf-netconf-acm@2018-02-14.yang
# read /a/www/ietf-datatracker/7.27.0/env/share/yang/modules/ietf/ietf-yang-types.yang
# read /a/www/ietf-ftp/yang/draftmod/ietf-yang-types@2021-02-22.yang
# read /a/www/ietf-ftp/yang/rfcmod/ietf-module-tags@2021-01-04.yang
ietf-data-object-tags-state@2019-05-03.yang:60: warning: the module seems to use RFC 2119 keywords, but the required text from RFC 8174 is not found (see pyang --ietf-help for details).
yanglint SO 1.6.7: yanglint --verbose -p {tmplib} -p {rfclib} -p {draftlib} -p {ianalib} -p {cataloglib} {model} -i:
No validation errors
ietf-data-object-tags@2019-05-03.yang:
pyang 2.4.0: pyang --verbose --ietf -p {libs} {model}:
# module search path: a/www/ietf-ftp/yang/rfcmod/:/a/www/ietf-ftp/yang/draftmod/:/a/www/ietf-ftp/yang/ianamod/:/a/www/ietf-ftp/yang/catalogmod/:.:/var/lib/wwwrun/yang/modules:/a/www/ietf-datatracker/7.27.0/env/share/yang/modules
# read ietf-data-object-tags@2019-05-03.yang (CL)
# read /a/www/ietf-datatracker/7.27.0/env/share/yang/modules/ietf/ietf-netconf-acm.yang
# read /a/www/ietf-ftp/yang/rfcmod/ietf-netconf-acm@2018-02-14.yang
# read /a/www/ietf-datatracker/7.27.0/env/share/yang/modules/ietf/ietf-yang-types.yang
# read /a/www/ietf-ftp/yang/draftmod/ietf-yang-types@2021-02-22.yang
# read /a/www/ietf-ftp/yang/rfcmod/ietf-module-tags@2021-01-04.yang
ietf-data-object-tags@2019-05-03.yang:62: warning: the module seems to use RFC 2119 keywords, but the required text from RFC 8174 is not found (see pyang --ietf-help for details).
yanglint SO 1.6.7: yanglint --verbose -p {tmplib} -p {rfclib} -p {draftlib} -p {ianalib} -p {cataloglib} {model} -i:
No validation errors
|
Stream |
WG state
|
|
WG Document
|
|
Document shepherd |
|
No shepherd assigned
|
IESG |
IESG state |
|
I-D Exists
|
|
Consensus Boilerplate |
|
Unknown
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
NETMOD Working Group Q. Wu
Internet-Draft Huawei
Updates: 8407 (if approved) B. Claise
Intended status: Standards Track Cisco
Expires: August 23, 2021 P. Liu
Z. Du
China Mobile
M. Boucadair
Orange
February 19, 2021
Self Describing Data Object Tags
draft-ietf-netmod-node-tags-01
Abstract
This document defines a method to tag data objects associated with
operation and management data in YANG Modules. This YANG data object
tagging method can be used to classify data objects from different
YANG modules and identify characteristics data. It also can 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. When the state of all subscriptions of a
particular Subscriber to be fetched is huge, the amount of data to be
streamed out to the destination can be greatly reduced and only
targeted to the characteristics data. These data object tags may be
registered as well as assigned during the module definition; assigned
by implementations; or dynamically defined and set by users.
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
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 23, 2021.
Wu, et al. Expires August 23, 2021 [Page 1]
Internet-Draft Data Object Tags February 2021
Copyright Notice
Copyright (c) 2021 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. Self Describing Data Object Tags Use Case . . . . . . . . 4
1.1.1. Massive Data Object Collection . . . . . . . . . . . 4
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 6
1.2.1. Requirements Notation . . . . . . . . . . . . . . . . 6
1.2.2. Glossary . . . . . . . . . . . . . . . . . . . . . . 7
2. Data Object Tag Values . . . . . . . . . . . . . . . . . . . 7
2.1. IETF Tags Prefix . . . . . . . . . . . . . . . . . . . . 7
2.2. Vendor Tags Prefix . . . . . . . . . . . . . . . . . . . 7
2.3. User Tags Prefix . . . . . . . . . . . . . . . . . . . . 7
2.4. Reserved Tags Prefix . . . . . . . . . . . . . . . . . . 7
3. Data Object Tag Management . . . . . . . . . . . . . . . . . 8
3.1. Module Design Tagging . . . . . . . . . . . . . . . . . . 8
3.2. Implementation Tagging . . . . . . . . . . . . . . . . . 9
3.3. User Tagging . . . . . . . . . . . . . . . . . . . . . . 9
4. Data Object Tags Module Structure . . . . . . . . . . . . . . 9
4.1. Data Object Tags Module Tree . . . . . . . . . . . . . . 9
5. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 9
6. Guidelines to Model Writers . . . . . . . . . . . . . . . . . 12
6.1. Define Standard Tags . . . . . . . . . . . . . . . . . . 12
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13
7.1. YANG Data Object Tag Prefixes Registry . . . . . . . . . 13
7.2. IETF YANG Data Object Tags Registry . . . . . . . . . . . 14
7.3. Updates to the IETF XML Registry . . . . . . . . . . . . 16
Show full document text