diff mbox

[ovs-dev,2/2] doc: Add info on distributions shipping openvswitch package.

Message ID 1486502303-88648-2-git-send-email-bhanuprakash.bodireddy@intel.com
State Accepted
Headers show

Commit Message

Bodireddy, Bhanuprakash Feb. 7, 2017, 9:18 p.m. UTC
List details of various popular distributions shipping Open vSwitch
packages. Also include the information of the distros supporting DPDK
accelerated datapath.

Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com>
---
 Documentation/automake.mk                     |  1 +
 Documentation/intro/install/distributions.rst | 72 +++++++++++++++++++++++++++
 Documentation/intro/install/index.rst         |  1 +
 3 files changed, 74 insertions(+)
 create mode 100644 Documentation/intro/install/distributions.rst

Comments

Flavio Leitner Feb. 8, 2017, 1:28 p.m. UTC | #1
On Tue, Feb 07, 2017 at 09:18:23PM +0000, Bhanuprakash Bodireddy wrote:
> List details of various popular distributions shipping Open vSwitch
> packages. Also include the information of the distros supporting DPDK
> accelerated datapath.
> 
> Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com>
> ---
>  Documentation/automake.mk                     |  1 +
>  Documentation/intro/install/distributions.rst | 72 +++++++++++++++++++++++++++
>  Documentation/intro/install/index.rst         |  1 +
>  3 files changed, 74 insertions(+)
>  create mode 100644 Documentation/intro/install/distributions.rst
> 
> diff --git a/Documentation/automake.mk b/Documentation/automake.mk
> index 42553f0..456ab44 100644
> --- a/Documentation/automake.mk
> +++ b/Documentation/automake.mk
> @@ -12,6 +12,7 @@ EXTRA_DIST += \
>  	Documentation/intro/install/bash-completion.rst \
>  	Documentation/intro/install/debian.rst \
>  	Documentation/intro/install/documentation.rst \
> +	Documentation/intro/install/distributions.rst \
>  	Documentation/intro/install/dpdk.rst \
>  	Documentation/intro/install/fedora.rst \
>  	Documentation/intro/install/general.rst \
> diff --git a/Documentation/intro/install/distributions.rst b/Documentation/intro/install/distributions.rst
> new file mode 100644
> index 0000000..c991eda
> --- /dev/null
> +++ b/Documentation/intro/install/distributions.rst
> @@ -0,0 +1,72 @@
> +..
> +      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.
> +
> +====================================
> +Distributions packaging Open vSwitch
> +====================================
> +
> +This document lists various popular distributions packaging Open vSwitch.
> +Open vSwitch is packaged by various distributions for multiple platforms and
> +architectures.
> +
> +.. note::
> +  The packaged version available with distributions may not be latest
> +  Open vSwitch release.
> +
> +Debian
> +-------
> +
> +You can use ``apt-get`` or ``aptitude`` to install the .deb packages and must
> +be superuser.
> +
> +1. Debian has ``openvswitch-switch`` and ``openvswitch-common`` .deb packages
> +that includes the core userspace components of the switch.
> +
> +2. For kernel datapath, ``openvswitch-datapath-dkms`` can be installed to
> +automatically build and install Open vSwitch kernel module for your running
> +kernel.
> +
> +3. For DPDK datapath, Open vSwitch with DPDK support is bundled in the package
> +``openvswitch-switch-dpdk``.
> +
> +Fedora
> +------
> +
> +Fedora provides ``openvswitch``, ``openvswitch-devel``, ``openvswitch-test``
> +and ``openvswitch-debuginfo`` rpm packages. You can install ``openvswitch``
> +package in minimum installation. Use ``yum`` or ``dnf`` to install the rpm
> +packages and must be superuser.
> +
> +Redhat
> +------
> +
> +RHEL distributes ``openvswitch`` rpm package that supports kernel datapath.
> +DPDK accelerated Open vSwitch can be installed using ``openvswitch-dpdk``
> +package.


That has changed and now there is only a single package (DPDK enabled)
called ``openvswitch``.
Ben Pfaff March 8, 2017, 12:42 a.m. UTC | #2
On Tue, Feb 07, 2017 at 09:18:23PM +0000, Bhanuprakash Bodireddy wrote:
> List details of various popular distributions shipping Open vSwitch
> packages. Also include the information of the distros supporting DPDK
> accelerated datapath.
> 
> Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com>

Thanks for writing documentation!  I applied this to master and
branch-2.7.
diff mbox

Patch

diff --git a/Documentation/automake.mk b/Documentation/automake.mk
index 42553f0..456ab44 100644
--- a/Documentation/automake.mk
+++ b/Documentation/automake.mk
@@ -12,6 +12,7 @@  EXTRA_DIST += \
 	Documentation/intro/install/bash-completion.rst \
 	Documentation/intro/install/debian.rst \
 	Documentation/intro/install/documentation.rst \
+	Documentation/intro/install/distributions.rst \
 	Documentation/intro/install/dpdk.rst \
 	Documentation/intro/install/fedora.rst \
 	Documentation/intro/install/general.rst \
diff --git a/Documentation/intro/install/distributions.rst b/Documentation/intro/install/distributions.rst
new file mode 100644
index 0000000..c991eda
--- /dev/null
+++ b/Documentation/intro/install/distributions.rst
@@ -0,0 +1,72 @@ 
+..
+      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.
+
+====================================
+Distributions packaging Open vSwitch
+====================================
+
+This document lists various popular distributions packaging Open vSwitch.
+Open vSwitch is packaged by various distributions for multiple platforms and
+architectures.
+
+.. note::
+  The packaged version available with distributions may not be latest
+  Open vSwitch release.
+
+Debian
+-------
+
+You can use ``apt-get`` or ``aptitude`` to install the .deb packages and must
+be superuser.
+
+1. Debian has ``openvswitch-switch`` and ``openvswitch-common`` .deb packages
+that includes the core userspace components of the switch.
+
+2. For kernel datapath, ``openvswitch-datapath-dkms`` can be installed to
+automatically build and install Open vSwitch kernel module for your running
+kernel.
+
+3. For DPDK datapath, Open vSwitch with DPDK support is bundled in the package
+``openvswitch-switch-dpdk``.
+
+Fedora
+------
+
+Fedora provides ``openvswitch``, ``openvswitch-devel``, ``openvswitch-test``
+and ``openvswitch-debuginfo`` rpm packages. You can install ``openvswitch``
+package in minimum installation. Use ``yum`` or ``dnf`` to install the rpm
+packages and must be superuser.
+
+Redhat
+------
+
+RHEL distributes ``openvswitch`` rpm package that supports kernel datapath.
+DPDK accelerated Open vSwitch can be installed using ``openvswitch-dpdk``
+package.
+
+OpenSuSE
+--------
+
+OpenSUSE provides ``openvswitch``, ``openvswitch-switch`` rpm packages. Also
+``openvswitch-dpdk`` and ``openvswitch-dpdk-switch`` can be installed for
+Open vSwitch using DPDK accelerated datapath.
diff --git a/Documentation/intro/install/index.rst b/Documentation/intro/install/index.rst
index 8696b4e..3193c73 100644
--- a/Documentation/intro/install/index.rst
+++ b/Documentation/intro/install/index.rst
@@ -56,6 +56,7 @@  provided below.
 .. toctree::
    :maxdepth: 2
 
+   distributions
    debian
    fedora
    rhel