| Internet-Draft | YANG-Push to Message Broker Integration | June 2024 |
| Graf & Elhassany | Expires 23 December 2024 | [Page] |
This document describes the motivation and architecture of a native YANG-Push notifications and YANG Schema integration into a Message Broker and YANG Schema Registry.¶
This note is to be removed before publishing as an RFC.¶
Discussion of this document takes place on the Operations and Management Area Working Group Working Group mailing list (nmop@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/nmop/.¶
Source for this draft and an issue tracker can be found at https://github.com/network-analytics/draft-daisy-kafka-yang-integration/.¶
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 23 December 2024.¶
Copyright (c) 2024 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
Nowadays network operators are using YANG [RFC7950] to model their configurations and obtain YANG modelled data from their networks. It is well understood that plain text are initially intended for humans and need effort to make it machine readable due to the lack of semantics. YANG modeled data is addressing most of these needs.¶
Increasingly more network operators organizing their data in a Data Mesh [Deh22] where a Message Broker such as Apache Kafka [Kaf11] or RabbitMQ [Rab07] facilitates the exchange of messages among data processing components like a stream processor to filter, enrich, correlate or aggregate, or a time series database to store data.¶
Even though YANG is intend to ease the handling of data, this promise has not yet been fulfilled for Network Telemetry [RFC9232]. From subscribing on a YANG datastore, publishing a YANG modeled notifications message from the network and viewing the data in a time series database, manual labor, such as obtaining the YANG schema from the network and creating a transformation or ingestion specification into a time series database, is needed to make a Message Broker and its data processing components with YANG notifications interoparable. Since YANG modules can change over time, for example when a router is being upgraded to a newer software release, this process needs to be adjusted contionously, leading often to errors in the data chain if dependencies are not properly tracked and schema changes adjusted simultaneously.¶
With [RFC3535] the IAB set the requirements for Network Management in 2003. From these requirements NETCONF [RFC6241], NETCONF Notifications [RFC5277] and RESTCONF [RFC8040] have been defined to configure through <edit-config> and retrieve operational data through <get> and NETCONF notifications through <notification> from a YANG datastore on a network node.¶
With YANG-Push, as defined in [RFC8639], [RFC8640] and [RFC8641], periodical and on-change subscriptions to the YANG datastore can be dynamically or statically configured. When notifications are dynamically configured, messages are published over the initially established NETCONF session, while when it is statically configured messages are published through HTTPS-based [I-D.ietf-netconf-https-notif] or UDP-based [I-D.ietf-netconf-udp-notif] transport. Section 3.7 of [RFC8641] describes push-update messages where the YANG subscribed data is being published, where Section 2.7 of [RFC8639] describes the subscription state change notifications where changes in the subscription are being described.¶
Apache Kafka [Kaf11] is a Message Broker that supports producing and consuming messages from so called topics. Each topic has one or more partitions where messages are replicated or load balanced to scale out. With the introduction of Confluent Schema Registry [Con18] a topic can contain one or more subjects. A subject refers to a Schema defining the structure of the message. The Schema then is used to validate messages sent through topics and are identified by a Schema ID. The Schema ID is issued when the Schema is registered to the Confluent Schema Registry. Once the Schema ID is obtained, it can be prefixed to the message with a Confluent Schema Registry compatible serializer. Messages can then be validated against Schema at the producer or at the consumer from a topic to ensure Schema integrity of the message. The type of Schema evolution scheme can be defined per subject, wherever non backward compatibility changes are allowed or not.¶
This document focuses on YANG-Push [RFC8641] as the messaging protocol between the network node and the Network Telemetry [RFC9232] data collection. It describes the main components and the aimed architecture for deploying such solution in a production network. Then, it illustrates the integration of the YANG 1.1 [RFC7950] as a schema modeling language into the Apache Kafka Message Broker and Confluent Schema Registry [Con18].¶
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 defines the following terms:¶
Message Broker: is an intermediary software component that translates messages from the formal messaging protocol of the sender to the formal messaging protocol of the receiver routed in topics. Message brokers are elements in Data Mesh where software applications communicate by exchanging formally-defined messages.¶
Stream Catalog: provides a single point of access that allows users to centrally search semantics for information across a Message Broker.¶
Additionally it makes use of the terms defined in [RFC8639], Apache Kafka [Kaf11] and Confluent Schema Registry Documentation [ConDoc18].¶
The following terms are used as defined in [RFC8639]:¶
The following terms are used as defined in Apache Kafka Message Broker [Kaf11]:¶
The following terms are used as defined in Confluent Schema Registry Documentation [ConDoc18]:¶
There are four main objectives for native YANG-Push notifications and YANG Schema integration into a Message Broker.¶
Automate the Data Mesh onboarding of newly subscribed YANG metrics.¶
The preservation of the YANG schema, that includes the YANG data types as defined in [RFC6991] and the nested structure of the YANG module, throughout the data processing chain ensures that metrics can be processed and visualized as they were originally intended. Not only for users but also for automated closed loop operation actions.¶
[RFC7950] defines in Section 7.21.3 and 7.21.4 the description and reference statement. This information is intended for the user, describing in a human-readable fashion the meaning of a definition. In Data Mesh, this information can be imported from the YANG Schema Registry into a Stream Catalog where subjects within Message Broker are identifiable and searchable. An example of a Stream Catalog is Apache Atlas [Atl15]. It can also be applied for time series data visualization in a similar fashion.¶
Since the YANG Schema is preserved for operational metrics in the Message Broker, a standardization for integration between network data collection and stream processor or time series database is implied.¶
The architecture consists of 6 elements. Figure 1 gives an overview on the workflow.¶
+------------------------------------------------------------+
| Time Series Database |
+------------------------------------------------------------+
^
| (12) Ingest Data
| According to Schema
+------------------------------------------------------------+
| Time Series Database Ingestion |
+------------------------------------------------------------+
(10) Get | ^ ^ (9) Validate
Schema | | | Serialized Message
| | | Schema on Consumer
| | |
| | +--------------------+
| | | Message |
| | | Broker |
| | +--------------------+
| | |
| | (11) Issue | (8) Serialize
| | | YANG-Push Message
| | | annotated Schema
v | Schema (6) Post | ID on Producer
+--------------------+ Schema +--------------------+
| YANG | <-------------- | Data Collection |
| Schema Registry | --------------> | YANG-Push Receiver |
+--------------------+ (7) Issue +--------------------+
Schema ID (4) Get | ^ (3) Receive
Schema | | YANG-Push
| | Subscription
| | Start Message
| | ^
| | |
| | | (5) Publish
| | | YANG-Push
| | | Message
| | | with
(1) Discover Notif. v | | Subscr. ID
+--------------------+ Capabilities +--------------------+
| Manage YANG-Push | ---------------> | Network Node |
| Subscription | (2) Subscribe | YANG-Push Publisher|
+--------------------+ ---------------> +--------------------+
The workflow diagram (Figure 1) describes the steps from establishing the YANG-Push subscription to Time Series Database ingestion.¶
With step number (1) in the workflow diagram, the YANG-Push notification capabilities are being discovered according to Section 3 of [RFC9196], in with step (2) a YANG-Push subscription is according to Section 2.4 and 2.5 of [RFC8639] dynamically or statically configured, and with step (3) subscription state change notifications are sent according to section 2.7 from the YANG-Push publisher to the receiver to inform which event stream filter has been applied to which subscription ID.¶
When the YANG-Push subscription is managed dynamically, the YANG data is being received on the same NETCONF session where the subscription is being maintained. With configured subscription the YANG data is sent to the YANG-Push receiver through a separate transport session.¶
[I-D.ietf-netconf-yang-notifications-versioning] adds the capability to subscribe to a specific YANG module revision or a YANG module which needs to be backward compatible to in step (2) and adds the module name, revision and revision-label information into the subscription state change notifications in step (3).¶
Figure 2 provides and example how to create a YANG-Push configured subscription with NETCONF in XML [W3C.REC-xml-20081126] with UDP-based [I-D.ietf-netconf-udp-notif] transport¶
========== NOTE: '\' line wrapping per RFC 8792) ===========
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config>
<subscriptions xmlns="urn:ietf:params:xml:ns:yang:ietf\
-subscribed-notifications">
<subscription>
<id>6666</id>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf\
-yang-push"
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf\
-datastores">ds:operational</datastore>
<datastore-xpath-filter xmlns="urn:ietf:params:xml:ns\
:yang:ietf-yang-push"
xmlns:if="urn:ietf:params:xml:ns:yang:ietf-inter\
faces">/if:interfaces</datastore-xpath-filter>
<revision xmlns="urn:ietf:params:xml:ns:yang:ietf-yang\
-push-revision">2018-02-20</revision>
<transport xmlns:unt="urn:ietf:params:xml:ns:yang:ietf\
-udp-notif-transport">unt:udp-notif</transport>
<encoding>encode-json</encoding>
<receivers>
<receiver>
<name>subscription-specific-receiver-def</name>
<receiver-instance-ref xmlns="urn:ietf:params:xml\
:ns:yang:ietf-subscribed-notif-receivers">\
global-udp-notif-receiver-def</receiver-instance-ref>
</receiver>
</receivers>
<periodic xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<period>6000</period>
</periodic>
</subscription>
<receiver-instances xmlns="urn:ietf:params:xml:ns:yang:ietf\
-subscribed-notif-receivers">
<receiver-instance>
<name>global-udp-notif-receiver-def</name>
<udp-notif-receiver xmlns="urn:ietf:params:xml:ns:yang\
:ietf-udp-notif-transport">
<address>192.0.5.1</address>
<port>12345</port>
<enable-segmentation>false</enable-segmentation>
<max-segment-size/>
</udp-notif-receiver>
</receiver-instance>
</receiver-instances>
</subscriptions>
</config>
</edit-config>
</rpc>
Figure 3 provides an example of a JSON encoded, [RFC7951], subscription-started state change notification message over HTTPS-based [I-D.ietf-netconf-https-notif] or UDP-based [I-D.ietf-netconf-udp-notif] transport with [I-D.tgraf-netconf-notif-sequencing], [I-D.tgraf-netconf-yang-push-observation-time] and [I-D.ietf-netconf-yang-notifications-versioning] as extensions for the same subscription.¶
{
"ietf-notification:notification": {
"eventTime": "2023-03-25T08:30:11.22Z",
"ietf-notification-sequencing:sysName": "example-router",
"ietf-notification-sequencing:sequenceNumber": 1,
"ietf-subscribed-notification:subscription-started": {
"id": 6666,
"ietf-yang-push:datastore": "ietf-datastores:operational",
"ietf-yang-push:datastore-xpath-filter": "/if:interfaces",
"ietf-yang-push-revision:revision": "2014-05-08",
"ietf-yang-push-revision:module-name": "ietf-interfaces",
"ietf-yang-push-revision:revision-label": "",
"ietf-distributed-notif:message-observation-domain-id": [1,2],
"transport": "ietf-udp-notif-transport:udp-notif",
"encoding": "encode-json",
"ietf-yang-push:periodic": {
"ietf-yang-push:period": 100
}
}
}
}
With step number (4) in the workflow diagram, a YANG-Push push-update or push-change-update message, depending on wherever periodical or on-change subscription has been established, is sent from the YANG-Push publisher to the receiver according to Section 3.7 of [RFC8639].¶
[I-D.ahuang-netconf-notif-yang] defines the NETCONF notification header specified in [RFC5277] in YANG to enable JSON and CBOR encoding.¶
[I-D.tgraf-netconf-notif-sequencing] adds sysName, messagePublisherId and sequenceNumber in the NETCONF notification header to each message to identify from which network node and publishing process, according to [I-D.ietf-netconf-distributed-notif] a network node with distributed architecture could have multiple messagePublisherId's, the message has been published from. The sequenceNumber enables to recognize loss from the YANG-Push publisher in step (2) down to the Time Series Database Ingestion in step (12).¶
[I-D.tgraf-netconf-yang-push-observation-time] adds observation-time and point-in-time in the YANG-Push push-update or push-change-update message. observation-time contains the timestamp and point-in-time when the metrics where observed. See Section 3 of [I-D.tgraf-netconf-yang-push-observation-time] for more details.¶
Figure 4 provides an example of a JSON encoded, [RFC7951], push-update notification message over HTTPS-based [I-D.ietf-netconf-https-notif] or UDP-based [I-D.ietf-netconf-udp-notif] transport with [I-D.tgraf-netconf-notif-sequencing] and [I-D.tgraf-netconf-yang-push-observation-time] as extensions for the same subscription.¶
========== NOTE: '\' line wrapping per RFC 8792) ===========
{
"ietf-notification:notification": {
"eventTime": "2023-03-25T08:30:11.22Z",
"ietf-notification-sequencing:sysName": "example-router",
"ietf-notification-sequencing:sequenceNumber": 1,
"ietf-yang-push:push-update": {
"id": 6666,
"ietf-yang-push-observation-timestamp:observation-time": \
"2023-03-25T08:30:11.22Z",
"ietf-yang-push-observation-timestamp:point-in-time": \
"state-changed",
"datastore-contents": {
"ietf-interfaces:interfaces": [
{
"interface": {
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"oper-status": "up",
"mtu": 1500
}
}
]
}
}
}
}
Figure 5 provides an example of a JSON encoded, [RFC7951], push-change-update notification message over HTTPS-based [I-D.ietf-netconf-https-notif] or UDP-based [I-D.ietf-netconf-udp-notif] transport with [I-D.tgraf-netconf-notif-sequencing] and [I-D.tgraf-netconf-yang-push-observation-time] as extensions for the same subscription.¶
========== NOTE: '\' line wrapping per RFC 8792) ===========
{
"ietf-notification:notification": {
"eventTime": "2023-03-25T08:30:11.22Z",
"ietf-notification-sequencing:sysName": "example-router",
"ietf-notification-sequencing:sequenceNumber": 1,
"ietf-yang-push:push-change-update": {
"id": 2222,
"ietf-yang-push-observation-timestamp:observation-time": \
"2023-03-25T08:30:11.22Z",
"ietf-yang-push-observation-timestamp:point-in-time": \
"state-changed",
"datastore-contents": {
"yang-patch": {
"patch-id": "patch_54",
"comment": "Changing encoding to JSON and increasing \
the period to 10 minutes",
"edit": [
{
"edit-id": "id_change_1",
"operation": "merge",
"target": "/ietf-subscribed-notifications\:subs\
criptions/subscription[id=2222]",
"value": {
"ietf-subscribed-notifications:encoding": \
"ietf-subscribed-notifications:encode-json",
"ietf-yang-push:periodic": {
"period": 60000
}
}
}
]
}
}
}
}
}
For all the YANG modules and revisions of each subscription ID in the subscription state change notification received in step number (3) in the workflow diagram, all the YANG module dependencies need to be determined through the YANG Library [RFC8525], and then through NETCONF <get-schema> rpc calls according to [RFC6022] all YANG modules need to be retrieved as described in step (4) in the workflow diagram.¶
[I-D.lincla-netconf-yang-library-augmentation] extends the YANG Library so that not only the submodule but also the augmentation list can be obtained.¶
Figure 9 in Section 4.1 and YANG module in Section 5 of [RFC8641] defines the payload of YANG-push notifications where "datastore-contents" or the "value" of a "push-change-update") is "anydata". [RFC7950] Section 7.10 states that anydata represents an unknown set of nodes that can be modeled with YANG, and the model is not known at design time and that the model of the unknown set of nodes can be signaled through another protocol. This poses and issue in the schema validation of YANG-Push notifications and will be further clarified in point number (1) and (2) in Appendix B.¶
The schema registry SHOULD support YANG as the format for defining schema. For each schema registered into the schema registry, a schema ID is returned. That schema ID can be used when interacting with the Message Broker to indicate the schema to use with the message.Ӧ
Confluent Schema Registry is pluggable. Currently Supports AVRO, JSON Schema and Protobuf. The YANG support is being developed at [Yak24] as part of this architecture. Enable to register, obtain and compare [YSR24] YANG Schemas. One YANG Schema with all its augmentations is being registered per YANG-Push subscription ID. for each YANG Schema a locally significant Schema ID is being issued as described in step (7) in the workflow diagram.¶
curl -X POST -H "Content Type: application/vnd.schemaregistry.v1+json" -d @ietf-interfaces@2018-02-20.json http://localhost:8081/subjects/ietf-interfaces/
curl http://localhost:8081/subjects/ ubjects/ | jq
curl http://localhost:8081/subjects/ietf-interfaces/versions
curl http://localhost:8081/subjects/ietf-interfaces/versions/1
The previously issued Schema ID is prefixed to the previously in Section 4.3 described metadata augmented YANG push push-update message and serialized to a Message Broker topic in step (8) of the workflow diagram.¶
From the Message Broker topic the message is being consumed and the prefixed Schema ID is being used in step (10) of the workflow diagram to retrieve the YANG Schema to validate the Schema integrity of the message.¶
The time series database ingestion specifications are being derived with the in Section 4.6 already retrieved Schema ID and YANG-Push push-update messages can be now ingested and indexed into the database table according to their schema in step (12).¶
The YANG data is being ingested in step (12)according to the previously defined ingestion specification and indexed with the timestamp defined in observation-time as defined in [I-D.tgraf-netconf-yang-push-observation-time]. A network operator is now able to query the previously subscribed YANG data.¶
Note to the RFC-Editor: Please remove this section before publishing.¶
This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in [RFC7942]. The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist.¶
According to [RFC7942], "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit".¶
Ahmed Elhassany is developing a YANG Schema Extension in Confluent Schema Registry.¶
The source code can be obtained here: [YSR24], the progress report here: [YSRPR24], and was validated at the IETF 117 hackathon.¶
Zhuoyao Lin developed as part of her internship a library to parse YANG-Push subscription notifications, identify YANG module dependencises with YANG Library [RFC8525] and obtain with NETCONF <get-schema> rpc calls [RFC6022] all YANG modules from YANG-Push publisher.¶
The source code can be obtained here: [LYP23] and was validated at the IETF 117 hackathon.¶
Zhuoyao Lin implemented [I-D.lincla-netconf-yang-library-augmentation] in order to discover augmented-by YANG modules in YANG Library [RFC8525].¶
The source code can be obtained here: [YLA24] and was validated at the IETF 119 hackathon.¶
The authors would like to thank Yannick Buchs and Benoit Claise for their review and valuable comments. Alex Huang Feng, Jean Quilbeuf and Zhuoyao Lin for review and contributing code and providing examples and inputs to the open points.¶
IETF 115:¶
IETF 116:¶
IETF 118:¶
IETF 119:¶
IETF 120:¶
Lists all current open points to be either further researched and clarified or tested with running code.¶
Note to the RFC-Editor: Please remove this section before publishing.¶