| 1 |
<pre>Internet Engineering Task Force (IETF) J. Haas |
| 2 |
Request for Comments: 8242 Juniper |
| 3 |
Category: Informational S. Hares |
| 4 |
ISSN: 2070-1721 Huawei |
| 5 |
September 2017 |
| 6 |
|
| 7 |
|
| 8 |
<span class="h1">Interface to the Routing System (I2RS) Ephemeral State Requirements</span> |
| 9 |
|
| 10 |
Abstract |
| 11 |
|
| 12 |
"An Architecture for the Interface to the Routing System" (<a href="./rfc7921">RFC 7921</a>) |
| 13 |
abstractly describes a number of requirements for ephemeral state (in |
| 14 |
terms of capabilities and behaviors) that any protocol suite |
| 15 |
attempting to meet the needs of the Interface to the Routing System |
| 16 |
(I2RS) protocol has to provide. This document describes, in detail, |
| 17 |
requirements for ephemeral state for those implementing the I2RS |
| 18 |
protocol. |
| 19 |
|
| 20 |
Status of This Memo |
| 21 |
|
| 22 |
This document is not an Internet Standards Track specification; it is |
| 23 |
published for informational purposes. |
| 24 |
|
| 25 |
This document is a product of the Internet Engineering Task Force |
| 26 |
(IETF). It represents the consensus of the IETF community. It has |
| 27 |
received public review and has been approved for publication by the |
| 28 |
Internet Engineering Steering Group (IESG). Not all documents |
| 29 |
approved by the IESG are a candidate for any level of Internet |
| 30 |
Standard; see <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>. |
| 31 |
|
| 32 |
Information about the current status of this document, any errata, |
| 33 |
and how to provide feedback on it may be obtained at |
| 34 |
<a href="https://www.rfc-editor.org/info/rfc8242">https://www.rfc-editor.org/info/rfc8242</a>. |
| 35 |
|
| 36 |
|
| 37 |
|
| 38 |
|
| 39 |
|
| 40 |
|
| 41 |
|
| 42 |
|
| 43 |
|
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Haas & Hares Informational [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 55 |
|
| 56 |
|
| 57 |
Copyright Notice |
| 58 |
|
| 59 |
Copyright (c) 2017 IETF Trust and the persons identified as the |
| 60 |
document authors. All rights reserved. |
| 61 |
|
| 62 |
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal |
| 63 |
Provisions Relating to IETF Documents |
| 64 |
(<a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a>) in effect on the date of |
| 65 |
publication of this document. Please review these documents |
| 66 |
carefully, as they describe your rights and restrictions with respect |
| 67 |
to this document. Code Components extracted from this document must |
| 68 |
include Simplified BSD License text as described in Section 4.e of |
| 69 |
the Trust Legal Provisions and are provided without warranty as |
| 70 |
described in the Simplified BSD License. |
| 71 |
|
| 72 |
Table of Contents |
| 73 |
|
| 74 |
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-3">3</a> |
| 75 |
<a href="#section-1.1">1.1</a>. Requirements Language ......................................<a href="#page-4">4</a> |
| 76 |
<a href="#section-2">2</a>. Architectural Requirements for Ephemeral State ..................<a href="#page-4">4</a> |
| 77 |
<a href="#section-3">3</a>. Ephemeral State Requirements ....................................<a href="#page-5">5</a> |
| 78 |
<a href="#section-3.1">3.1</a>. Persistence ................................................<a href="#page-5">5</a> |
| 79 |
<a href="#section-3.2">3.2</a>. Constraints ................................................<a href="#page-6">6</a> |
| 80 |
<a href="#section-3.3">3.3</a>. Hierarchy ..................................................<a href="#page-6">6</a> |
| 81 |
<a href="#section-3.4">3.4</a>. Ephemeral Configuration Overlapping Local Configuration ....<a href="#page-6">6</a> |
| 82 |
<a href="#section-4">4</a>. YANG Features for Ephemeral State ...............................<a href="#page-7">7</a> |
| 83 |
<a href="#section-5">5</a>. NETCONF Features for Ephemeral State ............................<a href="#page-7">7</a> |
| 84 |
<a href="#section-6">6</a>. RESTCONF Features for Ephemeral State ...........................<a href="#page-7">7</a> |
| 85 |
7. Requirements regarding Supporting Multi-Head Control via |
| 86 |
Client ..........................................................<a href="#page-7">7</a> |
| 87 |
<a href="#section-8">8</a>. Multiple Message Transactions ...................................<a href="#page-9">9</a> |
| 88 |
<a href="#section-9">9</a>. Pub/Sub Requirements Expanded for Ephemeral State ...............<a href="#page-9">9</a> |
| 89 |
<a href="#section-10">10</a>. IANA Considerations ...........................................<a href="#page-10">10</a> |
| 90 |
<a href="#section-11">11</a>. Security Considerations .......................................<a href="#page-10">10</a> |
| 91 |
<a href="#section-12">12</a>. Normative References ..........................................<a href="#page-10">10</a> |
| 92 |
Acknowledgements ..................................................<a href="#page-12">12</a> |
| 93 |
Authors' Addresses ................................................<a href="#page-12">12</a> |
| 94 |
|
| 95 |
|
| 96 |
|
| 97 |
|
| 98 |
|
| 99 |
|
| 100 |
|
| 101 |
|
| 102 |
|
| 103 |
|
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Haas & Hares Informational [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 111 |
|
| 112 |
|
| 113 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 114 |
|
| 115 |
The Interface to the Routing System (I2RS) Working Group (WG) is |
| 116 |
chartered with providing architecture and mechanisms to inject into |
| 117 |
and retrieve information from the routing system. The I2RS |
| 118 |
Architecture document [<a href="./rfc7921" title=""An Architecture for the Interface to the Routing System"">RFC7921</a>] abstractly documents a number of |
| 119 |
requirements for implementing the I2RS and defines ephemeral state as |
| 120 |
"state that does not survive the reboot of a routing device or the |
| 121 |
reboot of the software handling the I2RS software on a routing |
| 122 |
device" (see <a href="./rfc7921#section-1.1">Section 1.1 of [RFC7921]</a>). <a href="#section-2">Section 2</a> of this document |
| 123 |
describes the specific requirements that the I2RS WG has identified |
| 124 |
based on the I2RS architecture's abstract requirements. The |
| 125 |
Interface to the Routing System (I2RS) Working Group (WG) is |
| 126 |
chartered with providing architecture and mechanisms to inject into |
| 127 |
and retrieve information from the routing system. The I2RS |
| 128 |
Architecture document [<a href="./rfc7921" title=""An Architecture for the Interface to the Routing System"">RFC7921</a>] abstractly documents a number of |
| 129 |
requirements for implementing the I2RS and defines ephemeral state as |
| 130 |
"state that does not survive the reboot of a routing device or the |
| 131 |
reboot of the software handling the I2RS software on a routing |
| 132 |
device" (see <a href="./rfc7921#section-1.1">Section 1.1 of [RFC7921]</a>). <a href="#section-2">Section 2</a> of this document |
| 133 |
provides a summary of these abstract requirements, and <a href="#section-3">section 3</a> |
| 134 |
recasts these abstract requirements into specific requirements for |
| 135 |
the Ephemeral state for any IETF network management system. |
| 136 |
|
| 137 |
The I2RS WG has chosen to use the YANG data modeling language |
| 138 |
[<a href="./rfc7950" title=""The YANG 1.1 Data Modeling Language"">RFC7950</a>] as the basis to implement its mechanisms. |
| 139 |
|
| 140 |
Additionally, the I2RS WG has chosen to reuse two existing protocols, |
| 141 |
NETCONF [<a href="./rfc6241" title=""Network Configuration Protocol (NETCONF)"">RFC6241</a>] and its similar but lighter-weight relative |
| 142 |
RESTCONF [<a href="./rfc8040" title=""RESTCONF Protocol"">RFC8040</a>], as the protocols for carrying I2RS. |
| 143 |
|
| 144 |
What does reuse of a protocol mean? Reuse means that while the |
| 145 |
combination of the YANG modeling language and the NETCONF and |
| 146 |
RESTCONF protocols is a good starting basis for the I2RS data |
| 147 |
modeling language and protocol, the requirements for I2RS protocol |
| 148 |
implementations should: |
| 149 |
|
| 150 |
1. select features from the YANG modeling language and the NETCONF |
| 151 |
and RESTCONF protocols per version of the I2RS protocol (see |
| 152 |
Sections <a href="#section-4">4</a>, <a href="#section-5">5</a>, and <a href="#section-6">6</a>), and |
| 153 |
|
| 154 |
2. propose additions to YANG, NETCONF, and RESTCONF per version of |
| 155 |
the I2RS protocol for key functions (ephemeral state, protocol |
| 156 |
security, publication/subscription service, traceability). |
| 157 |
|
| 158 |
The purpose of these requirements is to ensure clarity during I2RS |
| 159 |
protocol creation. |
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Haas & Hares Informational [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 167 |
|
| 168 |
|
| 169 |
Support for ephemeral state is an I2RS protocol requirement that |
| 170 |
necessitates datastore changes (see <a href="#section-3">Section 3</a>), YANG additions (see |
| 171 |
<a href="#section-4">Section 4</a>), NETCONF additions (see <a href="#section-5">Section 5</a>), and RESTCONF additions |
| 172 |
(see <a href="#section-6">Section 6</a>). |
| 173 |
|
| 174 |
Sections <a href="#section-7">7</a>-<a href="#section-9">9</a> provide details that expand upon the changes in Sections |
| 175 |
3-6 to clarify requirements discussed by the I2RS and NETCONF WGs. |
| 176 |
<a href="#section-7">Section 7</a> provides additional requirements that detail how write- |
| 177 |
conflicts should be resolved if two I2RS client write the same data. |
| 178 |
<a href="#section-8">Section 8</a> describes I2RS requirements for support of multiple message |
| 179 |
transactions. <a href="#section-9">Section 9</a> highlights two requirements for I2RS |
| 180 |
publication/subscription [<a href="./rfc7923" title=""Requirements for Subscription to YANG Datastores"">RFC7923</a>] that must be expanded for |
| 181 |
ephemeral state. |
| 182 |
|
| 183 |
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Requirements Language</span> |
| 184 |
|
| 185 |
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", |
| 186 |
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and |
| 187 |
"OPTIONAL" in this document are to be interpreted as described in |
| 188 |
<a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] [<a href="./rfc8174" title=""Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"">RFC8174</a>] when, and only when, they appear in all |
| 189 |
capitals, as shown here. |
| 190 |
|
| 191 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Architectural Requirements for Ephemeral State</span> |
| 192 |
|
| 193 |
The I2RS architecture [<a href="./rfc7921" title=""An Architecture for the Interface to the Routing System"">RFC7921</a>] and the I2RS problem statement |
| 194 |
[<a href="./rfc7920" title=""Problem Statement for the Interface to the Routing System"">RFC7920</a>] define the important high-level requirements for the I2RS |
| 195 |
protocol in abstract terms. This section distills this high-level |
| 196 |
abstract guidance into specific requirements for the I2RS protocol. |
| 197 |
To aid the reader, there are references back to the abstract |
| 198 |
descriptions in the I2RS architecture document and the I2RS problem |
| 199 |
statement, but the reader should note the requirements below are not |
| 200 |
explicitly stated in the I2RS architecture document or in the I2RS |
| 201 |
problem statement. |
| 202 |
|
| 203 |
Requirements: |
| 204 |
|
| 205 |
1. The I2RS protocol SHOULD support an asynchronous programmatic |
| 206 |
interface with properties described in <a href="./rfc7920#section-5">Section 5 of [RFC7920]</a> |
| 207 |
(e.g., high throughput) with support for target information |
| 208 |
streams, filtered events, and thresholded events (real-time |
| 209 |
events) sent by an I2RS agent to an I2RS client (from <a href="./rfc7921#section-1.1">Section 1.1 |
| 210 |
of [RFC7921]</a>). |
| 211 |
|
| 212 |
|
| 213 |
|
| 214 |
|
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Haas & Hares Informational [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 223 |
|
| 224 |
|
| 225 |
2. An I2RS agent MUST record the client identity when a node is |
| 226 |
created or modified. The I2RS agent SHOULD be able to read the |
| 227 |
client identity of a node and use the client identity's |
| 228 |
associated priority to resolve conflicts. The secondary identity |
| 229 |
is useful for traceability and may also be recorded (from |
| 230 |
<a href="./rfc7921#section-4">Section 4 of [RFC7921]</a>). |
| 231 |
|
| 232 |
3. An I2RS client identity MUST have only one priority for the |
| 233 |
client's identifier. A collision on writes is considered an |
| 234 |
error, but the priority associated with each client identifier is |
| 235 |
utilized to compare requests from two different clients in order |
| 236 |
to modify an existing node entry. Only an entry from a client |
| 237 |
that is higher priority can modify an existing entry (first entry |
| 238 |
wins). Priority only has meaning at the time of use (from |
| 239 |
<a href="./rfc7921#section-7.8">Section 7.8 of [RFC7921]</a>). |
| 240 |
|
| 241 |
4. An I2RS client's secondary identity data is read-only metadata |
| 242 |
that is recorded by the I2RS agent associated with a data model's |
| 243 |
node when the data node is written. Just like the primary client |
| 244 |
identity, the secondary identity SHOULD only be recorded when the |
| 245 |
data node is written (from Sections <a href="#section-7.4">7.4</a> of [<a href="./rfc7921" title=""An Architecture for the Interface to the Routing System"">RFC7921</a>].) |
| 246 |
|
| 247 |
5. An I2RS agent MAY have a lower-priority I2RS client attempting to |
| 248 |
modify a higher-priority client's entry in a data model. The |
| 249 |
filtering out of lower-priority clients attempting to write or |
| 250 |
modify a higher-priority client's entry in a data model SHOULD be |
| 251 |
effectively handled and SHOULD not put an undue strain on the |
| 252 |
I2RS agent. (See <a href="./rfc7921#section-7.8">Section 7.8 of [RFC7921]</a> augmented by the |
| 253 |
resource limitation language in <a href="./rfc7921#section-8">Section 8 [RFC7921]</a>.) |
| 254 |
|
| 255 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Ephemeral State Requirements</span> |
| 256 |
|
| 257 |
In requirements Ephemeral-REQ-01 to Ephemeral-REQ-15, Ephemeral state |
| 258 |
is defined as potentially including in a data model ephemeral |
| 259 |
configuration and operational state which is flagged as ephemeral. |
| 260 |
|
| 261 |
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Persistence</span> |
| 262 |
|
| 263 |
Ephemeral-REQ-01: I2RS requires ephemeral state, i.e., state that |
| 264 |
does not persist across reboots. If state must be restored, it |
| 265 |
should be done solely by replay actions from the I2RS client via the |
| 266 |
I2RS agent. |
| 267 |
|
| 268 |
At first glance, the I2RS ephemeral state may seem equivalent to the |
| 269 |
writable-running datastore in NETCONF (e.g., running-config), which |
| 270 |
can be copied to a datastore that persists across a reboot (software |
| 271 |
or hardware). However, I2RS ephemeral state MUST NOT persist across |
| 272 |
a reboot (software or hardware). |
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
<span class="grey">Haas & Hares Informational [Page 5]</span></pre> |
| 277 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 278 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 279 |
|
| 280 |
|
| 281 |
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Constraints</span> |
| 282 |
|
| 283 |
Ephemeral-REQ-02: Non-ephemeral state MUST NOT refer to ephemeral |
| 284 |
state for constraint purposes; it SHALL be considered a validation |
| 285 |
error if it does. |
| 286 |
|
| 287 |
Ephemeral-REQ-03: Ephemeral state MUST be able to have constraints |
| 288 |
that refer to operational state, this includes potentially fast- |
| 289 |
changing or short-lived operational state nodes, such as MPLS LSP-ID |
| 290 |
(label-switched path ID) or a BGP Adj-RIB-IN (Adjacent RIB Inbound). |
| 291 |
Ephemeral state constraints should be assessed when the ephemeral |
| 292 |
state is written, and if any of the constraints change to make the |
| 293 |
constraints invalid after that time, the I2RS agent SHOULD notify the |
| 294 |
I2RS client. |
| 295 |
|
| 296 |
Ephemeral-REQ-04: Ephemeral state MUST be able to refer to non- |
| 297 |
ephemeral state as a constraint. Non-ephemeral state can be |
| 298 |
configuration state or operational state. |
| 299 |
|
| 300 |
Ephemeral-REQ-05: I2RS pub-sub [<a href="./rfc7923" title=""Requirements for Subscription to YANG Datastores"">RFC7923</a>], tracing [<a href="./rfc7922" title=""Interface to the Routing System (I2RS) Traceability: Framework and Information Model"">RFC7922</a>], RPC, or |
| 301 |
other mechanisms may lead to undesirable or unsustainable resource |
| 302 |
consumption on a system implementing an I2RS agent. It is |
| 303 |
RECOMMENDED that mechanisms be made available to permit |
| 304 |
prioritization of I2RS operations, when appropriate, to permit |
| 305 |
implementations to shed work load when operating under constrained |
| 306 |
resources. An example of such a work-shedding mechanism is rate- |
| 307 |
limiting. |
| 308 |
|
| 309 |
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Hierarchy</span> |
| 310 |
|
| 311 |
Ephemeral-REQ-06: YANG MUST have the ability to do the following: |
| 312 |
|
| 313 |
1. define a YANG module or submodule schema that only contains data |
| 314 |
nodes with the property of being ephemeral, and |
| 315 |
|
| 316 |
2. augment a YANG module with additional YANG schema nodes that have |
| 317 |
the property of being ephemeral. |
| 318 |
|
| 319 |
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Ephemeral Configuration Overlapping Local Configuration</span> |
| 320 |
|
| 321 |
Ephemeral-REQ-07: Local configuration MUST have a priority that is |
| 322 |
comparable with individual I2RS client priorities for making changes. |
| 323 |
This priority will determine whether local configuration changes or |
| 324 |
individual ephemeral configuration changes take precedence as |
| 325 |
described in [<a href="./rfc7921" title=""An Architecture for the Interface to the Routing System"">RFC7921</a>]. The I2RS protocol MUST support this |
| 326 |
mechanism. |
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
<span class="grey">Haas & Hares Informational [Page 6]</span></pre> |
| 333 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span> |
| 334 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 335 |
|
| 336 |
|
| 337 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. YANG Features for Ephemeral State</span> |
| 338 |
|
| 339 |
Ephemeral-REQ-08: In addition to config true/false, there MUST be a |
| 340 |
way to indicate that YANG schema nodes represent ephemeral state. It |
| 341 |
is desirable to allow for, and have a way to indicate, config false |
| 342 |
YANG schema nodes that are writable operational state. |
| 343 |
|
| 344 |
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. NETCONF Features for Ephemeral State</span> |
| 345 |
|
| 346 |
Ephemeral-REQ-09: The changes to NETCONF must include: |
| 347 |
|
| 348 |
1. Support for communication mechanisms to enable an I2RS client to |
| 349 |
determine that an I2RS agent supports the mechanisms needed for |
| 350 |
I2RS operation. |
| 351 |
|
| 352 |
2. The ephemeral state MUST support notification of write conflicts |
| 353 |
using the priority requirements defined in <a href="#section-7">Section 7</a> (see |
| 354 |
requirements Ephemeral-REQ-11 through Ephemeral-REQ-14). |
| 355 |
|
| 356 |
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. RESTCONF Features for Ephemeral State</span> |
| 357 |
|
| 358 |
Ephemeral-REQ-10: The conceptual changes to RESTCONF are: |
| 359 |
|
| 360 |
1. Support for communication mechanisms to enable an I2RS client to |
| 361 |
determine that an I2RS agent supports the mechanisms needed for |
| 362 |
I2RS operation. |
| 363 |
|
| 364 |
2. The ephemeral state MUST support notification of write conflicts |
| 365 |
using the priority requirements defined in <a href="#section-7">Section 7</a> (see |
| 366 |
requirements Ephemeral-REQ-11 through Ephemeral-REQ-14). |
| 367 |
|
| 368 |
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Requirements regarding Supporting Multi-Head Control via Client</span> |
| 369 |
<span class="h2"> Priority</span> |
| 370 |
|
| 371 |
To support multi-headed control, I2RS requires that there be a |
| 372 |
decidable means of arbitrating the correct state of data when |
| 373 |
multiple clients attempt to manipulate the same piece of data. This |
| 374 |
is done via a priority mechanism with the highest priority winning. |
| 375 |
This priority is per client. |
| 376 |
|
| 377 |
Ephemeral-REQ-11: The following requirements must be supported by the |
| 378 |
I2RS protocol in order to support I2RS client identity and priority: |
| 379 |
|
| 380 |
o the data nodes MUST store I2RS client identity and MAY store the |
| 381 |
effective priority at the time the data node is stored. |
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
<span class="grey">Haas & Hares Informational [Page 7]</span></pre> |
| 389 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span> |
| 390 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 391 |
|
| 392 |
|
| 393 |
o Per SEC-REQ-07 in <a href="./rfc8241#section-4.3">Section 4.3 of [RFC8241]</a>, an I2RS Identifier |
| 394 |
MUST have just one priority. The I2RS protocol MUST support the |
| 395 |
ability to have data nodes store I2RS client identity and not the |
| 396 |
effective priority of the I2RS client at the time the data node is |
| 397 |
stored. |
| 398 |
|
| 399 |
o The priority MAY be dynamically changed by AAA, but the exact |
| 400 |
actions are part of the protocol definition as long as collisions |
| 401 |
are handled as described in Ephemeral-REQ-12, Ephemeral-REQ-13, |
| 402 |
and Ephemeral-REQ-14. |
| 403 |
|
| 404 |
Ephemeral-REQ-12: When a collision occurs as two I2RS clients are |
| 405 |
trying to write the same data node, this collision is considered an |
| 406 |
error. The I2RS priorities are used to provide a deterministic |
| 407 |
resolution to the conflict. When there is a collision, and the data |
| 408 |
node is changed, a notification (which includes indicating the data |
| 409 |
node the collision occurred on) MUST be sent to the original client |
| 410 |
to give the original client a chance to deal with the issues |
| 411 |
surrounding the collision. The original client may need to fix their |
| 412 |
state. |
| 413 |
|
| 414 |
Explanation: RESTCONF and NETCONF updates can come in concurrently |
| 415 |
from alternative sources. Therefore, the collision detection and |
| 416 |
comparison of priority needs to occur for any type of update. |
| 417 |
|
| 418 |
For example, RESTCONF tracks the source of configuration change via |
| 419 |
the entity-tag (see <a href="./rfc8040#section-3.5.2">Section 3.5.2 of [RFC8040]</a>), which the server |
| 420 |
returns to the client along with the value in GET or HEAD methods. |
| 421 |
RESTCONF requires that this resource entity-tag be updated whenever a |
| 422 |
resource or configuration resource within the resource is altered. |
| 423 |
In the RESTCONF processing, when the resource or a configuration |
| 424 |
resource within the resource is altered, the processing of the |
| 425 |
configuration change for two I2RS clients must detect an I2RS |
| 426 |
collision and resolve the collision using the priority mechanism. |
| 427 |
|
| 428 |
Ephemeral-REQ-13: Multi-headed control is required for collisions and |
| 429 |
the priority resolution of collisions. Multi-headed control is not |
| 430 |
tied to ephemeral state. The I2RS protocol MUST NOT mandate the |
| 431 |
internal mechanism for how AAA protocols (e.g., Radius or Diameter) |
| 432 |
or mechanisms distribute priority per identity except that any AAA |
| 433 |
protocols MUST operate over a secure transport layer (see Radius |
| 434 |
[<a href="./rfc6614" title=""Transport Layer Security (TLS) Encryption for RADIUS"">RFC6614</a>] and Diameter [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]). Mechanisms that prevent |
| 435 |
collisions of two clients trying to modify the same node of data are |
| 436 |
the focus. |
| 437 |
|
| 438 |
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
<span class="grey">Haas & Hares Informational [Page 8]</span></pre> |
| 445 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span> |
| 446 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 447 |
|
| 448 |
|
| 449 |
Ephemeral-REQ-14: A deterministic conflict resolution mechanism MUST |
| 450 |
be provided to handle the error scenario in which two clients, with |
| 451 |
the same priority, update the same configuration data node. The I2RS |
| 452 |
architecture gives one way that this could be achieved: by specifying |
| 453 |
that the first update wins. Other solutions that prevent oscillation |
| 454 |
of the config data node are also acceptable. |
| 455 |
|
| 456 |
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Multiple Message Transactions</span> |
| 457 |
|
| 458 |
Ephemeral-REQ-15: <a href="#section-7.9">Section 7.9</a> of the [<a href="./rfc7921" title=""An Architecture for the Interface to the Routing System"">RFC7921</a>] states the I2RS |
| 459 |
architecture does not include multi-message atomicity and roll-back |
| 460 |
mechanisms. The I2RS protocol implementation MUST NOT require the |
| 461 |
support of these features. As part of this requirement, the I2RS |
| 462 |
protocol should support: |
| 463 |
|
| 464 |
multiple operations in one message. An error in one operation |
| 465 |
MUST NOT stop additional operations from being carried out, nor |
| 466 |
can it cause previous operations to be rolled back. |
| 467 |
|
| 468 |
multiple operations in multiple messages, but multiple message- |
| 469 |
command error handling MUST NOT insert errors into the I2RS |
| 470 |
ephemeral state. |
| 471 |
|
| 472 |
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Pub/Sub Requirements Expanded for Ephemeral State</span> |
| 473 |
|
| 474 |
I2RS clients require the ability to monitor changes to ephemeral |
| 475 |
state. While subscriptions are well defined for receiving |
| 476 |
notifications, the need to create a notification set for all |
| 477 |
ephemeral configuration state may be overly burdensome to the user. |
| 478 |
|
| 479 |
Thus, there is a need for a general subscription mechanism that can |
| 480 |
provide notification of changed state, with sufficient information to |
| 481 |
permit the client to retrieve the impacted nodes. This should be |
| 482 |
doable without requiring the notifications to be created as part of |
| 483 |
every single I2RS module. |
| 484 |
|
| 485 |
The publication/subscription requirements for I2RS are in [<a href="./rfc7923" title=""Requirements for Subscription to YANG Datastores"">RFC7923</a>], |
| 486 |
and the following general requirements SHOULD be understood to be |
| 487 |
expanded to include ephemeral state: |
| 488 |
|
| 489 |
o Pub-Sub-REQ-01: The subscription service MUST support |
| 490 |
subscriptions against ephemeral state in operational datastores, |
| 491 |
configuration datastores, or both. |
| 492 |
|
| 493 |
|
| 494 |
|
| 495 |
|
| 496 |
|
| 497 |
|
| 498 |
|
| 499 |
|
| 500 |
<span class="grey">Haas & Hares Informational [Page 9]</span></pre> |
| 501 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span> |
| 502 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 503 |
|
| 504 |
|
| 505 |
o Pub-Sub-REQ-02: The subscription service MUST support filtering so |
| 506 |
that subscribed updates under a target node might publish either: |
| 507 |
|
| 508 |
1. only ephemeral state in operational data or configuration |
| 509 |
data, or |
| 510 |
|
| 511 |
2. both ephemeral and operational data. |
| 512 |
|
| 513 |
o Pub-Sub-REQ-03: The subscription service MUST support |
| 514 |
subscriptions that are ephemeral. (For example, an ephemeral data |
| 515 |
model that has ephemeral subscriptions.) |
| 516 |
|
| 517 |
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. IANA Considerations</span> |
| 518 |
|
| 519 |
This document does not require any IANA actions. |
| 520 |
|
| 521 |
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Security Considerations</span> |
| 522 |
|
| 523 |
The security requirements for the I2RS protocol are covered in |
| 524 |
[<a href="./rfc8241" title=""Interface to the Routing System (I2RS) Security-Related Requirements"">RFC8241</a>]. |
| 525 |
|
| 526 |
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. Normative References</span> |
| 527 |
|
| 528 |
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate |
| 529 |
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, |
| 530 |
DOI 10.17487/RFC2119, March 1997, |
| 531 |
<<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>>. |
| 532 |
|
| 533 |
[<a id="ref-RFC6241">RFC6241</a>] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., |
| 534 |
and A. Bierman, Ed., "Network Configuration Protocol |
| 535 |
(NETCONF)", <a href="./rfc6241">RFC 6241</a>, DOI 10.17487/RFC6241, June 2011, |
| 536 |
<<a href="https://www.rfc-editor.org/info/rfc6241">https://www.rfc-editor.org/info/rfc6241</a>>. |
| 537 |
|
| 538 |
[<a id="ref-RFC6614">RFC6614</a>] Winter, S., McCauley, M., Venaas, S., and K. Wierenga, |
| 539 |
"Transport Layer Security (TLS) Encryption for RADIUS", |
| 540 |
<a href="./rfc6614">RFC 6614</a>, DOI 10.17487/RFC6614, May 2012, |
| 541 |
<<a href="https://www.rfc-editor.org/info/rfc6614">https://www.rfc-editor.org/info/rfc6614</a>>. |
| 542 |
|
| 543 |
[<a id="ref-RFC6733">RFC6733</a>] Fajardo, V., Ed., Arkko, J., Loughney, J., and G. Zorn, |
| 544 |
Ed., "Diameter Base Protocol", <a href="./rfc6733">RFC 6733</a>, |
| 545 |
DOI 10.17487/RFC6733, October 2012, |
| 546 |
<<a href="https://www.rfc-editor.org/info/rfc6733">https://www.rfc-editor.org/info/rfc6733</a>>. |
| 547 |
|
| 548 |
[<a id="ref-RFC7920">RFC7920</a>] Atlas, A., Ed., Nadeau, T., Ed., and D. Ward, "Problem |
| 549 |
Statement for the Interface to the Routing System", |
| 550 |
<a href="./rfc7920">RFC 7920</a>, DOI 10.17487/RFC7920, June 2016, |
| 551 |
<<a href="https://www.rfc-editor.org/info/rfc7920">https://www.rfc-editor.org/info/rfc7920</a>>. |
| 552 |
|
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
<span class="grey">Haas & Hares Informational [Page 10]</span></pre> |
| 557 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span> |
| 558 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 559 |
|
| 560 |
|
| 561 |
[<a id="ref-RFC7921">RFC7921</a>] Atlas, A., Halpern, J., Hares, S., Ward, D., and T. |
| 562 |
Nadeau, "An Architecture for the Interface to the Routing |
| 563 |
System", <a href="./rfc7921">RFC 7921</a>, DOI 10.17487/RFC7921, June 2016, |
| 564 |
<<a href="https://www.rfc-editor.org/info/rfc7921">https://www.rfc-editor.org/info/rfc7921</a>>. |
| 565 |
|
| 566 |
[<a id="ref-RFC7922">RFC7922</a>] Clarke, J., Salgueiro, G., and C. Pignataro, "Interface to |
| 567 |
the Routing System (I2RS) Traceability: Framework and |
| 568 |
Information Model", <a href="./rfc7922">RFC 7922</a>, DOI 10.17487/RFC7922, June |
| 569 |
2016, <<a href="https://www.rfc-editor.org/info/rfc7922">https://www.rfc-editor.org/info/rfc7922</a>>. |
| 570 |
|
| 571 |
[<a id="ref-RFC7923">RFC7923</a>] Voit, E., Clemm, A., and A. Gonzalez Prieto, "Requirements |
| 572 |
for Subscription to YANG Datastores", <a href="./rfc7923">RFC 7923</a>, |
| 573 |
DOI 10.17487/RFC7923, June 2016, |
| 574 |
<<a href="https://www.rfc-editor.org/info/rfc7923">https://www.rfc-editor.org/info/rfc7923</a>>. |
| 575 |
|
| 576 |
[<a id="ref-RFC7950">RFC7950</a>] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", |
| 577 |
<a href="./rfc7950">RFC 7950</a>, DOI 10.17487/RFC7950, August 2016, |
| 578 |
<<a href="https://www.rfc-editor.org/info/rfc7950">https://www.rfc-editor.org/info/rfc7950</a>>. |
| 579 |
|
| 580 |
[<a id="ref-RFC8040">RFC8040</a>] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF |
| 581 |
Protocol", <a href="./rfc8040">RFC 8040</a>, DOI 10.17487/RFC8040, January 2017, |
| 582 |
<<a href="https://www.rfc-editor.org/info/rfc8040">https://www.rfc-editor.org/info/rfc8040</a>>. |
| 583 |
|
| 584 |
[<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in <a href="./rfc2119">RFC</a> |
| 585 |
<a href="./rfc2119">2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>, DOI 10.17487/RFC8174, |
| 586 |
May 2017, <<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>>. |
| 587 |
|
| 588 |
[<a id="ref-RFC8241">RFC8241</a>] Hares, S., Migault, D., and J. Halpern, "Interface to the |
| 589 |
Routing System (I2RS) Security-Related Requirements", |
| 590 |
<a href="./rfc8241">RFC 8241</a>, DOI 10.17487/RFC8241, September 2017, |
| 591 |
<<a href="https://www.rfc-editor.org/info/rfc8241">https://www.rfc-editor.org/info/rfc8241</a>>. |
| 592 |
|
| 593 |
|
| 594 |
|
| 595 |
|
| 596 |
|
| 597 |
|
| 598 |
|
| 599 |
|
| 600 |
|
| 601 |
|
| 602 |
|
| 603 |
|
| 604 |
|
| 605 |
|
| 606 |
|
| 607 |
|
| 608 |
|
| 609 |
|
| 610 |
|
| 611 |
|
| 612 |
<span class="grey">Haas & Hares Informational [Page 11]</span></pre> |
| 613 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span> |
| 614 |
<span class="grey"><a href="./rfc8242">RFC 8242</a> I2RS Ephemeral State Requirements September 2017</span> |
| 615 |
|
| 616 |
|
| 617 |
Acknowledgements |
| 618 |
|
| 619 |
This document is an attempt to distill lengthy conversations on the |
| 620 |
I2RS mailing list for an architecture that was, for a long period of |
| 621 |
time, a moving target. Some individuals in particular warrant |
| 622 |
specific mention for their extensive help in providing the basis for |
| 623 |
this document: |
| 624 |
|
| 625 |
Alia Atlas, |
| 626 |
Andy Bierman, |
| 627 |
Martin Bjorklund, |
| 628 |
Dean Bogdanavic, |
| 629 |
Rex Fernando, |
| 630 |
Joel Halpern, |
| 631 |
Thomas Nadeau, |
| 632 |
Juergen Schoenwaelder, |
| 633 |
Kent Watsen, |
| 634 |
Robert Wilton, and |
| 635 |
Joe Clarke. |
| 636 |
|
| 637 |
Authors' Addresses |
| 638 |
|
| 639 |
Jeff Haas |
| 640 |
Juniper |
| 641 |
|
| 642 |
Email: [email protected] |
| 643 |
|
| 644 |
|
| 645 |
Susan Hares |
| 646 |
Huawei |
| 647 |
Saline |
| 648 |
United States of America |
| 649 |
|
| 650 |
Email: [email protected] |
| 651 |
|
| 652 |
|
| 653 |
|
| 654 |
|
| 655 |
|
| 656 |
|
| 657 |
|
| 658 |
|
| 659 |
|
| 660 |
|
| 661 |
|
| 662 |
|
| 663 |
|
| 664 |
|
| 665 |
|
| 666 |
|
| 667 |
|
| 668 |
Haas & Hares Informational [Page 12] |
| 669 |
</pre> |