Restconf subscription and HTTP push for YANG datastores
draft-voit-netconf-restconf-yang-push-01

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2015-11-13
Replaces draft-voit-restconf-yang-push
Replaced by draft-voit-netconf-restconf-notif
Stream (None)
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
NETCONF                                                          E. Voit
Internet-Draft                                                  A. Clemm
Intended status: Informational                               A. Tripathy
Expires: May 15, 2016                                  E. Nilsen-Nygaard
                                                      A. Gonzalez Prieto
                                                           Cisco Systems
                                                       November 12, 2015

        Restconf subscription and HTTP push for YANG datastores
                draft-voit-netconf-restconf-yang-push-01

Abstract

   This document defines Restconf subscription and push mechanisms to
   continuously stream information from YANG datastores over HTTP.
   These mechanisms allow client applications or operations support
   systems to request custom sets of updates from a YANG datastore.
   This document also specifies how to stream updates over HTTP without
   Restconf.  In either case, updates are pushed by a datastore to a
   receiver per a subscription policy, without requiring continuous
   requests.

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 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 May 15, 2016.

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

Voit, et al.              Expires May 15, 2016                  [Page 1]
Internet-Draft                Restconf Push                November 2015

   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  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  Subscription Model  . . . . . . . . . . . . . . . . . . .   4
     3.2.  Subscription states at Publisher  . . . . . . . . . . . .   5
     3.3.  Mechanisms for Subscription Establishment and Maintenance   6
     3.4.  Negotiation of Subscription Policies  . . . . . . . . . .   8
     3.5.  Support for Periodic and On-change  . . . . . . . . . . .   8
     3.6.  Filters and Streams . . . . . . . . . . . . . . . . . . .   9
     3.7.  Authorization . . . . . . . . . . . . . . . . . . . . . .   9
     3.8.  Subscription Multiplexing . . . . . . . . . . . . . . . .   9
     3.9.  Push Data Stream and Transport Mapping  . . . . . . . . .  10
     3.10. YANG Tree . . . . . . . . . . . . . . . . . . . . . . . .  14
   4.  YANG Module . . . . . . . . . . . . . . . . . . . . . . . . .  15
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .  18
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  18
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .  19
     6.2.  Informative References  . . . . . . . . . . . . . . . . .  19
   Appendix A.  Dynamic YANG Subscription when the Subscriber and
                Receiver are different . . . . . . . . . . . . . . .  20
   Appendix B.  End-to-End Deployment Guidance . . . . . . . . . . .  21
     B.1.  Call Home . . . . . . . . . . . . . . . . . . . . . . . .  21
     B.2.  TLS Heartbeat . . . . . . . . . . . . . . . . . . . . . .  21
     B.3.  Putting it together . . . . . . . . . . . . . . . . . . .  22
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  22

1.  Introduction

   Requirements for subscriptions to YANG datastores are defined in
   [pub-sub-reqs].  Mechanisms to support YANG subscriptions and
   datastore object push over a NETCONF are defined in
   [netconf-yang-push].  Restconf support of subscriptions, with HTTP
   transport of pushed updates is also needed by the market.  This
   document provides such a specification.

   Key benefits of pushing data via HTTP include:

   o  Ability to configure static subscriptions on a Publisher
Show full document text