| NETCONF Working Group | Z. Wang |
| Internet-Draft | Q. Wu |
| Intended status: Standards Track | Huawei |
| Expires: September 4, 2020 | P. Liu |
| H. Cai | |
| China Mobile | |
| March 3, 2020 |
Bulk Subscription to YANG Event Notification
draft-wang-netconf-bulk-subscribed-notifications-01
This document defines a YANG data model and associated mechanism that allows subscriber applications to bulk subscribe to publishers' event streams based on group identifier. This allows the publishers to report multiple notifications in a single bundling message.
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 September 4, 2020.
Copyright (c) 2020 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 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.
The Subscription to YANG Notifications specification [RFC8639] uses a "stream" name in subscription protocol operation for identifying the targeted event stream against which the subscription is applied and supports multiple subscriptions on a single transport session. Notification Message Headers and Bundles [I-D.ietf-netconf-notification-messages] allows multiple notifications bundled into one transportable message. However the subscription protocol operation doesn't provide specific criteria to classify subscriptions and therefore lacks the capability to explicitly indicate which specific subscription associated with the notification should be bundled together,e.g., subscription A and B are bundled based on their relationship with a set of YANG data models while subscription C and D are bundled based on "transport" and "encoding" parameters,both bundled groups are transported in the same transport session. A group identifier associated with a set of subscriptions or YANG data models enables the ability to perform encapsulation operation on a set of subscriptions with common characteristics via a single transaction. The group identifier provides a more optimal mechanism for notification encapsulation which would otherwise require multiple atomic transactions on a per subscription (i.e., one message per notification) basis. Following are some of the use-cases where such identifier can be used.
This document defines a YANG data model and associated mechanism that classify subscription based on various different filtering criteria and allow subscriber applications to bulk subscribe/unsubscribe to publishers' event streams based on group identifier. This allows the publishers to report multiple notification in a single bundling message defined in [I-D.ietf-netconf-notification-messages].
The key words "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] [RFC8174] when, and only when, they appear in all capitals, as shown here.
This document uses the following terms:
The YANG data model for the Bulk Subscriptions to YANG Event Notification has been split into two modules:
The following tree diagrams [RFC8340] provide an overview of the data model for "ietf-bulk-subscription.yang" module and the "ietf-bulk-notification.yang" module.
module: ietf-bulk-subscription
+--rw bundle-groups
+--rw bundle-group* [group-id]
+--rw group-id string
+--rw subscription-id* leafref
+--rw yang-module* yang:yang-identifier
augment /sn:subscriptions/sn:subscription:
+--rw max-bundle-latency uint32
+--rw compression-algorithm string
+---x bundle-subscription
+---input
+---w group-id? -> /bundle-groups/bundle-group/group-id
+---w max-bundle-latency uint32
+---w compression-algorithm string
+---w subscription-id* subscription-id
+---w masked-subscription-id* subscription-id
module: ietf-bulk-notification
augment-structure /nm:message/nm:message-header:
+--rw group-id? string
+--rw compression-algorithm string
<CODE BEGINS> file "ietf-bulk-subscription@2019-09-23.yang"
module ietf-bulk-subscription {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bulk-subscription";
prefix bs;
import ietf-subscribed-notifications {
prefix sn;
}
import ietf-yang-types {
prefix yang;
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"";
description
"NETCONF Protocol Data Types and Protocol Operations.
Copyright (c) 2011 IETF Trust and the persons identified as
the document authors. 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 6241; see
the RFC itself for full legal notices.";
revision 2019-09-23 {
description
"Initial revision";
reference "RFC XXXX: Bulk Subscription to YANG Event Notification";
}
identity encode-cbor {
base sn:encoding;
description
"Encode data using cbor.";
}
identity encode-gpb {
base sn:encoding;
description
"Encode data using gpb.";
}
container bundle-groups {
list bundle-group {
key "group-id";
leaf group-id {
type string;
description
"This group ID is used as an index within the bulk subscription module
, which indicates subscription classification criteria.";
}
leaf-list subscription-id {
type leafref {
path "/sn:subscriptions/sn:subscription/sn:id";
}
description
"subscription-id";
}
leaf-list yang-module {
type yang:yang-identifier;
description
"Name of the YANG module list supported by the publisher.";
}
description
"List for group that classify different subscriptions into groups.";
}
leaf compression-algorithm {
type string;
description
"The technology with which an originator compress bytestream
contents.";
}
description
"Container for subscription group.";
}
augment "/sn:subscriptions/sn:subscription" {
leaf max-bundle-latency {
type uint32;
units centiseconds;
default 400;
description
"The maximum latency before a specific YANG Notifications generated
must egress a publisher.";
}
leaf compression-algorithm {
type string;
description
"The technology with which an originator compress bytestream
contents.";
}
description
"Augment the subscribed-notifications module with transport specific inforamtion.";
}
rpc bundle-subscription {
description
"Bundle subscription. This paremeter indicates what subscription must be bundled together.";
input {
leaf group-id {
type string;
description
"This group ID is used as an index within the bulk subscription module";
}
leaf-list subscription-id {
type uint32;
description
"Subscription-id paremeter indicates what subscription must be bundled together.";
}
leaf-list mask-subscription-id {
type uint32;
description
"Mask subscription-id paremeter indicates what subscription must
not be bundled together.";
}
leaf max-bundle-latency {
type uint32;
units centiseconds;
default 400;
description
"The maximum latency before a specific YANG Notifications generated
must egress a publisher.";
}
leaf compression-algorithm {
type string;
description
"The technology with which an originator compress bytestream
contents.";
}
}
}
}
<CODE ENDS>
<CODE BEGINS> file "ietf-bulk-notification@2019-09-23.yang"
module ietf-bulk-notification {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bulk-notification";
prefix bn;
import ietf-yang-structure-ext {
prefix sx;
}
import ietf-notification-messages {
prefix nm;
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"";
description
"NETCONF Protocol Data Types and Protocol Operations.
Copyright (c) 2011 IETF Trust and the persons identified as
the document authors. 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 6241; see
the RFC itself for full legal notices.";
revision 2019-09-23 {
description
"Initial revision";
reference
"RFC XXXX: Bulk Subscription to YANG Event Notification";
}
sx:augment-structure "/nm:message/nm:message-header" {
leaf group-id {
type string;
description
"To identify the group to which a set of notifications belongs.";
}
leaf compression-algorithm {
type string;
description
"The technology with which an originator compress bytestream
contents.";
}
description
"Group related informations are added to the 'message-header' of
the ietf-notification-messages to identify the group to which a
set of notifications belongs." and compression algorithms used by
the publisher.;
}
}
<CODE ENDS>
This document registers two URIs in the IETF XML registry [RFC3688]. Following the format in [RFC3688], the following registrations are requested to be made:
---------------------------------------------------------------------
URI: urn:ietf:params:xml:ns:yang:ietf-bulk-subscription
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-bulk-notification
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
---------------------------------------------------------------------
This document registers two YANG modules in the YANG Module Names registry [RFC7950]. . Following the format in [RFC6020], the following registration has been made:
---------------------------------------------------------------------
Name: ietf-bulk-subscription
Namespace: urn:ietf:params:xml:ns:yang:ietf-bulk-subscription
Prefix: trig
Reference: RFC xxxx
Name: ietf-bulk-notification
Namespace: urn:ietf:params:xml:ns:yang:ietf-bulk-notification
Prefix: evt
Reference: RFC xxxx
---------------------------------------------------------------------
The YANG module specified in this document defines a schema for data that is designed to be accessed via network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446].
The NETCONF Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.
There are a number of data nodes defined in this YANG module that are writable/creatable/deletable (i.e., config true, which is the default). These data nodes may be considered sensitive in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability:
Thanks to Eric Voit for reviewing this draft and providing important input to this document.
| [RFC3688] | Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004. |
| [RFC6020] | Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010. |
| [RFC8340] | Bjorklund, M. and L. Berger, "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018. |