From 1af530bc2417c8cc98a11d88deca7d57ecb91734 Mon Sep 17 00:00:00 2001 From: Justin Pettit Date: Sat, 22 Aug 2015 13:24:42 -0700 Subject: [PATCH] ovn-northd: Add man page describing daemon. Signed-off-by: Justin Pettit Acked-by: Russell Bryant --- 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(+) create mode 100644 ovn/northd/ovn-northd.8.xml diff --git a/ovn/northd/.gitignore b/ovn/northd/.gitignore index c0a87abd9..97a59801b 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 f83295b13..6e713fc97 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 000000000..316f7295b --- /dev/null +++ b/ovn/northd/ovn-northd.8.xml @@ -0,0 +1,103 @@ + + +

Name

+

ovn-northd -- Open Virtual Network central control daemon

+ +

Synopsis

+

ovn-northd [options]

+ +

Description

+

+ ovn-northd is a centralized daemon responsible for + translating the high-level OVN configuration into logical + configuration consumable by daemons such as + ovn-controller. It translates the logical network + configuration in terms of conventional network concepts, taken + from the OVN Northbound Database (see ovn-nb(5)), + into logical datapath flows in the OVN Southbound Database (see + ovn-sb(5)) below it. +

+ +

Configuration

+

+ ovn-northd requires a connection to the Northbound + and Southbound databases. The default is db.sock + in the local Open vSwitch's "run" directory. This may be + overridden with the following commands: +

+
    +
  • +

    + --ovnnb-db=database +

    +

    + The database containing the OVN Northbound Database. +

    +
    • +
  • +

    + --ovsnb-db=database +

    +

    + The database containing the OVN Southbound Database. +

    +
    • +
+

+ The database argument must take one of the following forms: +

+
    +
  • +

    + ssl:ip:port +

    +

    + The specified SSL port on the host at the given + ip, which must be expressed as an IP address (not a DNS + name) in IPv4 or IPv6 address format. If ip is an IPv6 + address, then wrap ip with square brackets, e.g.: + ssl:[::1]:6640. The --private-key, + --certificate, and --ca-cert options are + mandatory when this form is used. +

    +
    • +
  • +

    + tcp:ip:port +

    +

    + Connect to the given TCP port on ip, where + ip can be IPv4 or IPv6 address. If ip is an + IPv6 address, then wrap ip with square brackets, e.g.: + tcp:[::1]:6640. +

    +
    • +
  • +

    + unix:file +

    +

    + On POSIX, connect to the Unix domain server socket named + file. +

    +

    + On Windows, connect to a localhost TCP port whose value is written + in file. +

    +
    • +
+ +

RUNTIME MANAGEMENT COMMANDS

+

+ ovs-appctl can send commands to a running + ovn-northd process. The currently supported commands + are described below. +

+
exit
+
+ Causes ovn-northd to gracefully terminate. +
+
+

+ + diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/openvswitch-fedora.spec.in index 1e62341ed..4d403e075 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 -- 2.20.1