Commit 43f317ff authored by Stephen Finucane's avatar Stephen Finucane Committed by Ben Pfaff

doc: Further populate the 'howto' section

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: default avatarStephen Finucane <stephen@that.guru>
Signed-off-by: default avatarBen Pfaff <blp@ovn.org>
parent 795752a3
......@@ -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 \
......
......@@ -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
......@@ -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
<IntegrationGuide.rst>`__, 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
......
......@@ -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:
::
......
......@@ -75,8 +75,6 @@ docs = \
OPENFLOW.rst \
PORTING.rst \
README.rst \
README-lisp.rst \
README-native-tunneling.rst \
WHY-OVS.rst
EXTRA_DIST = \
$(docs) \
......
.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
......
......@@ -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.
......
......@@ -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
......
......@@ -143,7 +143,7 @@ utilities/ovs-sim
</p>
<pre>
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.
</pre>
......@@ -157,8 +157,8 @@ ovs-vsctl add-br br0 # Add bridge br0 inside hv0.
default <code>system</code> type of bridges and interfaces are
replaced by <code>dummy</code> devices. Other types of devices,
however, retain their usual functions, which means that, e.g.,
<code>vxlan</code> tunnels still act as tunnels (see
<code>README-native-tunneling.rst</code>).
<code>vxlan</code> tunnels still act as tunnels (refer to the
documentation).
</p>
</dd>
......
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment