The documentation of the ct_lb action wasn't up to date. Add the
description for backends and hash_fields.
Fixes: 5af304e7478a ("Support selection fields in load balancer.")
Signed-off-by: Han Zhou <hz...@ovn.org>
---
ovn-sb.xml | 29 ++++++++++++++++++-----------
1 file changed, 18 insertions(+), 11 deletions(-)
diff --git a/ovn-sb.xml b/ovn-sb.xml
index f7c41ccdc..3afea4ed4 100644
--- a/ovn-sb.xml
+++ b/ovn-sb.xml
@@ -1955,21 +1955,19 @@
</dd>
<dt><code>ct_lb;</code></dt>
-
<dt><code>ct_lb(</code><var>ip</var>[<code>:</code><var>port</var>]...<code>);</code></dt>
+ <dt><code>ct_lb(backends=<var>ip</var>[:<var>port</var>][,...][;
hash_fields=<var>field1</var>,<var>field2</var>,...]);</code></dt>
<dd>
<p>
- With one or more arguments, <code>ct_lb</code> commits the packet
+ With arguments, <code>ct_lb</code> commits the packet
to the connection tracking table and DNATs the packet's destination
IP address (and port) to the IP address or addresses (and optional
- ports) specified in the string. If multiple comma-separated IP
- addresses are specified, each is given equal weight for picking the
- DNAT address. Processing automatically moves on to the next table,
- as if <code>next;</code> were specified, and later tables act on
- the packet as modified by the connection tracker. Connection
- tracking state is scoped by the logical port when the action is
- used in a flow for a logical switch, so overlapping
- addresses may be used. Connection tracking state is scoped by the
- logical topology when the action is used in a flow for a router.
+ ports) specified in the <code>backends</code>. If multiple
+ comma-separated IP addresses are specified, each is given equal
+ weight for picking the DNAT address. By default,
+ <code>dp_hash</code> is used as the OpenFlow group selection
+ method, but if <code>hash_fields</code> is specified,
+ <code>hash</code> is used as the selection method, and the fields
+ listed are used as the hash fields.
</p>
<p>
Without arguments, <code>ct_lb</code> sends the packet to the
@@ -1979,6 +1977,15 @@
will automatically get DNATed to the same IP address as the first
packet in that connection.
</p>
+ <p>
+ Processing automatically moves on to the next table,
+ as if <code>next;</code> were specified, and later tables act on
+ the packet as modified by the connection tracker. Connection
+ tracking state is scoped by the logical port when the action is
+ used in a flow for a logical switch, so overlapping
+ addresses may be used. Connection tracking state is scoped by the
+ logical topology when the action is used in a flow for a router.
+ </p>
</dd>
<dt>
--
2.30.2
_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
