[ovs-dev,ovn] ovn-northd: Fix documentation and comments for bridged redirection.
diff mbox series

Message ID 20200224233922.697819-1-blp@ovn.org
State New
Headers show
Series
  • [ovs-dev,ovn] ovn-northd: Fix documentation and comments for bridged redirection.
Related show

Commit Message

Ben Pfaff Feb. 24, 2020, 11:39 p.m. UTC
The series that introduced redirect-type first used "vlan" as the
name for the feature, then changed to "bridged" without updating all
the comments and the documentation.  This updates those.

CC: Ankur Sharma <ankur.sharma@nutanix.com>
Fixes: 37cd27b8a85e ("OVN: Vlan backed DVR N-S, redirect-type option")
Fixes: 8ba15c3d1084 ("OVN: Vlan backed DVR N-S, avoid get_arp on non redirect chassis.")
Fixes: 03493b33c073 ("OVN: Vlan backed DVR N-S, redirect packet via localnet port")
Signed-off-by: Ben Pfaff <blp@ovn.org>
---
 northd/ovn-northd.c    |  2 +-
 ovn-architecture.7.xml | 20 ++++++++++----------
 utilities/ovn-nbctl.c  |  4 ++--
 3 files changed, 13 insertions(+), 13 deletions(-)

Comments

Numan Siddique Feb. 25, 2020, 9:33 a.m. UTC | #1
On Tue, Feb 25, 2020 at 5:09 AM Ben Pfaff <blp@ovn.org> wrote:
>
> The series that introduced redirect-type first used "vlan" as the
> name for the feature, then changed to "bridged" without updating all
> the comments and the documentation.  This updates those.
>
> CC: Ankur Sharma <ankur.sharma@nutanix.com>
> Fixes: 37cd27b8a85e ("OVN: Vlan backed DVR N-S, redirect-type option")
> Fixes: 8ba15c3d1084 ("OVN: Vlan backed DVR N-S, avoid get_arp on non redirect chassis.")
> Fixes: 03493b33c073 ("OVN: Vlan backed DVR N-S, redirect packet via localnet port")
> Signed-off-by: Ben Pfaff <blp@ovn.org>

Acked-by: Numan Siddique <numans@ovn.org>

Thanks
Numan

