diff mbox series

[ovs-dev,v2] ovn-nbctl: Add --template option for lb-add

Message ID 20250401140149.35668-1-rosemarie@redhat.com
State Accepted
Delegated to: Dumitru Ceara
Headers show
Series [ovs-dev,v2] ovn-nbctl: Add --template option for lb-add | expand

Checks

Context Check Description
ovsrobot/apply-robot warning apply and check: warning
ovsrobot/github-robot-_Build_and_Test fail github build: failed
ovsrobot/github-robot-_ovn-kubernetes success github build: passed

Commit Message

Rosemarie O'Riorden April 1, 2025, 2:01 p.m. UTC
In the ovn-nbctl manpage, --template was missing for lb-add. This commit
fixes the documentation.

Reported-at: https://issues.redhat.com/browse/FDP-1050
Signed-off-by: Rosemarie O'Riorden <rosemarie@redhat.com>
---
v2: Remove accidental ovs subproject commit change.
---
 utilities/ovn-nbctl.8.xml | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

Comments

Ales Musil April 3, 2025, 8:10 a.m. UTC | #1
On Tue, Apr 1, 2025 at 4:02 PM Rosemarie O'Riorden via dev <
ovs-dev@openvswitch.org> wrote:

> In the ovn-nbctl manpage, --template was missing for lb-add. This commit
> fixes the documentation.
>
> Reported-at: https://issues.redhat.com/browse/FDP-1050
> Signed-off-by: Rosemarie O'Riorden <rosemarie@redhat.com>
> ---
> v2: Remove accidental ovs subproject commit change.
> ---
>  utilities/ovn-nbctl.8.xml | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
>
> diff --git a/utilities/ovn-nbctl.8.xml b/utilities/ovn-nbctl.8.xml
> index aa0291375..c33944193 100644
> --- a/utilities/ovn-nbctl.8.xml
> +++ b/utilities/ovn-nbctl.8.xml
> @@ -1345,7 +1345,7 @@
>
>      <h2>Load Balancer Commands</h2>
>      <dl>
> -        <dt>[<code>--may-exist</code> | <code>--add-duplicate</code> |
> <code>--reject</code> | <code>--event</code>] <code>lb-add</code>
> <var>lb</var> <var>vip</var> <var>ips</var> [<var>protocol</var>]</dt>
> +        <dt>[<code>--may-exist</code> | <code>--add-duplicate</code> |
> <code>--reject</code> | <code>--event</code> | <code>--template</code>]
> <code>lb-add</code> <var>lb</var> <var>vip</var> <var>ips</var>
> [<var>protocol</var>]</dt>
>        <dd>
>          <p>
>           Creates a new load balancer named <var>lb</var> with the provided
> @@ -1395,6 +1395,15 @@
>           <code>--reject</code> one.
>          </p>
>
> +        <p>
> +         If the load balancer is created with <code>--template</code>
> option,
> +         local template variables may be used as arguments. These
> variables
> +         are stored in Chassis_Template_Var. To see the supported variable
> +         formats, see <code>ovn-nb</code>(5). The following example adds a
> +         templated load balancer: <code>ovn-nbctl --template lb-add lb1
> +         ^vip:^vport ^backend udp ipv4</code>.
> +        </p>
> +
>          <p>
>           The following example adds a load balancer.
>          </p>
> --
> 2.48.1
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
>
Looks good to me, thanks.
Acked-by: Ales Musil <amusil@redhat.com>
Dumitru Ceara April 3, 2025, 12:21 p.m. UTC | #2
On 4/3/25 10:10 AM, Ales Musil wrote:
> On Tue, Apr 1, 2025 at 4:02 PM Rosemarie O'Riorden via dev <
> ovs-dev@openvswitch.org> wrote:
> 
>> In the ovn-nbctl manpage, --template was missing for lb-add. This commit
>> fixes the documentation.
>>
>> Reported-at: https://issues.redhat.com/browse/FDP-1050
>> Signed-off-by: Rosemarie O'Riorden <rosemarie@redhat.com>
>> ---
>> v2: Remove accidental ovs subproject commit change.
>> ---

Hi Rosemarie, Ales,

> Looks good to me, thanks.
> Acked-by: Ales Musil <amusil@redhat.com>
> 

Thanks!  Applied to main, 25.03, 24.09 and 24.03.

Regards,
Dumitru
diff mbox series

Patch

diff --git a/utilities/ovn-nbctl.8.xml b/utilities/ovn-nbctl.8.xml
index aa0291375..c33944193 100644
--- a/utilities/ovn-nbctl.8.xml
+++ b/utilities/ovn-nbctl.8.xml
@@ -1345,7 +1345,7 @@ 
 
     <h2>Load Balancer Commands</h2>
     <dl>
-        <dt>[<code>--may-exist</code> | <code>--add-duplicate</code> | <code>--reject</code> | <code>--event</code>] <code>lb-add</code> <var>lb</var> <var>vip</var> <var>ips</var> [<var>protocol</var>]</dt>
+        <dt>[<code>--may-exist</code> | <code>--add-duplicate</code> | <code>--reject</code> | <code>--event</code> | <code>--template</code>] <code>lb-add</code> <var>lb</var> <var>vip</var> <var>ips</var> [<var>protocol</var>]</dt>
       <dd>
         <p>
          Creates a new load balancer named <var>lb</var> with the provided
@@ -1395,6 +1395,15 @@ 
          <code>--reject</code> one.
         </p>
 
+        <p>
+         If the load balancer is created with <code>--template</code> option,
+         local template variables may be used as arguments. These variables
+         are stored in Chassis_Template_Var. To see the supported variable
+         formats, see <code>ovn-nb</code>(5). The following example adds a
+         templated load balancer: <code>ovn-nbctl --template lb-add lb1
+         ^vip:^vport ^backend udp ipv4</code>.
+        </p>
+
         <p>
          The following example adds a load balancer.
         </p>