I2RS Ephemeral State Requirements

The Interface to the Routing System (I2RS) Working Group is chartered with providing architecture and mechanisms to inject into and retrieve information from the routing system. The I2RS Architecture document abstractly documents a number of requirements for implementing the I2RS requirements. Section 2 reviews 10 key requirements related to ephemeral state. The I2RS Working Group has chosen to use the YANG data modeling language as the basis to implement its mechanisms. Additionally, the I2RS Working group has chosen to re-use two existing protocols, NETCONF and its similar but lighter-weight relative RESTCONF , as the protocols for carrying I2RS. What does re-use of a protocol mean? Re-use means that while YANG, NETCONF and RESTCONF are a good starting basis for the I2RS protocol, the creation of the I2RS protocol implementations requires that the I2RS requirements select features from YANG, NETCONF, and RESTCONF per version of the I2RS protocol (See sections 4, 5, and 6) propose additions to YANG, NETCONF, and RESTCONF per version of the I2RS protocol for key functions (ephemeral state, protocol security, publication/subscription service, traceability), suggest protocol strawman as ideas for the NETCONF, RESTCONF, and YANG changes. The purpose of these requirements and the suggested protocol straw man is to provide a quick turnaround on creating the I2RS protocol. Support for ephemeral state is I2RS protocol requirement that requires datastore changes (see section 3), Yang additions (see section 4), NETCONF additions (see section 5), and RESTCONF additions (see section 6). Sections 7-9 provide details that expand upon the changes in sections 3-6 to clarify requirements discussed by the I2RS and NETCONF working groups. Sections 7 provide additional requirements that detail how write-conflicts should be resolved if two I2RS client write the same data. Section 8 provides an additional requirement that details on I2RS support of multiple message transactions. Section 9 highlights two requirements in the I2RS publication/subscription requirements that must be expanded for ephemeral state.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

The I2RS architecture defines important high-level requirements for the I2RS protocol. The following are ten requirements that contains which provide context for the ephemeral data state requirements given in sections 3-8: The I2RS protocol SHOULD support highly reliable notifications (but not perfectly reliable notifications) from an I2RS agent to an I2RS client. The I2RS protocol SHOULD support a high bandwidth, asynchronous interface, with real-time guarantees on getting data from an I2RS agent by an I2RS client. The I2RS protocol will operate on data models which MAY be protocol independent or protocol dependent. I2RS Agent MUST record the client identity when a node is created or modified. The I2RS Agent SHOULD to be able to read the client identity of a node and use the client identity's associated priority to resolve conflicts. The secondary identity is useful for traceability and may also be recorded. Client identity MUST have only one priority for the client's identifier. A collision on writes is considered an error, but the priority associated with each client identifier is utilized to compare requests from two different clients in order to modify an existing node entry. Only an entry from a client which is higher priority can modify an existing entry (First entry wins). Priority only has meaning at the time of use. The Agent identity and the Client identity SHOULD be passed outside of the I2RS protocol in a authentication and authorization protocol (AAA). Client priority may be passed in the AAA protocol. The values of identities are originally set by operators, and not standardized. An I2RS Client and I2RS Agent MUST mutually authenticate each other based on pre-established authenticated identities. Secondary identity data is read-only meta-data that is recorded by the I2RS agent associated with a data model's node is written, updated or deleted. Just like the primary identity, the secondary identity SHOULD only be recorded when the data node is written or updated or deleted I2RS agent MAY have a lower priority I2RS client attempting to modify a higher priority client's entry in a data model. The filtering out of lower priority clients attempting to write or modify a higher priority client's entry in a data model SHOULD be effectively handled and not put an undue strain on the I2RS agent. The I2RS protocol MUST support the use of a secure transport. However, certain functions such as notifications MAY use a non-secure transport. Each model or service (notification, logging) must define within the model or service the valid uses of a non-secure transport.

Ephemeral-REQ-01: I2RS requires ephemeral state; i.e. state that does not persist across reboots. If state must be restored, it should be done solely by replay actions from the I2RS client via the I2RS agent. While at first glance this may seem equivalent to the writable- running data store in NETCONF, running-config can be copied to a persistent data store, like startup config. I2RS ephemeral state MUST NOT be persisted.

