--- 1/draft-ietf-netconf-yang-patch-02.txt 2015-01-30 18:15:02.655536624 -0800 +++ 2/draft-ietf-netconf-yang-patch-03.txt 2015-01-30 18:15:02.735538569 -0800 @@ -1,23 +1,21 @@ Network Working Group A. Bierman Internet-Draft YumaWorks Intended status: Standards Track M. Bjorklund -Expires: July 6, 2015 Tail-f Systems +Expires: August 3, 2015 Tail-f Systems K. Watsen Juniper Networks - R. Fernando - Cisco - January 2, 2015 + January 30, 2015 YANG Patch Media Type - draft-ietf-netconf-yang-patch-02 + draft-ietf-netconf-yang-patch-03 Abstract This document describes a method for applying patches to NETCONF datastores using data defined with the YANG data modeling language. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. @@ -25,21 +23,21 @@ 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 July 6, 2015. + This Internet-Draft will expire on August 3, 2015. Copyright Notice Copyright (c) 2015 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 (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents @@ -49,67 +47,73 @@ the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 3 1.1.2. HTTP . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1.3. YANG . . . . . . . . . . . . . . . . . . . . . . . . 4 - 1.1.4. Terms . . . . . . . . . . . . . . . . . . . . . . . . 5 - 1.1.5. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 5 - 2. YANG Patch . . . . . . . . . . . . . . . . . . . . . . . . . 5 + 1.1.4. RESTCONF . . . . . . . . . . . . . . . . . . . . . . 5 + 1.1.5. Terms . . . . . . . . . . . . . . . . . . . . . . . . 5 + 1.1.6. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 5 + 2. YANG Patch . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1. Target Resource . . . . . . . . . . . . . . . . . . . . . 6 2.2. yang-patch Input . . . . . . . . . . . . . . . . . . . . 6 - 2.3. yang-patch-status Output . . . . . . . . . . . . . . . . 6 + 2.3. yang-patch-status Output . . . . . . . . . . . . . . . . 7 2.4. Target Data Node . . . . . . . . . . . . . . . . . . . . 7 - 2.5. Edit Operations . . . . . . . . . . . . . . . . . . . . . 7 + 2.5. Edit Operations . . . . . . . . . . . . . . . . . . . . . 8 2.6. Error Handling . . . . . . . . . . . . . . . . . . . . . 8 - 3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 8 - 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17 - 4.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 17 - 4.2. application/yang.patch Media Types . . . . . . . . . . . 17 + 2.7. yang-patch RESTCONF Capability . . . . . . . . . . . . . 9 + 3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 9 + 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18 + 4.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 18 + 4.2. application/yang.patch Media Types . . . . . . . . . . . 18 4.3. application/yang.patch-status Media Types . . . . . . . . 18 - 5. Security Considerations . . . . . . . . . . . . . . . . . . . 18 - 6. Normative References . . . . . . . . . . . . . . . . . . . . 18 - Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 19 - A.1. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 19 - A.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 20 - A.3. bierman:yang-patch-00 to ietf:yang-patch-00 . . . . . . . 21 - Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 21 - Appendix C. Example YANG Module . . . . . . . . . . . . . . . . 21 - C.1. YANG Patch Examples . . . . . . . . . . . . . . . . . . . 22 - C.1.1. Add Resources: Error . . . . . . . . . . . . . . . . 22 - C.1.2. Add Resources: Success . . . . . . . . . . . . . . . 24 - C.1.3. Move list entry example . . . . . . . . . . . . . . . 25 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 26 + 4.4. RESTCONF Capability URNs . . . . . . . . . . . . . . . . 19 + 5. Security Considerations . . . . . . . . . . . . . . . . . . . 19 + 6. Normative References . . . . . . . . . . . . . . . . . . . . 20 + Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 20 + Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 20 + B.1. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 21 + B.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 21 + B.3. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 21 + B.4. bierman:yang-patch-00 to ietf:yang-patch-00 . . . . . . . 22 + Appendix C. Open Issues . . . . . . . . . . . . . . . . . . . . 22 + Appendix D. Example YANG Module . . . . . . . . . . . . . . . . 22 + D.1. YANG Patch Examples . . . . . . . . . . . . . . . . . . . 23 + D.1.1. Add Resources: Error . . . . . . . . . . . . . . . . 23 + D.1.2. Add Resources: Success . . . . . . . . . . . . . . . 25 + D.1.3. Move list entry example . . . . . . . . . . . . . . . 27 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 28 1. Introduction There is a need for standard mechanisms to patch NETCONF [RFC6241] datastores which contain conceptual data that conforms to schema specified with YANG [RFC6020]. An "ordered edit list" approach is needed to provide client developers with a simpler edit request format that can be more efficient and also allow more precise client control of the transaction procedure than existing mechanisms. This document defines a media type for a YANG-based editing mechanism that can be used with the HTTP PATCH method [RFC5789] or custom NETCONF operations (defined with the YANG rpc-stmt). YANG Patch is designed to support multiple protocols with the same - mechanisms. The RESTCONF [RESTCONF] protocol utilizes YANG Patch - with the HTTP PATCH method. A new RPC operation can be defined to - utilize YANG Patch in the NETCONF protocol. Both the RESTCONF and - NETCONF protocols are designed to utilize the YANG data modeling - language to specify content schema modules. + mechanisms. The RESTCONF protocol defined in + [I-D.ietf-netconf-restconf] utilizes YANG Patch with the HTTP PATCH + method. A new RPC operation can be defined to utilize YANG Patch in + the NETCONF protocol. Both the RESTCONF and NETCONF protocols are + designed to utilize the YANG data modeling language to specify + content schema modules. 1.1. Terminology 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.1.1. NETCONF @@ -178,36 +182,50 @@ o presence container (or P-container) o RPC operation (now called protocol operation) o non-presence container (or NP-container) o ordered-by system o ordered-by user -1.1.4. Terms +1.1.4. RESTCONF + + The following terms are defined in [I-D.ietf-netconf-restconf]: + + o data resource + + o datasource resource + + o patch + + o RESTCONF capability + + o target resource + +1.1.5. Terms The following terms are used within this document: o YANG Patch: a conceptual edit request using the "yang-patch" YANG container, defined in Section 3. In HTTP, refers to a PATCH method where the media type is "application/yang.patch+xml" or "application/yang.patch+json". o YANG Patch Status: a conceptual edit status response using the YANG "yang-patch-status" container, defined in Section 3. In HTTP, refers to a response message for a PATCH method, where the message body is identified by the media type "application/ yang.patch-status+xml" or "application/yang.patch-status+json". -1.1.5. Tree Diagrams +1.1.6. Tree Diagrams A simplified graphical representation of the data model is used in this document. The meaning of the symbols in these diagrams is as follows: o Brackets "[" and "]" enclose list keys. o Abbreviations before data node names: "rw" means configuration (read-write) and "ro" state data (read-only). @@ -217,37 +235,35 @@ o Parentheses enclose choice and case nodes, and case nodes are also marked with a colon (":"). o Ellipsis ("...") stands for contents of subtrees that are not shown. 2. YANG Patch A "YANG Patch" is an ordered list of edits that are applied to the target datastore by the server. The specific fields are defined with - the 'yang-patch' container definition in the YANG module Section 3. + the 'application/yang.patch' extension definition in the YANG module + Section 3. For RESTCONF, the YANG Patch operation is invoked by the client by sending a PATCH method request with the YANG Patch media type. A message body representing the YANG Patch input parameters MUST be provided. The RESTCONF server MUST return the Accept-Patch header in an OPTIONS response, as specified in [RFC5789], which includes the media type - for YANG Patch. Example: + for YANG Patch. - Accept-Patch: application/yang.patch, application/yang.data + Example: - For NETCONF, a YANG "rpc" statement needs to be defined. The - "yang-patch" grouping MUST be included in the input parameters and - the "yang-patch-status" grouping MUST be included in the output - parameters. + Accept-Patch: application/yang.patch 2.1. Target Resource The YANG Patch operation uses a conceptual root within a NETCONF configuration datastore to identity the patch point for the edit operation. This root can be the datastore itself, or 1 or more data nodes within the datastore. For RESTCONF, the target resource is derived from the request URI. @@ -271,21 +286,23 @@ +--rw target target-resource-offset +--rw point? target-resource-offset +--rw where? enumeration +--rw value 2.3. yang-patch-status Output A data element representing the YANG Patch Status is returned to the client to report the detailed status of the edit operation. When used with the HTTP PATCH method, this data is identified by the YANG - Patch Status media type. + Patch Status media type, and the syntax specification is defined by + the 'application/yang.patch-status' extension statement defined in + Section 3. YANG Tree Diagram For "yang-patch-status" Container: +--rw yang-patch-status +--rw patch-id? string +--rw (global-status)? | +--:(global-errors) | | +--ro errors | | | +--:(ok) @@ -334,128 +351,143 @@ | replace | replace the target data resource with the edit value | | remove | remove a data resource if it already exists or no | | | error | +-----------+-------------------------------------------------------+ YANG Patch Edit Operations 2.6. Error Handling If a well-formed, schema-valid YANG Patch message is received, then - then the server will process the supplied edits in ascending order. - The following error modes apply to the processing of this edit list: + the server will process the supplied edits in ascending order. The + following error modes apply to the processing of this edit list: All the specified edits MUST be applied or the target datastore contents SHOULD be returned to its original state before the PATCH method started. The server MAY fail to restore the contents of the target datastore completely and with certainty. It is possible for a rollback to fail or an "undo" operation to fail. The server will save the running datastore to non-volatile storage if it has changed, after the edits have been attempted. -3. YANG Module +2.7. yang-patch RESTCONF Capability - The "ietf-yang-patch" module defines conceptual definitions within - groupings, which are not meant to be implemented as datastore - contents by a server. + A URI is defined to identify the YANG Patch extension to the base + RESTCONF protocol. If the server supports the YANG Patch media type, + then the "yang-patch" RESTCONF capability defined in Section 4.4 MUST + be present in the "capability" leaf-list in the + "ietf-restconf-monitoring" module defined in + [I-D.ietf-netconf-restconf]. - The "ietf-yang-types" and "ietf-inet_types" modules from [RFC6991] - are used by this module for some type definitions. +3. YANG Module - The "ietf-restconf" module from [RESTCONF] is used by this module for - a grouping definition. + The "ietf-yang-patch" module defines conceptual definitions with the + 'restconf-media-type' extension statements, which are not meant to be + implemented as datastore contents by a server. + + The "ietf-restconf" module from [I-D.ietf-netconf-restconf] is used + by this module for the 'restconf-media-type' extension definition. RFC Ed.: update the date below with the date of RFC publication and remove this note. - file "ietf-yang-patch@2015-01-02.yang" + file "ietf-yang-patch@2015-01-24.yang" + module ietf-yang-patch { namespace "urn:ietf:params:xml:ns:yang:ietf-yang-patch"; prefix "ypatch"; - import ietf-restconf { prefix rc; } + import ietf-restconf { + prefix rc; + revision-date 2015-01-30; + } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: - WG Chair: Bert Wijnen - - WG Chair: Mehmet Ersue + WG Chair: Mahesh Jethanandani + + Editor: Andy Bierman Editor: Martin Bjorklund Editor: Kent Watsen - - - Editor: Rex Fernando - "; + "; description "This module contains conceptual YANG specifications for the YANG Patch and YANG Patch Status data structures. Note that the YANG definitions within this module do not represent configuration data of any kind. The YANG grouping statements provide a normative syntax for XML and JSON message encoding purposes. - Copyright (c) 2014 IETF Trust and the persons identified as + Copyright (c) 2015 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: remove this note - // Note: extracted from draft-ietf-netconf-yang-patch-02.txt + // Note: extracted from draft-ietf-netconf-yang-patch-03.txt // RFC Ed.: update the date below with the date of RFC publication // and remove this note. - revision 2015-01-02 { + revision 2015-01-30 { description "Initial revision."; reference - "RFC XXXX: YANG Patch"; + "RFC XXXX: YANG Patch Media Type."; } typedef target-resource-offset { type string { length "1 .. max"; } description "Contains a relative Data Resource Identifier formatted string to identify a specific data sub-resource instance. The document root for all data resources is a target data resource that is specified in the object definition using this data type."; } + rc:restconf-media-type "application/yang.patch" { + uses yang-patch; + } + + rc:restconf-media-type "application/yang.patch-status" { + uses yang-patch-status; + } + grouping yang-patch { description "A grouping that contains a YANG container representing the syntax and semantics of a YANG Patch edit request message."; container yang-patch { description "Represents a conceptual sequence of datastore edits, @@ -826,30 +854,56 @@ Encoding considerations: TBD Security considerations: TBD Interoperability considerations: TBD // RFC Ed.: replace XXXX with RFC number and remove this note Published specification: RFC XXXX +4.4. RESTCONF Capability URNs + + This document registers several capability identifiers in "RESTCONF + Protocol Capability URNs" registry + + Index + Capability Identifier + ------------------------ + + :yang-patch + urn:ietf:params:restconf:capability:yang-patch:1.0 + 5. Security Considerations - TBD + The YANG Patch media type does not introduce any significant new + security threats, beyond what is described in + [I-D.ietf-netconf-restconf]. This document defines edit processing + instructions for a variant of the PATCH method, as used within the + RESTCONF protocol. + + It is important for server implementations to carefully validate all + the edit request parameters in some manner. If the entire YANG Patch + request cannot be completed, then no configuration changes to the + system are done. + + A server implementation SHOULD attempt to prevent system disruption + due to partial processing of the YANG Patch edit list. It may be + possible to construct an attack on such a server, which relies on the + edit processing order mandated by YANG Patch. 6. Normative References - [RESTCONF] + [I-D.ietf-netconf-restconf] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF - Protocol", draft-ietf-netconf-restconf-03 (work in - progress), October 2014. + Protocol", draft-ietf-netconf-restconf-04 (work in + progress), January 2015. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004. @@ -858,48 +912,62 @@ 5789, March 2010. [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, October 2010. [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, June 2011. - [RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991, - July 2013. - [RFC7158] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", RFC 7158, March 2013. [W3C.REC-xml-20081126] Yergeau, F., Maler, E., Paoli, J., Sperberg-McQueen, C., and T. Bray, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", World Wide Web Consortium Recommendation REC- xml-20081126, November 2008, . -Appendix A. Change Log +Appendix A. Acknowledgements + + The authors would like to thank the following people for their + contributions to this document: Rex Fernando. + +Appendix B. Change Log -- RFC Ed.: remove this section before publication. -A.1. 01 to 02 +B.1. 02 to 03 + + o added usage of restconf-media-type extension to map the yang-patch + and yang-patch-status groupings to media types + + o added yang-patch RESTCONF capability URI + + o Added sub-section for terms used from RESTCONF + + o filled in security considerations section + +B.2. 01 to 02 o Reversed order of change log + o Clarified anyxml structure of "value" parameter within a YANG patch request (github issue #1) o Updated RESTCONF reference o Added note to open issues section to check github instead -A.2. 00 to 01 +B.3. 00 to 01 o Added text requiring support for Accept-Patch header, and removed 'Identification of YANG Patch capabilities' open issue. o Removed 'location' leaf from yang-patch-status grouping o Removed open issue 'Protocol independence' because the location leaf was removed. o Removed open issue 'RESTCONF coupling' because there is no concern @@ -923,37 +991,37 @@ o Removed open issue 'Bulk editing support in yang-patch-status'. The 'location' leaf has been removed so this issue is no longer applicable. o Removed open issue 'Edit list mechanism'. Added text to the 'edit' list description-stmt about how the individual edits must be processed. There is no concern about duplicate edits which cause intermediate results to be altered by subsequent edits in the same edit list. -A.3. bierman:yang-patch-00 to ietf:yang-patch-00 +B.4. bierman:yang-patch-00 to ietf:yang-patch-00 o Created open issues section -Appendix B. Open Issues +Appendix C. Open Issues -- RFC Ed.: remove this section before publication. Refer to the github issue tracker for any open issues: https://github.com/netconf-wg/yang-patch/issues -Appendix C. Example YANG Module +Appendix D. Example YANG Module The example YANG module used in this document represents a simple media jukebox interface. The "example-jukebox" YANG module is - defined in [RESTCONF]. + defined in [I-D.ietf-netconf-restconf]. YANG Tree Diagram for "example-jukebox" Module: +--rw jukebox? +--rw library | +--rw artist [name] | | +--rw name string | | +--rw album [name] | | +--rw name string | | +--rw genre? identityref @@ -978,27 +1046,27 @@ +--rw player +--rw gap? decimal64 rpcs: +---x play +--ro input +--ro playlist string +--ro song-number uint32 -C.1. YANG Patch Examples +D.1. YANG Patch Examples This section includes RESTCONF examples. NETCONF examples are TBD. Most examples are shown in JSON encoding [RFC7158], and some are shown in XML encoding [W3C.REC-xml-20081126]. -C.1.1. Add Resources: Error +D.1.1. Add Resources: Error The following example shows several songs being added to an existing album. Each edit contains one song. The first song already exists, so an error will be reported for that edit. The rest of the edits were not attempted, since the first edit failed. Request from client: PATCH /restconf/data/example-jukebox:jukebox/ library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1 @@ -1080,21 +1149,21 @@ "Data already exists, cannot be created" } ] } } ] } } } -C.1.2. Add Resources: Success +D.1.2. Add Resources: Success The following example shows several songs being added to an existing album. o Each of 2 edits contains one song. o Both edits succeed and new sub-resources are created Request from client: @@ -1147,21 +1216,21 @@ Last-Modified: Mon, 23 Apr 2012 13:01:20 GMT Content-Type: application/yang.patch-status+json { "ietf-yang-patch:yang-patch-status" : { "patch-id" : "add-songs-patch-2", "ok" : [null] } } -C.1.3. Move list entry example +D.1.3. Move list entry example The following example shows a song being moved within an existing playlist. Song "1" in playlist "Foo-One" is being moved after song "3" in the playlist. The operation succeeds, so a non-error reply example can be shown. Request from client: PATCH /restconf/data/example-jukebox:jukebox/ playlist=Foo-One HTTP/1.1 @@ -1208,15 +1277,10 @@ Email: andy@yumaworks.com Martin Bjorklund Tail-f Systems Email: mbj@tail-f.com Kent Watsen Juniper Networks Email: kwatsen@juniper.net - - Rex Fernando - Cisco - - Email: rex@cisco.com