starlingx/docs
Code Issues Proposed changes

Removed proprietary (AVS and AVP) content from VNF section

Browse Source 
Change-Id: I22579ebff290a7a7edf1cbb4cd8f6943b4afbead
Signed-off-by: Keane Lim <keane.lim@windriver.com>
This commit is contained in:
Keane Lim 2021-04-20 11:43:41 -04:00
parent c6c13e601a
commit 2e30dbc072
9 changed files with 14 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
doc/source/_includes/overview-of-vnf-integration.rest Normal file
View File

0
doc/source/_includes/standard-virtio-backed-with-vhost-support.rest Normal file
View File

0
doc/source/_includes/use-a-vif-model-when-creating-ports.rest Normal file
View File

29
doc/source/vnf_integration/accelerated-virtual-interfaces.rst
View File

@ -1,29 +0,0 @@
.. xyo1466098370729
.. _accelerated-virtual-interfaces:
==============================
Accelerated Virtual Interfaces
==============================
|VNFs| can be configured to use |org| |AVP| to improve throughput when
compared to emulated virtual drivers.
The |prod-os| |AVP| virtual |NIC| is a shared memory based high performance networking
device. Its potential maximum throughput is higher than other emulated virtual
|NIC| devices \(for example, e1000\). For more information, see
:ref:`wrs-avp-pmd—Accelerated DPDK Network Drivers
<wrs-avp-pmd-accelerated-dpdk-network-drivers>`.
.. seealso::
- :ref:`Standard Virtio - Backed with Vhost Support
<standard-virtio-backed-with-vhost-support>`
- :ref:`wrs-avp-pmd—Accelerated DPDK Network Drivers
<wrs-avp-pmd-accelerated-dpdk-network-drivers>`
- :ref:`Using a VIF Model when Creating Ports
<use-a-vif-model-when-creating-ports>`

10
doc/source/vnf_integration/index.rst
View File

@ -21,15 +21,6 @@ Bootstrap Data
bootstrap-data
configuration-using-metadata
------------------------------
Accelerated Virtual Interfaces
------------------------------
.. toctree::
:maxdepth: 2
accelerated-virtual-interfaces
************************************
About Accelerated Virtual Interfaces
************************************
@ -38,7 +29,6 @@ About Accelerated Virtual Interfaces
:maxdepth: 2
standard-virtio-backed-with-vhost-support
wrs-avp-pmd-accelerated-dpdk-network-drivers
use-a-vif-model-when-creating-ports

10
doc/source/vnf_integration/overview-of-vnf-integration.rst
View File

@ -29,12 +29,10 @@ The following |VNF|-related integration topics are included in this document:
See :ref:`Bootstrap Data <bootstrap-data>`.
- Use |org| |AVPs| to improve throughput when compared to emulated
virtual drivers. See :ref:`Accelerated Virtual Interfaces
<accelerated-virtual-interfaces>`.
.. only:: partner
.. include:: ../_includes/overview-of-vnf-integration.rest
.. note::
|AVP|-|PMD| information is available in the following repository, for
more information, see `http://dpdk.org/ <http://dpdk.org/>`__.

13
doc/source/vnf_integration/standard-virtio-backed-with-vhost-support.rst
View File

@ -11,11 +11,10 @@ mechanism to bring existing applications into the production environment
immediately.
For virtio interfaces, |prod-os| supports vhost-user transparently by default.
This allows QEMU and AVS to share virtio queues through shared memory,
resulting in improved performance over standard virtio. The transparent
implementation provides a simplified alternative to the open-source |AVP|
kernel and |AVP|-|PMD| drivers. For more about these drivers, see
:ref:`Accelerated Virtual Interfaces <accelerated-virtual-interfaces>`. The
availability of vhost-user also offers additional performance enhancements
through optional multi-queue support for virtio interfaces.
.. only:: partner
.. include:: ../_includes/standard-virtio-backed-with-vhost-support.rest

37
doc/source/vnf_integration/use-a-vif-model-when-creating-ports.rst
View File

@ -9,39 +9,7 @@ Using a VIF Model when Creating Ports
For any non Virtio |NIC|, you must create a port beforehand using the VIF
model.
For example, to set up two |AVPs|, the heat template's binding:profile
would contain definitions similar to the following.
.. code-block:: yaml
port_tenant_net_tenant1_avp:
type: OS::Neutron::Port
properties:
name: heat_port_port-tenant-net-tenant1-avp
network: tenant1-net1
value_specs: {"binding:profile": {"vif_model":"avp"}}
port_internal_net_tenant1_avp:
type: OS::Neutron::Port
properties:
name: heat_port_port-internal-net-tenant1-avp
network: internal0-net1
value_specs: {"binding:profile": {"vif_model":"avp"}}
tenant1_avp:
type: OS::Nova::Server
properties:
name: tenant1-avp4
flavor: small
block_device_mapping:
- {device_name: vda, volume_id: { get_resource: vol_tenant1_avp } }
networks:
- {network: tenant1-mgmt-net}
- {port: { get_resource: port_tenant_net_tenant1_avp } }
- {port: { get_resource: port_internal_net_tenant1_avp } }
Alternatively, you can use the command line. For example:
You can use the command line. For example:
.. code-block:: none
@ -53,3 +21,6 @@ port.html
<https://docs.openstack.org/python-openstackclient/train/cli/command-objects/
port.html>`__.
.. only:: partner
.. include:: ../_includes/use-a-vif-model-when-creating-ports.rest

22
doc/source/vnf_integration/wrs-avp-pmd-accelerated-dpdk-network-drivers.rst
View File

@ -1,22 +0,0 @@
.. aca1426867398719
.. _wrs-avp-pmd-accelerated-dpdk-network-drivers:
=============================================
wrs-avp-pmd--Accelerated DPDK Network Drivers
=============================================
This component contains AVS-compatible |DPDK| drivers for high-performance
DPDK-based networking |VNFs|.
The |prod-os| |AVP| virtual |NIC| is a high-performance networking device.
It can provide line rate throughput \(depending on the guest and AVS
configuration\). This package provides the Intel |DPDK| compatible |PMD|. It
can be compiled as a component of an Intel |DPDK| distribution.
The |prod-os| |AVP|-|PMD| driver is available at `http://dpdk.org/
<http://dpdk.org/>`__.
.. note::
|org| no longer publishes |AVP|-|PMD| drivers on GitHub.