idnits 2.17.1 draft-tao-netconf-notif-node-tag-capabilities-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There are 3 instances of too long lines in the document, the longest one being 20 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (October 29, 2020) is 1268 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'I-D.netconf-notification-capabilities' is mentioned on line 78, but not defined == Unused Reference: 'RFC7950' is defined on line 347, but no explicit reference was found in the text == Unused Reference: 'RFC8126' is defined on line 355, but no explicit reference was found in the text == Unused Reference: 'RFC8342' is defined on line 369, but no explicit reference was found in the text == Unused Reference: 'RFC8407' is defined on line 374, but no explicit reference was found in the text Summary: 1 error (**), 0 flaws (~~), 6 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETCONF Working Group Q. Wu 3 Internet-Draft Q. Ma 4 Intended status: Standards Track Huawei 5 Expires: May 2, 2021 P. Liu 6 Y. Fu 7 China Mobile 8 October 29, 2020 10 Self describing data Node tag capability 11 draft-tao-netconf-notif-node-tag-capabilities-03 13 Abstract 15 Before a client application subscribes to updates from a datastore, 16 server capabilities related to "Subscription to YANG Datastores" can 17 be advertised using YANG Instance Data format. These server 18 capabilities can be documented at implement time or reported at run- 19 time. 21 This document proposes a YANG module for self describing data Object 22 tag capability which augments system capabilities model and provide 23 additional self describing data node attributes associated with node 24 selectors within per-node capabilities. 26 Status of This Memo 28 This Internet-Draft is submitted in full conformance with the 29 provisions of BCP 78 and BCP 79. 31 Internet-Drafts are working documents of the Internet Engineering 32 Task Force (IETF). Note that other groups may also distribute 33 working documents as Internet-Drafts. The list of current Internet- 34 Drafts is at https://datatracker.ietf.org/drafts/current/. 36 Internet-Drafts are draft documents valid for a maximum of six months 37 and may be updated, replaced, or obsoleted by other documents at any 38 time. It is inappropriate to use Internet-Drafts as reference 39 material or to cite them other than as "work in progress." 41 This Internet-Draft will expire on May 2, 2021. 43 Copyright Notice 45 Copyright (c) 2020 IETF Trust and the persons identified as the 46 document authors. All rights reserved. 48 This document is subject to BCP 78 and the IETF Trust's Legal 49 Provisions Relating to IETF Documents 50 (https://trustee.ietf.org/license-info) in effect on the date of 51 publication of this document. Please review these documents 52 carefully, as they describe your rights and restrictions with respect 53 to this document. Code Components extracted from this document must 54 include Simplified BSD License text as described in Section 4.e of 55 the Trust Legal Provisions and are provided without warranty as 56 described in the Simplified BSD License. 58 Table of Contents 60 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 61 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 62 2. Self-explanation data Node tag capability . . . . . . . . . . 3 63 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 64 3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 4 65 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 66 4.1. Updates to the IETF XML Registry . . . . . . . . . . . . 6 67 4.2. Updates to the YANG Module Names Registry . . . . . . . . 6 68 5. Security Considerations . . . . . . . . . . . . . . . . . . . 7 69 6. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 7 70 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 71 7.1. Normative References . . . . . . . . . . . . . . . . . . 7 72 7.2. Informative References . . . . . . . . . . . . . . . . . 9 73 Appendix A. Targeted data object subscription example . . . . . 9 74 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11 76 1. Introduction 78 As described in [I-D.netconf-notification-capabilities], a server 79 supporting YANG-Push MAY have a number of capabilities such as 81 o Supported (reporting) periods for periodic subscriptions; 83 o Maximum number of objects that can be sent in an update; 85 o Supported dampening periods for on-change subscriptions; 87 o The set of data nodes for which on-change notification is 88 supported. 90 Notification capability model defined in [I-D.netconf-notification- 91 capabilities] allows a client to discover basic system capability and 92 YANG-Push related capabilities both at implementation-time and run- 93 time. Without using this notification capability, it might lead to 94 unexpected failures or additional message exchanges for NETCONF 95 clients to discover data objects with specific capability supported 96 by a NETCONF server. 98 When all telemetry data on the server subscribed by a particular 99 subscriber is huge, it becomes more likely that a burst of streamed 100 data may temporarily overwhelm a receiver and consume expensive 101 computing and storage resource. Accordingly, there is a need for 102 filtering subscribed telemetry data on a server based on server 103 capabilities, which can greatly reduce the amount of data to be 104 streamed out to the destination. 106 However without telemetry data classification or prior knowledge of 107 data objects correlation relationship, it is difficult for NETCONF 108 clients to automatically select target data objects that are of 109 interest to the client applications, e.g., identify a set of objects 110 from different YANG data modules which have a common characteristic, 111 collect specific object type nodes for multiple dimensional network 112 visibility analysis. 114 This document proposes a YANG module for self describing data Node 115 tag capability which augments System Capabilities model and provide 116 additional self describing data node tag attributes associated with 117 node selector for queries filtering. 119 1.1. Terminology 121 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 122 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 123 "OPTIONAL" in this document are to be interpreted as described in BCP 124 14 [RFC2119] [RFC8174] when, and only when, they appear in all 125 capitals, as shown here. 127 2. Self-explanation data Node tag capability 129 The YANG module ietf-notification-capabilities defined in [I- 130 D.netconf-notification-capabilities] specifies the following server 131 capabilities related to YANG Push: 133 o A set of capabilities related to the amount of notifications the 134 server can send out 136 o Specification of which data nodes support on-change notifications. 138 o Capability values can be specified on server level, datastore 139 level or on specific data nodes (and their contained sub-tree) of 140 a specific datastore. Capability values on a smaller, more 141 specific part of the server's data always override more generic 142 values. 144 o On-change capability is not specified on a server level as 145 different datastores usually have different on-change 146 capabilities. On a datastore level on-change capability for 147 configuration and state data can be specified separately. 149 These server capabilities can be provided either at implementation 150 time or reported at run time. 152 This document augments system capabilities model and provide 153 additional data node self explaination tag attributes associated with 154 node selector within per-node capabilities: 156 o Specification of which data objects (e.g., data object tagged with 157 object tag, property subobject tag, metri subobject tag) they can 158 push to the target recipient; 160 o Specification of metric group tag associated with a set of metric 161 subobjects; 163 o Specfication of multi-source aggregation tag assocaited with 164 specific metric subobject; 166 2.1. Tree Diagram 168 The following tree diagram [RFC8340] provides an overview of the data 169 model. 171 module: ietf-self-describing-capabilities 172 augment /sysc:system-capabilities/sysc:datastore-capabilities/ + 173 sysc:per-node-capabilities/sys:node-selection/sys:node-selector: 174 +--ro self-describing-attributes 175 +--ro opm-tag* tags:tag 176 +--ro metric-group tags:tag 177 +--ro muli-source-tag tags:tag 179 3. YANG Module 181 file "ietf-self-describing-capabilities.yang" 182 module ietf-self-describing-capabilities { 183 yang-version 1.1; 184 namespace urn:ietf:params:xml:ns:yang:ietf-self-description-capabilities; 185 prefix sdc; 186 import ietf-system-capabilities { prefix sysc ; } 187 import ietf-module-tags { prefix tags; } 188 organization 189 "IETF NETMOD (Network Modeling) Working Group"; 190 contact 191 "WG Web: 192 WG List: 194 Editor: Qin Wu 195 196 Qiufang Ma 197 198 Peng Liu 199 200 Hui Cai 201 "; 202 description 203 "This module defines an extension to System Capabilities model 204 and provides additional self explaination data node tag attributes 205 associated with node selector for queries filtering. 207 Copyright (c) 2020 IETF Trust and the persons identified as 208 authors of the code. All rights reserved. 210 Redistribution and use in source and binary forms, with or 211 without modification, is permitted pursuant to, and subject 212 to the license terms contained in, the Simplified BSD License 213 set forth in Section 4.c of the IETF Trust's Legal Provisions 214 Relating to IETF Documents 215 (http://trustee.ietf.org/license-info). 217 This version of this YANG module is part of RFC XXXX; 218 see the RFC itself for full legal notices."; 219 revision 2020-07-08 { 220 description 221 "Initial revision"; 222 reference 223 "RFC XXXX"; 224 } 225 augment "/sysc:system-capabilities/sysc:datastore-capabilities" + 226 "/sysc:per-node-capabilities" + 227 "/sysc:node-selection/sysc:node-selector" { 228 description "Allows per-node capabilities have additional self-explanation attributes"; 229 container self-describing-attributes { 230 description "self describing attributes for specific data node."; 231 leaf-list opm-tag { 232 type tags:tag; 233 description 234 "Object, Property and Metric(OPM) Tags associated with 235 specific data object within YANG module. 236 See the IANA 'YANG Data Node Tag Prefixes' registry 237 for reserved prefixes and the IANA 238 'IETF YANG Data Node Tags' registry for IETF tags."; 239 } 240 leaf metric-group { 241 type tags:tag; 242 description 243 "The metric-group can be used to provide correlation between 244 different performance metric information associated with YANG 245 data node."; 246 } 247 leaf multi-source-tag { 248 type tags:tag; 249 description 250 "The multiple source tag can be used to aggregate peformance 251 metric from different sources."; 252 } 253 } 254 } 255 } 256 258 4. IANA Considerations 260 4.1. Updates to the IETF XML Registry 262 This document registers a URI in the "IETF XML Registry" [RFC3688]. 263 Following the format in [RFC3688], the following registration has 264 been made: 266 URI: 267 urn:ietf:params:xml:ns:yang:ietf-self-describing-capabilities 268 Registrant Contact: 269 The IESG. 270 XML: 271 N/A; the requested URI is an XML namespace. 273 4.2. Updates to the YANG Module Names Registry 275 This document registers one YANG module in the "YANG Module Names" 276 registry [RFC6020]. Following the format in [RFC6020], the following 277 registration has been made: 279 name: 280 ietf-self-describing-capabilities 281 namespace: 282 urn:ietf:params:xml:ns:yang:ietf-self-describing-capabilities 283 prefix: 284 sec 285 reference: 286 RFC XXXX (RFC Ed.: replace XXX with actual RFC number and remove 287 this note.) 289 5. Security Considerations 291 The YANG module specified in this document defines a schema for data 292 that is designed to be accessed via network management protocols such 293 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 294 is the secure transport layer, and the mandatory-to-implement secure 295 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer 296 is HTTPS, and the mandatory-to-implement secure transport is TLS 297 [RFC8446]. 299 The NETCONF Configuration Access Control Model (NACM) [RFC8341] 300 provides the means to restrict access for particular NETCONF or 301 RESTCONF users to a preconfigured subset of all available NETCONF or 302 RESTCONF protocol operations and content. 304 There are a number of data nodes defined in this YANG module that are 305 writable/creatable/deletable (i.e., config true, which is the 306 default). These data nodes may be considered sensitive in some 307 network environments. Write operations (e.g., edit-config) to these 308 data nodes without proper protection can have a negative effect on 309 network operations. These are the subtrees and data nodes and their 310 sensitivity/vulnerability: 312 o /sysc:system-capabilities/sysc:datastore-capabilities/sysc:per- 313 node-capabilities/sys:node-selection/sys:node-selector/sec:self- 314 describing-attributes/sec:opm-tag 316 o /sysc:system-capabilities/sysc:datastore-capabilities/sysc:per- 317 node-capabilities/sys:node-selection/sys:node-selector/sec:self- 318 describing-attributes/sec:metric-group 320 o /sysc:system-capabilities/sysc:datastore-capabilities/sysc:per- 321 node-capabilities/sys:node-selection/sys:node-selector/sec:self- 322 describing-attributes/sec:multi-source-tag 324 6. Contributors 326 The authors would like to thank Ran Tao, Hui Cai for his major 327 contributions to the initial modeling and use cases. 329 7. References 331 7.1. Normative References 333 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 334 Requirement Levels", BCP 14, RFC 2119, 335 DOI 10.17487/RFC2119, March 1997, 336 . 338 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 339 and A. Bierman, Ed., "Network Configuration Protocol 340 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 341 . 343 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 344 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 345 . 347 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 348 RFC 7950, DOI 10.17487/RFC7950, August 2016, 349 . 351 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 352 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 353 . 355 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 356 Writing an IANA Considerations Section in RFCs", BCP 26, 357 RFC 8126, DOI 10.17487/RFC8126, June 2017, 358 . 360 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 361 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 362 May 2017, . 364 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 365 Access Control Model", STD 91, RFC 8341, 366 DOI 10.17487/RFC8341, March 2018, 367 . 369 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 370 and R. Wilton, "Network Management Datastore Architecture 371 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 372 . 374 [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of 375 Documents Containing YANG Data Models", BCP 216, RFC 8407, 376 DOI 10.17487/RFC8407, October 2018, 377 . 379 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 380 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 381 . 383 7.2. Informative References 385 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 386 DOI 10.17487/RFC3688, January 2004, 387 . 389 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 390 the Network Configuration Protocol (NETCONF)", RFC 6020, 391 DOI 10.17487/RFC6020, October 2010, 392 . 394 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 395 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 396 . 398 Appendix A. Targeted data object subscription example 400 The following subsections provides targeted data object subscription 401 example. The subscription "id" values of 22 used below is just an 402 example. In production, the actual values of "id" might not be small 403 integers. 405 +-----------+ +-----------+ 406 | Subscriber| | Publisher | 407 +------+----+ +-----+-----+ 408 | | 409 | | 410 |Telemery data Tagging Advertisement 411 | (node-selector, opm-tag = metric) 412 |<---------------------------------| 413 | | 414 | establish-subscription | 415 | (datasore,node-selector) | 416 |--------------------------------->| 417 | | 418 | | 419 | | 420 | RPC Reply: OK, id = 22 | 421 |<---------------------------------| 422 | | 423 | | 424 | | 425 | Notification Message (for 22) | 426 | <--------------------------------| 427 | | 428 | | 429 | | 431 The publisher advertise telemetry data node capability to the 432 subscriber to instruct the receiver to subscribe targeted data object 433 with specific characteristics (e.g., performance metric related data 434 object) and specific data path corresponding to the targeted data 435 object. 437 The following XML example [W3C.REC-xml-20081126] illustrates the 438 advertisment of the list of available target objects: 440 441 443 acme-router-notification-capabilities 444 445 ietf-system-capabilities@2020-03-23 446 ietf-notification-capabilities@2020-03-23 447 ietf-data-export-capabilities@2020-03-23 448 449 450 Defines the notification capabilities of an acme-router. 451 The router only has running, and operational datastores. 452 Every change can be reported on-change from running, but 453 only config=true nodes and some config=false data from operational. 454 Statistics are not reported based on timer based trigger and counter 455 threshold based trigger. 456 457 458 463 464 ds:operational 465 466 \ 467 /if:interfaces/if:interface/if:statistics/if:in-errors\ 468 469 470 metric 471 loss 472 473 474 475 476 477 478 With telemetry data tagging information carried in the Telemetry data 479 Tagging Advertisement, the subscriber identifies targeted data object 480 and associated data path to the datastore node and sends a establish- 481 subscription RPC to subscribe specific data objects that are 482 interests to the client application from the publisher. 484 486 489 491 ds:operational 492 493 495 /if:interfaces/if:interface/if:statistics/if:in-errors 496 497 498 500 499 500 501 503 The publisher returns specific object type of operational state 504 related to the subscriber. 506 Authors' Addresses 508 Qin Wu 509 Huawei 510 101 Software Avenue, Yuhua District 511 Nanjing, Jiangsu 210012 512 China 514 Email: bill.wu@huawei.com 516 Qiufang Ma 517 Huawei 518 101 Software Avenue, Yuhua District 519 Nanjing, Jiangsu 210012 520 China 522 Email: maqiufang1@huawei.com 523 Peng Liu 524 China Mobile 525 32 Xuanwumen West St, Xicheng District 526 Beijing 10053 528 Email: liupengyjy@chinamobile.com 530 Yuexia Fu 531 China Mobile 532 32 Xuanwumen West St, Xicheng District 533 Beijing 10053 535 Email: yuexiafu@chinamobile.com