summaryrefslogtreecommitdiff
path: root/Documentation/ref
diff options
context:
space:
mode:
authorBen Pfaff <blp@ovn.org>2019-09-27 09:21:57 -0700
committerBen Pfaff <blp@ovn.org>2019-09-30 13:13:26 -0700
commit05bf1dbb98b0635a51f75e268ef8aed27601401d (patch)
treed636da9a9475bf0514cc24fd53a33cc236ac95d7 /Documentation/ref
parent817db730190e19df7f1519b384fefab6d90b52fa (diff)
downloadopenvswitch-05bf1dbb98b0635a51f75e268ef8aed27601401d.tar.gz
ovn: Remove remaining pieces.
A preceding commit removed the last remaining dependencies on OVN code, so remove the OVN code. Acked-by: Han Zhou <hzhou8@ebay.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/ref')
-rw-r--r--Documentation/ref/index.rst40
-rw-r--r--Documentation/ref/ovsdb.7.rst38
2 files changed, 19 insertions, 59 deletions
diff --git a/Documentation/ref/index.rst b/Documentation/ref/index.rst
index 0a80a5f41..0cb5ef571 100644
--- a/Documentation/ref/index.rst
+++ b/Documentation/ref/index.rst
@@ -54,46 +54,6 @@ The remainder are still in roff format can be found below:
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-actions.7.pdf>`__
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-actions.7.html>`__
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-actions.7.txt>`__
- * - ovn-architecture(7)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-architecture.7.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-architecture.7.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-architecture.7.txt>`__
- * - ovn-controller(8)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-controller.8.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-controller.8.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-controller.8.txt>`__
- * - ovn-controller-vtep(8)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-controller-vtep.8.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-controller-vtep.8.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-controller-vtep.8.txt>`__
- * - ovn-ctl(8)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-ctl.8.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-ctl.8.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-ctl.8.txt>`__
- * - ovn-nb(5)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-nb.5.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-nb.5.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-nb.5.txt>`__
- * - ovn-nbctl(8)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-nbctl.8.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-nbctl.8.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-nbctl.8.txt>`__
- * - ovn-northd(8)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-northd.8.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-northd.8.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-northd.8.txt>`__
- * - ovn-sb(5)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-sb.5.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-sb.5.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-sb.5.txt>`__
- * - ovn-sbctl(8)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-sbctl.8.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-sbctl.8.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-sbctl.8.txt>`__
- * - ovn-trace(8)
- - `(pdf) <http://www.openvswitch.org/support/dist-docs/ovn-trace.8.pdf>`__
- - `(html) <http://www.openvswitch.org/support/dist-docs/ovn-trace.8.html>`__
- - `(plain text) <http://www.openvswitch.org/support/dist-docs/ovn-trace.8.txt>`__
* - ovs-appctl(8)
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-appctl.8.pdf>`__
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-appctl.8.html>`__
diff --git a/Documentation/ref/ovsdb.7.rst b/Documentation/ref/ovsdb.7.rst
index b12d8066c..b1f3f5d49 100644
--- a/Documentation/ref/ovsdb.7.rst
+++ b/Documentation/ref/ovsdb.7.rst
@@ -47,11 +47,11 @@ While OVSDB is general-purpose and not particularly specialized for use with
Open vSwitch, Open vSwitch does use it for multiple purposes. The leading use
of OVSDB is for configuring and monitoring ``ovs-vswitchd(8)``, the Open
vSwitch switch daemon, using the schema documented in
-``ovs-vswitchd.conf.db(5)``. The Open Virtual Network (OVN) sub-project of OVS
-uses two OVSDB schemas, documented in ``ovn-nb(5)`` and ``ovn-sb(5)``.
-Finally, Open vSwitch includes the "VTEP" schema, documented in
-``vtep(5)`` that many third-party hardware switches support for
-configuring VXLAN, although OVS itself does not directly use this schema.
+``ovs-vswitchd.conf.db(5)``. The Open Virtual Network (OVN) project uses two
+OVSDB schemas, documented as part of that project. Finally, Open vSwitch
+includes the "VTEP" schema, documented in ``vtep(5)`` that many third-party
+hardware switches support for configuring VXLAN, although OVS itself does not
+directly use this schema.
The OVSDB protocol specification allows independent, interoperable
implementations of OVSDB to be developed. Open vSwitch includes an OVSDB
@@ -65,9 +65,8 @@ otherwise be unclear from the context.
In addition to these generic OVSDB server and client tools, Open vSwitch
includes tools for working with databases that have specific schemas:
-``ovs-vsctl`` works with the ``ovs-vswitchd`` configuration database,
-``vtep-ctl`` works with the VTEP database, ``ovn-nbctl`` works with
-the OVN Northbound database, and so on.
+``ovs-vsctl`` works with the ``ovs-vswitchd`` configuration database and
+``vtep-ctl`` works with the VTEP database.
RFC 7047 specifies the OVSDB protocol but it does not specify an on-disk
storage format. Open vSwitch includes ``ovsdb-tool(1)`` for working with its
@@ -183,8 +182,8 @@ can switch the backup server to an active role with the ``ovs-appctl`` command
access to the now-active server. Of course, administrators are slow to respond
compared to software, so in practice external management software detects the
active server's failure and changes the backup server's role. For example, the
-"Integration Guide for Centralized Control" in the Open vSwitch documentation
-describes how to use Pacemaker for this purpose in OVN.
+"Integration Guide for Centralized Control" in the OVN documentation describes
+how to use Pacemaker for this purpose in OVN.
Suppose an active server fails and its backup is promoted to active. If the
failed server is revived, it must be started as a backup server. Otherwise, if
@@ -222,11 +221,10 @@ To set up a clustered database, first initialize it on a single node by running
arguments, the ``create-cluster`` command can create an empty database or copy
a standalone database's contents into the new database.
-To configure a client, such as ``ovn-controller`` or ``ovn-sbctl``, to use a
-clustered database, first configure all of the servers to listen on a
-connection method that the client can reach, then point the client to all of
-the servers' connection methods, comma-separated. See `Connection Methods`_,
-below, for more detail.
+To configure a client to use a clustered database, first configure all of the
+servers to listen on a connection method that the client can reach, then point
+the client to all of the servers' connection methods, comma-separated. See
+`Connection Methods`_, below, for more detail.
Open vSwitch 2.9 introduced support for the clustered service model.
@@ -328,8 +326,8 @@ following consequences:
* When a client conducts a mix of read and write transactions across more than
one server in a cluster, it can see inconsistent results because a read
transaction might read stale data whose updates have not yet propagated from
- the leader. By default, ``ovn-sbctl`` and similar utilities connect to the
- cluster leader to avoid this issue.
+ the leader. By default, utilities such as ``ovn-sbctl`` (in OVN) connect to
+ the cluster leader to avoid this issue.
The same might occur for transactions against a single follower except that
the OVSDB server ensures that the results of a write forwarded to the leader
@@ -649,7 +647,9 @@ Open vSwitch implementations of generic OVSDB functionality:
``ovsdb-server(1)``, ``ovsdb-client(1)``, ``ovsdb-tool(1)``.
Tools for working with databases that have specific OVSDB schemas:
-``ovs-vsctl(8)``, ``vtep-ctl(8)``, ``ovn-nbctl(8)``, ``ovn-sbctl(8)``.
+``ovs-vsctl(8)``, ``vtep-ctl(8)``, and (in OVN) ``ovn-nbctl(8)``,
+``ovn-sbctl(8)``.
OVSDB schemas for Open vSwitch and related functionality:
-``ovs-vswitchd.conf.db(5)``, ``vtep(5)``, ``ovn-nb(5)``, ``ovn-sb(5)``.
+``ovs-vswitchd.conf.db(5)``, ``vtep(5)``, and (in OVN) ``ovn-nb(5)``,
+``ovn-sb(5)``.