On 9/24/26 7:55 AM, Ales Musil wrote: > The option reference had drifted from the accepted parser names, > defaults, and database lifecycle controls. Align the documented > options with the utility help and current defaults without changing > the command implementation. > > Assisted-by: GPT-5.6-Luna, OpenCode > Signed-off-by: Ales Musil <[email protected]> > --- > v2: Rebase on top of latest main. > Add missing options mentioned by Dumitru. > ---
Hi Ales, Thanks for the v2! > utilities/ovn-ctl.8.xml | 484 ++++++++++++++++++++++++++++++---------- > 1 file changed, 366 insertions(+), 118 deletions(-) > > diff --git a/utilities/ovn-ctl.8.xml b/utilities/ovn-ctl.8.xml > index 4ce6a03bd..0e6453df3 100644 > --- a/utilities/ovn-ctl.8.xml > +++ b/utilities/ovn-ctl.8.xml > @@ -199,101 +199,300 @@ > </dl> > > <h1>Options</h1> > - <p><code>--ovn-northd-priority=<var>NICE</var></code></p> > - <p><code>--ovn-northd-wrapper=<var>WRAPPER</var></code></p> > - <p><code>--ovn-controller-priority=<var>NICE</var></code></p> > - <p><code>--ovn-controller-wrapper=<var>WRAPPER</var></code></p> > - <p><code>--ovn-ic-priority=<var>NICE</var></code></p> > - <p><code>--ovn-ic-wrapper=<var>WRAPPER</var></code></p> > - <p><code>--ovsdb-nb-wrapper=<var>WRAPPER</var></code></p> > - <p><code>--ovsdb-sb-wrapper=<var>WRAPPER</var></code></p> > - <p><code>--ovn-br-controller-priority=<var>NICE</var></code></p> > - <p><code>--ovn-br-controller-wrapper=<var>WRAPPER</var></code></p> > - <p><code>--ovn-user=<var>USER:GROUP</var></code></p> > - <p><code>-h</code> | <code>--help</code></p> > + <p><code>--ovn-northd-priority=<var>NICE</var></code> sets the > + ovn-northd process niceness. The default is <code>-10</code>.</p> > + <p><code>--ovn-northd-wrapper=<var>WRAPPER</var></code> runs ovn-northd > + under the specified wrapper.</p> > + <p><code>--ovn-controller-priority=<var>NICE</var></code> sets the > + ovn-controller process niceness. The default is <code>-10</code>.</p> > + <p><code>--ovn-controller-wrapper=<var>WRAPPER</var></code> runs > + ovn-controller under the specified wrapper.</p> > + <p><code>--ovn-ic-priority=<var>NICE</var></code> sets the ovn-ic process > + niceness. The default is <code>-10</code>.</p> > + <p><code>--ovn-ic-wrapper=<var>WRAPPER</var></code> runs ovn-ic under the > + specified wrapper.</p> > + <p><code>--ovnbr-controller-priority=<var>NICE</var></code> sets the > + ovn-br-controller process niceness. The default is > <code>-10</code>.</p> > + <p><code>--ovnbr-controller-wrapper=<var>WRAPPER</var></code> runs > + ovn-br-controller under the specified wrapper.</p> > + <p><code>--ovsdb-nb-wrapper=<var>WRAPPER</var></code> runs the Northbound > + database server under the specified wrapper.</p> > + <p><code>--ovsdb-sb-wrapper=<var>WRAPPER</var></code> runs the Southbound > + database server under the specified wrapper.</p> > + <p><code>--ovn-user=<var>USER[:GROUP]</var></code> runs OVN daemons as > the > + specified user and optional group.</p> > + <p><code>--ovn-manage-ovsdb=<var>yes|no</var></code> controls whether > + <code>start_northd</code> and <code>stop_northd</code> also manage the > + NB and SB database servers. The default is <code>yes</code>.</p> > + <p><code>--ovn-controller-system-id=<var>SYSTEM_ID</var></code> sets the > + chassis name passed to ovn-controller. The default is empty.</p> > + <p><code>--ovsdb-disable-file-column-diff=<var>yes|no</var></code> > + controls whether database servers are started with > + <code>--disable-file-column-diff</code>. The default is > + <code>no</code>.</p> > + <p><code>-h</code> | <code>--help</code> displays usage information.</p> > > <h1>File location options</h1> > - <p><code>--db-sock=<var>SOCKET</var></code></p> > - <p><code>--db-nb-file=<var>FILE</var></code></p> > - <p><code>--db-sb-file=<var>FILE</var></code></p> > - <p><code>--db-nb-schema=<var>FILE</var></code></p> > - <p><code>--db-sb-schema=<var>FILE</var></code></p> > - <p><code>--db-sb-create-insecure-remote=<var>yes|no</var></code></p> > - <p><code>--db-nb-create-insecure-remote=<var>yes|no</var></code></p> > - <p><code>--db-ic-nb-file=<var>FILE</var></code></p> > - <p><code>--db-ic-sb-file=<var>FILE</var></code></p> > - <p><code>--db-ic-nb-schema=<var>FILE</var></code></p> > - <p><code>--db-ic-sb-schema=<var>FILE</var></code></p> > - <p><code>--db-ic-sb-create-insecure-remote=<var>yes|no</var></code></p> > - <p><code>--db-ic-nb-create-insecure-remote=<var>yes|no</var></code></p> > - <p><code>--db-nb-config-file=<var>FILE</var></code></p> > - <p><code>--db-sb-config-file=<var>FILE</var></code></p> > - <p><code>--db-ic-nb-config-file=<var>FILE</var></code></p> > - <p><code>--db-ic-sb-config-file=<var>FILE</var></code></p> > - <p><code>--db-sb-relay-config-file=<var>FILE</var></code></p> > - <p><code>--ovn-controller-ssl-key=<var>KEY</var></code></p> > - <p><code>--ovn-controller-ssl-cert=<var>CERT</var></code></p> > - <p><code>--ovn-controller-ssl-ca-cert=<var>CERT</var></code></p> > - > <p><code>--ovn-controller-ssl-bootstrap-ca-cert=<var>CERT</var></code></p> > - <p><code>--db-ovnbr-sock=<var>SOCKET</var></code></p> > - <p><code>--db-ovnbr-file=<var>FILE</var></code></p> > - <p><code>--db-ovnbr-schema=<var>FILE</var></code></p> > - <p><code>--db-ovnbr-create-insecure-remote=<var>yes|no</var></code></p> > - <p><code>--db-ovnbr-config-file=<var>FILE</var></code></p> > - <p><code>--ovn-br-controller-ssl-key=<var>KEY</var></code></p> > - <p><code>--ovn-br-controller-ssl-cert=<var>CERT</var></code></p> > - <p><code>--ovn-br-controller-ssl-ca-cert=<var>CERT</var></code></p> > - > <p><code>--ovn-br-controller-ssl-bootstrap-ca-cert=<var>CERT</var></code></p> > + <p><code>--db-sock=<var>SOCKET</var></code> sets the local Open vSwitch > + database socket.</p> > + <p><code>--db-nb-file=<var>FILE</var></code> sets the Northbound database > + file.</p> > + <p><code>--db-sb-file=<var>FILE</var></code> sets the Southbound database > + file.</p> > + <p> > + <code>--db-nb-sock=<var>SOCKET</var></code> and > + <code>--db-sb-sock=<var>SOCKET</var></code> set the NB and SB database > + sockets. Their defaults are <code>OVN_RUNDIR/ovnnb_db.sock</code> and > + <code>OVN_RUNDIR/ovnsb_db.sock</code>, respectively. > + </p> > + <p><code>--db-nb-schema=<var>FILE</var></code> sets the Northbound > database > + schema file.</p> > + <p><code>--db-sb-schema=<var>FILE</var></code> sets the Southbound > database > + schema file.</p> > + <p> > + <code>--db-ic-nb-sock=<var>SOCKET</var></code> and > + <code>--db-ic-sb-sock=<var>SOCKET</var></code> set the IC-NB and IC-SB > + database sockets. Their defaults are > + <code>OVN_RUNDIR/ovn_ic_nb_db.sock</code> and > + <code>OVN_RUNDIR/ovn_ic_sb_db.sock</code>, respectively. > + </p> > + <p> > + The <code>--db-nb-create-insecure-remote=<var>yes|no</var></code>, > + <code>--db-sb-create-insecure-remote=<var>yes|no</var></code>, > + <code>--db-ic-nb-create-insecure-remote=<var>yes|no</var></code>, > + <code>--db-ic-sb-create-insecure-remote=<var>yes|no</var></code>, and > + <code>--db-ovnbr-create-insecure-remote=<var>yes|no</var></code> > options > + accept <code>yes</code> or <code>no</code>. The default is > + <code>no</code>. When set to <code>yes</code>, the database server > + creates an insecure ptcp remote; <code>no</code> does not create that > + remote. > + </p> > + <p><code>--db-ic-nb-file=<var>FILE</var></code> sets the IC-NB database > + file.</p> > + <p><code>--db-ic-sb-file=<var>FILE</var></code> sets the IC-SB database > + file.</p> > + <p><code>--db-ic-nb-schema=<var>FILE</var></code> sets the IC-NB database > + schema file.</p> > + <p><code>--db-ic-sb-schema=<var>FILE</var></code> sets the IC-SB database > + schema file.</p> > + <p> > + <code>--db-nb-pidfile=<var>FILE</var></code> and > + <code>--db-sb-pidfile=<var>FILE</var></code> set the NB and SB database > + pidfiles. Their defaults are > + <code>OVN_RUNDIR/ovnnb_db.pid</code> and > + <code>OVN_RUNDIR/ovnsb_db.pid</code>, respectively. > + </p> > + <p> > + <code>--db-nb-ctrl-sock=<var>SOCKET</var></code> and > + <code>--db-sb-ctrl-sock=<var>SOCKET</var></code> set the NB and SB > + database control sockets. Their defaults are > + <code>OVN_RUNDIR/ovnnb_db.ctl</code> and > + <code>OVN_RUNDIR/ovnsb_db.ctl</code>, respectively. > + </p> > + <p><code>--db-nb-config-file=<var>FILE</var></code> sets the Northbound > + database server configuration file.</p> > + <p><code>--db-sb-config-file=<var>FILE</var></code> sets the Southbound > + database server configuration file.</p> > + <p><code>--db-ic-nb-config-file=<var>FILE</var></code> sets the IC-NB > + database server configuration file.</p> > + <p><code>--db-ic-sb-config-file=<var>FILE</var></code> sets the IC-SB > + database server configuration file.</p> > + <p><code>--db-sb-relay-config-file=<var>FILE</var></code> sets the > + Southbound relay server configuration file.</p> > + <p> > + <code>--db-nb-use-remote-in-db</code>, > + <code>--db-sb-use-remote-in-db</code>, > + <code>--db-ic-nb-use-remote-in-db</code>, and > + <code>--db-ic-sb-use-remote-in-db</code> accept <code>yes</code> or > + <code>no</code> and default to <code>yes</code>. A bare option is > + equivalent to specifying <code>yes</code>. The value <code>yes</code> > + makes ovsdb-server listen on remotes configured in the database > + <code>connections</code> column, while <code>no</code> does not. If a > + corresponding configuration file is specified, it takes precedence and > + this setting is ignored. > + </p> > + <p><code>--db-ovnbr-use-remote-in-db=<var>yes|no</var></code> controls > + whether ovsdb-server listens on the remotes configured in the database > + <code>connections</code> column. The default is <code>yes</code>.</p> > + <p><code>--ovn-controller-ssl-key=<var>KEY</var></code> sets the > + ovn-controller SSL/TLS private key file.</p> > + <p><code>--ovn-controller-ssl-cert=<var>CERT</var></code> sets the > + ovn-controller SSL/TLS certificate file.</p> > + <p><code>--ovn-controller-ssl-ca-cert=<var>CERT</var></code> sets the > + ovn-controller SSL/TLS CA certificate file.</p> > + <p><code>--ovn-controller-ssl-bootstrap-ca-cert=<var>CERT</var></code> > + bootstraps the ovn-controller SSL/TLS CA certificate file.</p> > + <p><code>--ovnbr-controller-ssl-key=<var>KEY</var></code> sets the > + ovn-br-controller SSL/TLS private key file.</p> > + <p><code>--ovnbr-controller-ssl-cert=<var>CERT</var></code> sets the > + ovn-br-controller SSL/TLS certificate file.</p> > + <p><code>--ovnbr-controller-ssl-ca-cert=<var>CERT</var></code> sets the > + ovn-br-controller SSL/TLS CA certificate file.</p> > + <p><code>--ovnbr-controller-ssl-bootstrap-ca-cert=<var>CERT</var></code> > + bootstraps the ovn-br-controller SSL/TLS CA certificate file.</p> > + <p><code>--ovnbr-db-ssl-key=<var>KEY</var></code> sets the > + ovn-br-controller database SSL/TLS private key file.</p> > + <p><code>--ovnbr-db-ssl-cert=<var>CERT</var></code> sets the > + ovn-br-controller database SSL/TLS certificate file.</p> > + <p><code>--ovnbr-db-ssl-ca-cert=<var>CERT</var></code> sets the > + ovn-br-controller database SSL/TLS CA certificate file.</p> > + <p><code>--db-ovnbr-sock=<var>SOCKET</var></code> sets the OVN bridge > + controller database socket.</p> > + <p><code>--db-ovnbr-file=<var>FILE</var></code> sets the OVN bridge > + controller database file.</p> > + <p> > + <code>--db-ic-nb-pidfile=<var>FILE</var></code>, > + <code>--db-ic-sb-pidfile=<var>FILE</var></code>, and > + <code>--db-ovnbr-pidfile=<var>FILE</var></code> set the IC-NB, IC-SB, > + and OVN bridge controller database pidfiles. Their defaults are > + <code>OVN_RUNDIR/ovn_ic_nb_db.pid</code>, > + <code>OVN_RUNDIR/ovn_ic_sb_db.pid</code>, and > + <code>OVN_RUNDIR/ovnbr_db.pid</code>, respectively. > + </p> > + <p> > + <code>--db-ic-nb-ctrl-sock=<var>SOCKET</var></code>, > + <code>--db-ic-sb-ctrl-sock=<var>SOCKET</var></code>, and > + <code>--db-ovnbr-ctrl-sock=<var>SOCKET</var></code> set database > + control sockets. Their defaults are > + <code>OVN_RUNDIR/ovn_ic_nb_db.ctl</code>, > + <code>OVN_RUNDIR/ovn_ic_sb_db.ctl</code>, and > + <code>OVN_RUNDIR/ovnbr_db.ctl</code>, respectively. > + </p> > + <p><code>--db-ovnbr-schema=<var>FILE</var></code> sets the OVN bridge > + controller database schema file.</p> > + <h2>Logging options</h2> This should be h1. I fixed that up and applied the patch to main. Regards, Dumitru _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
