[ovs-dev,1/1] ip6gretap documentation
diff mbox series

Message ID 20190622154128.24109-2-elibr@mellanox.com
State New
Headers show
Series
  • ip6gretap documentation
Related show

Commit Message

Eli Britstein June 22, 2019, 3:41 p.m. UTC
Signed-off-by: Eli Britstein <elibr@mellanox.com>
---
 vswitchd/vswitch.xml | 32 ++++++++++++++++++++------------
 1 file changed, 20 insertions(+), 12 deletions(-)

Comments

William Tu June 25, 2019, 4:13 p.m. UTC | #1
On Sat, Jun 22, 2019 at 8:42 AM Eli Britstein <elibr@mellanox.com> wrote:
>
> Signed-off-by: Eli Britstein <elibr@mellanox.com>
> ---

Acked-by: William Tu <u9012063@gmail.com>

>  vswitchd/vswitch.xml | 32 ++++++++++++++++++++------------
>  1 file changed, 20 insertions(+), 12 deletions(-)
>
> diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
> index bf4b6f8dc..b7d81cdaa 100644
> --- a/vswitchd/vswitch.xml
> +++ b/vswitchd/vswitch.xml
> @@ -2561,10 +2561,16 @@
>
>            <dt><code>gre</code></dt>
>            <dd>
> -            Generic Routing Encapsulation (GRE) over IPv4/IPv6 tunnel,
> +            Generic Routing Encapsulation (GRE) over IPv4 tunnel,
>              configurable to encapsulate layer 2 or layer 3 traffic.
>            </dd>
>
> +          <dt><code>ip6gretap</code></dt>
> +          <dd>
> +            Generic Routing Encapsulation (GRE) over IPv6 tunnel,
> +            encapsulate layer 2 traffic.
> +          </dd>
> +
>            <dt><code>vxlan</code></dt>
>            <dd>
>              <p>
> @@ -2623,8 +2629,8 @@
>      <group title="Tunnel Options">
>        <p>
>          These options apply to interfaces with <ref column="type"/> of
> -        <code>geneve</code>, <code>gre</code>, <code>vxlan</code>,
> -        <code>lisp</code> and <code>stt</code>.
> +        <code>geneve</code>, <code>gre</code>, <code>ip6gretap</code>,
> +        <code>vxlan</code>, <code>lisp</code> and <code>stt</code>.
>        </p>
>
>        <p>
> @@ -2921,10 +2927,10 @@
>          </column>
>        </group>
>
> -      <group title="Tunnel Options: gre, geneve, and vxlan">
> +      <group title="Tunnel Options: gre, ip6gretap, geneve, and vxlan">
>          <p>
> -          <code>gre</code>, <code>geneve</code>, and
> -          <code>vxlan</code> interfaces support these options.
> +          <code>gre</code>, <code>ip6gretap</code>, <code>geneve</code>,
> +          and <code>vxlan</code> interfaces support these options.
>          </p>
>
>          <column name="options" key="csum" type='{"type": "boolean"}'>
> @@ -2938,8 +2944,9 @@
>            <p>
>              When using the upstream Linux kernel module, computation of
>              checksums for <code>geneve</code> and <code>vxlan</code> requires
> -            Linux kernel version 4.0 or higher. <code>gre</code> supports
> -            checksums for all versions of Open vSwitch that support GRE.
> +            Linux kernel version 4.0 or higher. <code>gre</code> and
> +            <code>ip6gretap</code> support checksums for all versions of
> +            Open vSwitch that support GRE.
>              The out of tree kernel module distributed as part of OVS
>              can compute all tunnel checksums on any kernel version that it
>              is compatible with.
> @@ -2951,10 +2958,11 @@
>        <group title="Tunnel Options: IPsec">
>          <p>
>            Setting any of these options enables IPsec support for a given
> -          tunnel.  <code>gre</code>, <code>geneve</code>, <code>vxlan</code>,
> -          and <code>stt</code> interfaces support these options.  See the
> -          <code>IPsec</code> section in the <ref table="Open_vSwitch"/> table
> -          for a description of each mode.
> +          tunnel.  <code>gre</code>, <code>ip6gretap</code>,
> +          <code>geneve</code>, <code>vxlan</code> and <code>stt</code>
> +          interfaces support these options.  See the <code>IPsec</code>
> +          section in the <ref table="Open_vSwitch"/> table for a description
> +          of each mode.
>          </p>
>          <column name="options" key="psk" type='{"type": "string"}'>
>            <p>
> --
> 2.17.2
>

