From patchwork Tue Nov 22 18:18:54 2016
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: Stephen Finucane
X-Patchwork-Id: 697868
X-Patchwork-Delegate: rbryant@redhat.com
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 3tNYpr3HHPz9t1B
for ;
Wed, 23 Nov 2016 05:27:16 +1100 (AEDT)
Authentication-Results: ozlabs.org;
dkim=fail reason="key not found in DNS" (0-bit key;
unprotected) header.d=that.guru header.i=@that.guru
header.b="cXqn9ks1"; dkim-atps=neutral
Received: from mail.linux-foundation.org (localhost [127.0.0.1])
by mail.linuxfoundation.org (Postfix) with ESMTP id 5D153BCA;
Tue, 22 Nov 2016 18:21:04 +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 61744BC9
for ; Tue, 22 Nov 2016 18:21:03 +0000 (UTC)
X-Greylist: from auto-whitelisted by SQLgrey-1.7.6
Received: from caracal.maple.relay.mailchannels.net
(caracal.maple.relay.mailchannels.net [23.83.214.30])
by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 7B3251F5
for ; Tue, 22 Nov 2016 18:21:02 +0000 (UTC)
X-Sender-Id: mxroute|x-authuser|stephen@that.guru
Received: from relay.mailchannels.net (localhost [127.0.0.1])
by relay.mailchannels.net (Postfix) with ESMTP id B26D71206EF
for ; Tue, 22 Nov 2016 18:21:01 +0000 (UTC)
Received: from one.mxroute.com (ip-10-107-69-155.us-west-2.compute.internal
[10.107.69.155])
by relay.mailchannels.net (Postfix) with ESMTPA id E7711120E70
for ; Tue, 22 Nov 2016 18:21:00 +0000 (UTC)
X-Sender-Id: mxroute|x-authuser|stephen@that.guru
Received: from one.mxroute.com ([UNAVAILABLE]. [10.31.7.102])
(using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384)
by 0.0.0.0:2500 (trex/5.7.8); Tue, 22 Nov 2016 18:21:01 +0000
X-MC-Relay: Neutral
X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru
X-MailChannels-Auth-Id: mxroute
X-MC-Loop-Signature: 1479838861264:3558979716
X-MC-Ingress-Time: 1479838861264
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru;
s=default;
h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From:
Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding:
Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender:
Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:
List-Subscribe:List-Post:List-Owner:List-Archive;
bh=FeAZn7v2ga9HFc9lhHZTskZVrgC6IZjCboGVma/kR/g=;
b=cXqn9ks1lHW+9VmW2aCzExBv4q
kTnmEPTsK5jZuUFjhaPyVi0DJtFSpdSzW4iV8qRojDcmRS+CEp6hMoo8/YhVUgUD9VDySyJBhk+mk
nVY+SGddMD76oXbct2Lqokcj2DN2A2oa2jrAPINbaSpe/QxBK/wmIZEzjRuOb0Ekt+gy6elpbdmh9
8qHE9+mfd6696A0HSAJ4CMwiQnLEpo0XD+IIIVkFiBu7JjjS/WYs5M/VY0+A4ZTf6B8xmzMmbu/ej
xj3vU0eHJ2yohkcfG2QA6IuRD/81G0tRG3kYE0yZVrXEcN5McDd41iGLGF4W02PwwzgzfLTZyvPk7
s/rt5+Dg==;
From: Stephen Finucane
To: dev@openvswitch.org
Date: Tue, 22 Nov 2016 18:18:54 +0000
Message-Id: <1479838739-26356-10-git-send-email-stephen@that.guru>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1479838739-26356-1-git-send-email-stephen@that.guru>
References: <1479838739-26356-1-git-send-email-stephen@that.guru>
X-OutGoing-Spam-Status: No, score=-10.0
X-AuthUser: stephen@that.guru
X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=no version=3.3.1
X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on
smtp1.linux-foundation.org
Subject: [ovs-dev] [PATCH 09/14] doc: Further populate the 'howto' section
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
There are a couple of references to these for various build systems.
The website is going to be our "one true resource" for all docs, so
simply remove these references.
Signed-off-by: Stephen Finucane
---
Documentation/automake.mk | 4 ++++
Documentation/howto/index.rst | 8 ++++++++
README-lisp.rst => Documentation/howto/lisp.rst | 0
.../howto/native-tunneling.rst | 0
.../howto/openstack-containers.rst | 10 +++++-----
vtep/README.ovs-vtep.rst => Documentation/howto/vtep.rst | 14 +++++++-------
Makefile.am | 2 --
ofproto/ofproto-tnl-unixctl.man | 3 +--
ovn/automake.mk | 1 -
rhel/openvswitch.spec.in | 2 +-
utilities/ovs-sim.1.xml | 6 +++---
vtep/automake.mk | 1 -
12 files changed, 29 insertions(+), 22 deletions(-)
rename README-lisp.rst => Documentation/howto/lisp.rst (100%)
rename README-native-tunneling.rst => Documentation/howto/native-tunneling.rst (100%)
rename ovn/CONTAINERS.OpenStack.rst => Documentation/howto/openstack-containers.rst (96%)
rename vtep/README.ovs-vtep.rst => Documentation/howto/vtep.rst (95%)
diff --git a/Documentation/automake.mk b/Documentation/automake.mk
index 50e9808..2622f83 100644
--- a/Documentation/automake.mk
+++ b/Documentation/automake.mk
@@ -28,6 +28,10 @@ EXTRA_DIST += \
Documentation/howto/libvirt.rst \
Documentation/howto/selinux.rst \
Documentation/howto/ssl.rst \
+ Documentation/howto/native-tunneling.rst \
+ Documentation/howto/lisp.rst \
+ Documentation/howto/openstack-containers.rst \
+ Documentation/howto/vtep.rst
Documentation/ref/index.rst \
Documentation/faq/index.rst \
Documentation/internals/index.rst
diff --git a/Documentation/howto/index.rst b/Documentation/howto/index.rst
index 81b2931..fe85a34 100644
--- a/Documentation/howto/index.rst
+++ b/Documentation/howto/index.rst
@@ -37,4 +37,12 @@ topics covered herein, refer to :doc:`/topics/index`.
selinux
libvirt
ssl
+ lisp
+ native-tunneling
+ vtep
+
+.. toctree::
+ :maxdepth: 1
+
docker
+ openstack-containers
diff --git a/README-lisp.rst b/Documentation/howto/lisp.rst
similarity index 100%
rename from README-lisp.rst
rename to Documentation/howto/lisp.rst
diff --git a/README-native-tunneling.rst b/Documentation/howto/native-tunneling.rst
similarity index 100%
rename from README-native-tunneling.rst
rename to Documentation/howto/native-tunneling.rst
diff --git a/ovn/CONTAINERS.OpenStack.rst b/Documentation/howto/openstack-containers.rst
similarity index 96%
rename from ovn/CONTAINERS.OpenStack.rst
rename to Documentation/howto/openstack-containers.rst
index 2934d1c..f10f60e 100644
--- a/ovn/CONTAINERS.OpenStack.rst
+++ b/Documentation/howto/openstack-containers.rst
@@ -45,10 +45,10 @@ example.
* When VM-A is created on a hypervisor, its VIF gets added to the Open vSwitch
integration bridge. This creates a row in the Interface table of the
- ``Open_vSwitch`` database. As explained in the `integration guide
- `__, the vif-id associated with the VM network
- interface gets added in the ``external_ids:iface-id`` column of the newly
- created row in the Interface table.
+ ``Open_vSwitch`` database. As explained in the `integration guide`, the
+ vif-id associated with the VM network interface gets added in the
+ ``external_ids:iface-id`` column of the newly created row in the Interface
+ table.
* Since VM-A belongs to a logical network, it gets an IP address. This IP
address is used to spawn containers (either manually or through container
@@ -102,7 +102,7 @@ example.
* When a container is eventually deleted, the network plugin in that VM may
make a call to Neutron to delete that port. Neutron in turn will delete the
- entry in the Logical_Switch_Port table of the OVN Northbound Database.
+ entry in the ``Logical_Switch_Port`` table of the OVN Northbound Database.
As an example, consider Docker containers. Since Docker currently does not
have a network plugin feature, this example uses a hypothetical wrapper around
diff --git a/vtep/README.ovs-vtep.rst b/Documentation/howto/vtep.rst
similarity index 95%
rename from vtep/README.ovs-vtep.rst
rename to Documentation/howto/vtep.rst
index 668ee08..6a52024 100644
--- a/vtep/README.ovs-vtep.rst
+++ b/Documentation/howto/vtep.rst
@@ -36,12 +36,12 @@ The VTEP emulator is a Python script that invokes calls to tools like vtep-ctl
and ovs-vsctl. It is only useful when Open vSwitch daemons like ovsdb-server
and ovs-vswitchd are running and installed. To do this, either:
-- Follow the instructions in ``Documentation/intro/install/general`` (don't
- start any daemons yet).
+- Follow the instructions in :doc:`/intro/install/general` (don't start any
+ daemons yet).
-- Follow the instructions in ``Documentation/intro/install/debian`` and then
- install the ``openvswitch-vtep`` package (if operating on a debian based
- machine). This will automatically start the daemons.
+- Follow the instructions in :doc:`/intro/install/debian` and then install the
+ ``openvswitch-vtep`` package (if operating on a debian based machine). This
+ will automatically start the daemons.
Design
------
@@ -152,8 +152,8 @@ using the debian packages as mentioned in step 2 of the "Requirements" section.
$ vtep-ctl set Physical_Switch br0 tunnel_ips=10.2.2.1
6. Start the VTEP emulator. If you installed the components following
- ``Documentation/intro/install/general``, run the following from the same
- directory as this README:
+ :doc:`/intro/install/general`, run the following from the ``vtep``
+ directory:
::
diff --git a/Makefile.am b/Makefile.am
index a99c26e..d297c5a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -74,8 +74,6 @@ docs = \
OPENFLOW.rst \
PORTING.rst \
README.rst \
- README-lisp.rst \
- README-native-tunneling.rst \
WHY-OVS.rst
EXTRA_DIST = \
$(docs) \
diff --git a/ofproto/ofproto-tnl-unixctl.man b/ofproto/ofproto-tnl-unixctl.man
index 7767197..c70cca5 100644
--- a/ofproto/ofproto-tnl-unixctl.man
+++ b/ofproto/ofproto-tnl-unixctl.man
@@ -1,6 +1,5 @@
.SS "OPENVSWITCH TUNNELING COMMANDS"
-These commands query and modify OVS tunnel components. Ref to
-README-native-tunneling.rst for more info.
+These commands query and modify OVS tunnel components.
.
.IP "\fBovs/route/add ipv4_address/plen output_bridge [GW]\fR"
Adds ipv4_address/plen route to vswitchd routing table. output_bridge
diff --git a/ovn/automake.mk b/ovn/automake.mk
index 3bcc1d5..7465f8e 100644
--- a/ovn/automake.mk
+++ b/ovn/automake.mk
@@ -72,7 +72,6 @@ DISTCLEANFILES += ovn/ovn-architecture.7
EXTRA_DIST += \
ovn/TODO.rst \
- ovn/CONTAINERS.OpenStack.rst \
ovn/OVN-GW-HA.rst
# Version checking for ovn-nb.ovsschema.
diff --git a/rhel/openvswitch.spec.in b/rhel/openvswitch.spec.in
index d03588c..8484626 100644
--- a/rhel/openvswitch.spec.in
+++ b/rhel/openvswitch.spec.in
@@ -249,7 +249,7 @@ exit 0
/usr/share/openvswitch/vswitch.ovsschema
/usr/share/openvswitch/vtep.ovsschema
%doc COPYING DESIGN.rst NOTICE README.rst WHY-OVS.rst FAQ.rst NEWS
-%doc rhel/README.RHEL.rst README-native-tunneling.rst
+%doc rhel/README.RHEL.rst
/var/lib/openvswitch
/var/log/openvswitch
diff --git a/utilities/ovs-sim.1.xml b/utilities/ovs-sim.1.xml
index 0430e73..62ac22b 100644
--- a/utilities/ovs-sim.1.xml
+++ b/utilities/ovs-sim.1.xml
@@ -143,7 +143,7 @@ utilities/ovs-sim
-sim_add hv0 # Create sandbox hv0.
+sim_add hv0 # Create sandbox hv0.
as hv0 # Set hv0 as default sandbox.
ovs-vsctl add-br br0 # Add bridge br0 inside hv0.
@@ -157,8 +157,8 @@ ovs-vsctl add-br br0 # Add bridge br0 inside hv0.
default system
type of bridges and interfaces are
replaced by dummy
devices. Other types of devices,
however, retain their usual functions, which means that, e.g.,
- vxlan
tunnels still act as tunnels (see
- README-native-tunneling.rst
).
+ vxlan
tunnels still act as tunnels (refer to the
+ documentation).
diff --git a/vtep/automake.mk b/vtep/automake.mk
index 6a98144..4e284d3 100644
--- a/vtep/automake.mk
+++ b/vtep/automake.mk
@@ -40,7 +40,6 @@ vtep_vtep_ctl_LDADD = vtep/libvtep.la lib/libopenvswitch.la
scripts_SCRIPTS += \
vtep/ovs-vtep
-docs += vtep/README.ovs-vtep.rst
EXTRA_DIST += vtep/ovs-vtep
FLAKE8_PYFILES += vtep/ovs-vtep