diff mbox

[ovs-dev,2/7] ovn-northd.8: Update documentation.

Message ID 1467188231-10194-3-git-send-email-guru@ovn.org
State Accepted
Headers show

Commit Message

Gurucharan Shetty June 29, 2016, 8:17 a.m. UTC
When new tables are introduced, it gets a little harder to
track all the different table numbers used in the documentation.
This commit changes some table numbers to names to make it a little
easier to update documentation when new tables are introduced in the
upcoming commits.

Signed-off-by: Gurucharan Shetty <guru@ovn.org>
---
 ovn/northd/ovn-northd.8.xml | 40 ++++++++++++++++++++++------------------
 1 file changed, 22 insertions(+), 18 deletions(-)

Comments

Zong Kai LI June 30, 2016, 4:08 a.m. UTC | #1
>
> -      Ingress table 3 prepares flows for possible stateful ACL processing
> -      in table 4.  It contains a priority-0 flow that simply moves
> -      traffic to table 4.  If stateful ACLs are used in the logical
> -      datapath, a priority-100 flow is added that sends IP packets to
> -      the connection tracker before advancing to table 4.
> +      This table prepares flows for possible stateful ACL processing in
> +      ingress table <code>ACLs</code>.  It contains a priority-0 flow that
> +      simply moves traffic to the next table.  If stateful ACLs are used
> in the
> +      logical datapath, a priority-100 flow is added that sends IP
> packets to
> +      the connection tracker before advancing to ingress table
> +      <code>ACLs</code>.
>      </p>


After this changing, shall we also need to update the following line,
remove "<code>from-lport</code>" to make table name simpler and clearer?


>      <h3>Ingress table 4: <code>from-lport</code> ACLs</h3>
>



> -      This is similar to ingress table 3 except for <code>to-lport</code>
> -      traffic.
> +      This is similar to ingress table <code>Pre-ACLs</code> except for
> +     <code>to-lport</code> traffic.
>      </p>
>
>      <h3>Egress Table 1: <code>to-lport</code> ACLs</h3>
>

ditto

thanks.
Zong Kai, LI
Gurucharan Shetty June 30, 2016, 2:51 p.m. UTC | #2
On 29 June 2016 at 21:08, Zong Kai LI <zealokii@gmail.com> wrote:

> >
> > -      Ingress table 3 prepares flows for possible stateful ACL
> processing
> > -      in table 4.  It contains a priority-0 flow that simply moves
> > -      traffic to table 4.  If stateful ACLs are used in the logical
> > -      datapath, a priority-100 flow is added that sends IP packets to
> > -      the connection tracker before advancing to table 4.
> > +      This table prepares flows for possible stateful ACL processing in
> > +      ingress table <code>ACLs</code>.  It contains a priority-0 flow
> that
> > +      simply moves traffic to the next table.  If stateful ACLs are used
> > in the
> > +      logical datapath, a priority-100 flow is added that sends IP
> > packets to
> > +      the connection tracker before advancing to ingress table
> > +      <code>ACLs</code>.
> >      </p>
>
>
> After this changing, shall we also need to update the following line,
> remove "<code>from-lport</code>" to make table name simpler and clearer?
>

The intention of this patch is to only change table numbers to table names.
Changing existing table names, should ideally come in a different patch
with proper rationale on why we want to change the name. Currently,
'from-lport' and 'to-lport' acts as qualifiers to make it a little easier
to read (I personally find it helpful.).

>
>
> >      <h3>Ingress table 4: <code>from-lport</code> ACLs</h3>
> >
>
>
>
> > -      This is similar to ingress table 3 except for
> <code>to-lport</code>
> > -      traffic.
> > +      This is similar to ingress table <code>Pre-ACLs</code> except for
> > +     <code>to-lport</code> traffic.
> >      </p>
> >
> >      <h3>Egress Table 1: <code>to-lport</code> ACLs</h3>
> >
>
> ditto
>
> thanks.
> Zong Kai, LI
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> http://openvswitch.org/mailman/listinfo/dev
>
Ben Pfaff July 3, 2016, 4:36 a.m. UTC | #3
On Wed, Jun 29, 2016 at 01:17:06AM -0700, Gurucharan Shetty wrote:
> When new tables are introduced, it gets a little harder to
> track all the different table numbers used in the documentation.
> This commit changes some table numbers to names to make it a little
> easier to update documentation when new tables are introduced in the
> upcoming commits.
> 
> Signed-off-by: Gurucharan Shetty <guru@ovn.org>

