| Internet-Draft | Adaptive Subscription | October 2020 |
| Wu, et al. | Expires 17 April 2021 | [Page] |
This document defines a YANG data model and associated mechanism enabling subscriber's adaptive subscriptions to a publisher's event streams with various different period intervals to report updates. Applying these elements allows both subscriber and publisher to automatically adjust the volume of telemetry traffic sent from publisher to the receivers.¶
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 17 April 2021.¶
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.¶
YANG-Push subscriptions [RFC8641] allow client applications to subscribe to continuous datastore updates without needing to poll. It defines a mechanism (i.e.,update trigger) to determine when an update record needs to be generated. Two type of subscriptions are introduced in [RFC8641], distinguished by how updates are triggered: periodic and on-change.¶
However in some large scale deployments (e.g., wireless network performance monitoring) where an increased data collection rate is being used, it becomes more likely that a burst of streamed data may temporarily overwhelm a receiver and consume expensive network resource (e.g., air interface resource). If the rate at which we can collect a stream of data is set too low, these telemetry data are not sufficient to detect and diagnose problems and verify correct network behavior. There is a need for a service to configure both collectors and publishers with multiple different period intervals and automatically switch to different period intervals according to resource usage change, e.g., when the wireless signal strength falls below a configured low watermark, the subscribed data can be streamed at a higher rate while when the wireless signal strength crosses a configured high watermark, the subscribed data can be streamed at lower rate.¶
This document defines a YANG data model and associated mechanism enabling subscriber's adaptive subscriptions to a publisher's event streams. Applying these elements allows both subscriber and publisher to automatically adjust the volume of telemetry traffic sent from publisher to the receivers.¶
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:¶
This document defines a YANG module "ietf-adaptive-subscription", which augments the "update-trigger" choice defined in the "ietf-yang-push" module [RFC8641] with subscription configuration parameters that are specific to adaptive subscription.¶
In addition to Subscription state notifications defined in [RFC8639] and Notifications for Subscribed Content defined in [RFC8641], "ietf-adaptive-subscription" YANG module also defines "adaptive-update" notification to report update interval change.¶
The following tree diagrams [RFC8340] provide an overview of the data model for "ietf-adaptive-subscription.yang" module.¶
module: ietf-adaptive-subscription
augment /sn:subscriptions/sn:subscription/yp:update-trigger:
+--rw (adaptive-subscription)?
+--:(adaptive-subscriptions)
+--rw adaptive-subscriptions
+--rw adaptive-period* [name]
+--rw name string
+--rw xpath-external-eval string
+--rw watermark? uint32
+--rw period centiseconds
+--rw anchor-time? yang:date-and-time
augment /sn:establish-subscription/sn:input/yp:update-trigger:
+-- (adaptive-subscription)?
+--:(adaptive-subscriptions)
+--rw adaptive-subscriptions
+--rw adaptive-period* [name]
+--rw name string
+--rw xpath-external-eval string
+--rw watermark? uint32
+--rw period centiseconds
+--rw anchor-time? yang:date-and-time
notifications:
+---n adaptive-period-update
+--ro id? sn:subscription-id
+--ro period centiseconds
+--ro anchor-time? yang:date-and-time
+--ro (selection-filter)?
+--:(by-reference)
| +--ro selection-filter-ref selection-filter-ref
+--:(within-subscription)
+--ro (filter-spec)?
+--:(datastore-subtree-filter)
| +--ro datastore-subtree-filter? <anydata> {sn:subtree}?
+--:(datastore-xpath-filter)
+--ro datastore-xpath-filter? yang:xpath1.0 {sn:xpath}?¶
For adaptive subscriptions, triggered updates will occur at the boundaries of specified time intervals when a trigger condition is satisfied. These boundaries can be calculated from the adaptive periodic parameters:¶
The augmentation of YANG module ietf-yang-push made to RPCs specified in YANG module ietf-subscribed-notifications [RFC8639] is introduced. This augmentation concerns the "establish- subscription" RPC, which is augmented with parameters that are needed to specify adaptive subscriptions. These parameters are same as one defined in Section 2.1.¶
The subscriber MAY invoke the "modify-subscription" RPC for a subscription it previously established. The subscriber will include newly desired values in the "modify-subscription" RPC. Parameters not included MUST remain unmodified. Section 4.4.2 of [RFC8641] provides an example where a subscriber attempts to modify the period and datastore XPath filter of a subscription using NETCONF. The period can be the 'period' parameter defined by ietf-adaptive-subscription.¶
The adaptive update notification is similar to Subscription state change notifications defined in [RFC8639]. It is inserted into the sequence of notification messages sent to a particular receiver. The adaptive update notification cannot be dropped or filtered out, it cannot be stored in replay buffers, and it is delivered only to impacted receivers of a subscription. The identification of adaptive update notification is easy to separate from other notification messages through the use of the YANG extension "subscription-state-notif". This extension tags a notification as a subscription state change notification.¶
The objects in the 'adpative-update' notification include:¶
<CODE BEGINS> file "ietf-adaptive-subscription@2020-02-14.yang"
module ietf-adaptive-subscription {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-adaptive-subscription";
prefix as;
import ietf-subscribed-notifications {
prefix sn;
}
import ietf-yang-push {
prefix yp;
}
import ietf-yang-types {
prefix yang;
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"";
description
"NETCONF Protocol Data Types and Protocol Operations.
Copyright (c) 2020 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 xxxx; see
the RFC itself for full legal notices.";
revision 2019-12-15 {
description
"Initial revision";
reference
"RFCxxx Adaptive subscription to YANG notification.";
}
typedef centiseconds {
type uint32;
description
"A period of time, measured in units of 0.01 seconds.";
}
typedef seconds {
type uint32;
description
"A period of time, measured in units of 1 seconds.";
}
typedef operator {
type enumeration {
enum unequal {
description
"Indicates that the comparision type is unequal to.";
}
enum equal {
description
"Indicates that the comparision type is equal to.";
}
enum less {
description
"Indicates that the comparision type is less than.";
}
enum less-or-equal {
description
"Indicates that the comparision type is less than
or equal to.";
}
enum greater {
description
"Indicates that the comparision type is greater than.";
}
enum greater-or-equal {
description
"Indicates that the comparision type is greater than
or equal to.";
}
}
description
"definition of the operator";
}
grouping adaptive-subscription-modifiable {
description
"This grouping describes the datastore-specific adaptive subscription
conditions that can be changed during the lifetime of the
subscription.";
choice adaptive-subscription {
description
"Defines necessary conditions for sending an event record to
the subscriber.";
container adaptive-subscriptions {
list adaptive-period {
description
"Defines necessary conditions to switch update interval for
sending an event record to the subscriber. The event record output
generation will not be influeced these conditions.";
key "name";
leaf name {
type string {
length "1..64";
}
description
"The name of the condition to be matched. A device MAY further
restrict the length of this name; space and special
characters are not allowed.";
}
leaf xpath-external-eval {
type string;
description
"A XPath string, representing a logical expression,
which can contain comparisons of datastore values
and logical operations in the XPath format.";
}
leaf watermark {
type uint32;
description
"The watermark for targeted data object. The high
watermark, lowe watermark can be specified for the
targeted data object.";
}
leaf period {
type centiseconds;
mandatory true;
description
"Duration of time that should occur between periodic
push updates, in units of 0.01 seconds.";
}
leaf anchor-time {
type yang:date-and-time;
description
"Designates a timestamp before or after which a series
of periodic push updates are determined. The next
update will take place at a point in time that is a
multiple of a period from the 'anchor-time'.
For example, for an 'anchor-time' that is set for the
top of a particular minute and a period interval of a
minute, updates will be sent at the top of every
minute that this subscription is active.";
}
}
description
"Container for adaptive subscription.";
}
}
}
augment "/sn:subscriptions/sn:subscription/yp:update-trigger" {
description
"This augmentation adds additional subscription parameters
that apply specifically to adaptive subscription.";
uses adaptive-subscription-modifiable;
}
augment "/sn:establish-subscription/sn:input/yp:update-trigger" {
description
"This augmentation adds additional subscription parameters
that apply specifically to datastore updates to RPC input.";
uses adaptive-subscription-modifiable;
}
notification adaptive-period-update {
sn:subscription-state-notification;
description
"This notification contains a push update that in turn contains
data subscribed to via a subscription. In the case of a
periodic subscription, this notification is sent for periodic
updates. It can also be used for synchronization updates of
an on-change subscription. This notification shall only be
sent to receivers of a subscription. It does not constitute
a general-purpose notification that would be subscribable as
part of the NETCONF event stream by any receiver.";
leaf id {
type sn:subscription-id;
description
"This references the subscription that drove the
notification to be sent.";
}
leaf period {
type centiseconds;
mandatory true;
description
"New duration of time that should occur between periodic
push updates, in units of 0.01 seconds.";
}
leaf anchor-time {
type yang:date-and-time;
description
"Designates a timestamp before or after which a series
of periodic push updates are determined. The next
update will take place at a point in time that is a
multiple of a period from the 'anchor-time'.
For example, for an 'anchor-time' that is set for the
top of a particular minute and a period interval of a
minute, updates will be sent at the top of every
minute that this subscription is active.";
}
uses yp:datastore-criteria {
refine "selection-filter/within-subscription" {
description
"Specifies the selection filter and where it originated
from. If the 'selection-filter-ref' is populated, the
filter in the subscription came from the 'filters'
container. Otherwise, it is populated in-line as part
of the subscription itself.";
}
}
}
}
<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-adaptive-subscription
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-adaptive-subscription
Namespace: urn:ietf:params:xml:ns:yang:ietf-adaptive-subscription
Prefix: as
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:¶
The authors would like to thank Michale Wang for his major contributions to the initial modeling and use cases.¶
The example YANG module used in this document represents a simple wifi mac interface.¶
YANG tree diagram for the "example-wifi-mac" module:¶
module: example-wifi-mac
+--rw clients
+--ro client* [mac]
+--ro mac yang:mac-address
+--ro rssi? int8
+--ro snr? uint8
+--ro ss? uint8
+--ro phy-rate? uint16
+--ro channel-support* uint8
+--ro neighbors
| +--ro neighbor-bssid? yang:mac-address
| +--ro neighbor-channel? uint8
| +--ro neighbor-rssi? int8
| +--ro neighbor-antenna? uint8
| +--ro channel-load-report? uint8
+--ro ssid
+--ro name? string
+--ro enabled? boolean
+--ro broadcast-filter? boolean
+--ro multicast-filter? boolean
+--ro ipv6-ndp-filter? boolean
+--ro ipv6-ndp-filter-timer? uint16
+--ro station-isolation? boolean¶
module example-wifi-mac {
yang-version 1;
namespace "http://example.com/yang/wifi-mac";
prefix wifi;
import ietf-yang-types {
prefix yang;
}
container clients {
description
"Top-level container for clients operational state data.";
list client {
key "mac";
config false;
description
"List of clients per BSS.";
leaf mac {
type yang:mac-address;
description
"MAC address of the client.";
}
leaf rssi {
type int8;
description
"The RSSI of this client in dBm. Expressed as negative
number";
}
leaf snr {
type uint8;
description
"The SNR of AP to Client, in dB.";
}
leaf ss {
type uint8;
description
"Number of Spatial Streams supported by the client.";
}
leaf phy-rate {
type uint16;
description
"Last used PHY rate of connected client.";
}
leaf-list channel-support {
type uint8;
description
"List of supported channels.";
}
container neighbors {
description
"Container for Client beacon reports. Requires 802.11k
enabled. See Sec. 5.2.7.1 of 802.11k-2008 Standard.";
leaf neighbor-bssid {
type yang:mac-address;
description
"The BSSID of this neighbor.";
}
leaf neighbor-channel {
type uint8;
description
"The channel of this neighbor.";
}
leaf neighbor-rssi {
type int8;
description
"The RSSI of this neighbor in dBm, expressed as a negative
number.";
}
leaf neighbor-antenna {
type uint8;
description
"Antenna details for this neighbor.";
}
leaf channel-load-report {
type uint8;
description
"Channel load, as reported by Client to AP
normalized to 255. See Sec. 10.11.9.3 of 802.11ac-2013
Spec.";
}
}
container ssid {
description
"Top level container for ssids, including configuration
and state data.";
leaf name {
type string;
description
"The name of the SSID.";
}
leaf enabled {
type boolean;
default "true";
description
"The desired operational state (up/down) of this SSID.";
}
leaf broadcast-filter {
type boolean;
description
"Convert all downstream broadcast ARP to unicast
only if Station is associated to the AP. Drop packet
if Station is not associated to the AP. All other
broadcast, except DHCP, is dropped by the AP.
DHCP Offers/ACKs are converted to Unicast, over-the-air.";
}
leaf multicast-filter {
type boolean;
description
"Drop all downstream Multicast packets.";
}
leaf ipv6-ndp-filter {
type boolean;
description
"Neighbor Advertisements will be cached at the AP (or WLC)
and unicast in response to Neighbor Solicitations.
Router Advertisements, in response to a Router Solicitation
are converted to Unicast for over-the-air transmission.";
}
leaf ipv6-ndp-filter-timer {
type uint16;
units "seconds";
description
"Time, in seconds, the ndp-filter will cache
Neighbor Advertisements (NA).";
}
leaf station-isolation {
type boolean;
description
"Block Station peer to peer communication.";
}
}
}
}
}¶
The examples within this document use the normative YANG module "ietf-adaptive-subscription" as defined in Section 3 and the non-normative example YANG module "example-wifi-mac" as defined in Appendix A.1.¶
This section shows some typical adaptive subscription and notification message exchanges.¶
The client configure adaptive subscription parameters on the server. The adaptive subscription configuration parameters require the server to scan all clients every 5 seconds if the ssid value of client is greater than -65dB; If the ssid value of client is less than -65dB, switch to 60 seconds period value, and then scan all clients every 60 seconds.¶
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<top xmlns="http://example.com/schema/1.2/config">
<yp:datastore
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
ds:running
</yp:datastore>
<yp:datastore-xpath-filter
xmlns:ex="https://example.com/sample-data/1.0">
/ex:example-wifi-mac
</yp:datastore-xpath-filter>
<as:adaptive-subscriptions
xmlns:as="urn:ietf:params:xml:ns:yang:ietf-adaptive-subscription">
<as:adaptive-period>
<as:condition-expression>as:clients/as:client[ssid > -65]</as:
condition-expression>
<as:watermark>-65</as:watermark>
<as:period>5</as:period>
</as:adaptive-period>
<as:adaptive-period>
<as:condition-expression>as:clients/as:client[ssid < -65]</as:
condition-expressioni>
<as:watermark>-65</as:watermark>
<as:period>60</as:period>
</as:adaptive-period>
</as:adaptive-subscriptions>
</top>
</config>
</edit-config>
</rpc>¶
The subscriber sends an "establish-subscription" RPC with the parameters listed in to request the creation of a adaptive subscription. The adaptive subscription configuration parameters require the server to scan all clients every 5 seconds if the ssid value of client is greater than -65dB; If the ssid value of client is less than -65dB, switch to 60 seconds period value, and then scan all clients every 60 seconds. (Section 2)¶
<netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<yp:datastore
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
ds:running
</yp:datastore>
<yp:datastore-xpath-filter
xmlns:ex="https://example.com/sample-data/1.0">
/ex:example-wifi-mac
</yp:datastore-xpath-filter>
<as:adaptive-subscriptions
xmlns="urn:ietf:params:xml:ns:yang:ietf-adaptive-subscription">
<as:adaptive-period>
<as:condition-expression>as:clients/as:client[ssid > -65]
</as:condition-expressioni>
<as:watermark>-65</as:watermark>
<as:period>5</as:period>
</as:adaptive-period>
<as:adaptive-period>
<as:condition-expression>as:clients/as:client[ssid < -65]
</as:condition-expressioni>
<as:watermark>-65</as:watermark>
<as:period>60</as:period>
</as:adaptive-period>
</as:adaptive-subscriptions>
</establish-subscription>
</netconf:rpc>¶
In another example, the adaptive subscription configuration parameters could also require the server to scan all clients every 5 seconds if the difference between maximum value of client ssid and minimum value of client ssid is greater than 0.20dB; If the difference between maximum value of client ssid and minimum value of client ssid is less than 20dB, switch to 60 seconds period value and then scan all clients every 60 seconds.¶
<netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<yp:datastore
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
ds:running
</yp:datastore>
<yp:datastore-xpath-filter
xmlns:ex="https://example.com/sample-data/1.0">
/ex:example-wifi-mac
</yp:datastore-xpath-filter>
<as:adaptive-subscriptions>
<as:data-path>as:clients/as:client</as:data-path>
<as:target>ssid</as:target>
<as:adaptive-period>
<as:condition-expression>as:clients/as:client[max(ssid)-min(ssid) >20]
</as:condition-expressioni>
<as:watermark>20</as:watermark>
<as:period>5</as:period>
</as:adaptive-period>
<as:adaptive-period>
<as:condition-expression>as:clients/as:client[max(ssid)-min(ssid) < 20]
</as:condition-expressioni>
<as:watermark>20</as:watermark>
<as:period>60</as:period>
</as:adaptive-period>
</as:adaptive-subscriptions>
</establish-subscription>
</netconf:rpc>¶
Upon the server switches to from the update interval 5 seconds to the new update interval 60 seconds, Before sending event records to receivers, the "adaptive-update" notification should be generated and sent to the receivers to inform the receivers that the update interval value is switched to the new value.¶
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2016-11-21T13:51:00Z</eventTime>
<adaptive-update xmlns="http://example.com/ietf-adaptive-subscription">
<id>0</id>
<period>60</period>
<yp:datastore
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
ds:running
</yp:datastore>
<yp:datastore-xpath-filter
xmlns:ex="https://example.com/sample-data/1.0">
/ex:example-wifi-mac
</yp:datastore-xpath-filter>
</adaptive-update>
</notification>¶