From f150a8bafbf2ab7cc2e85f3c63ad443eb4f376eb Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Thu, 22 Dec 2016 09:54:44 +0000 Subject: [PATCH] doc: Document various language bindings Signed-off-by: Stephen Finucane Signed-off-by: Ben Pfaff --- Documentation/automake.mk | 1 + Documentation/index.rst | 4 +- Documentation/topics/index.rst | 1 + Documentation/topics/language-bindings.rst | 60 ++++++++++++++++++++++ 4 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 Documentation/topics/language-bindings.rst diff --git a/Documentation/automake.mk b/Documentation/automake.mk index b488807ef94..b7b3cc1fa86 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -31,6 +31,7 @@ EXTRA_DIST += \ Documentation/topics/testing.rst \ Documentation/topics/high-availability.rst \ Documentation/topics/integration.rst \ + Documentation/topics/language-bindings.rst \ Documentation/topics/openflow.rst \ Documentation/topics/ovsdb-replication.rst \ Documentation/topics/porting.rst \ diff --git a/Documentation/index.rst b/Documentation/index.rst index 32b41e17e72..5a925135f27 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -72,10 +72,12 @@ Deeper Dive - **Windows** :doc:`topics/windows` -- **Testing** :doc:`topics/testing` +- **Integrations:** :doc:`topics/language-bindings` - **Reference Guides:** :doc:`ref/index` +- **Testing** :doc:`topics/testing` + - **Packaging:** :doc:`intro/install/debian` | :doc:`intro/install/rhel` | :doc:`intro/install/fedora` diff --git a/Documentation/topics/index.rst b/Documentation/topics/index.rst index e5a8b4db9a7..28ee04e738f 100644 --- a/Documentation/topics/index.rst +++ b/Documentation/topics/index.rst @@ -42,6 +42,7 @@ that way. ovsdb-replication dpdk/index windows + language-bindings testing .. toctree:: diff --git a/Documentation/topics/language-bindings.rst b/Documentation/topics/language-bindings.rst new file mode 100644 index 00000000000..5114125cf89 --- /dev/null +++ b/Documentation/topics/language-bindings.rst @@ -0,0 +1,60 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +================= +Language Bindings +================= + +Bindings exist for Open vSwitch in a variety of languages. + +Official Bindings +----------------- + +Python +~~~~~~ + +The Python bindings are part of the `Open vSwitch package`__. You can install +the bindings using ``pip``: + +.. code-block:: shell + + $ pip install ovs + +__ https://github.com/openvswitch/ovs/tree/master/python/ovs + +Third-Party Bindings +-------------------- + +Lua +~~~ + +- `LJIT2ovs:`__ LuaJIT binding for Open vSwitch + +__ https://github.com/wiladams/LJIT2ovs + +Go +~~ + +- `go-odp:`__ A Go library to control the Open vSwitch in-kernel datapath + +__ https://github.com/weaveworks/go-odp