From patchwork Thu Apr 20 15:39:30 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lance Richardson X-Patchwork-Id: 752852 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3w833k4YL4z9s65 for ; Fri, 21 Apr 2017 01:40:34 +1000 (AEST) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 53C92C33; Thu, 20 Apr 2017 15:39:34 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 94A3CC2C for ; Thu, 20 Apr 2017 15:39:33 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id B5A8F1A2 for ; Thu, 20 Apr 2017 15:39:31 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 22553C04B317 for ; Thu, 20 Apr 2017 15:39:31 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 22553C04B317 Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=lrichard@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 22553C04B317 Received: from thinkcentre.localdomain.com (ovpn-124-242.rdu2.redhat.com [10.10.124.242]) by smtp.corp.redhat.com (Postfix) with ESMTP id DA07E8260C for ; Thu, 20 Apr 2017 15:39:30 +0000 (UTC) From: Lance Richardson To: dev@openvswitch.org Date: Thu, 20 Apr 2017 11:39:30 -0400 Message-Id: <20170420153930.4212-1-lrichard@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Thu, 20 Apr 2017 15:39:31 +0000 (UTC) X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH 2/3] northd: document command-line options in man page X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org Signed-off-by: Lance Richardson --- ovn/northd/ovn-northd.8.xml | 101 ++++++++++++++++---------------------------- 1 file changed, 36 insertions(+), 65 deletions(-) diff --git a/ovn/northd/ovn-northd.8.xml b/ovn/northd/ovn-northd.8.xml index ab8fd88..6d86f86 100644 --- a/ovn/northd/ovn-northd.8.xml +++ b/ovn/northd/ovn-northd.8.xml @@ -18,75 +18,46 @@ ovn-sb(5)) below it.

-

Configuration

+

Options

+
+
--ovnnb-db=database
+
+ The OVSDB database containing the OVN Northbound Database. If the + OVN_NB_DB environment variable is set, its value is used + as the default. Otherwise, the default is + unix:@RUNDIR@/ovnnb_db.sock. +
+
--ovnsb-db=database
+
+ The OVSDB database containing the OVN Southbound Database. If the + OVN_SB_DB environment variable is set, its value is used + as the default. Otherwise, the default is + unix:@RUNDIR@/ovnsb_db.sock. +
+

- ovn-northd requires a connection to the Northbound - and Southbound databases. The defaults are ovnnb_db.sock - and ovnsb_db.sock respectively - in the local Open vSwitch's "run" directory. This may be - overridden with the following commands: + database in the above options must take one of the following + forms:

-
    -
  • -

    - --ovnnb-db=database -

    -

    - The database containing the OVN Northbound Database. -

    -
    • -
  • -

    - --ovnsb-db=database -

    -

    - The database containing the OVN Southbound Database. -

    -
    • -
+ + + +

Daemon Options

+ + +

Logging Options

+ + +

PKI Options

- The database argument must take one of the following forms: + PKI configuration is required in order to use SSL for the connections to + the Northbound and Southbound databases.

-
    -
  • -

    - 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. -

    -
    • -
+ + +

Other Options

+ +

Runtime Management Commands