diff mbox series

[ovs-dev,1/1] vswitch.xml: Add description of SRv6 tunnel and related options.

Message ID 20230330072947.90677-1-nmiki@yahoo-corp.jp
State Accepted
Commit 0f34ecbd5a73b00f1dd8c6675c7be6fec6e094d4
Headers show
Series [ovs-dev,1/1] vswitch.xml: Add description of SRv6 tunnel and related options. | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/intel-ovs-compilation success test: success

Commit Message

Nobuhiro MIKI March 30, 2023, 7:29 a.m. UTC
The description of SRv6 was missing in vswitch.xml, which is
used to generate the man page, so this patch adds it.

Fixes: 03fc1ad78521 ("userspace: Add SRv6 tunnel support.")
Signed-off-by: Nobuhiro MIKI <nmiki@yahoo-corp.jp>
---
 vswitchd/vswitch.xml | 39 ++++++++++++++++++++++++++++++++-------
 1 file changed, 32 insertions(+), 7 deletions(-)

Comments

Ilya Maximets March 30, 2023, 8:48 p.m. UTC | #1
On 3/30/23 09:29, Nobuhiro MIKI wrote:
> The description of SRv6 was missing in vswitch.xml, which is
> used to generate the man page, so this patch adds it.
> 
> Fixes: 03fc1ad78521 ("userspace: Add SRv6 tunnel support.")
> Signed-off-by: Nobuhiro MIKI <nmiki@yahoo-corp.jp>
> ---
>  vswitchd/vswitch.xml | 39 ++++++++++++++++++++++++++++++++-------
>  1 file changed, 32 insertions(+), 7 deletions(-)
> 
> diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
> index 88e2c94e2f0e..19b79ddb5d48 100644
> --- a/vswitchd/vswitch.xml
> +++ b/vswitchd/vswitch.xml
> @@ -2845,6 +2845,16 @@
>              </p>
>            </dd>
>  
> +          <dt><code>SRv6</code></dt>

I converted this to lowercase because 'type' is case-sensitive
(capital 'B' in 'Bareudp' is a mistake..) and applied the patch.
Thanks!

Best regards, Ilya Maximets.
diff mbox series

Patch

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 88e2c94e2f0e..19b79ddb5d48 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -2845,6 +2845,16 @@ 
             </p>
           </dd>
 
+          <dt><code>SRv6</code></dt>
+          <dd>
+            <p>
+            Segment Routing IPv6 (SRv6) tunnel encapsulates L3 traffic as
+            "IPv6 in IPv6" or "IPv4 in IPv6" with Segment Routing Header (SRH)
+            defined in RFC 8754. The segment list in SRH can be set using a
+            SRv6 specific option.
+            </p>
+          </dd>
+
         </dl>
       </column>
     </group>
@@ -2853,8 +2863,8 @@ 
       <p>
         These options apply to interfaces with <ref column="type"/> of
         <code>geneve</code>, <code>bareudp</code>, <code>gre</code>,
-        <code>ip6gre</code>, <code>vxlan</code>, <code>lisp</code> and
-        <code>stt</code>.
+        <code>ip6gre</code>, <code>vxlan</code>, <code>lisp</code>,
+        <code>stt</code> and <code>srv6</code>.
       </p>
 
       <p>
@@ -2867,7 +2877,8 @@ 
         considered more specific than <ref column="options" key="local_ip"/> if
         a port defines one and another port defines the other.
         <ref column="options" key="in_key"/> is not applicable for bareudp
-        tunnels. Hence it is not considered while identifying a bareudp tunnel.
+        and srv6 tunnels. Hence it is not considered while identifying
+        bareudp or srv6 tunnels.
       </p>
 
       <column name="options" key="remote_ip">
@@ -2935,8 +2946,9 @@ 
 
       <column name="options" key="in_key">
         <p>
-          Optional, not applicable for <code>bareudp</code>. The key that
-          received packets must contain, one of:
+          Optional, not applicable for <code>bareudp</code> and
+          <code>srv6</code>. The key that received packets must contain,
+          one of:
         </p>
 
         <ul>
@@ -2965,8 +2977,9 @@ 
 
       <column name="options" key="out_key">
       <p>
-        Optional, not applicable for <code>bareudp</code>. The key to be set
-        on outgoing packets, one of:
+        Optional, not applicable for <code>bareudp</code> and
+        <code>srv6</code>. The key to be set on outgoing packets,
+        one of:
       </p>
 
         <ul>
@@ -3264,6 +3277,18 @@ 
       </column>
     </group>
 
+    <group title="Tunnel Options: SRv6 only">
+      <column name="options" key="srv6_segs">
+        <p>
+           Specifies the segment list in Segment Routing Header (SRH).
+           It consists of a comma-separated list of segments represented
+           in IPv6 format, e.g. "fc00:100::1,fc00:200::1,fc00:300::1".
+           Note that the first segment must be the same as
+           <ref column="options" key="remote_ip"/>.
+        </p>
+      </column>
+    </group>
+
     <group title="Patch Options">
       <p>
         These options apply only to <dfn>patch ports</dfn>, that is, interfaces