6wind-virtual-accelerator-plugin: va typo

Update the typos of virtual accelerator -> Virtual Accelerator.

Change-Id: I44b87a5947647a944ae3239a4ec83fadb9dc2a65
Signed-off-by: Vincent JARDIN <vincent.jardin@6wind.com>
This commit is contained in:
Vincent JARDIN 2016-06-07 01:13:15 +02:00
parent 9b796d14a9
commit 83577ade80
15 changed files with 60 additions and 60 deletions

View File

@ -9,7 +9,7 @@ class virtual_accelerator {
# General configuration
$settings = hiera('6wind-virtual-accelerator', {})
# 6WIND virtual accelerator settings
# 6WIND Virtual Accelerator settings
$advanced_params = $settings['advanced_params_enabled']
$fp_mem = $settings['fp_mem']
$cores_per_port = $settings['cores_per_port']

View File

@ -1,4 +1,4 @@
Appendix
========
#. `6WIND virtual accelerator overview <http://www.6wind.com/products/6wind-virtual-accelerator/>`_
#. `6WIND Virtual Accelerator overview <http://www.6wind.com/products/6wind-virtual-accelerator/>`_

View File

@ -49,7 +49,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'The 6WIND virtual accelerator plugin for Fuel'
project = u'The 6WIND Virtual Accelerator plugin for Fuel'
copyright = u'2016, 6WIND SA.'
# The version info for the project you're documenting, acts as replacement for
@ -202,7 +202,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'fuel-plugin-6wind-va.tex', u'The 6WIND virtual accelerator Plugin for Fuel Documentation',
('index', 'fuel-plugin-6wind-va.tex', u'The 6WIND Virtual Accelerator Plugin for Fuel Documentation',
u'6WIND SA', 'manual'),
]
@ -236,7 +236,7 @@ latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[e
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'fuel-plugin-6wind-va', u'Guide to the 6WIND virtual accelerator Plugin ver. 1.0-1.0.0-1 for Fuel',
('index', 'fuel-plugin-6wind-va', u'Guide to the 6WIND Virtual Accelerator Plugin ver. 1.0-1.0.0-1 for Fuel',
[u'6WIND SA'], 1)
]
@ -250,8 +250,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'fuel-plugin-6wind-va', u'The 6WIND virtual accelerator Plugin for Fuel Documentation',
u'6WIND SA', 'fuel-plugin-6wind-va', 'The 6WIND virtual accelerator Plugin for Fuel Documentation',
('index', 'fuel-plugin-6wind-va', u'The 6WIND Virtual Accelerator Plugin for Fuel Documentation',
u'6WIND SA', 'fuel-plugin-6wind-va', 'The 6WIND Virtual Accelerator Plugin for Fuel Documentation',
'Miscellaneous'),
]
@ -276,7 +276,7 @@ pdf_inline_footnotes = True
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'The 6WIND virtual accelerator Plugin for Fuel'
epub_title = u'The 6WIND Virtual Accelerator Plugin for Fuel'
epub_author = u'6WIND SA'
epub_publisher = u'6WIND SA'
epub_copyright = u'2016, 6WIND SA'

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 92 KiB

View File

@ -1,6 +1,6 @@
.. _fuel-plugin-6wind-virtual-accelerator:
Guide to the 6WIND virtual accelerator plugin for Fuel 7.0
Guide to the 6WIND Virtual Accelerator plugin for Fuel 7.0
==========================================================
.. toctree::

View File