Ephemeral-REQ-02: Non-ephemeral state MUST NOT refer to ephemeral state for constraint purposes; it SHALL be considered a validation error if it does. Ephemeral-REQ-03: Ephemeral state must be able to utilized temporary operational state (e.g. MPLS LSP-ID or a BGP IN-RIB) as a constraints. Ephemeral-REQ-04: Ephemeral state MAY refer to non-ephemeral state for purposes of implementing constraints. The designer of ephemeral state modules are advised that such constraints may impact the speed of processing ephemeral state commits and should avoid them when speed is essential. Ephemeral-REQ-05: Ephemeral state handling and notifications could increase need for CPU processing, data flow rates across a transport, or the rate of publication of data in a subscription or the logging for traceability. The I2RS Agent SHOULD have the ability to constraints for OAM functions operating to limit CPU processing, data rate across a transport, the rate of publication of data in a subscription, and logging rates; and the I2RS Agent SHOULD have the ability to prioritize some of the management data flows between the I2RS Agent and I2RS Client. In order to constrain resources needed, the I2RS Agent MAY also schedule data flows or split data flows unto multiple data flow streams.

Ephemeral-REQ-06: The ability to augment an object with appropriate YANG structures that have the property of being ephemeral. An object defined as any one of the following: Yang module(and the module's schema tree), submodule or components of a submodule (e.g. derived types, groupings, data node, RPCs, actions, and notifications), or a schema node (container, leaf, leaf-list, choice, case, rpc, input, output, notifications, and anyxml). See for examples of yang syntax.

Ephemeral-REQ-07: Yang MUST have a way to indicate in a data model that nodes have the following properties: ephemeral, writable/not-writable, and status/configuration. Yang must also have a way to specify on a model or sub-model level whether the data MAY optionally flow across an non-secure transport.

Ephemeral-REQ-08: The conceptual changes to NETCONF protocol version support for I2RS modifications - (e.g. I2RS version 1) support for ephemeral model scope indication - which indicates whether a module is an ephemeral-only module or mixed ephemeral config (ephemeral + config), mixed derived state (ephemeral and opstate). multiple message support - supports the I2RS "all or nothing" concept ( section 7.9) which is the same as NETCONF "roll-back-on-error". support for the following transports protocol supported: "TCP", "SSH", "TLS", and non-secure transport (see section 3.2 in requirements SEC-REQ-09 and SEC-REQ-11 for details). NETCONF should be able to expand the number of secure transport protocols supported as I2RS may add additional transport protocols. ability to restrict non-secure transport support to specific portions of a data models marked as valid to transfer via insecure protocol. ephemeral state overwriting of configuration state MUST be controlled by the following policy knobs (as defined by section 6.3 and 6.3.1): ephemeral configuration overwrites local configuration (true/false; normal value: true), and Update of local configuration value supersedes and overwrites the ephemeral configuration (true/false; normal value: false). The ephemeral overwriting to local configuration described in (6) above is considered to be the composite of all ephemeral values by all clients. Some may consider this approach as a single pane of glass for ephemeral state. The ephemeral state must support notification of write conflicts using the priority requirements defined in section 7 below in requirements Ephemeral-REQ-10 through Ephemeral-REQ-13). Ephemeral data stores SHOULD not require support interactions with writable-running, candidate data store, confirmed commit, and a distinct start-up capability, This list of requirements require the following the following existing features are supported: support for the following encodings: XML or JSON. support for the following transports protocol supported: "TCP", "SSH", "TLS". all of the following NETCONF protocol specifications: yang pub-sub push , yang module library , call-home , and server model with the server module must be augmented to support mutual authentication (see section 3.1 in requirements: SEC-REQ-01 to SEC-REQ-08).

