diff mbox

[ovs-dev,v11,5/5] ovn: rewrite redirect-chassis description in ovn-nb.xml

Message ID 1485046342-24044-6-git-send-email-mickeys.dev@gmail.com
State Superseded
Headers show

Commit Message

Mickey Spiegel Jan. 22, 2017, 12:52 a.m. UTC
This optional patch addresses offline comments that the documentation
in ovn-nb.xml should not describe southbound constructs or flow
details, since it is user facing documentation.

Signed-off-by: Mickey Spiegel <mickeys.dev@gmail.com>
---
 ovn/ovn-nb.xml | 25 ++++++++++---------------
 1 file changed, 10 insertions(+), 15 deletions(-)

Comments

Gurucharan Shetty Jan. 26, 2017, 5:45 p.m. UTC | #1
On 21 January 2017 at 16:52, Mickey Spiegel <mickeys.dev@gmail.com> wrote:

> This optional patch addresses offline comments that the documentation
> in ovn-nb.xml should not describe southbound constructs or flow
> details, since it is user facing documentation.
>
> Signed-off-by: Mickey Spiegel <mickeys.dev@gmail.com>
>
Acked-by: Gurucharan Shetty <guru@ovn.org>


> ---
>  ovn/ovn-nb.xml | 25 ++++++++++---------------
>  1 file changed, 10 insertions(+), 15 deletions(-)
>
> diff --git a/ovn/ovn-nb.xml b/ovn/ovn-nb.xml
> index 6b193c4..2af46b6 100644
> --- a/ovn/ovn-nb.xml
> +++ b/ovn/ovn-nb.xml
> @@ -1111,24 +1111,19 @@
>        <column name="options" key="redirect-chassis">
>          <p>
>            If set, this indicates that this logical router port represents
> -          a distributed gateway port.  In addition to the southbound
> -          database port representing this distributed gateway port,
> another
> -          port will be created in the southbound database that represents
> a
> -          particular instance, bound to a specific chassis, of this
> -          otherwise distributed logical router port.  This additional port
> -          can then be specified as an <code>outport</code> in some of the
> -          ingress pipeline flows.  This will cause matching packets to be
> -          directed to a specific chassis to carry out the egress pipeline,
> -          allowing a subset of logical router functionality to be
> -          implemented in a centralized manner.  At the beginning of the
> -          egress pipeline, the <code>outport</code> will be reset to the
> -          value of the distributed port.
> +          a distributed gateway port that connects this router to a
> logical
> +          switch with a localnet port.  There may be at most one such
> +          logical router port on each logical router.
>          </p>
>
>          <p>
> -          This option specifies the name of the <code>chassis</code> to
> which
> -          the additional southbound port binding of type
> -          <code>chassisredirect</code> will be bound.
> +          Even when a <code>redirect-chassis</code> is specified, the
> +          logical router port still effectively resides on each chassis.
> +          However, due to the implications of the use of L2 learning in
> the
> +          physical network, as well as the need to support advanced
> features
> +          such as one-to-many NAT (aka IP masquerading), a subset of the
> +          logical router processing is handled in a centralized manner on
> +          the specified <code>redirect-chassis</code>.
>          </p>
>
>          <p>
> --
> 1.9.1
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
diff mbox

Patch

diff --git a/ovn/ovn-nb.xml b/ovn/ovn-nb.xml
index 6b193c4..2af46b6 100644
--- a/ovn/ovn-nb.xml
+++ b/ovn/ovn-nb.xml
@@ -1111,24 +1111,19 @@ 
       <column name="options" key="redirect-chassis">
         <p>
           If set, this indicates that this logical router port represents
-          a distributed gateway port.  In addition to the southbound
-          database port representing this distributed gateway port, another
-          port will be created in the southbound database that represents a
-          particular instance, bound to a specific chassis, of this
-          otherwise distributed logical router port.  This additional port
-          can then be specified as an <code>outport</code> in some of the
-          ingress pipeline flows.  This will cause matching packets to be
-          directed to a specific chassis to carry out the egress pipeline,
-          allowing a subset of logical router functionality to be
-          implemented in a centralized manner.  At the beginning of the
-          egress pipeline, the <code>outport</code> will be reset to the
-          value of the distributed port.
+          a distributed gateway port that connects this router to a logical
+          switch with a localnet port.  There may be at most one such
+          logical router port on each logical router.
         </p>
 
         <p>
-          This option specifies the name of the <code>chassis</code> to which
-          the additional southbound port binding of type
-          <code>chassisredirect</code> will be bound.
+          Even when a <code>redirect-chassis</code> is specified, the
+          logical router port still effectively resides on each chassis.
+          However, due to the implications of the use of L2 learning in the
+          physical network, as well as the need to support advanced features
+          such as one-to-many NAT (aka IP masquerading), a subset of the
+          logical router processing is handled in a centralized manner on
+          the specified <code>redirect-chassis</code>.
         </p>
 
         <p>