diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/howto/dpdk.rst | 11 | ||||
| -rw-r--r-- | Documentation/howto/userspace-tunneling.rst | 4 | ||||
| -rw-r--r-- | Documentation/intro/install/distributions.rst | 4 | ||||
| -rw-r--r-- | Documentation/intro/install/dpdk.rst | 6 | ||||
| -rw-r--r-- | Documentation/topics/dpdk/bridge.rst | 7 | ||||
| -rw-r--r-- | Documentation/topics/dpdk/index.rst | 6 | ||||
| -rw-r--r-- | Documentation/topics/dpdk/phy.rst | 10 | ||||
| -rw-r--r-- | Documentation/topics/dpdk/pmd.rst | 6 | ||||
| -rw-r--r-- | Documentation/topics/dpdk/ring.rst | 6 | ||||
| -rw-r--r-- | Documentation/topics/dpdk/vhost-user.rst | 6 | ||||
| -rw-r--r-- | Documentation/topics/testing.rst | 4 |
11 files changed, 36 insertions, 34 deletions
diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst index 6397d25f1..766a7950c 100644 --- a/Documentation/howto/dpdk.rst +++ b/Documentation/howto/dpdk.rst @@ -25,14 +25,15 @@ Using Open vSwitch with DPDK ============================ -This document describes how to use Open vSwitch with DPDK datapath. +This document describes how to use Open vSwitch with DPDK. .. important:: - Using the DPDK datapath requires building OVS with DPDK support. The - mapping of OVS version to DPDK can vary between releases. For version - mapping information refer to :doc:`releases FAQ </faq/releases>`. For - build instructions refer to :doc:`/intro/install/dpdk`. + Using DPDK with OVS requires configuring OVS at build time to use + the DPDK library. The version of DPDK that OVS supports varies + from one OVS release to another, as described in the :doc:`releases + FAQ </faq/releases>`. For build instructions refer to + :doc:`/intro/install/dpdk`. Ports and Bridges ----------------- diff --git a/Documentation/howto/userspace-tunneling.rst b/Documentation/howto/userspace-tunneling.rst index 1b9d8b9eb..0122ce76e 100644 --- a/Documentation/howto/userspace-tunneling.rst +++ b/Documentation/howto/userspace-tunneling.rst @@ -74,8 +74,8 @@ Two Physical Hosts The environment assumes the use of two hosts, named `host1` and `host2`. We only detail the configuration of `host1` but a similar configuration can be used for `host2`. Both hosts should be configured with Open vSwitch (with or -without the DPDK datapath), QEMU/KVM and suitable VM images. Open vSwitch -should be running before proceeding. +without DPDK), QEMU/KVM and suitable VM images. Open vSwitch should be running +before proceeding. Configuration Steps ------------------- diff --git a/Documentation/intro/install/distributions.rst b/Documentation/intro/install/distributions.rst index 5987178ea..54362c0a4 100644 --- a/Documentation/intro/install/distributions.rst +++ b/Documentation/intro/install/distributions.rst @@ -46,8 +46,8 @@ that includes the core userspace components of the switch. 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``. +3. For fast userspace switching, Open vSwitch with DPDK support is +bundled in the package ``openvswitch-switch-dpdk``. Fedora ------ diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst index 6e5f1ea60..50de7fbac 100644 --- a/Documentation/intro/install/dpdk.rst +++ b/Documentation/intro/install/dpdk.rst @@ -107,8 +107,8 @@ Install DPDK Install OVS ~~~~~~~~~~~ -OVS can be installed using different methods. For OVS to use DPDK datapath, it -has to be configured with DPDK support (``--with-dpdk``). +OVS can be installed using different methods. For OVS to use DPDK, it +has to be configured to build against the DPDK library (``--with-dpdk``). .. note:: This section focuses on generic recipe that suits most cases. For @@ -288,7 +288,7 @@ with either the ovs-vswitchd logs, or by running either of the commands:: "DPDK 17.11.0" At this point you can use ovs-vsctl to set up bridges and other Open vSwitch -features. Seeing as we've configured the DPDK datapath, we will use DPDK-type +features. Seeing as we've configured DPDK support, we will use DPDK-type ports. For example, to create a userspace bridge named ``br0`` and add two ``dpdk`` ports to it, run:: diff --git a/Documentation/topics/dpdk/bridge.rst b/Documentation/topics/dpdk/bridge.rst index 4ca79a4ab..d9bc7eba4 100644 --- a/Documentation/topics/dpdk/bridge.rst +++ b/Documentation/topics/dpdk/bridge.rst @@ -25,13 +25,14 @@ DPDK Bridges ============ -The DPDK datapath requires specially configured bridge(s) in order to utilize -DPDK-backed :doc:`physical <phy>` and :doc:`virtual <vhost-user>` ports. +Bridge must be specially configured to utilize DPDK-backed +:doc:`physical <phy>` and :doc:`virtual <vhost-user>` ports. Quick Example ------------- -This example demonstrates how to add a bridge using the DPDK datapath:: +This example demonstrates how to add a bridge that will take advantage +of DPDK:: $ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev diff --git a/Documentation/topics/dpdk/index.rst b/Documentation/topics/dpdk/index.rst index cf24a7b6d..f2862ea70 100644 --- a/Documentation/topics/dpdk/index.rst +++ b/Documentation/topics/dpdk/index.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -================= -The DPDK Datapath -================= +============ +DPDK Support +============ .. NOTE(stephenfin): Part of this doc is included in 'howto/dpdk'. Update that .. if you modify this document diff --git a/Documentation/topics/dpdk/phy.rst b/Documentation/topics/dpdk/phy.rst index 93d74df45..0867076da 100644 --- a/Documentation/topics/dpdk/phy.rst +++ b/Documentation/topics/dpdk/phy.rst @@ -125,11 +125,11 @@ Multiqueue ---------- Poll Mode Driver (PMD) threads are the threads that do the heavy lifting for -the DPDK datapath. Correct configuration of PMD threads and the Rx queues they -utilize is a requirement in order to deliver the high-performance possible with -DPDK acceleration. It is possible to configure multiple Rx queues for ``dpdk`` -ports, thus ensuring this is not a bottleneck for performance. For information -on configuring PMD threads, refer to :doc:`pmd`. +userspace switching. Correct configuration of PMD threads and the Rx +queues they utilize is a requirement in order to deliver the high-performance +possible with DPDK acceleration. It is possible to configure multiple Rx queues +for ``dpdk`` ports, thus ensuring this is not a bottleneck for performance. For +information on configuring PMD threads, refer to :doc:`pmd`. .. _dpdk-phy-flow-control: diff --git a/Documentation/topics/dpdk/pmd.rst b/Documentation/topics/dpdk/pmd.rst index b0e19d794..6f1fdcbc6 100644 --- a/Documentation/topics/dpdk/pmd.rst +++ b/Documentation/topics/dpdk/pmd.rst @@ -26,9 +26,9 @@ PMD Threads =========== Poll Mode Driver (PMD) threads are the threads that do the heavy lifting for -the DPDK datapath and perform tasks such as continuous polling of input ports -for packets, classifying packets once received, and executing actions on the -packets once they are classified. +userspace switching. They perform tasks such as continuous polling of +input ports for packets, classifying packets once received, and executing +actions on the packets once they are classified. PMD threads utilize Receive (Rx) and Transmit (Tx) queues, commonly known as *rxq*\s and *txq*\s. While Tx queue configuration happens automatically, Rx diff --git a/Documentation/topics/dpdk/ring.rst b/Documentation/topics/dpdk/ring.rst index e48b44ce8..81c2efb37 100644 --- a/Documentation/topics/dpdk/ring.rst +++ b/Documentation/topics/dpdk/ring.rst @@ -32,9 +32,9 @@ DPDK Ring Ports :doc:`vhost-user ports <vhost-user>` are a better choice and should be used instead. -The DPDK datapath provides DPDK-backed ring ports that are implemented using -DPDK's ``librte_ring`` library. For more information on this library, refer to -the `DPDK documentation`_. +OVS userspace switching supports ring ports implemented using DPDK's +``librte_ring`` library. For more information on this library, refer +to the `DPDK documentation`_. .. important:: diff --git a/Documentation/topics/dpdk/vhost-user.rst b/Documentation/topics/dpdk/vhost-user.rst index fab87bd3d..cda5b122f 100644 --- a/Documentation/topics/dpdk/vhost-user.rst +++ b/Documentation/topics/dpdk/vhost-user.rst @@ -25,9 +25,9 @@ DPDK vHost User Ports ===================== -The DPDK datapath provides DPDK-backed vHost user ports as a primary way to -interact with guests. For more information on vHost User, refer to the `QEMU -documentation`_ on same. +OVS userspace switching supports supports vHost user ports as a +primary way to interact with guests. For more information on vHost +User, refer to the `QEMU documentation`_ on same. .. important:: diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst index 31433c591..8b5d268e0 100644 --- a/Documentation/topics/testing.rst +++ b/Documentation/topics/testing.rst @@ -324,8 +324,8 @@ The results of the testsuite are in ``tests/system-userspace-testsuite.dir``. All the features documented under `Unit Tests`_ are available for the userspace datapath testsuite. -DPDK datapath -''''''''''''' +Userspace datapath with DPDK +'''''''''''''''''''''''''''' To test :doc:`/intro/install/dpdk` (i.e., the build was configured with ``--with-dpdk``, the DPDK is installed), run the testsuite and generate |