RESTCONF and HTTP Transport for Event Notifications
draft-ietf-netconf-restconf-notif-04

The information below is for an old version of the document
Document Type Active Internet-Draft (netconf WG)
Last updated 2018-01-31
Replaces draft-voit-netconf-restconf-notif
Stream IETF
Intended RFC status (None)
Formats pdf htmlized bibtex
Reviews
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)
NETCONF                                                          E. Voit
Internet-Draft                                               A. Tripathy
Intended status: Standards Track                       E. Nilsen-Nygaard
Expires: August 4, 2018                                    Cisco Systems
                                                                A. Clemm
                                                                  Huawei
                                                      A. Gonzalez Prieto
                                                                  VMWare
                                                              A. Bierman
                                                               YumaWorks
                                                        January 31, 2018

          RESTCONF and HTTP Transport for Event Notifications
                  draft-ietf-netconf-restconf-notif-04

Abstract

   This document defines RESTCONF, HTTP2, and HTTP1.1 bindings for the
   transport of subscription requests and corresponding push updates.
   Being subscribed may be either publisher defined event streams or
   nodes/subtrees of YANG Datastores.

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 4, 2018.

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
   (https://trustee.ietf.org/license-info) in effect on the date of

Voit, et al.             Expires August 4, 2018                 [Page 1]
Internet-Draft               RESTCONF-Notif                 January 2018

   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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Solution  . . . . . . . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Dynamic YANG Subscription with RESTCONF control . . . . .   3
   4.  Mandatory JSON and datastore support  . . . . . . . . . . . .   6
   5.  Notification Messages . . . . . . . . . . . . . . . . . . . .   7
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .   7
   7.  Acknowledgments . . . . . . . . . . . . . . . . . . . . . . .   7
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   7
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .   7
     8.2.  Informative References  . . . . . . . . . . . . . . . . .   8
   Appendix A.  End-to-End Deployment Guidance . . . . . . . . . . .   9
     A.1.  Call Home . . . . . . . . . . . . . . . . . . . . . . . .   9
     A.2.  TLS Heartbeat . . . . . . . . . . . . . . . . . . . . . .   9
   Appendix B.  RESTCONF over GRPC . . . . . . . . . . . . . . . . .   9
   Appendix C.  Encoded Subscription and Notification Message
                Examples . . . . . . . . . . . . . . . . . . . . . .  10
     C.1.  RESTCONF Subscription and Events over HTTP1.1 . . . . . .  10
     C.2.  Event Notification over HTTP2 . . . . . . . . . . . . . .  14
   Appendix D.  Changes between revisions  . . . . . . . . . . . . .  14
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  15

1.  Introduction

   Mechanisms to support event subscription and push are defined in
   [I-D.draft-ietf-netconf-subscribed-notifications].  Enhancements to
   [I-D.draft-ietf-netconf-subscribed-notifications] which enable YANG
   Datastore subscription and push are defined in
   [I-D.ietf-netconf-yang-push].  This document provides a transport
   specification for these protocols over RESTCONF and HTTP.  Driving
   these requirements is [RFC7923].

   The streaming of notifications encapsulating the resulting
   information push can be done with either HTTP1.1 and HTTP2.  When
   using HTTP2 [RFC7540] benefits which can be realized include:

   o  Elimination of head-of-line blocking

Voit, et al.             Expires August 4, 2018                 [Page 2]
Show full document text