[ovs-dev,3/3] ovn-controller: document command-line options in man page

Submitted by Lance Richardson on April 20, 2017, 3:39 p.m.

Details

Message ID 20170420153934.4254-1-lrichard@redhat.com
State New
Headers show

Commit Message

Lance Richardson April 20, 2017, 3:39 p.m.
Signed-off-by: Lance Richardson <lrichard@redhat.com>
---
 ovn/controller/ovn-controller.8.xml | 64 +++++++++++++------------------------
 1 file changed, 23 insertions(+), 41 deletions(-)

Patch hide | download patch | download mbox

diff --git a/ovn/controller/ovn-controller.8.xml b/ovn/controller/ovn-controller.8.xml
index f9cbbfe..dcca716 100644
--- a/ovn/controller/ovn-controller.8.xml
+++ b/ovn/controller/ovn-controller.8.xml
@@ -20,6 +20,26 @@ 
       machine-local and do not run over a physical network.
     </p>
 
+    <h1>Options</h1>
+  
+    <h2>Daemon Options</h2>
+    <xi:include href="lib/daemon.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+
+    <h2>Logging Options</h2>
+    <xi:include href="lib/vlog.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+
+    <h2>PKI Options</h2>
+    <p>
+      PKI configuration is required in order to use SSL for the connections to
+      the Northbound and Southbound databases.
+    </p>
+    <xi:include href="lib/ssl.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+
+    <h2>Other Options</h2>
+
+    <xi:include href="lib/common.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+
+
     <h1>Configuration</h1>
     <p>
       <code>ovn-controller</code> retrieves most of its configuration
@@ -28,47 +48,9 @@ 
       vSwitch's "run" directory.  It may be overridden by specifying the
       <var>ovs-database</var> argument in one of the following forms:
     </p>
-    <ul>
-      <li>
-        <p>
-          <code>ssl:<var>ip</var>:<var>port</var></code>
-        </p>
-        <p>
-          The specified SSL <var>port</var> on the host at the given
-          <var>ip</var>, which must be expressed as an IP address (not a DNS
-          name) in IPv4 or IPv6 address format.  If <var>ip</var> is an IPv6
-          address, then wrap <var>ip</var> with square brackets, e.g.:
-          <code>ssl:[::1]:6640</code>.  The <code>--private-key</code>,
-          <code>--certificate</code> and either of <code>--ca-cert</code>
-          or <code>--bootstrap-ca-cert</code> options are mandatory when this
-          form is used.
-        </p>
-      </li>
-      <li>
-        <p>
-          <code>tcp:<var>ip</var>:<var>port</var></code>
-        </p>
-        <p>
-          Connect to the given TCP <var>port</var> on <var>ip</var>, where
-          <var>ip</var> can be IPv4 or IPv6 address. If <var>ip</var> is an
-          IPv6 address, then wrap <var>ip</var> with square brackets, e.g.:
-          <code>tcp:[::1]:6640</code>.
-        </p>
-      </li>
-      <li>
-        <p>
-          <code>unix:<var>file</var></code>
-        </p>
-        <p>
-          On POSIX, connect to the Unix domain server socket named
-          <var>file</var>.
-        </p>
-        <p>
-          On Windows, connect to a localhost TCP port whose value is written
-          in <var>file</var>.
-        </p>
-      </li>
-    </ul>
+    <xi:include href="ovsdb/remote-active.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+    <xi:include href="ovsdb/remote-passive.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+
     <p>
       <code>ovn-controller</code> assumes it gets configuration
       information from the following keys in the <code>Open_vSwitch</code>