> ---
>  northd/ovn-northd.c    |  2 +-
>  ovn-architecture.7.xml | 20 ++++++++++----------
>  utilities/ovn-nbctl.c  |  4 ++--
>  3 files changed, 13 insertions(+), 13 deletions(-)
>
> diff --git a/northd/ovn-northd.c b/northd/ovn-northd.c
> index 3aba0487d451..4ae4a04a8d3a 100644
> --- a/northd/ovn-northd.c
> +++ b/northd/ovn-northd.c
> @@ -9442,7 +9442,7 @@ build_lrouter_flows(struct hmap *datapaths, struct hmap *ports,
>                      /* Packet is on a non gateway chassis and
>                       * has an unresolved ARP on a network behind gateway
>                       * chassis attached router port. Since, redirect type
> -                     * is set to vlan, hence instead of calling "get_arp"
> +                     * is "bridged", instead of calling "get_arp"
>                       * on this node, we will redirect the packet to gateway
>                       * chassis, by setting destination mac router port mac.*/
>                      ds_clear(&match);
> diff --git a/ovn-architecture.7.xml b/ovn-architecture.7.xml
> index 6ff924a43ff1..9c8c6ff2dbb3 100644
> --- a/ovn-architecture.7.xml
> +++ b/ovn-architecture.7.xml
> @@ -1662,18 +1662,18 @@
>    </ol>
>
>    <p>
> -    VLAN based redirection
> +    VLAN-based redirection:
>
>      As an enhancement to <code>reside-on-redirect-chassis</code> we support
> -    VLAN based redirection as well. By setting
> -    <code>options:redirect-type</code> to <code>vlan</code> to a gateway
> +    VLAN-based redirection as well. By setting
> +    <code>options:redirect-type</code> to <code>bridged</code> on a gateway
>      chassis attached router port, user can enforce that redirected packet
>      should not use tunnel port but rather use localnet port of peer logical
> -    switch to go out as vlan packet.
> +    switch to go out on a physical VLAN.
>    </p>
>
>    <p>
> -    Following happens for a VLAN based redirection:
> +    Following happens for bridged redirection:
>    </p>
>    <ol>
>      <li>
> @@ -1688,9 +1688,9 @@
>      </li>
>
>      <li>
> -      This VLAN backed redirected packet has destination mac
> -      as router port mac (the one to which gateway chassis is attached) and
> -      vlan id is that of localnet port (peer logical switch of
> +      This redirected packet has destination mac
> +      as router port mac (the one to which gateway chassis is attached).
> +      Its VLAN id is that of localnet port (peer logical switch of
>        the logical router port).
>      </li>
>
> @@ -1705,7 +1705,7 @@
>    </ol>
>
>    <p>
> -    Some guidelines and expections with VLAN based redirection:
> +    Some guidelines and expections with bridged redirection:
>    </p>
>
>    <ol>
> @@ -1725,7 +1725,7 @@
>
>      <li>
>        Default redirection type continues to be <code>overlay</code>.
> -      User can switch the redirect-type between <code>vlan</code>
> +      User can switch the redirect-type between <code>bridged</code>
>        and <code>overlay</code> by changing the value of
>        <code>options:redirect-type</code>
>      </li>
> diff --git a/utilities/ovn-nbctl.c b/utilities/ovn-nbctl.c
> index 33cb75046ee6..e80058e614a3 100644
> --- a/utilities/ovn-nbctl.c
> +++ b/utilities/ovn-nbctl.c
> @@ -680,11 +680,11 @@ Logical router port commands:\n\
>    lrp-set-redirect-type PORT TYPE\n\
>                              set whether redirected packet to gateway chassis\n\
>                              of PORT will be encapsulated or not\n\
> -                            ('overlay' or 'vlan')\n\
> +                            ('overlay' or 'bridged')\n\
>    lrp-get-redirect-type PORT\n\
>                              get whether redirected packet to gateway chassis\n\
>                              of PORT will be encapsulated or not\n\
> -                            ('overlay' or 'vlan')\n\
> +                            ('overlay' or 'bridged')\n\
>  \n\
>  Route commands:\n\
>    [--policy=POLICY] [--ecmp] lr-route-add ROUTER PREFIX NEXTHOP [PORT]\n\
> --
> 2.24.1
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
Numan Siddique Feb. 27, 2020, 7:42 p.m. UTC | #2
On Tue, Feb 25, 2020 at 3:03 PM Numan Siddique <numans@ovn.org> wrote:
>
> On Tue, Feb 25, 2020 at 5:09 AM Ben Pfaff <blp@ovn.org> wrote:
> >
> > The series that introduced redirect-type first used "vlan" as the
> > name for the feature, then changed to "bridged" without updating all
> > the comments and the documentation.  This updates those.
> >
> > CC: Ankur Sharma <ankur.sharma@nutanix.com>
> > Fixes: 37cd27b8a85e ("OVN: Vlan backed DVR N-S, redirect-type option")
> > Fixes: 8ba15c3d1084 ("OVN: Vlan backed DVR N-S, avoid get_arp on non redirect chassis.")
> > Fixes: 03493b33c073 ("OVN: Vlan backed DVR N-S, redirect packet via localnet port")
> > Signed-off-by: Ben Pfaff <blp@ovn.org>
>
> Acked-by: Numan Siddique <numans@ovn.org>

I applied this patch to master and branch-20.03.

Thanks
Numan

>
> Thanks
> Numan
>
> > ---
> >  northd/ovn-northd.c    |  2 +-
> >  ovn-architecture.7.xml | 20 ++++++++++----------
> >  utilities/ovn-nbctl.c  |  4 ++--
> >  3 files changed, 13 insertions(+), 13 deletions(-)
> >
> > diff --git a/northd/ovn-northd.c b/northd/ovn-northd.c
> > index 3aba0487d451..4ae4a04a8d3a 100644
> > --- a/northd/ovn-northd.c
> > +++ b/northd/ovn-northd.c
> > @@ -9442,7 +9442,7 @@ build_lrouter_flows(struct hmap *datapaths, struct hmap *ports,
> >                      /* Packet is on a non gateway chassis and
> >                       * has an unresolved ARP on a network behind gateway
> >                       * chassis attached router port. Since, redirect type
> > -                     * is set to vlan, hence instead of calling "get_arp"
> > +                     * is "bridged", instead of calling "get_arp"
> >                       * on this node, we will redirect the packet to gateway
> >                       * chassis, by setting destination mac router port mac.*/
> >                      ds_clear(&match);
> > diff --git a/ovn-architecture.7.xml b/ovn-architecture.7.xml
> > index 6ff924a43ff1..9c8c6ff2dbb3 100644
> > --- a/ovn-architecture.7.xml
> > +++ b/ovn-architecture.7.xml
> > @@ -1662,18 +1662,18 @@
> >    </ol>
> >
> >    <p>
> > -    VLAN based redirection
> > +    VLAN-based redirection:
> >
> >      As an enhancement to <code>reside-on-redirect-chassis</code> we support
> > -    VLAN based redirection as well. By setting
> > -    <code>options:redirect-type</code> to <code>vlan</code> to a gateway
> > +    VLAN-based redirection as well. By setting
> > +    <code>options:redirect-type</code> to <code>bridged</code> on a gateway
> >      chassis attached router port, user can enforce that redirected packet
> >      should not use tunnel port but rather use localnet port of peer logical
> > -    switch to go out as vlan packet.
> > +    switch to go out on a physical VLAN.
> >    </p>
> >
> >    <p>
> > -    Following happens for a VLAN based redirection:
> > +    Following happens for bridged redirection:
> >    </p>
> >    <ol>
> >      <li>
> > @@ -1688,9 +1688,9 @@
> >      </li>
> >
> >      <li>
> > -      This VLAN backed redirected packet has destination mac
> > -      as router port mac (the one to which gateway chassis is attached) and
> > -      vlan id is that of localnet port (peer logical switch of
> > +      This redirected packet has destination mac
> > +      as router port mac (the one to which gateway chassis is attached).
> > +      Its VLAN id is that of localnet port (peer logical switch of
> >        the logical router port).
> >      </li>
> >
> > @@ -1705,7 +1705,7 @@
> >    </ol>
> >
> >    <p>
> > -    Some guidelines and expections with VLAN based redirection:
> > +    Some guidelines and expections with bridged redirection:
> >    </p>
> >
> >    <ol>
> > @@ -1725,7 +1725,7 @@
> >
> >      <li>
> >        Default redirection type continues to be <code>overlay</code>.
> > -      User can switch the redirect-type between <code>vlan</code>
> > +      User can switch the redirect-type between <code>bridged</code>
> >        and <code>overlay</code> by changing the value of
> >        <code>options:redirect-type</code>
> >      </li>
> > diff --git a/utilities/ovn-nbctl.c b/utilities/ovn-nbctl.c
> > index 33cb75046ee6..e80058e614a3 100644
> > --- a/utilities/ovn-nbctl.c
> > +++ b/utilities/ovn-nbctl.c
> > @@ -680,11 +680,11 @@ Logical router port commands:\n\
> >    lrp-set-redirect-type PORT TYPE\n\
> >                              set whether redirected packet to gateway chassis\n\
> >                              of PORT will be encapsulated or not\n\
> > -                            ('overlay' or 'vlan')\n\
> > +                            ('overlay' or 'bridged')\n\
> >    lrp-get-redirect-type PORT\n\
> >                              get whether redirected packet to gateway chassis\n\
> >                              of PORT will be encapsulated or not\n\
> > -                            ('overlay' or 'vlan')\n\
> > +                            ('overlay' or 'bridged')\n\
> >  \n\
> >  Route commands:\n\
> >    [--policy=POLICY] [--ecmp] lr-route-add ROUTER PREFIX NEXTHOP [PORT]\n\
> > --
> > 2.24.1
> >
> > _______________________________________________
> > dev mailing list
> > dev@openvswitch.org
> > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
> >

Patch
diff mbox series

diff --git a/northd/ovn-northd.c b/northd/ovn-northd.c
index 3aba0487d451..4ae4a04a8d3a 100644
--- a/northd/ovn-northd.c
+++ b/northd/ovn-northd.c
@@ -9442,7 +9442,7 @@  build_lrouter_flows(struct hmap *datapaths, struct hmap *ports,
                     /* Packet is on a non gateway chassis and
                      * has an unresolved ARP on a network behind gateway
                      * chassis attached router port. Since, redirect type
-                     * is set to vlan, hence instead of calling "get_arp"
+                     * is "bridged", instead of calling "get_arp"
                      * on this node, we will redirect the packet to gateway
                      * chassis, by setting destination mac router port mac.*/
                     ds_clear(&match);
diff --git a/ovn-architecture.7.xml b/ovn-architecture.7.xml
index 6ff924a43ff1..9c8c6ff2dbb3 100644
--- a/ovn-architecture.7.xml
+++ b/ovn-architecture.7.xml
@@ -1662,18 +1662,18 @@ 
   </ol>
 
   <p>
-    VLAN based redirection
+    VLAN-based redirection:
 
     As an enhancement to <code>reside-on-redirect-chassis</code> we support
-    VLAN based redirection as well. By setting
-    <code>options:redirect-type</code> to <code>vlan</code> to a gateway
+    VLAN-based redirection as well. By setting
+    <code>options:redirect-type</code> to <code>bridged</code> on a gateway
     chassis attached router port, user can enforce that redirected packet
     should not use tunnel port but rather use localnet port of peer logical
-    switch to go out as vlan packet.
+    switch to go out on a physical VLAN.
   </p>
 
   <p>
-    Following happens for a VLAN based redirection:
+    Following happens for bridged redirection:
   </p>
   <ol>
     <li>
@@ -1688,9 +1688,9 @@ 
     </li>
 
     <li>
-      This VLAN backed redirected packet has destination mac
-      as router port mac (the one to which gateway chassis is attached) and
-      vlan id is that of localnet port (peer logical switch of
+      This redirected packet has destination mac
+      as router port mac (the one to which gateway chassis is attached).
+      Its VLAN id is that of localnet port (peer logical switch of
       the logical router port).
     </li>
 
@@ -1705,7 +1705,7 @@ 
   </ol>
 
   <p>
-    Some guidelines and expections with VLAN based redirection:
+    Some guidelines and expections with bridged redirection:
   </p>
 
   <ol>
@@ -1725,7 +1725,7 @@ 
 
     <li>
       Default redirection type continues to be <code>overlay</code>.
-      User can switch the redirect-type between <code>vlan</code>
+      User can switch the redirect-type between <code>bridged</code>
       and <code>overlay</code> by changing the value of
       <code>options:redirect-type</code>
     </li>
diff --git a/utilities/ovn-nbctl.c b/utilities/ovn-nbctl.c
index 33cb75046ee6..e80058e614a3 100644
--- a/utilities/ovn-nbctl.c
+++ b/utilities/ovn-nbctl.c
@@ -680,11 +680,11 @@  Logical router port commands:\n\
   lrp-set-redirect-type PORT TYPE\n\
                             set whether redirected packet to gateway chassis\n\
                             of PORT will be encapsulated or not\n\
-                            ('overlay' or 'vlan')\n\
+                            ('overlay' or 'bridged')\n\
   lrp-get-redirect-type PORT\n\
                             get whether redirected packet to gateway chassis\n\
                             of PORT will be encapsulated or not\n\
-                            ('overlay' or 'vlan')\n\
+                            ('overlay' or 'bridged')\n\
 \n\
 Route commands:\n\
   [--policy=POLICY] [--ecmp] lr-route-add ROUTER PREFIX NEXTHOP [PORT]\n\