Ephemeral-REQ-09: The conceptual changes to RESTCONF are: protocol version support for I2RS protocol modification (e.g. I2RS-version 1). ephemeral model scope allowed - ephemeral modules, mixed config module (ephemeral and config), mixed derived state (ephemeral and opstate). support for both of the following transport protocol suites: HTTP over TLS (secure HTTP as defined in RESTCONF section 2), HTTP used in a non-secure fashion (See , section 3.2, requirements SEC-REQ-09 and SEC-REQ-11 for details), and RESTCONF SHOULD be able to expand the transports supported as as future I2RS protocol versions may support other transports. The ability to restrict insecure transports to specific portions of a data model marked as valid to transfer via an insecure protocol. Support for the development of a RESTCONF based yang pub-sub push based on the requirements in and equivalent to the netconf . ephemeral state overwriting of configuration state MUST be controlled by the following policy knobs (as defined by section 6.3 and 6.3.1) Ephemeral configuration overwrites local configuration (true/false; normal value:true), and Update of local configuration value supersedes and overwrites the ephemeral configuration (true/false; normal value:false). The ephemeral state overwriting a local configuration described above is considered to be the composite of all ephemeral state values by all clients. Some may consider this a single "pane of glass" for the ephemeral values. RESTCONF support ephemeral state MUST support notification of write conflicts using the priority requirements (see section 7 below, specifically requirements Ephemeral-REQ-10 through Ephemeral-REQ-13). Expansion of existing "edit-collision" features (timestamp and Entity tag) to include I2RS client-priorities is preferred since I2RS client-Agents exchange MAY wish to use the existing edit-collision features in RESTCONF. Ephemeral data stores SHOULD not require support for interactions with writeable-running, candidate data stores, confirmed commit, and a distinct start-up capability. This requirement also requires that RESTCONF support all of the following specifications: support for the following encodings: XML or JSON. all of the following current RESTCONF specifications: RESTCONF , the yang-patch features as specified in , yang module library as defined in RESTCONF section 3.3.3), call-home , zero-touch , and server modules (server module must be augmented to support mutual authentication).

To support Multi-Headed Control, I2RS requires that there be a decidable means of arbitrating the correct state of data when multiple clients attempt to manipulate the same piece of data. This is done via a priority mechanism with the highest priority winning. This priority is per-client. Ephemeral-REQ-10: The data nodes MAY store I2RS client identity and not the effective priority at the time the data node is stored. Per SEC-REQ-07 in section 3.1 of , an identifier must have just one priority. Therefore, the data nodes MAY store I2RS client identity and not the effective priority of the I2RS client at the time the data node is stored. The priority MAY be dynamically changed by AAA, but the exact actions are part of the protocol definition as long as collisions are handled as described in Ephemeral-REQ-10, Ephemeral-REQ-11, and Ephemeral-REQ-12. Ephemeral-REQ-11: When a collision occurs as two clients are trying to write the same data node, this collision is considered an error and priorities were created to give a deterministic result. When there is a collision, a notification MUST BE sent to the original client to give the original client a chance to deal with the issues surrounding the collision. The original client may need to fix their state. Ephemeral-REQ-12: The requirement to support multi-headed control is required for collisions and the priority resolution of collisions. Multi-headed control is not tied to ephemeral state. I2RS is not mandating how AAA supports priority. Mechanisms which prevent collisions of two clients trying the same node of data are the focus. Ephemeral-REQ-13: If two clients have the same priority, the architecture says the first one wins. The I2RS protocol has this requirement to prevent was the oscillation between clients. If one uses the last wins scenario, you may oscillate. That was our opinion, but a design which prevents oscillation is the key point.

Ephemeral-REQ-14: Section 7.9 of the states the I2RS architecture does not include multi-message atomicity and roll-back mechanisms. I2RS notes multiple operations in one or more messages handling can handle errors within the set of operations in many ways. No multi-message commands SHOULD cause errors to be inserted into the I2RS ephemeral data-store.

I2RS clients require the ability to monitor changes to ephemeral state. While subscriptions are well defined for receiving notifications, the need to create a notification set for all ephemeral configuration state may be overly burdensome to the user. There is thus a need for a general subscription mechanism that can provide notification of changed state, with sufficient information to permit the client to retrieve the impacted nodes. This should be doable without requiring the notifications to be created as part of every single I2RS module. The publication/subscription requirements for I2RS are in , and the following general requirements SHOULD be understood to be expanded to to include ephemeral state: Pub-Sub-REQ-01: The Subscription Service MUST support subscriptions against ephemeral data in operational data stores, configuration data stores or both. Pub-Sub-REQ-02: The Subscription Service MUST support filtering so that subscribed updates under a target node might publish only ephemeral data in operational data or configuration data, or publish both ephemeral and operational data.

There are no IANA requirements for this document.

The security requirements for the I2RS protocol are covered in document. The security requirements for the I2RS protocol environment are in .

This document is an attempt to distill lengthy conversations on the I2RS mailing list for an architecture that was for a long period of time a moving target. Some individuals in particular warrant specific mention for their extensive help in providing the basis for this document: Alia Atlas Andy Bierman Martin Bjorklund Dean Bogdanavich Rex Fernando Joel Halpern Thomas Nadeau Juergen Schoenwaelder Kent Watsen