Patch
diff mbox series

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index bf4b6f8dc..b7d81cdaa 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -2561,10 +2561,16 @@ 
 
           <dt><code>gre</code></dt>
           <dd>
-            Generic Routing Encapsulation (GRE) over IPv4/IPv6 tunnel,
+            Generic Routing Encapsulation (GRE) over IPv4 tunnel,
             configurable to encapsulate layer 2 or layer 3 traffic.
           </dd>
 
+          <dt><code>ip6gretap</code></dt>
+          <dd>
+            Generic Routing Encapsulation (GRE) over IPv6 tunnel,
+            encapsulate layer 2 traffic.
+          </dd>
+
           <dt><code>vxlan</code></dt>
           <dd>
             <p>
@@ -2623,8 +2629,8 @@ 
     <group title="Tunnel Options">
       <p>
         These options apply to interfaces with <ref column="type"/> of
-        <code>geneve</code>, <code>gre</code>, <code>vxlan</code>,
-        <code>lisp</code> and <code>stt</code>.
+        <code>geneve</code>, <code>gre</code>, <code>ip6gretap</code>,
+        <code>vxlan</code>, <code>lisp</code> and <code>stt</code>.
       </p>
 
       <p>
@@ -2921,10 +2927,10 @@ 
         </column>
       </group>
 
-      <group title="Tunnel Options: gre, geneve, and vxlan">
+      <group title="Tunnel Options: gre, ip6gretap, geneve, and vxlan">
         <p>
-          <code>gre</code>, <code>geneve</code>, and
-          <code>vxlan</code> interfaces support these options.
+          <code>gre</code>, <code>ip6gretap</code>, <code>geneve</code>,
+          and <code>vxlan</code> interfaces support these options.
         </p>
 
         <column name="options" key="csum" type='{"type": "boolean"}'>
@@ -2938,8 +2944,9 @@ 
           <p>
             When using the upstream Linux kernel module, computation of
             checksums for <code>geneve</code> and <code>vxlan</code> requires
-            Linux kernel version 4.0 or higher. <code>gre</code> supports
-            checksums for all versions of Open vSwitch that support GRE.
+            Linux kernel version 4.0 or higher. <code>gre</code> and
+            <code>ip6gretap</code> support checksums for all versions of
+            Open vSwitch that support GRE.
             The out of tree kernel module distributed as part of OVS
             can compute all tunnel checksums on any kernel version that it
             is compatible with.
@@ -2951,10 +2958,11 @@ 
       <group title="Tunnel Options: IPsec">
         <p>
           Setting any of these options enables IPsec support for a given
-          tunnel.  <code>gre</code>, <code>geneve</code>, <code>vxlan</code>,
-          and <code>stt</code> interfaces support these options.  See the
-          <code>IPsec</code> section in the <ref table="Open_vSwitch"/> table
-          for a description of each mode.
+          tunnel.  <code>gre</code>, <code>ip6gretap</code>,
+          <code>geneve</code>, <code>vxlan</code> and <code>stt</code>
+          interfaces support these options.  See the <code>IPsec</code>
+          section in the <ref table="Open_vSwitch"/> table for a description
+          of each mode.
         </p>
         <column name="options" key="psk" type='{"type": "string"}'>
           <p>