@@ -400,42 +400,62 @@
</dd>
</dl>
- <h1>Logical Switch/Router LB Commands</h1>
+ <h1>Load Balancer Commands</h1>
<dl>
<dt>[<code>--may-exist</code> | <code>--add-duplicate</code>]
<code>lb-add</code> <var>lb</var> <var>vip</var> <var>ips</var>
[<var>protocol</var>]
<dd>
- Creates a new load balancer named <var>lb</var> with the
<var>vip</var> or
- adds the <var>vip</var> to <var>lb</var>. A single load balancer
can
- have multiple vips. We should assign <var>lb</var> a virtual IPv4
address
- (and an optional port number with : as a separator) and the
corresponding
- endpoint IPv4 addresses (and optional port numbers with : as
separators)
- separated by commas. The optional argument <var>protocol</var>
must be
- either <code>tcp</code> or <code>udp</code>. This argument is
useful when
- a port number is provided as part of the <var>vip</var>. If the
<var>protocol</var>
- is unspecified and a port number is provided as part of
<var>vip</var>,
- OVN assumes the <var>protocol</var> to be <code>tcp</code>. It is
an
- error if the <var>vip</var> has been included in the load balancer
named
- <var>lb</var>, unless <code>--may-exist</code> is specified.
- With <code>--add-duplicate</code>, the command really creates a
new load
- balancer with a duplicate name. The following example adds a load
balancer
- with <var>protocol</var> <code>udp</code>:
<p>
- <code>lb-add lb0 30.0.0.10:80 192.168.10.10:80,192.168.10.20:80,
192.168.10.30:80 udp</code>
+ Creates a new load balancer named <var>lb</var> with the provided
+ <var>vip</var> and <var>ips</var> or adds the <var>vip</var> to
+ an existing <var>lb</var>. <var>vip</var> should be a
+ virtual IPv4 address (or an IPv4 address and a port number with
+ <code>:</code> as a separator). Examples for <var>vip</var> are
+ <code>192.168.1.4</code> and <code>192.168.1.5:8080</code>.
+ <var>ips</var> should be comma separated IPv4 endpoints (or comma
+ separated IPv4 addresses and port numbers with <code>:</code> as
a
+ separator). Examples for <var>ips</var> are
<code>10.0.0.1,10.0.0.2
+ </code> or <code>20.0.0.10:8800,20.0.0.11:8800</code>.
+ </p>
+
+ <p>
+ The optional argument <var>protocol</var> must be either
+ <code>tcp</code> or <code>udp</code>. This argument is useful
when
+ a port number is provided as part of the <var>vip</var>. If the
+ <var>protocol</var> is unspecified and a port number is provided
as
+ part of the <var>vip</var>, OVN assumes the <var>protocol</var>
to
+ be <code>tcp</code>.
+ </p>
+
+ <p>
+ It is an error if the <var>vip</var> already exists in the load
+ balancer named <var>lb</var>, unless <code>--may-exist</code> is
+ specified. With <code>--add-duplicate</code>, the command really
+ creates a new load balancer with a duplicate name.
+ </p>
+
+ <p>
+ The following example adds a load balancer.
+ </p>
+ <p>
+ <code>lb-add lb0 30.0.0.10:80