@ -6,16 +6,16 @@ Prerequisites
This guide assumes that you have `installed Fuel <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
and all the nodes of your future environment are discovered and functional.
Note, the 6WIND virtual accelerator Fuel plugin will download virtual
Note, the 6WIND Virtual Accelerator Fuel plugin will download virtual
accelerator packages from a remote repository. Make sure that nodes can correctly
reach Internet.
To correctly deploy the 6WIND virtual accelerator Fuel plugin you will need
To correctly deploy the 6WIND Virtual Accelerator Fuel plugin you will need
a credentials package (in base64 format).
If you have already purchased 6WIND software you should have this package,
otherwise contact 6WIND support team.
On the other hand, if you just want to evaluate the 6WIND virtual accelerator
On the other hand, if you just want to evaluate the 6WIND Virtual Accelerator
you still need to `contact 6WIND <http://www.6wind.com/company-profile/contact-us/>`_.
Requirements
@ -27,7 +27,7 @@ Verify this typing the following command:
fuel --version
In order to correctly install the 6WIND virtual accelerator plugin on Fuel
In order to correctly install the 6WIND Virtual Accelerator plugin on Fuel
compute(s) the following requirements are mandatory:
#. Use KVM as hypervisor virtualization driver
@ -41,7 +41,7 @@ instead of the default Fuel setup that puts this interface on the same used
for pxe and management.
Support for VxLAN and for bridged VLAN will be available in future releases.
The 6WIND virtual accelerator needs qemu and libvirt supporting vhostuser and
The 6WIND Virtual Accelerator needs qemu and libvirt supporting vhostuser and
multiqueue features to correclty run its fast packet processing stack.
In particular on the compute nodes the following packages are needed:
@ -54,10 +54,10 @@ For this reason the default behavior for the plugin is to retrieve the
stages of deployment.
Installing 6WIND virtual accelerator Plugin
Installing 6WIND Virtual Accelerator Plugin
-------------------------------------------
#. Download 6WIND virtual accelerator plugin from the `Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
#. Download 6WIND Virtual Accelerator plugin from the `Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
#. Copy the downloaded rpm to the Fuel Master node:
::
@ -78,7 +78,7 @@ Installing 6WIND virtual accelerator Plugin
..
Configuring 6WIND virtual accelerator Plugin
Configuring 6WIND Virtual Accelerator Plugin
--------------------------------------------
#. First you have to `create environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_ in Fuel Web UI.
@ -92,7 +92,7 @@ Configuring 6WIND virtual accelerator Plugin
:width: 80%
#. Please select Neutron networking.
The 6WIND virtual accelerator supports only VLAN segmentation.
The 6WIND Virtual Accelerator supports only VLAN segmentation.
.. image:: images/network.png
:width: 80%

View File

@ -1,14 +1,14 @@
Introduction
============
This document contains instructions for installing and configuring 6WIND virtual
accelerator plugin for Fuel.
This document contains instructions for installing and configuring 6WIND Virtual
Accelerator plugin for Fuel.
Key terms, acronyms and abbreviations
-------------------------------------
+---------------------------+---------------------------+
| 6WIND virtual accelerator | |
| 6WIND Virtual Accelerator | |
| | |
+---------------------------+---------------------------+
| VA | 6WIND Virtual Accelerator |
@ -129,5 +129,5 @@ Licensing information
---------------------
+---------------------------+------------+
| 6WIND virtual accelerator | Commercial |
| 6WIND Virtual Accelerator | Commercial |
+---------------------------+------------+

View File

