treat-as-withdrawn documentation

Provides guide to enable treat-as-withdraw procedures.

JIRA: BGPCEP-359
Change-Id: I7b47580b960d5007416206094737c8a0ca6fe287
Signed-off-by: Matej Perina <matej.perina@pantheon.tech>

diff --git a/docs/bgp/bgp-user-guide-revised-error-handling.rst b/docs/bgp/bgp-user-guide-revised-error-handling.rst
new file mode 100644 (file)
index 0000000..4921f81
--- /dev/null
+++ b/docs/bgp/bgp-user-guide-revised-error-handling.rst
@@ -0,0 +1,45 @@
+.. _bgp-user-guide-revised-error-handling:
+
+Revised Error Handling for BGP UPDATE Messages
+==============================================
+
+According to `RFC4271 <https://tools.ietf.org/html/rfc4271>`_ a BGP speaker that receives an UPDATE message containing a malformed attribute
+is required to reset the session over which the offending attribute was received. Revised Error Handling procedures defined in `RFC7606 <https://tools.ietf.org/html/rfc7606>`_
+is introducing a ways to avoid negative effects of session restart. This document provides guide to configure specific approach called *treat-as-withdraw*
+which is treating malformed UPDATE messages as their withdrawal equivalent.
+
+Configuration
+^^^^^^^^^^^^^
+*Treat-as-withdraw* procedures are disabled by default. There are two ways to enable it. One via *peer-group* to affect all neighbors in that group and one via *neighbor*.
+
+For *neighbor* configuration:
+
+**URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols/protocol/openconfig-policy-types:BGP/bgp-example/bgp/neighbors/neighbor/192.0.2.1/error-handling``
+
+For *peer-group* configuration:
+
+**URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols/protocol/openconfig-policy-types:BGP/bgp-example/bgp/peer-groups/peer-group/external-neighbor/error-handling``
+
+**Method:** ``PUT``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+   :linenos:
+   :emphasize-lines: 3
+
+   <error-handling xmlns="urn:opendaylight:params:xml:ns:yang:bgp:openconfig-extensions">
+        <config>
+            <treat-as-withdraw>true</treat-as-withdraw>
+        </config>
+    </error-handling>
+
+@line 3: *True* to enable *treat-as-withdraw* procedures, *False* to disabled it
+
+.. note:: If neighbor Error handling configuration in *neighbor* ALWAYS supersed *peer-group* configuration. That means if *peer-group* have error handling enabled and *neighbor* disabled, result is disabled error handling.
+
+References
+^^^^^^^^^^
+* `Revised Error Handling for BGP UPDATE Messages <https://tools.ietf.org/html/rfc7606>`_
\ No newline at end of file

diff --git a/docs/bgp/bgp-user-guide-supported-capabilities.rst b/docs/bgp/bgp-user-guide-supported-capabilities.rst
index 3651d7d8727c09b61e53c4724764c5f605240ed2..9329d2950d2a05359695cf1d54e9f9fcc71e2266 100644 (file)
--- a/docs/bgp/bgp-user-guide-supported-capabilities.rst
+++ b/docs/bgp/bgp-user-guide-supported-capabilities.rst
@@ -40,4 +40,5 @@ In addition to the base protocol implementation, the plugin provides many extens
 * `RFC7911 <https://tools.ietf.org/html/rfc7911>`_  - Advertisement of Multiple Paths in BGP
 * `RFC2918 <https://tools.ietf.org/html/rfc2918>`_  - Route Refresh Capability for BGP-4
 * `RFC4724 <https://tools.ietf.org/html/rfc4724>`_  - Graceful Restart Mechanism for BGP
-   * `draft-uttaro-idr-bgp-persistence-04 <https://tools.ietf.org/html/draft-uttaro-idr-bgp-persistence-04>`_ - Support for Long-lived BGP Graceful Restart
\ No newline at end of file
+   * `draft-uttaro-idr-bgp-persistence-04 <https://tools.ietf.org/html/draft-uttaro-idr-bgp-persistence-04>`_ - Support for Long-lived BGP Graceful Restart
+* `RFC7606 <https://tools.ietf.org/html/rfc7606>`_ - Revised Error Handling for BGP UPDATE Messages

diff --git a/docs/bgp/index.rst b/docs/bgp/index.rst
index 4b83d7d1d3dd8c878afa632961228b45e41f5598..ac958da798c4a6237a845eb899a2838e7870a684 100644 (file)
--- a/docs/bgp/index.rst
+++ b/docs/bgp/index.rst
@@ -30,3 +30,4 @@ The user should learn about BGP basic concepts, supported capabilities, configur
    bgp-user-guide-test-tools
    bgp-user-guide-pmsi-attribute
    bgp-user-guide-troubleshooting
+   bgp-user-guide-revised-error-handling