[ovs-dev] [PATCH 6/7] ovn-northd: Add man page describing daemon.
Justin Pettit
jpettit at nicira.com
Tue Aug 25 01:12:37 UTC 2015
Signed-off-by: Justin Pettit <jpettit at nicira.com>
---
ovn/northd/.gitignore | 1 +
ovn/northd/automake.mk | 3 +
ovn/northd/ovn-northd.8.xml | 103 +++++++++++++++++++++++++++++++++++++++
rhel/openvswitch-fedora.spec.in | 1 +
4 files changed, 108 insertions(+), 0 deletions(-)
create mode 100644 ovn/northd/ovn-northd.8.xml
diff --git a/ovn/northd/.gitignore b/ovn/northd/.gitignore
index c0a87ab..97a5980 100644
--- a/ovn/northd/.gitignore
+++ b/ovn/northd/.gitignore
@@ -1 +1,2 @@
/ovn-northd
+/ovn-northd.8
diff --git a/ovn/northd/automake.mk b/ovn/northd/automake.mk
index f83295b..6e713fc 100644
--- a/ovn/northd/automake.mk
+++ b/ovn/northd/automake.mk
@@ -5,3 +5,6 @@ ovn_northd_ovn_northd_LDADD = \
ovn/lib/libovn.la \
ovsdb/libovsdb.la \
lib/libopenvswitch.la
+man_MANS += ovn/northd/ovn-northd.8
+EXTRA_DIST += ovn/northd/ovn-northd.8.xml
+DISTCLEANFILES += ovn/northd/ovn-northd.8
diff --git a/ovn/northd/ovn-northd.8.xml b/ovn/northd/ovn-northd.8.xml
new file mode 100644
index 0000000..316f729
--- /dev/null
+++ b/ovn/northd/ovn-northd.8.xml
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manpage program="ovn-northd" section="8" title="ovn-northd">
+ <h1>Name</h1>
+ <p>ovn-northd -- Open Virtual Network central control daemon</p>
+
+ <h1>Synopsis</h1>
+ <p><code>ovn-northd</code> [<var>options</var>]</p>
+
+ <h1>Description</h1>
+ <p>
+ <code>ovn-northd</code> is a centralized daemon responsible for
+ translating the high-level OVN configuration into logical
+ configuration consumable by daemons such as
+ <code>ovn-controller</code>. It translates the logical network
+ configuration in terms of conventional network concepts, taken
+ from the OVN Northbound Database (see <code>ovn-nb</code>(5)),
+ into logical datapath flows in the OVN Southbound Database (see
+ <code>ovn-sb</code>(5)) below it.
+ </p>
+
+ <h1>Configuration</h1>
+ <p>
+ <code>ovn-northd</code> requires a connection to the Northbound
+ and Southbound databases. The default is <code>db.sock</code>
+ in the local Open vSwitch's "run" directory. This may be
+ overridden with the following commands:
+ </p>
+ <ul>
+ <li>
+ <p>
+ <code>--ovnnb-db=<var>database</var></code>
+ </p>
+ <p>
+ The database containing the OVN Northbound Database.
+ </p>
+ </li>
+ <li>
+ <p>
+ <code>--ovsnb-db=<var>database</var></code>
+ </p>
+ <p>
+ The database containing the OVN Southbound Database.
+ </p>
+ </li>
+ </ul>
+ <p>
+ The <var>database</var> argument must take 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 <code>--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>
+
+ <h1>RUNTIME MANAGEMENT COMMANDS</h1>
+ <p>
+ <code>ovs-appctl</code> can send commands to a running
+ <code>ovn-northd</code> process. The currently supported commands
+ are described below.
+ <dl>
+ <dt><code>exit</code></dt>
+ <dd>
+ Causes <code>ovn-northd</code> to gracefully terminate.
+ </dd>
+ </dl>
+ </p>
+
+</manpage>
diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/openvswitch-fedora.spec.in
index 1e62341..4d403e0 100644
--- a/rhel/openvswitch-fedora.spec.in
+++ b/rhel/openvswitch-fedora.spec.in
@@ -336,6 +336,7 @@ rm -rf $RPM_BUILD_ROOT
%{_mandir}/man8/ovn-controller-vtep.8*
%{_mandir}/man8/ovn-ctl.8*
%{_mandir}/man8/ovn-nbctl.8*
+%{_mandir}/man8/ovn-northd.8*
%{_mandir}/man8/ovn-sbctl.8*
%config %{_datadir}/openvswitch/ovn-nb.ovsschema
%config %{_datadir}/openvswitch/ovn-sb.ovsschema
--
1.7.5.4
More information about the dev
mailing list