draft-ietf-netmod-yang-metadata-04.txt   draft-ietf-netmod-yang-metadata-05.txt 
NETMOD Working Group L. Lhotka NETMOD Working Group L. Lhotka
Internet-Draft CZ.NIC Internet-Draft CZ.NIC
Intended status: Standards Track February 24, 2016 Updates: 6110 (if approved) March 10, 2016
Expires: August 27, 2016 Intended status: Standards Track
Expires: September 11, 2016
Defining and Using Metadata with YANG Defining and Using Metadata with YANG
draft-ietf-netmod-yang-metadata-04 draft-ietf-netmod-yang-metadata-05
Abstract Abstract
This document defines a YANG extension statement that allows for This document defines a YANG extension statement that allows for
defining metadata annotations in YANG modules. The document also defining metadata annotations in YANG modules. The document also
specifies XML and JSON encoding of annotations and other rules for specifies XML and JSON encoding of annotations and other rules for
annotating instances of YANG data nodes. annotating instances of YANG data nodes.
Status of This Memo Status of This Memo
skipping to change at page 1, line 33 skipping to change at page 1, line 34
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on August 27, 2016. This Internet-Draft will expire on September 11, 2016.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 10 skipping to change at page 2, line 10
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1. Keywords . . . . . . . . . . . . . . . . . . . . . . . . 4 2.1. Keywords . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2. Terms Defined in Other Documents . . . . . . . . . . . . 4 2.2. Terms Defined in Other Documents . . . . . . . . . . . . 5
2.3. Namespaces and Prefixes . . . . . . . . . . . . . . . . . 6 2.3. Namespaces and Prefixes . . . . . . . . . . . . . . . . . 6
2.4. Definitions of New Terms . . . . . . . . . . . . . . . . 6 2.4. Definitions of New Terms . . . . . . . . . . . . . . . . 7
3. Defining Annotations in YANG . . . . . . . . . . . . . . . . 6 3. Defining Annotations in YANG . . . . . . . . . . . . . . . . 7
3.1. Example Definition . . . . . . . . . . . . . . . . . . . 7 3.1. Example Definition . . . . . . . . . . . . . . . . . . . 8
4. Using Annotations . . . . . . . . . . . . . . . . . . . . . . 8 4. Using Annotations . . . . . . . . . . . . . . . . . . . . . . 8
5. The Encoding of Annotations . . . . . . . . . . . . . . . . . 9 5. The Encoding of Annotations . . . . . . . . . . . . . . . . . 9
5.1. XML Encoding . . . . . . . . . . . . . . . . . . . . . . 9 5.1. XML Encoding . . . . . . . . . . . . . . . . . . . . . . 9
5.2. JSON Encoding . . . . . . . . . . . . . . . . . . . . . . 9 5.2. JSON Encoding . . . . . . . . . . . . . . . . . . . . . . 10
5.2.1. Metadata Object and Annotations . . . . . . . . . . . 10 5.2.1. Metadata Object and Annotations . . . . . . . . . . . 10
5.2.2. Adding Annotations to Anydata, Container and List 5.2.2. Adding Annotations to Anydata, Container and List
Entries . . . . . . . . . . . . . . . . . . . . . . . 10 Entries . . . . . . . . . . . . . . . . . . . . . . . 10
5.2.3. Adding Annotations to Anyxml and Leaf Instances . . . 11 5.2.3. Adding Annotations to Anyxml and Leaf Instances . . . 11
5.2.4. Adding Annotations to Leaf-list Entries . . . . . . . 12 5.2.4. Adding Annotations to Leaf-list Entries . . . . . . . 12
6. Representing Annotations in DSDL Schemas . . . . . . . . . . 12 6. Representing Annotations in DSDL Schemas . . . . . . . . . . 12
7. Metadata YANG Module . . . . . . . . . . . . . . . . . . . . 14 7. Metadata YANG Module . . . . . . . . . . . . . . . . . . . . 14
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16
9. Security Considerations . . . . . . . . . . . . . . . . . . . 16 9. Security Considerations . . . . . . . . . . . . . . . . . . . 17
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 17 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 17
11.1. Normative References . . . . . . . . . . . . . . . . . . 17 11.1. Normative References . . . . . . . . . . . . . . . . . . 17
11.2. Informative References . . . . . . . . . . . . . . . . . 18 11.2. Informative References . . . . . . . . . . . . . . . . . 18
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 18 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 19
A.1. Changes Between Revisions -03 and -04 . . . . . . . . . . 18 A.1. Changes Between Revisions -04 and -05 . . . . . . . . . . 19
A.2. Changes Between Revisions -02 and -03 . . . . . . . . . . 19 A.2. Changes Between Revisions -03 and -04 . . . . . . . . . . 19
A.3. Changes Between Revisions -01 and -02 . . . . . . . . . . 19 A.3. Changes Between Revisions -02 and -03 . . . . . . . . . . 19
A.4. Changes Between Revisions -00 and -01 . . . . . . . . . . 19 A.4. Changes Between Revisions -01 and -02 . . . . . . . . . . 19
A.5. Changes Between draft-lhotka-netmod-yang-metadata-01 and A.5. Changes Between Revisions -00 and -01 . . . . . . . . . . 19
draft-ietf-netmod-yang-metadata-00 . . . . . . . . . . . 19 A.6. Changes Between draft-lhotka-netmod-yang-metadata-01 and
A.6. Changes Between draft-lhotka-netmod-yang-metadata-00 and draft-ietf-netmod-yang-metadata-00 . . . . . . . . . . . 20
-01 . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 A.7. Changes Between draft-lhotka-netmod-yang-metadata-00 and
-01 . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 20 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 20
1. Introduction 1. Introduction
There is a need to be able to annotate instances of There is a need to be able to annotate instances of
YANG [I-D.ietf-netmod-rfc6020bis] data nodes with metadata. Typical YANG [I-D.ietf-netmod-rfc6020bis] data nodes with metadata. Typical
use cases are: use cases are:
o Complementing regular data model information with instance- o Complementing regular data model information with instance-
specific metadata, comments etc. specific metadata, comments etc.
skipping to change at page 4, line 20 skipping to change at page 4, line 20
tools supporting a certain annotation can thus take them into tools supporting a certain annotation can thus take them into
account and modify their behavior accordingly. account and modify their behavior accordingly.
o Semantics of an annotation are defined in the "description" and o Semantics of an annotation are defined in the "description" and
"reference" statements. "reference" statements.
o An annotation can be declared as conditional by using the "if- o An annotation can be declared as conditional by using the "if-
feature" statement. feature" statement.
o Values of annotations are not limited to strings; any YANG built- o Values of annotations are not limited to strings; any YANG built-
in or derived type may be used for them. in or derived type may be specified for them.
In the XML encoding, XML attributes are a natural instrument for In the XML encoding, XML attributes are a natural instrument for
attaching annotations to data node instances. This document attaching annotations to data node instances. This document
deliberately adopts some restrictions in order to remain compatible deliberately adopts some restrictions in order to remain compatible
with the XML encoding of YANG data node instances and limitations of with the XML encoding of YANG data node instances and limitations of
XML attributes. Specifically, XML attributes. Specifically,
o annotations are scalar values and cannot be further structured; o annotations are scalar values and cannot be further structured;
o annotations cannot be attached to a whole list or leaf-list o annotations cannot be attached to a whole list or leaf-list
instance, only to individual list or leaf-list entries. instance, only to individual list or leaf-list entries.
Due to the rules for YANG extensions (see sec. 6.3.1 in
[I-D.ietf-netmod-rfc6020bis]), annotation definitions posit
relatively weak conformance requirements. The alternative of
introducing a new built-in YANG statement for defining annotations
was considered, but it was seen as a major change to the language
that is inappropriate for YANG 1.1, which was chartered as a
maintenance revision. After evaluating real-life usage of metadata
annotations, it is conceivable that such a new built-in statement
might be added in a future revision of YANG.
2. Terminology 2. Terminology
2.1. Keywords 2.1. Keywords
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
2.2. Terms Defined in Other Documents 2.2. Terms Defined in Other Documents
skipping to change at page 5, line 16 skipping to change at page 5, line 29
o server. o server.
The following terms are defined in [I-D.ietf-netmod-rfc6020bis]: The following terms are defined in [I-D.ietf-netmod-rfc6020bis]:
o action, o action,
o anydata, o anydata,
o anyxml, o anyxml,
o data type, o built-in type,
o container, o container,
o data model, o data model,
o data node, o data node,
o data tree, o data tree,
o derived type,
o extension, o extension,
o leaf, o leaf,
o leaf-list, o leaf-list,
o list, o list,
o module, o module,
skipping to change at page 14, line 23 skipping to change at page 14, line 28
7. Metadata YANG Module 7. Metadata YANG Module
RFC Editor: In this section, replace all occurrences of 'XXXX' with RFC Editor: In this section, replace all occurrences of 'XXXX' with
the actual RFC number and all occurrences of the revision date below the actual RFC number and all occurrences of the revision date below
with the date of RFC publication (and remove this note). with the date of RFC publication (and remove this note).
RFC Editor: Also please replace all occurrences of 'RFC 6020bis' with RFC Editor: Also please replace all occurrences of 'RFC 6020bis' with
the actual RFC number that will be assigned to the actual RFC number that will be assigned to
[I-D.ietf-netmod-rfc6020bis]. [I-D.ietf-netmod-rfc6020bis].
<CODE BEGINS> file "ietf-yang-metadata@2016-02-24.yang" <CODE BEGINS> file "ietf-yang-metadata@2016-03-10.yang"
module ietf-yang-metadata { module ietf-yang-metadata {
namespace "urn:ietf:params:xml:ns:yang:ietf-yang-metadata"; namespace "urn:ietf:params:xml:ns:yang:ietf-yang-metadata";
prefix "md"; prefix "md";
organization organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group"; "IETF NETMOD (NETCONF Data Modeling Language) Working Group";
skipping to change at page 15, line 20 skipping to change at page 15, line 26
without modification, is permitted pursuant to, and subject to without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX This version of this YANG module is part of RFC XXXX
(http://tools.ietf.org/html/rfcXXXX); see the RFC itself for (http://tools.ietf.org/html/rfcXXXX); see the RFC itself for
full legal notices."; full legal notices.";
revision 2016-02-24 { revision 2016-03-10 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC XXXX: Defining and Using Metadata with YANG"; "RFC XXXX: Defining and Using Metadata with YANG";
} }
extension annotation { extension annotation {
argument name; argument name;
description description
"This extension allows for defining metadata annotations in "This extension allows for defining metadata annotations in
skipping to change at page 17, line 28 skipping to change at page 17, line 35
11.1. Normative References 11.1. Normative References
[I-D.ietf-netmod-rfc6020bis] [I-D.ietf-netmod-rfc6020bis]
Bjorklund, M., "The YANG 1.1 Data Modeling Language", Bjorklund, M., "The YANG 1.1 Data Modeling Language",
draft-ietf-netmod-rfc6020bis-11 (work in progress), draft-ietf-netmod-rfc6020bis-11 (work in progress),
February 2016. February 2016.
[I-D.ietf-netmod-yang-json] [I-D.ietf-netmod-yang-json]
Lhotka, L., "JSON Encoding of Data Modeled with YANG", Lhotka, L., "JSON Encoding of Data Modeled with YANG",
draft-ietf-netmod-yang-json-08 (work in progress), draft-ietf-netmod-yang-json-09 (work in progress), March
February 2016. 2016.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>. <http://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<http://www.rfc-editor.org/info/rfc3688>. <http://www.rfc-editor.org/info/rfc3688>.
skipping to change at page 18, line 48 skipping to change at page 19, line 9
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>. <http://www.rfc-editor.org/info/rfc6241>.
Appendix A. Change Log Appendix A. Change Log
RFC Editor: Remove this section upon publication as an RFC. RFC Editor: Remove this section upon publication as an RFC.
A.1. Changes Between Revisions -03 and -04 A.1. Changes Between Revisions -04 and -05
o Added explanation of why a YANG extension is used rather than a
built-in statement.
A.2. Changes Between Revisions -03 and -04
o Added explanation of what "top level of a module" means. o Added explanation of what "top level of a module" means.
A.2. Changes Between Revisions -02 and -03 A.3. Changes Between Revisions -02 and -03
o Section 4 was considerably simplified, also because member names o Section 4 was considerably simplified, also because member names
starting with "@" are now permitted by starting with "@" are now permitted by
[I-D.ietf-netmod-yang-json]. [I-D.ietf-netmod-yang-json].
A.3. Changes Between Revisions -01 and -02 A.4. Changes Between Revisions -01 and -02
o The "type" statement became mandatory. o The "type" statement became mandatory.
o Terminology section was extended. o Terminology section was extended.
o The annotation "inactive" defined in the example module was o The annotation "inactive" defined in the example module was
replaced with "last-modified" that is supposedly less replaced with "last-modified" that is supposedly less
controversial. controversial.
o Introduction now states limitation due to XML attribute o Introduction now states limitation due to XML attribute
skipping to change at page 19, line 33 skipping to change at page 19, line 46
o A recommendation was added to define annotations in a module by o A recommendation was added to define annotations in a module by
themselves. themselves.
o Section "Using Annotations" was added. o Section "Using Annotations" was added.
o An example for "anyxml" was added. o An example for "anyxml" was added.
o RFC 6241 was moved to informative references. o RFC 6241 was moved to informative references.
A.4. Changes Between Revisions -00 and -01 A.5. Changes Between Revisions -00 and -01
o Define JSON encoding for annotations attached to 'anydata' nodes. o Define JSON encoding for annotations attached to 'anydata' nodes.
A.5. Changes Between draft-lhotka-netmod-yang-metadata-01 and draft- A.6. Changes Between draft-lhotka-netmod-yang-metadata-01 and draft-
ietf-netmod-yang-metadata-00 ietf-netmod-yang-metadata-00
o References to RFC 6020 were changed to the 6020bis I-D. o References to RFC 6020 were changed to the 6020bis I-D.
o Text about RFC 2119 key words was added to "ietf-yang-metadata" o Text about RFC 2119 key words was added to "ietf-yang-metadata"
module description. module description.
A.6. Changes Between draft-lhotka-netmod-yang-metadata-00 and -01 A.7. Changes Between draft-lhotka-netmod-yang-metadata-00 and -01
o Encoding of annotations for anyxml nodes was changed to be the o Encoding of annotations for anyxml nodes was changed to be the
same as for leafs. This was necessary because anyxml value now same as for leafs. This was necessary because anyxml value now
needn't be an object. needn't be an object.
o It is stated that "md:annotation" statement defines only the o It is stated that "md:annotation" statement defines only the
syntax of an annotation. syntax of an annotation.
o Allowed "if-feature" as a substatement of "md:annotation". o Allowed "if-feature" as a substatement of "md:annotation".
 End of changes. 21 change blocks. 
31 lines changed or deleted 50 lines changed or added

This html diff was produced by rfcdiff 1.44. The latest version is available from http://tools.ietf.org/tools/rfcdiff/