NETCONF Working Group Z. Wang
Internet-Draft Q. Wu
Intended status: Standards Track Huawei
Expires: May 6, 2020 November 3, 2019
Bulk Subscription to YANG Event Notification
draft-wang-netconf-bulk-subscribed-notifications-00
Abstract
This document defines a YANG data model and associated mechanism that
allows subscriber applications to bulk subscribe to publishers' event
streams based on their requirements. And it also allows the
publishers to report multiple event streams or subscriptions into a
single notification message based on group identifier affiliation.
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 May 6, 2020.
Copyright Notice
Copyright (c) 2019 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.
Wang & Wu Expires May 6, 2020 [Page 1]
Internet-Draft Bulk Subscription November 2019
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Model Overview . . . . . . . . . . . . . . . . . . . . . . . 4
3. Bulk Subscription YANG Module . . . . . . . . . . . . . . . . 5
4. Bulk Notification YANG Module . . . . . . . . . . . . . . . . 6
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8
5.1. Updates to the IETF XML Registry . . . . . . . . . . . . 8
5.2. Updates to the YANG Module Names Registry . . . . . . . . 8
6. Security Considerations . . . . . . . . . . . . . . . . . . . 8
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
7.1. Normative References . . . . . . . . . . . . . . . . . . 9
7.2. Informative References . . . . . . . . . . . . . . . . . 10
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10
1. Introduction
The Subscription to YANG Notifications specification [RFC8639] uses A
"stream" name in dynamic subscription protocol operation for
identifying the targeted event stream against which the subscription
is applied. Notification Message Headers and Bundles [I-D. ietf-
netconf-notification-messages] uses subscription-id for identifying
the targeted subscription. However the dynamic subscription protocol
operation lack the capability to identify a set of event streams or a
set of subscriptions which have a common characteristic. A group
identifier associated with an event stream enables the ability to
perform protocol operation on a set of event stream via a single
transaction. The group identifier provides a more optimal mechanism
for protocol operation which would otherwise require multiple atomic
transactions on a per event stream basis. Following are some of the
use-cases where such identifier can be used.
o For establishing a Dynamic Subscription, the subscriber may send a
a single request the creation of a subscription for each of event
stream's groups and perform creation of a subscription for all
event steam's that are part of that group.
o The subscriber in dynamic subscription domain may choose to delete
a dynamic subscription or end a dynamic subscription that is not
associated with the specific transport session and domain. In
such case, the subscriber can perform delete-subscription or kill-
subscription signaling using the group ID associated with a
specific set of event streams.
o Multiple notifications (e.g., multiple notifications associated
with creation of a subscription or decomssion of subscription)
bundled into one transportable message
Wang & Wu Expires May 6, 2020 [Page 2]
Internet-Draft Bulk Subscription November 2019
This document defines a YANG data model and associated mechanism that
allows subscriber applications to bulk subscribe to publishers' event
streams based on their requirements. And it also allows the
publishers to report multiple event streams or subscriptions into a
single notification message based on group identifier affiliation.
1.1. Terminology
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:
Event: Something that happens which may be of interest or trigger
the invocation of the rule. A fault, an alarm, a change in
network state, network security threat, hardware malfunction,
buffer untilization crossing a threshold, network connection
setup, an external input to the system, for example [RFC3877].
Client: Defined in [RFC8342].
Configuration: Defined in [RFC8342].
Configured subscription: Defined in [RFC8639]
Configuration datastore: Defined in [RFC8342].
Event record: A set of information detailing an event [RFC8639].
Event stream: A continuous, chronologically ordered set of events
aggregated under some context [RFC8639].
Notification message: Information intended for a receiver
indicating that one or more events have occurred [RFC8639].
Publisher: An entity responsible for streaming notification messages
per the terms of a subscription [RFC8639].
Receiver: A target to which a publisher pushes subscribed event
records. For dynamic subscriptions, the receiver and subscriber
are the same entity [RFC8639].
Subscriber: A client able to request and negotiate a contract for
the generation and push of event records from a publisher. For
Wang & Wu Expires May 6, 2020 [Page 3]
Internet-Draft Bulk Subscription November 2019
dynamic subscriptions, the receiver and subscriber are the same
entity [RFC8639].
Subscription: A contract with a publisher, stipulating the
information that one or more receivers wish to have pushed from
the publisher without the need for further solicitation [RFC8639].
2. Model Overview
The YANG data model for the Bulk Subscriptions and Notifications has
been split into two modules:
o The ietf-bulk-subscription.yang module defines a list for
classifying different event streams into groups. Each group is
associated with a group identifier and a set of event streams. A
stream group is identified by a "group-id" string. This string is
used both as an index within the bulk subscription module and to
associate subscription with a group of streams, as shown in the
subscription augmentation.
o The ietf-bulk-notification.yang module augment the YANG structure
of ietf-notification-messages.yang [draft-ietf-netconf-
notification-messages], a "group-id" is added to the "message-
header" of the ietf-notification-messages.yang to identify the
group to which a set of notifications belongs.
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 groups
+--rw group* [group-id]
+--rw group-id string
+--rw stream* string
augment /sn:subscriptions/sn:subscription/sn:target:
+--:(stream-group)
+--rw group-id? -> /groups/group/group-id
augment /sn:establish-subscription/sn:input/sn:target:
+--:(stream-group)
+-- group-id? -> /groups/group/group-id
module: ietf-bulk-notification
augment-structure /nm:message/nm:message-header:
+--rw message-type identityref
+--rw group-id? string
Wang & Wu Expires May 6, 2020 [Page 4]
Internet-Draft Bulk Subscription November 2019
3. Bulk Subscription YANG Module
<CODE BEGINS> file "ietf-bulk-subscription@2019-10-14.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-10-14 {
description
"Initial revision";
reference
"FOO";
}
container groups {
list group {
key "group-id";
leaf group-id {
type string;
description
Wang & Wu Expires May 6, 2020 [Page 5]
Internet-Draft Bulk Subscription November 2019
"This group ID is used as an index within the bulk subscription module";
}
leaf-list stream {
type string;
description
"A continuous, chronologically ordered set of events aggregated under some context";
}
description
"List for group that classify different event streams into groups.";
}
description
"Container for event stream group";
}
augment "/sn:subscriptions/sn:subscription/sn:target" {
case stream-group {
leaf group-id {
type leafref {
path "/bs:groups/bs:group/bs:group-id";
}
description
"This group ID is used to associate subscription with a group of streams";
}
description
"Augment the subscribed-notifications module with event stream group inforamtion.";
}
}
augment "/sn:establish-subscription/sn:input/sn:target" {
case stream-group {
leaf group-id {
type leafref {
path "/bs:groups/bs:group/bs:group-id";
}
description
"This group ID is used to associate subscription with a group of streams";
}
description
"Augment the establish-subscription RPC with event stream group inforamtion.";
}
}
}
<CODE ENDS>
4. Bulk Notification YANG Module
<CODE BEGINS> file "ietf-bulk-notification@2019-09-23.yang"
module ietf-bulk-notification {
yang-version 1.1;
Wang & Wu Expires May 6, 2020 [Page 6]
Internet-Draft Bulk Subscription November 2019
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
"FOO";
}
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.";
}
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.";
}
}
<CODE ENDS>
Wang & Wu Expires May 6, 2020 [Page 7]
Internet-Draft Bulk Subscription November 2019
5. IANA Considerations
5.1. Updates to the IETF XML Registry
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.
---------------------------------------------------------------------
5.2. Updates to the YANG Module Names Registry
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
---------------------------------------------------------------------
6. Security Considerations
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
Wang & Wu Expires May 6, 2020 [Page 8]
Internet-Draft Bulk Subscription November 2019
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:
o /groups/group/group-id
o /groups/group/stream
o /sn:subscriptions/sn:subscription/sn:target/sn:stream/bs:group-id
o sn:establish-subscription/sn:input/sn:target/sn:stream /bs:group-
id
7. References
7.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
Wang & Wu Expires May 6, 2020 [Page 9]
Internet-Draft Bulk Subscription November 2019
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/info/rfc8126>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[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,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of
Documents Containing YANG Data Models", BCP 216, RFC 8407,
DOI 10.17487/RFC8407, October 2018,
<https://www.rfc-editor.org/info/rfc8407>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
7.2. Informative References
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
Authors' Addresses
Wang & Wu Expires May 6, 2020 [Page 10]
Internet-Draft Bulk Subscription November 2019
Michael Wang
Huawei
101 Software Avenue, Yuhua District
Nanjing, Jiangsu 210012
China
Email: wangzitao@huawei.com
Qin Wu
Huawei
101 Software Avenue, Yuhua District
Nanjing, Jiangsu 210012
China
Email: bill.wu@huawei.com
Wang & Wu Expires May 6, 2020 [Page 11]