draft-ietf-netmod-opstate-reqs-03.txt   draft-ietf-netmod-opstate-reqs-04.txt 
NETMOD Working Group K. Watsen NETMOD Working Group K. Watsen
Internet-Draft Juniper Networks Internet-Draft Juniper Networks
Intended status: Informational T. Nadeau Intended status: Informational T. Nadeau
Expires: July 11, 2016 Brocade Networks Expires: July 25, 2016 Brocade Networks
January 8, 2016 January 22, 2016
Terminology and Requirements for Enhanced Handling of Operational State Terminology and Requirements for Enhanced Handling of Operational State
draft-ietf-netmod-opstate-reqs-03 draft-ietf-netmod-opstate-reqs-04
Abstract Abstract
This document primarily regards the difference between the intended This document primarily regards the difference between the intended
configuration and the applied configuration of a device and how configuration and the applied configuration of a device and how
intended and applied configuration relate to the operational state of intended and applied configuration relate to the operational state of
a device. This document defines requirements for the applied a device. This document defines requirements for the applied
configuration's data model and its values, as well as for enabling a configuration's data model and its values, as well as for enabling a
client to know when a configuration has been fully applied or not, client to know when a configuration has been fully applied or not,
how to access operational state, and how to relate intended how to access operational state, and how to relate intended
skipping to change at page 1, line 38 skipping to change at page 1, line 38
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 11, 2016. This Internet-Draft will expire on July 25, 2016.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2
3. Backwards Compatibility . . . . . . . . . . . . . . . . . . . 4 3. Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4
4. Requirements . . . . . . . . . . . . . . . . . . . . . . . . 4 4. Security Considerations . . . . . . . . . . . . . . . . . . . 5
5. Security Considerations . . . . . . . . . . . . . . . . . . . 5 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 6
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 7.1. Normative References . . . . . . . . . . . . . . . . . . 6
8.1. Normative References . . . . . . . . . . . . . . . . . . 6 7.2. Informative References . . . . . . . . . . . . . . . . . 6
8.2. Informative References . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6
1. Introduction 1. Introduction
This document primarily regards the difference between the intended This document primarily regards the difference between the intended
configuration and the applied configuration of a device and how configuration and the applied configuration of a device and how
intended and applied configuration relate to the operational state of intended and applied configuration relate to the operational state of
a device. This document defines requirements for the applied a device. This document defines requirements for the applied
configuration's data model and its values, as well as for enabling a configuration's data model and its values, as well as for enabling a
client to know when a configuration has been fully applied or not, client to know when a configuration has been fully applied or not,
skipping to change at page 3, line 22 skipping to change at page 3, line 20
of [RFC6244] of [RFC6244]
NOTE: The server's ability to report applied configuration NOTE: The server's ability to report applied configuration
accurately may be limited in some cases, such as when the accurately may be limited in some cases, such as when the
configuration goes through an intermediate layer without an configuration goes through an intermediate layer without an
ability to inspect the lower layer. ability to inspect the lower layer.
Asynchronous Configuration Operation: A configuration request to Asynchronous Configuration Operation: A configuration request to
update the running configuration of a server that is applied update the running configuration of a server that is applied
asynchronously with respect to the client request. The server asynchronously with respect to the client request. The server
MUST update its intended configuration (see term) before replying MUST update its intended configuration before replying to the
to the client indicating whether the request will be processed. client indicating whether the request will be processed. This
This reply to the client only indicates whether there are any reply to the client only indicates whether there are any errors
errors in the original request. The server's applied in the original request. The server's applied configuration
configuration state (see term) is updated after the configuration state is updated after the configuration change has been fully
change has been fully effected to all impacted components in the effected to all impacted components in the server.
server. Once applied, there MUST be a mechanism for the client
to determine when the request has completed processing and
whether the intended config is now fully effective or there are
any errors from applying the configuration change, which could be
from an asynchronous notification or via a client operation.
Derived State: This data represents information which is generated Derived State: This data represents information which is generated
as part of the server's own interactions. For example, derived as part of the server's own interactions. For example, derived
state may consist of the results of protocol interactions (the state may consist of the results of protocol interactions (the
negotiated duplex state of an Ethernet link), statistics (such as negotiated duplex state of an Ethernet link), statistics (such as
message queue depth), or counters (such as packet input or output message queue depth), or counters (such as packet input or output
bytes). bytes).
Intended Configuration: This data represents the configuration state Intended Configuration: This data represents the configuration state
that the network operator intends the server to be in, and that that the network operator intends the server to be in, and that
skipping to change at page 4, line 4 skipping to change at page 3, line 44
Intended Configuration: This data represents the configuration state Intended Configuration: This data represents the configuration state
that the network operator intends the server to be in, and that that the network operator intends the server to be in, and that
has been accepted by the server as valid configuration. With has been accepted by the server as valid configuration. With
respect to NETCONF architecture, the intended configuration is respect to NETCONF architecture, the intended configuration is
captured by the "config database" box listed on page 15 of captured by the "config database" box listed on page 15 of
[RFC6244] [RFC6244]
Operational State: Operational State is the current state of the Operational State: Operational State is the current state of the
system as known to the various components of the system (e.g., system as known to the various components of the system (e.g.,
control plane daemons, operating system kernels, line cards). control plane daemons, operating system kernels, line cards).
The operational state includes both applied configuration and The operational state includes both applied configuration and
derived state. derived state.
Synchronous Configuration Operation: A configuration request to Synchronous Configuration Operation: A configuration request to
update the running configuration of a server that is applied update the running configuration of a server that is applied
synchronously with respect to the client request (i.e. a blocking synchronously with respect to the client request (i.e. a blocking
call). The server MUST fully attempt to apply the configuration call). The server MUST fully attempt to apply the configuration
change to all impacted components in the server, updating both change to all impacted components in the server, updating both
the server's intended and applied configuration (see terms), the server's intended and applied configuration, before replying
before replying to the client. The reply to the client indicates to the client. The reply to the client indicates whether there
whether there are any errors in the request or errors from are any errors in the request or errors from applying the
applying the configuration change. configuration change.
3. Backwards Compatibility
Any solution satisfying the requirements specified in this document
MUST ensure backwards compatibility with regards to existing
deployments. Specifically, it MUST be possible to upgrade a server
to one that supports the solution without breaking existing/legacy
clients. Likewise, it MUST be possible for a client that has been
coded to support the solution to interoperate appropriately with
existing/legacy servers.
4. Requirements 3. Requirements
1. Ability to interact with both intended and applied configuration 1. Ability to interact with both intended and applied configuration
A. The ability to ask the operational components of a server A. The ability to ask the operational components of a server
(e.g., line cards) for the configuration that they are (e.g., line cards) for the configuration that they are
currently using. This is the applied configuration (see currently using. This is the applied configuration.
term).
B. Applied configuration is read-only B. Applied configuration is read-only
C. The data model for the applied configuration is the same as C. The data model for the applied configuration is the same as
the data model for the intended configuration (same leaves) the data model for the intended configuration (same leaves)
D. When a configuration change for any intended configuration D. When a configuration change for any intended configuration
node has been successfully applied to the server (e.g. not node has been successfully applied to the server (e.g. not
failed, nor deferred due to absent hardware) then the failed, nor deferred due to absent hardware) then the
existence and value of the corresponding applied existence and value of the corresponding applied
configuration node must match the intended configuration configuration node must match the intended configuration
node. node.
2. Support for both synchronous and asynchronous configuration 2. Support for both synchronous and asynchronous configuration
operations (see terms) operations
A. A server may support only synchronous configuration
A. A server MUST support only synchronous configuration
operations, or only asynchronous configuration operations, or operations, or only asynchronous configuration operations, or
both synchronous and asynchronous configuration operations on both synchronous and asynchronous configuration operations on
a client-specified per-operation basis. a client-specified per-operation basis.
B. Servers that support asynchronous configuration operations B. Servers that support asynchronous configuration operations
MAY also provide a verify operation that a client can request MUST provide a mechanism to notify the client when a request
from the server to return information regarding the has completed processing. The notification MUST indicate
whether the intended config is now fully applied or if there
were any errors from applying the configuration change.
C. Servers that support asynchronous configuration operations
SHOULD also provide a verify operation that a client can
request from the server to return information regarding the
difference between the intended and applied configurations. difference between the intended and applied configurations.
C. The configuration protocol MUST specify how configuration D. The configuration protocol MUST specify how configuration
errors are handled. Errors MAY be handled by semantics errors are handled. Errors SHOULD be handled by semantics
similar to NETCONF's error-options for the <edit-config> similar to NETCONF's error-options for the <edit-config>
operation (stop-on-error, continue-on-error, rollback-on- operation (stop-on-error, continue-on-error, rollback-on-
error), as described in Section 7.2 in [RFC6241], but error), as described in Section 7.2 in [RFC6241], but
extended to incorporate both the intended and applied extended to incorporate both the intended and applied
configurations. Support for "rollback on error" semantics configurations. Support for "rollback on error" semantics
SHOULD be provided. SHOULD be provided.
3. Separation of the applied configuration and derived state aspects 3. Separation of the applied configuration and derived state aspects
of operational state; ability to retrieve them independently and of operational state; ability to retrieve them independently and
together together
skipping to change at page 5, line 39 skipping to change at page 5, line 25
B. Be able to retrieve only the derived state aspects of B. Be able to retrieve only the derived state aspects of
operational state operational state
C. Be able to retrieve both the applied configuration and C. Be able to retrieve both the applied configuration and
derived state aspects of operational state together derived state aspects of operational state together
4. Ability to relate configuration with its corresponding 4. Ability to relate configuration with its corresponding
operational state operational state
A. Ability to map intended config nodes to corresponding applied A. Ability to relate intended config nodes to corresponding
config nodes applied config nodes
B. Ability to map intended config nodes to associated derived B. Ability to relate intended config nodes to associated derived
state nodes state nodes
C. The mappings needs to be programmatically consumable C. The relationships need to be programmatically consumable
5. Security Considerations 5. Backwards compatibility
A. It MUST be possible to upgrade a server to one that supports
the solution without breaking existing/legacy clients.
B. It MUST be possible for a client that has been coded to
support the solution to interoperate appropriately with
existing/legacy servers.
4. Security Considerations
It is understood that the intended and applied configurations will It is understood that the intended and applied configurations will
differ while synchronization is in progress. During the differ while synchronization is in progress. During the
synchronization process, the server will be in an inconsistent state synchronization process, the server will be in an inconsistent state
from the client's perspective. Implementations need to take care to from the client's perspective. Implementations need to take care to
ensure that this process minimizes gaps in the application of ensure that this process minimizes gaps in the application of
security policy (e.g., replacing a firewall policy in a single step). security policy (e.g., replacing a firewall policy in a single step).
Implementations additionally need to ensure that any gaps in security Implementations additionally need to ensure that any gaps in security
policies are not dependent on external input that an attacker might policies are not dependent on external input that an attacker might
be able to control or prevent access to. be able to control or prevent access to.
6. IANA Considerations 5. IANA Considerations
None None
7. Acknowledgements 6. Acknowledgements
The authors would like to thank the following for contributing to The authors would like to thank the following for contributing to
this document (in alphabetic order): Acee Lindem, Andy Bierman, Anees this document (in alphabetic order): Acee Lindem, Andy Bierman, Anees
Shaikh, Benoit Claise, Carl Moberg, Dan Romascanu, Dean Bogdanovic, Shaikh, Benoit Claise, Carl Moberg, Dan Romascanu, Dean Bogdanovic,
Gert Grammel, Jason Sterne, Jonathan Hansford, Juergen Schoenwaelder, Gert Grammel, Jason Sterne, Jonathan Hansford, Juergen Schoenwaelder,
Lou Berger, Mahesh Jethanandani, Martin Bjorklund, Phil Shafer, Randy Lou Berger, Mahesh Jethanandani, Martin Bjorklund, Phil Shafer, Randy
Presuhn, Rob Shakir, Robert Wilton. Presuhn, Rob Shakir, Robert Wilton.
8. References 7. References
8.1. Normative References 7.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>. <http://www.rfc-editor.org/info/rfc2119>.
8.2. Informative References 7.2. Informative References
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>. <http://www.rfc-editor.org/info/rfc6241>.
[RFC6244] Shafer, P., "An Architecture for Network Management Using [RFC6244] Shafer, P., "An Architecture for Network Management Using
NETCONF and YANG", RFC 6244, DOI 10.17487/RFC6244, June NETCONF and YANG", RFC 6244, DOI 10.17487/RFC6244, June
2011, <http://www.rfc-editor.org/info/rfc6244>. 2011, <http://www.rfc-editor.org/info/rfc6244>.
 End of changes. 21 change blocks. 
57 lines changed or deleted 55 lines changed or added

This html diff was produced by rfcdiff 1.42. The latest version is available from http://tools.ietf.org/tools/rfcdiff/