@ -4,21 +4,21 @@ User Guide
This section provides a deeper explanation of plugin parameters and a description
of required steps to verify that everything is working fine after deployment.
Note that this User Guide provides information on 6WIND virtual accelerator
plugin for Fuel (and not on the 6WIND virtual accelerator software itself).
Note that this User Guide provides information on 6WIND Virtual Accelerator
plugin for Fuel (and not on the 6WIND Virtual Accelerator software itself).
`Contact 6WIND <http://www.6wind.com/company-profile/contact-us/>`_
to obtain more details on how to retrieve the virtual accelerator software and
to obtain more details on how to retrieve the Virtual Accelerator software and
its documentation.
When configuring the 6WIND virtual accelerator Fuel plugin, you have to provide
credentials for virtual accelerator software download.
The plugin will then install and run the virtual accelerator using its default
When configuring the 6WIND Virtual Accelerator Fuel plugin, you have to provide
credentials for Virtual Accelerator software download.
The plugin will then install and run the Virtual Accelerator using its default
configuration values.
Configuring 6WIND virtual accelerator parameters
Configuring 6WIND Virtual Accelerator parameters
------------------------------------------------
The 6WIND virtual accelerator plugin makes possible to modify these default
The 6WIND Virtual Accelerator plugin makes possible to modify these default
configuration parameters before deployment.
In order to do this you need to activate the **Advanced parameters** checkbox
in the 6WIND Virtual Accelerator Fuel plugin section in the Web UI Settings tab.
@ -28,18 +28,18 @@ in the 6WIND Virtual Accelerator Fuel plugin section in the Web UI Settings tab.
At this point some additional fields will show up and you will be able to edit
with your desired values.
Please contact 6WIND support team or refer to 6WIND virtual accelerator documentation
Please contact 6WIND support team or refer to 6WIND Virtual Accelerator documentation
for more information on the meaning of these fields.
If you already have a virtual accelerator configuration file,
If you already have a Virtual Accelerator configuration file,
you can upload it to the nodes having the 6WIND Virtual Accelerator role enabled.
Note, this file will replace the default virtual accelerator configuration file
Note, this file will replace the default Virtual Accelerator configuration file
and overload all the defined configuration paramaters.
It is **strongly recommended** to provide a license file if you have one.
Without license the plugin will still correclty install the
6WIND virtual accelerator but it will run in evaluation mode (48 hours).
6WIND Virtual Accelerator but it will run in evaluation mode (48 hours).
At the end of the evaluation period you will experience significant performance
degradation and loss of connectivity for your instances since there will be
nomore any hugepages backing.
@ -48,12 +48,12 @@ Use updated libvirt and qemu packages
-------------------------------------
As briefly described in the installation section, in order to correctly spawn
virtual machines using the accelerated network stack 6WIND virtual accelerator
virtual machines using the accelerated network stack 6WIND Virtual Accelerator
provides, the compute nodes need to run recent versions of libvirt and qemu
packages.
By default the 6WIND virtual accelerator Fuel plugin retrieves and installs
By default the 6WIND Virtual Accelerator Fuel plugin retrieves and installs
its updated libvirt and qemu packages from a remote repository maintained by 6WIND.
It is possible to force the plugin to keep the default libvirt and qemu packages
provided by the Linux distribution.
@ -61,15 +61,15 @@ provided by the Linux distribution.
To do this simply unselect the **Use updated external packages** checkbox.
Note, default libvirt and qemu packages on MOS 7.0 do not have all the features
required for proper 6WIND virtual accelerator integration. Thus we strongly
required for proper 6WIND Virtual Accelerator integration. Thus we strongly
advise to keep the **Use updated external packages** enabled.
Sanity checks after deployment
------------------------------
The installation section of this document described how to correctly start a
Fuel deployment using the 6WIND virtual accelerator plugin.
At the end of this process the 6WIND virtual accelerator and its dependent
Fuel deployment using the 6WIND Virtual Accelerator plugin.
At the end of this process the 6WIND Virtual Accelerator and its dependent
components should be all up and running.
As first step make sure that the system uses the proper libvirt and qemu
@ -87,10 +87,10 @@ versions.
aptitude show qemu-system-x86 | grep Version
The next step is checking that the 6WIND virtual accelerator software and
The next step is checking that the 6WIND Virtual Accelerator software and
its Openstack extensions have been correctly installed.
#. Check 6WIND virtual accelerator package status (should be **State: installed**)
#. Check 6WIND Virtual Accelerator package status (should be **State: installed**)
::
@ -123,7 +123,7 @@ To do that please refer to `6WIND Openstack extensions official documentation <h
Known issues
============
The current implementation of the 6WIND virtual accelerator plugin uses a credentials
The current implementation of the 6WIND Virtual Accelerator plugin uses a credentials
package in base64 format for 6WIND software download.
This behavior should be replaced using a regular credentials package instead of
its base64 encoding.

View File

@ -89,7 +89,7 @@ attributes:
type: "hidden"
value: true
label: "Important notes:"
description: "Before changing default settings for virtual Accelerator, please have a look at
description: "Before changing default settings for Virtual Accelerator, please have a look at
6WIND's Virtual Accelerator online documentation for applicable values:\n
Product description: http://www.6wind.com/products/6wind-virtual-accelerator/\n
User Guide: http://www.6wind.com/products/6wind-virtual-accelerator/\n"

View File

@ -4,11 +4,11 @@
# Plugin name
name: 6wind-virtual-accelerator
# Human-readable name for your plugin
title: 6WIND Virtual accelerator Fuel plugin
title: 6WIND Virtual Accelerator Fuel plugin
# Plugin version
version: '1.0.3'
# Description
description: Enable use of 6WIND virtual accelerator plugin for Neutron
description: Enable use of 6WIND Virtual Accelerator plugin for Neutron
# Required Fuel version
fuel_version: ['7.0', '8.0']
# Specify license of your plugin

View File

@ -5,11 +5,11 @@
http://creativecommons.org/licenses/by/3.0/legalcode
======================================================
Fuel Plugin for 6WIND virtual accelerator installation
Fuel Plugin for 6WIND Virtual Accelerator installation
======================================================
The Fuel plugin for 6WIND virtual accelerator allows to install and integrate
the virtual accelerator on desired nodes (compute) running Mirantis Openstack 7.0.
The Fuel plugin for 6WIND Virtual Accelerator allows to install and integrate
the Virtual Accelerator on desired nodes (compute) running Mirantis Openstack 7.0.
This plugin uses the Fuel pluggable architecture and it must be compatible with
(at least) the version 7.0 of Mirantis OpenStack.
@ -23,7 +23,7 @@ Proposed change
===============
Implement a Fuel plugin which will perform all the necessary steps to install
and configure Mirantis OpenStack nodes to use the 6WIND virtual accelerator.
and configure Mirantis OpenStack nodes to use the 6WIND Virtual Accelerator.
Alternatives
------------
@ -95,12 +95,12 @@ Work Items
metadata)
* Implement puppet modules with the following functions:
- Retrieve 6WIND virtual accelerator software from repository
- Retrieve 6WIND Virtual Accelerator software from repository
- Eventually updates libvirt and qemu Mirantis Openstack packages on compute nodes
- 6WIND virtual accelerator deployment on selected OpenStack nodes
- Configure Mirantis Openstack to support 6WIND virtual accelerator
- 6WIND Virtual Accelerator deployment on selected OpenStack nodes
- Configure Mirantis Openstack to support 6WIND Virtual Accelerator
* Test 6WIND virtual accelerator plugin
* Test 6WIND Virtual Accelerator plugin
* Create Documentation
@ -131,4 +131,4 @@ References
==========
* Fuel 7.0 Plug-in Guide https://docs.mirantis.com/openstack/fuel/fuel-7.0/plugin-dev.html
* 6WIND virtual accelerator product info http://www.6wind.com/products/6wind-virtual-accelerator/
* 6WIND Virtual Accelerator product info http://www.6wind.com/products/6wind-virtual-accelerator/

View File

@ -3,6 +3,6 @@
Introduction
============
This folder contains scripts to be used when testing the 6WIND virtual accelerator Fuel plugin.
This folder contains scripts to be used when testing the 6WIND Virtual Accelerator Fuel plugin.
Please refer to TestPlan document for more details on how to use these scripts.

View File

@ -18,7 +18,7 @@ NB_EXCEPTIONS=$(expr $NB_EXCEPTIONS_AFTER - $NB_EXCEPTIONS_BEFORE)
# Here we verify 2 things.
# The first check wants to assure that the packets received by the spawned vm
# were processed by 6WIND virtual accelerator and not sent to slow path (exception).
# were processed by 6WIND Virtual Accelerator and not sent to slow path (exception).
# The second check wants to assure that this traffic towards the vm correctly
# passed via the accelerated ovs.
# This is a simple heuristics but it should be enough.

View File

@ -29,10 +29,10 @@ if [[ $? -eq 1 ]]; then
exit 1
fi
echo "Verify that network interface is managed by virtual accelerator"
echo "Verify that network interface is managed by Virtual Accelerator"
ssh root@$COMPUTE 'bash /root/compute_verify_driver.sh'
if [[ $? -eq 1 ]]; then
echo "TEST FAILED: Virtual machine network interface is not managed by 6WIND virtual accelerator. Exiting..."
echo "TEST FAILED: Virtual machine network interface is not managed by 6WIND Virtual Accelerator. Exiting..."
cleanup
exit 1
fi
@ -45,7 +45,7 @@ if [[ $? -eq 1 ]]; then
exit 1
fi
echo "Check virtual accelerator statistics before traffic"
echo "Check Virtual Accelerator statistics before traffic"
ssh root@$COMPUTE 'bash /root/compute_check_stats_before.sh'
if [[ $? -eq 1 ]]; then
echo "TEST FAILED: Unable to retrieve virtual interface pre-stats. Exiting..."
@ -61,7 +61,7 @@ if [[ $? -eq 1 ]]; then
exit 1
fi
echo "Check virtual accelerator statistics after traffic"
echo "Check Virtual Accelerator statistics after traffic"
ssh root@$COMPUTE 'bash /root/compute_check_stats_after.sh'
if [[ $? -eq 1 ]]; then
echo "TEST FAILED: A part or all the traffic sent was not accelerated"