Re: [ovs-dev] [PATCH 02/15] doc: Convert IntegrationGuide to rST

[Russell Bryant]

On Tue, Oct 18, 2016 at 4:03 PM, Stephen Finucane  wrote:

> Signed-off-by: Stephen Finucane 
> ---
>  IntegrationGuide.md | 169 --
>  IntegrationGuide.rst| 195 ++
> ++
>  Makefile.am |   2 +-
>  ovn/CONTAINERS.OpenStack.md |   4 +-
>  ovn/ovn-architecture.7.xml  |   6 +-
>  ovn/ovn-sb.xml  |   2 +-
>  6 files changed, 202 insertions(+), 176 deletions(-)
>  delete mode 100644 IntegrationGuide.md
>  create mode 100644 IntegrationGuide.rst
>

applied to master, thanks.


-- 
Russell Bryant
___
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev

[ovs-dev] [PATCH 02/15] doc: Convert IntegrationGuide to rST

[Stephen Finucane]

Signed-off-by: Stephen Finucane 
---
 IntegrationGuide.md | 169 --
 IntegrationGuide.rst| 195 
 Makefile.am |   2 +-
 ovn/CONTAINERS.OpenStack.md |   4 +-
 ovn/ovn-architecture.7.xml  |   6 +-
 ovn/ovn-sb.xml  |   2 +-
 6 files changed, 202 insertions(+), 176 deletions(-)
 delete mode 100644 IntegrationGuide.md
 create mode 100644 IntegrationGuide.rst

diff --git a/IntegrationGuide.md b/IntegrationGuide.md
deleted file mode 100644
index 5d3e574..000
--- a/IntegrationGuide.md
+++ /dev/null
@@ -1,169 +0,0 @@
-Integration Guide for Centralized Control
-=
-
-This document describes how to integrate Open vSwitch onto a new
-platform to expose the state of the switch and attached devices for
-centralized control.  (If you are looking to port the switching
-components of Open vSwitch to a new platform, please see the PORTING
-document.)  The focus of this guide is on hypervisors, but many of the
-interfaces are useful for hardware switches, as well.  The XenServer
-integration is the most mature implementation, so most of the examples
-are drawn from it.
-
-The externally visible interface to this integration is
-platform-agnostic.  We encourage anyone who integrates Open vSwitch to
-use the same interface, because keeping a uniform interface means that
-controllers require less customization for individual platforms (and
-perhaps no customization at all).
-
-Integration centers around the Open vSwitch database and mostly involves
-the 'external_ids' columns in several of the tables.  These columns are
-not interpreted by Open vSwitch itself.  Instead, they provide
-information to a controller that permits it to associate a database
-record with a more meaningful entity.  In contrast, the 'other_config'
-column is used to configure behavior of the switch.  The main job of the
-integrator, then, is to ensure that these values are correctly populated
-and maintained.
-
-An integrator sets the columns in the database by talking to the
-ovsdb-server daemon.  A few of the columns can be set during startup by
-calling the ovs-ctl tool from inside the startup scripts.  The
-'xenserver/etc_init.d_openvswitch' script provides examples of its use,
-and the ovs-ctl(8) manpage contains complete documentation.  At runtime,
-ovs-vsctl can be be used to set columns in the database.  The script
-'xenserver/etc_xensource_scripts_vif' contains examples of its use, and
-ovs-vsctl(8) manpage contains complete documentation.
-
-Python and C bindings to the database are provided if deeper integration
-with a program are needed.  The XenServer ovs-xapi-sync daemon
-('xenserver/usr_share_openvswitch_scripts_ovs-xapi-sync') provides an
-example of using the Python bindings.  More information on the python
-bindings is available at 'python/ovs/db/idl.py'.  Information on the C
-bindings is available at 'lib/ovsdb-idl.h'.
-
-The following diagram shows how integration scripts fit into the Open vSwitch
-architecture:
-
-++
-|   Controller Cluster   +
-++
-|
-|
-   +--+
-   || |
-   | +--+---+ |
-   | |  | |
-   |   +---+   +--+   |
-   |   |   ovsdb-server|---|   ovs-vswitchd   |   |
-   |   +---+   +--+   |
-   | |  | |
-   |  +-+   | |
-   |  | Integration scripts |   | |
-   |  | (ex: ovs-xapi-sync) |   | |
-   |  +-+   | |
-   ||   Userspace |
-   |--|
-   ||  Kernel |
-   || |
-   | +-+  |
-   | |  OVS Kernel Module  |  |
-   | +-+  |
-   +--+
-
-
-A description of the most relevant fields for integration follows.  By
-setting these values, controllers are able to understand the network and
-manage it more dynamically and precisely.  For more details about the
-database and