draft-ietf-netmod-yang-metadata-03.txt   draft-ietf-netmod-yang-metadata-04.txt 
NETMOD Working Group L. Lhotka NETMOD Working Group L. Lhotka
Internet-Draft CZ.NIC Internet-Draft CZ.NIC
Intended status: Standards Track January 28, 2016 Intended status: Standards Track February 24, 2016
Expires: July 31, 2016 Expires: August 27, 2016
Defining and Using Metadata with YANG Defining and Using Metadata with YANG
draft-ietf-netmod-yang-metadata-03 draft-ietf-netmod-yang-metadata-04
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 33
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 July 31, 2016. This Internet-Draft will expire on August 27, 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 33 skipping to change at page 2, line 33
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 . . . . . . . . . . . . . . . . . . . 16
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 . . . . . . . . . . . . . . . . . . . . . 18
A.1. Changes Between Revisions -01 and -02 . . . . . . . . . . 18 A.1. Changes Between Revisions -03 and -04 . . . . . . . . . . 18
A.2. Changes Between Revisions -01 and -02 . . . . . . . . . . 19 A.2. Changes Between Revisions -02 and -03 . . . . . . . . . . 19
A.3. Changes Between Revisions -00 and -01 . . . . . . . . . . 19 A.3. Changes Between Revisions -01 and -02 . . . . . . . . . . 19
A.4. Changes Between draft-lhotka-netmod-yang-metadata-01 and A.4. Changes Between Revisions -00 and -01 . . . . . . . . . . 19
A.5. Changes Between draft-lhotka-netmod-yang-metadata-01 and
draft-ietf-netmod-yang-metadata-00 . . . . . . . . . . . 19 draft-ietf-netmod-yang-metadata-00 . . . . . . . . . . . 19
A.5. Changes Between draft-lhotka-netmod-yang-metadata-00 and A.6. Changes Between draft-lhotka-netmod-yang-metadata-00 and
-01 . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 -01 . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
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-
skipping to change at page 14, line 19 skipping to change at page 14, line 19
The second step of the DSDL mapping procedure, i.e., the The second step of the DSDL mapping procedure, i.e., the
transformation of the hybrid schema to RELAX NG, Schematron and DSRL transformation of the hybrid schema to RELAX NG, Schematron and DSRL
schemas, is unaffected by the inclusion of "md:annotation". schemas, is unaffected by the inclusion of "md:annotation".
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).
<CODE BEGINS> file "ietf-yang-metadata@2016-01-28.yang" RFC Editor: Also please replace all occurrences of 'RFC 6020bis' with
the actual RFC number that will be assigned to
[I-D.ietf-netmod-rfc6020bis].
<CODE BEGINS> file "ietf-yang-metadata@2016-02-24.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";
contact contact
"WG Web: <http://tools.ietf.org/wg/netmod/> "WG Web: <http://tools.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org> WG List: <mailto:netmod@ietf.org>
WG Chair: Thomas Nadeau WG Chair: Lou Berger
<mailto:tnadeau@lucidvision.com> <mailto:lberger@labn.net>
WG Chair: Juergen Schoenwaelder WG Chair: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de> <mailto:j.schoenwaelder@jacobs-university.de>
WG Chair: Kent Watsen WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net> <mailto:kwatsen@juniper.net>
Editor: Ladislav Lhotka Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz>"; <mailto:lhotka@nic.cz>";
description description
"This YANG module defines an extension statement that allows for "This YANG module defines an extension statement that allows for
defining metadata annotations. defining metadata annotations.
Copyright (c) 2015 IETF Trust and the persons identified as Copyright (c) 2016 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
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).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as described
in RFC 2119 (http://tools.ietf.org/html/rfc2119).
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-01-28 { revision 2016-02-24 {
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
YANG modules. The 'md:annotation' statement can appear only at YANG modules. The 'md:annotation' statement can appear only at
the top level of a YANG module. the top level of a YANG module or submodule, i.e. it becomes a
new alternative in the ABNF production rule for 'body-stmts'
(sec. 14 in RFC 6020bis).
The argument of the 'md:annotation' statement defines the name The argument of the 'md:annotation' statement defines the name
of the annotation. Syntactically it is a YANG identifier as of the annotation. Syntactically it is a YANG identifier as
defined in RFC 6020bis, sec. 6.2. defined in RFC 6020bis, sec. 6.2.
An annotation defined with this extension statement inherits An annotation defined with this extension statement inherits
the namespace and other context from the YANG module in which the namespace and other context from the YANG module in which
it is defined. it is defined.
Data type of the annotation value is specified in the same way Data type of the annotation value is specified in the same way
skipping to change at page 17, line 21 skipping to change at page 17, line 23
The author wishes to thank Andy Bierman, Martin Bjorklund, Benoit The author wishes to thank Andy Bierman, Martin Bjorklund, Benoit
Claise, Juergen Schoenwaelder, and Kent Watsen for their helpful Claise, Juergen Schoenwaelder, and Kent Watsen for their helpful
comments and suggestions. comments and suggestions.
11. References 11. References
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-09 (work in progress), draft-ietf-netmod-rfc6020bis-11 (work in progress),
December 2015. 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-06 (work in progress), October draft-ietf-netmod-yang-json-08 (work in progress),
2015. February 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 43 skipping to change at page 18, line 48
[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 -01 and -02 A.1. Changes Between Revisions -03 and -04
o Added explanation of what "top level of a module" means.
A.2. 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.2. Changes Between Revisions -01 and -02 A.3. 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 27 skipping to change at page 19, line 33
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.3. Changes Between Revisions -00 and -01 A.4. 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.4. Changes Between draft-lhotka-netmod-yang-metadata-01 and draft- A.5. 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.5. Changes Between draft-lhotka-netmod-yang-metadata-00 and -01 A.6. 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. 18 change blocks. 
29 lines changed or deleted 35 lines changed or added

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