--- 1/draft-ietf-netconf-nmda-restconf-04.txt 2018-10-09 01:13:13.729695109 -0700 +++ 2/draft-ietf-netconf-nmda-restconf-05.txt 2018-10-09 01:13:13.753695682 -0700 @@ -1,25 +1,25 @@ Network Working Group M. Bjorklund Internet-Draft Tail-f Systems Updates: 8040 (if approved) J. Schoenwaelder Intended status: Standards Track Jacobs University -Expires: October 22, 2018 P. Shafer +Expires: April 12, 2019 P. Shafer K. Watsen Juniper Networks R. Wilton Cisco Systems - April 20, 2018 + October 9, 2018 RESTCONF Extensions to Support the Network Management Datastore Architecture - draft-ietf-netconf-nmda-restconf-04 + draft-ietf-netconf-nmda-restconf-05 Abstract This document extends the RESTCONF protocol defined in RFC 8040 in order to support the Network Management Datastore Architecture defined in RFC 8342. This document updates RFC 8040 by introducing new datastore resources, adding a new query parameter, and requiring the usage of I-D.ietf-netconf-rfc7895bis by RESTCONF servers implementing the @@ -36,21 +36,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 October 22, 2018. + This Internet-Draft will expire on April 12, 2019. Copyright Notice Copyright (c) 2018 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 @@ -133,46 +133,48 @@ NMDA. 3.1. New Datastore Resources This document defines a set of new resources representing datastores as defined in [RFC8342]. These resources are available using the following resource path template: {+restconf}/ds/ - The path component is encoded as an "identity" according - to the JSON encoding rules for identities, defined in Section 4 of - [RFC7951]. Such an identity MUST be derived from the "datastore" - identity defined in the "ietf-datastores" YANG module [RFC8342]. + The path component is encoded as an "identityref" + according to the JSON encoding rules for identities, defined in + Section 6.8 of [RFC7951]. The namespace-qualified form MUST be used. + Such an identity MUST be derived from the "datastore" identity + defined in the "ietf-datastores" YANG module [RFC8342]. Specifically: o The resource {+restconf}/ds/ietf-datastores:operational refers to the operational state datastore. o The resource {+restconf}/ds/ietf-datastores:running refers to the running configuration datastore. o The resource {+restconf}/ds/ietf-datastores:intended refers to the intended configuration datastore. An NMDA-compliant server MUST implement {+restconf}/ds/ietf- - datastores:operational. Other datastore resources are optional to - implement. + datastores:operational. Other datastore resources MAY be + implemented. YANG actions can only be invoked in {+restconf}/ds/ietf- datastores:operational. - If a server implements the example datastore "ds-ephemeral" in the - module "example-ds-ephemeral", it would implement the resource - {+restconf}/ds/example-ds-ephemeral:ds-ephemeral. + If a server implements other datastores, such as the example + datastore "ds-ephemeral" in the module "example-ds-ephemeral", the + server would implement the resource {+restconf}/ds/example- ds- + ephemeral:ds-ephemeral. 3.2. Protocol Operations The protocol operations available for the new datastore resources (Section 3.1) are the same as the protocol operations defined in [RFC8040] for the {+restconf}/data resource with the following exceptions: o Dynamic configuration datastores are excluded, as each dynamic configuration datastore definition needs to be reviewed for what @@ -186,21 +188,21 @@ o The semantics of the "with-defaults" query parameter ([RFC8040], Section 4.8.9) differs when interacting with the operational state datastore. The semantics are described below, in Section 3.2.1. o [RFC8040], Section 3.5.4, paragraph 3 does not apply when interacting with any resource under {+restconf}/ds. 3.2.1. With-defaults query parameter on the operational state datastore The "with-defaults" query parameter ([RFC8040], Section 4.8.9) is - optional to support when interacting with {+restconf}/ds/ietf- + OPTIONAL to support when interacting with {+restconf}/ds/ietf- datastores:operational. The associated capability to indicate a server's support is identified with the URI: urn:ietf:params:restconf:capability:with-operational-defaults:1.0 For servers that support it, the behavior of the "with-defaults" query parameter on the operational state datastore is defined as follows: o If no "with-defaults" query parameter is specified, or if it is @@ -239,21 +241,21 @@ Data in the operational state datatstore can come from multiple sources. The server should return the most accurate value for the "origin" metadata annotation as possible, indicating the source of the operational value, as specified in Section 5.3.4 of [RFC8342]. When encoding the origin metadata annotation for a hierarchy of returned nodes, the annotation can be omitted for a child node when the value matches that of the parent node, as described in "ietf-origin" YANG module [RFC8342]. - The "with-origin" query parameter is optional to support. It is + The "with-origin" query parameter is OPTIONAL to support. It is identified with the URI: urn:ietf:params:restconf:capability:with-origin:1.0 4. IANA Considerations This document defines two capability identifier URNs in the "RESTCONF Capability URNs" registry defined in [RFC8040]: Index @@ -261,71 +263,70 @@ --------------------- :with-origin urn:ietf:params:restconf:capability:with-origin:1.0 :with-operational-defaults urn:ietf:params:restconf:capability:with-operational-defaults:1.0 5. Security Considerations - This documents extends the RESTCONF protocol by introducing new + This document extends the RESTCONF protocol by introducing new datastore resources. The lowest RESTCONF layer is HTTPS, and the - mandatory-to-implement secure transport is TLS [RFC5246]. The + mandatory-to-implement secure transport is TLS [RFC8446]. The RESTCONF protocol uses the network configuration access control model [RFC8341], which provides the means to restrict access for particular RESTCONF users to a preconfigured subset of all available RESTCONF protocol operations and content. The security constraints for the base RESTCONF protocol (see - Section 12 of [RFC8040] apply to the new RESTCONF datastore resources - defined in this document. + Section 12 of [RFC8040]) apply to the new RESTCONF datastore + resources defined in this document. 6. Normative References [I-D.ietf-netconf-rfc7895bis] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., and R. Wilton, "YANG Library", draft-ietf-netconf- rfc7895bis-06 (work in progress), April 2018. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate - Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ - RFC2119, March 1997, . - - [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security - (TLS) Protocol Version 1.2", RFC 5246, DOI 10.17487/ - RFC5246, August 2008, . + Requirement Levels", BCP 14, RFC 2119, + DOI 10.17487/RFC2119, March 1997, . - [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", RFC - 7951, DOI 10.17487/RFC7951, August 2016, . + [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", + RFC 7951, DOI 10.17487/RFC7951, August 2016, + . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration - Access Control Model", STD 91, RFC 8341, DOI 10.17487/ - RFC8341, March 2018, . + Access Control Model", STD 91, RFC 8341, + DOI 10.17487/RFC8341, March 2018, . [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, . + [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol + Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, + . + Authors' Addresses Martin Bjorklund Tail-f Systems Email: mbj@tail-f.com Juergen Schoenwaelder Jacobs University Email: j.schoenwaelder@jacobs-university.de