From patchwork Tue Oct 6 19:35:58 2015
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: Ben Pfaff
X-Patchwork-Id: 526951
Return-Path:
X-Original-To: incoming@patchwork.ozlabs.org
Delivered-To: patchwork-incoming@bilbo.ozlabs.org
Received: from archives.nicira.com (unknown
[IPv6:2600:3c00::f03c:91ff:fe6e:bdf7])
by ozlabs.org (Postfix) with ESMTP id 3D8AF140D92
for ;
Wed, 7 Oct 2015 06:36:19 +1100 (AEDT)
Received: from archives.nicira.com (localhost [127.0.0.1])
by archives.nicira.com (Postfix) with ESMTP id 70619106F3;
Tue, 6 Oct 2015 12:36:18 -0700 (PDT)
X-Original-To: dev@openvswitch.org
Delivered-To: dev@openvswitch.org
Received: from mx3v1.cudamail.com (mx3.cudamail.com [64.34.241.5])
by archives.nicira.com (Postfix) with ESMTPS id C365D106F2
for ; Tue, 6 Oct 2015 12:36:16 -0700 (PDT)
Received: from bar4.cudamail.com (bar2 [192.168.15.2])
by mx3v1.cudamail.com (Postfix) with ESMTP id B78AA618A15
for ; Tue, 6 Oct 2015 13:36:10 -0600 (MDT)
X-ASG-Debug-ID: 1444160168-03dc210f7a3eaa0001-byXFYA
Received: from mx3-pf3.cudamail.com ([192.168.14.3]) by bar4.cudamail.com
with
ESMTP id NdvrfEGrix8Usegb (version=TLSv1 cipher=DHE-RSA-AES256-SHA
bits=256 verify=NO) for ;
Tue, 06 Oct 2015 13:36:08 -0600 (MDT)
X-Barracuda-Envelope-From: blp@nicira.com
X-Barracuda-RBL-Trusted-Forwarder: 192.168.14.3
Received: from unknown (HELO mail-pa0-f43.google.com) (209.85.220.43)
by mx3-pf3.cudamail.com with ESMTPS (RC4-SHA encrypted);
6 Oct 2015 19:36:06 -0000
Received-SPF: unknown (mx3-pf3.cudamail.com: Multiple SPF records returned)
X-Barracuda-RBL-Trusted-Forwarder: 209.85.220.43
Received: by pablk4 with SMTP id lk4so217944154pab.3
for ; Tue, 06 Oct 2015 12:36:07 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20130820;
h=x-gm-message-state:from:to:cc:subject:date:message-id;
bh=r1AdXXvj29kM4vH3BxDfeNi3ha6bGVZu9ouPa1JsYsU=;
b=KrTttIaMpEqG06nuBn9odJPUN0wQXyzz/OemsJ7DK940IenrZuuhrfE5OhHNfkWW2e
ntME/64fUhh9vDQMDOq1d92xqVU6ufoelpweUJ/gouUcpJK8h+Ej95IomF3LU3OUvvE/
2CYkQ5lDj+rEUo+7YEjNmbuPOmYrldvwHL0YBGFUZM9nl0rVyLCSBHPkAuGMWDHyLx18
N94FIl+FbGx3NSZbPTMo0UU42H718YcJO0NQxXC4kGrSxJc3PT6NprxG25wXp+HtLWls
5PEYKwgPQYs2O2lQK+A4THqvKEL0ve17LwkXxEwMh0RKA6KXTIgKk7IudRNhRINc1pqk
JLEQ==
X-Gm-Message-State:
ALoCoQnG1IYntXs8ucqeOj4B5YbVvaKvzsfWR4ArxGvlkxlBCdrMHh+DBMyk8bu2TAV4L/Rr5aAF
X-Received: by 10.69.2.227 with SMTP id br3mr49060283pbd.9.1444160167129;
Tue, 06 Oct 2015 12:36:07 -0700 (PDT)
Received: from sigabrt.gateway.sonic.net
(173-228-112-165.dsl.dynamic.fusionbroadband.com. [173.228.112.165])
by smtp.gmail.com with ESMTPSA id
qa5sm34960564pbc.70.2015.10.06.12.36.05
(version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128);
Tue, 06 Oct 2015 12:36:06 -0700 (PDT)
X-CudaMail-Envelope-Sender: blp@nicira.com
X-Barracuda-Apparent-Source-IP: 173.228.112.165
From: Ben Pfaff
To: dev@openvswitch.org
X-CudaMail-Whitelist-To: dev@openvswitch.org
X-CudaMail-MID: CM-V3-1005056030
X-CudaMail-DTE: 100615
X-CudaMail-Originating-IP: 209.85.220.43
Date: Tue, 6 Oct 2015 12:35:58 -0700
X-ASG-Orig-Subj: [##CM-V3-1005056030##][PATCH 1/2] ovn-controller: Improve
formatting of manpage.
Message-Id: <1444160159-7425-1-git-send-email-blp@nicira.com>
X-Mailer: git-send-email 2.1.3
X-Barracuda-Connect: UNKNOWN[192.168.14.3]
X-Barracuda-Start-Time: 1444160168
X-Barracuda-Encrypted: DHE-RSA-AES256-SHA
X-Barracuda-URL: https://web.cudamail.com:443/cgi-mod/mark.cgi
X-ASG-Whitelist: Header =?UTF-8?B?eFwtY3VkYW1haWxcLXdoaXRlbGlzdFwtdG8=?=
X-Virus-Scanned: by bsmtpd at cudamail.com
X-Barracuda-BRTS-Status: 1
Cc: Ben Pfaff
Subject: [ovs-dev] [PATCH 1/2] ovn-controller: Improve formatting of manpage.
X-BeenThere: dev@openvswitch.org
X-Mailman-Version: 2.1.16
Precedence: list
List-Id:
List-Unsubscribe: ,
List-Archive:
List-Post:
List-Help:
List-Subscribe: ,
MIME-Version: 1.0
Errors-To: dev-bounces@openvswitch.org
Sender: "dev"
First, the structure here was funny, with one nested inside another,
plus a
nested inside a . I'm surprised that the formatter didn't
complain but at any rate it's better to avoid this structure.
Second, this
seemed better off as a , so I changed it to use that
structure.
Signed-off-by: Ben Pfaff
Acked-by: Justin Pettit
---
ovn/controller/ovn-controller.8.xml | 106 +++++++++++++++++-------------------
1 file changed, 49 insertions(+), 57 deletions(-)
diff --git a/ovn/controller/ovn-controller.8.xml b/ovn/controller/ovn-controller.8.xml
index 92cd669..99d2d18 100644
--- a/ovn/controller/ovn-controller.8.xml
+++ b/ovn/controller/ovn-controller.8.xml
@@ -73,63 +73,55 @@
ovn-controller
assumes it gets configuration
information from the following keys in the Open_vSwitch
table of the local OVS instance:
-
- -
-
- external_ids:system-id
specifies the chassis
- name to use in the Chassis table.
-
-
- -
-
- external_ids:ovn-bridge
specifies the
- integration bridge to which logical ports are attached.
- The default is br-int
. If this bridge does
- not exist when ovn-controller starts, it will be created
- automatically with the default configuration suggested in
- ovn-architecture
(7).
-
-
- -
-
- external_ids:ovn-remote
specifies the OVN
- database that this system should connect to for its
- configuration.
-
-
- -
-
- external_ids:ovn-encap-type
specifies the
- encapsulation type that a chassis should use to connect to
- this node. Supported tunnel types for connecting
- hypervisors are geneve
and stt
.
- Gateways may use geneve
, vxlan
,
- or stt
.
-
-
- -
-
- external_ids:ovn-encap-ip
specifies the IP
- address that a chassis should use to connect to this node
- using encapsulation type specified by
- external_ids:ovn-encap-ip
.
-
-
- -
-
- external_ids:ovn-bridge-mappings
specifies a list
- of key-value pairs that map a physical network name to a local
- ovs bridge that provides connectivity to that network.
- An example value mapping two physical network names to two ovs
- bridges would be: physnet1:br-eth0,physnet2:br-eth1
.
-
-
-
-
- Currently, ovn-controller
does not support changing
- the OVN database mid-run. If the value needs to change, the
- daemon must be restarted. This behavior should be improved.
-
+
+
+ external_ids:system-id
+ - The chassis name to use in the Chassis table.
+
+ external_ids:ovn-bridge
+ -
+ The integration bridge to which logical ports are attached. The
+ default is
br-int
. If this bridge does not exist when
+ ovn-controller starts, it will be created automatically with the
+ default configuration suggested in ovn-architecture
(7).
+
+
+ external_ids:ovn-remote
+ -
+
+ The OVN database that this system should connect to for its
+ configuration.
+
+
+
+ Currently, ovn-controller
does not support changing this
+ setting mid-run. If the value needs to change, the daemon must be
+ restarted. (This behavior should be improved.)
+
+
+
+ external_ids:ovn-encap-type
+ -
+ The encapsulation type that a chassis should use to connect to this
+ node. Supported tunnel types for connecting hypervisors are
+
geneve
and stt
. Gateways may use
+ geneve
, vxlan
, or stt
.
+
+
+ external_ids:ovn-encap-ip
+ -
+ The IP address that a chassis should use to connect to this node using
+ encapsulation type specified by
external_ids:ovn-encap-ip
.
+
+
+ external_ids:ovn-bridge-mappings
+ -
+ A list of key-value pairs that map a physical network name to a local
+ ovs bridge that provides connectivity to that network. An example
+ value mapping two physical network names to two ovs bridges would be:
+
physnet1:br-eth0,physnet2:br-eth1
.
+
+
RUNTIME MANAGEMENT COMMANDS