Acked-by: Ben Pfaff <blp@ovn.org>
diff mbox

Patch

diff --git a/ovn/northd/ovn-northd.8.xml b/ovn/northd/ovn-northd.8.xml
index 260cc14..4d712a1 100644
--- a/ovn/northd/ovn-northd.8.xml
+++ b/ovn/northd/ovn-northd.8.xml
@@ -191,7 +191,7 @@ 
 
       <li>
         One priority-0 fallback flow that matches all packets and advances to
-        table 2.
+        the next table.
       </li>
     </ul>
 
@@ -236,18 +236,19 @@ 
 
       <li>
         One priority-0 fallback flow that matches all packets and advances to
-        table 3.
+        the next table.
       </li>
     </ul>
 
     <h3>Ingress Table 3: <code>from-lport</code> Pre-ACLs</h3>
 
     <p>
-      Ingress table 3 prepares flows for possible stateful ACL processing
-      in table 4.  It contains a priority-0 flow that simply moves
-      traffic to table 4.  If stateful ACLs are used in the logical
-      datapath, a priority-100 flow is added that sends IP packets to
-      the connection tracker before advancing to table 4.
+      This table prepares flows for possible stateful ACL processing in
+      ingress table <code>ACLs</code>.  It contains a priority-0 flow that
+      simply moves traffic to the next table.  If stateful ACLs are used in the
+      logical datapath, a priority-100 flow is added that sends IP packets to
+      the connection tracker before advancing to ingress table
+      <code>ACLs</code>.
     </p>
 
     <h3>Ingress table 4: <code>from-lport</code> ACLs</h3>
@@ -266,7 +267,7 @@ 
     </p>
 
     <p>
-      Ingress table 4 also contains a priority 0 flow with action
+      This table also contains a priority 0 flow with action
       <code>next;</code>, so that ACLs allow packets by default.  If the
       logical datapath has a statetful ACL, the following flows will
       also be added:
@@ -308,7 +309,7 @@ 
     <ul>
       <li>
         Priority-100 flows to skip ARP responder if inport is of type
-        <code>localnet</code>, and advances directly to table 6.
+        <code>localnet</code>, and advances directly to the next table.
       </li>
 
       <li>
@@ -339,7 +340,7 @@  output;
 
       <li>
         One priority-0 fallback flow that matches all packets and advances to
-        table 6.
+        the next table.
       </li>
     </ul>
 
@@ -377,29 +378,32 @@  output;
     <h3>Egress Table 0: <code>to-lport</code> Pre-ACLs</h3>
 
     <p>
-      This is similar to ingress table 3 except for <code>to-lport</code>
-      traffic.
+      This is similar to ingress table <code>Pre-ACLs</code> except for
+     <code>to-lport</code> traffic.
     </p>
 
     <h3>Egress Table 1: <code>to-lport</code> ACLs</h3>
 
     <p>
-      This is similar to ingress table 4 except for <code>to-lport</code> ACLs.
+      This is similar to ingress table <code>ACLs</code> except for
+      <code>to-lport</code> ACLs.
     </p>
 
     <h3>Egress Table 2: Egress Port Security - IP</h3>
 
     <p>
-      This is similar to the ingress port security logic in table 1 except
-      that <code>outport</code>, <code>eth.dst</code>, <code>ip4.dst</code>
-      and <code>ip6.dst</code> are checked instead of <code>inport</code>,
-      <code>eth.src</code>, <code>ip4.src</code> and <code>ip6.src</code>
+      This is similar to the port security logic in table
+      <code>Ingress Port Security - IP</code> except that <code>outport</code>,
+      <code>eth.dst</code>, <code>ip4.dst</code> and <code>ip6.dst</code>
+      are checked instead of <code>inport</code>, <code>eth.src</code>,
+      <code>ip4.src</code> and <code>ip6.src</code>
     </p>
 
     <h3>Egress Table 3: Egress Port Security - L2</h3>
 
     <p>
-      This is similar to the ingress port security logic in ingress table 0,
+      This is similar to the ingress port security logic in ingress table
+      <code>Admission Control and Ingress Port Security - L2</code>,
       but with important differences.  Most obviously, <code>outport</code> and
       <code>eth.dst</code> are checked instead of <code>inport</code> and
       <code>eth.src</code>.  Second, packets directed to broadcast or multicast