openstack
/
os-vif
Code Issues Proposed changes

doc: Fix formatting issues 

- Definition lists can't have newlines between the term and definition
- Asterisks should be preferred to single backticks for italicising
  text, as the latter means "default role" which can be customized in
  some environments.
- Some literals aren't formatted as such

Change-Id: I0554a4ba49fd4cc071bc7f129686a7697b9c0d35
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane 2018-07-05 17:25:49 +01:00
parent ba61a98117
commit a0bdbcbdad
3 changed files with 18 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/user/plugins/linux-bridge.rst
View File

@ -2,17 +2,16 @@
Linux Bridge
============
The Linux Bridge plugin, ``vif_plug_linux_bridge``, is an `os-vif` VIF plugin
The Linux Bridge plugin, ``vif_plug_linux_bridge``, is an *os-vif* VIF plugin
for the Linux Bridge network backend. It is one of three plugins provided as part
of `os-vif` itself, the others being :doc:`ovs` and :doc:`noop`.
of *os-vif* itself, the others being :doc:`ovs` and :doc:`noop`.
Supported VIF Types
===================
-------------------
The Linux Bridge plugin provides support for the following VIF types:
`VIFBridge`
``VIFBridge``
Configuration where a guest is connected to a Linux bridge via a TAP device.
This is the only supported configuration for this plugin.

15
doc/source/user/plugins/noop.rst
View File

@ -2,20 +2,19 @@
no-op
=====
The no-op plugin, ``vif_plug_noop``, is an `os-vif` VIF plugin
for use with network backends that do not require pluging of network interfaces.
It is one of three plugins provided as part of `os-vif` itself, the others
being :doc:`ovs` and :doc:`linux-bridge`.
The no-op plugin, ``vif_plug_noop``, is an *os-vif* VIF plugin for use with
network backends that do not require plugging of network interfaces. It is one
of three plugins provided as part of *os-vif* itself, the others being
:doc:`ovs` and :doc:`linux-bridge`.
Supported VIF Types
===================
-------------------
The no-op plugin provides support for the following VIF types:
`VIFVHostUser`
``VIFVHostUser``
Configuration where a guest exposes a UNIX socket for its control plane. This
configuration is used with a userspace dataplane such as vpp or snabb switch.
configuration is used with a userspace dataplane such as VPP or Snabb switch.
Refer to :ref:`vif-vhostuser` for more information.

18
doc/source/user/plugins/ovs.rst
View File

@ -2,38 +2,34 @@
Open vSwitch
============
The Open vSwitch plugin, `vif_plug_ovs`, is an `os-vif` VIF plugin for the Open
vSwitch network backend. It is one of three plugins provided as part of `os-vif`
itself, the others being :doc:`linux-bridge` and :doc:`noop`.
The Open vSwitch plugin, ``vif_plug_ovs``, is an *os-vif* VIF plugin for the
Open vSwitch network backend. It is one of three plugins provided as part of
*os-vif* itself, the others being :doc:`linux-bridge` and :doc:`noop`.
Supported VIF Types
-------------------
The Open vSwitch plugin provides support for the following VIF types:
`VIFOpenVSwitch`
``VIFOpenVSwitch``
Configuration where a guest is directly connected an Open vSwitch bridge.
Refer to :ref:`vif-openvswitch` for more information.
`VIFBridge`
``VIFBridge``
Configuration where a guest is connected to a Linux bridge via a TAP device,
and that bridge is connected to the Open vSwitch bridge. This allows for the
use of ``iptables`` rules for filtering traffic.
Refer to :ref:`vif-bridge` for more information.
`VIFVHostUser`
``VIFVHostUser``
Configuration where a guest exposes a UNIX socket for its control plane. This
configuration is used with the `DPDK datapath of Open vSwitch`__.
Refer to :ref:`vif-vhostuser` for more information.
`VIFHostDevice`
``VIFHostDevice``
Configuration where an :term:`SR-IOV` PCI device :term:`VF` is passed through
to a guest. The ``hw-tc-offload`` feature should be enabled on the SR-IOV
:term:`PF` using ``ethtool``: