6wind-virtual-accelerator-plugin: update doc for Fuel 9 plugin

This patch updates documentation and screenshot for Fule 9 support.

Signed-off-by: Francesco Santoro <francesco.santoro@6wind.com>

Change-Id: I1c6f783fb362f6f7cbe6adbef65c185894cc48cc
This commit is contained in:
Francesco Santoro 2016-08-31 17:00:09 +02:00
parent 9b7c313919
commit a4eda756c8
10 changed files with 38 additions and 27 deletions

View File

@ -57,9 +57,9 @@ copyright = u'2016, 6WIND SA.'
# built documents.
#
# The short 1.0-1.0.0-1 version.
version = '2.0'
version = '3.0'
# The full version, including alpha/beta/rc tags.
release = '2.0-2.0.1-1'
release = '3.0-3.0.0-1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View File

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

View File

@ -4,7 +4,7 @@ Installation Guide
Prerequisites
-------------
This guide assumes that you have `installed Fuel <https://docs.mirantis.com/openstack/fuel/fuel-8.0/fuel-install-guide.html#introduction-to-fuel-8-0-installation-guide>`_
This guide assumes that you have `installed Fuel <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
and all the nodes of your future environment are discovered and functional.
Note, the 6WIND Virtual Accelerator Fuel plugin will download virtual
accelerator packages from a remote repository. Make sure that nodes can correctly
@ -21,7 +21,7 @@ you still need to `contact 6WIND <http://www.6wind.com/company-profile/contact-u
Requirements
------------
This plugin is intended to be installed on nodes running Fuel 8.0 (version 8.0.0)
This plugin is intended to be installed on nodes running Fuel 9.0 (version 9.0.0)
Verify this typing the following command:
::
@ -48,6 +48,17 @@ For this reason the default behavior for the plugin is to retrieve the
6WIND libvirt and qemu packages and replace the Mirantis ones in the early
stages of deployment.
Fuel 9 provides an experimental support for builtin NFV features that enables
some DPDK packages and OVS-DPDK. Because of some limitations of this
experimental support, make sure to keep the default Fuel setup that does not
enable NFV features. The 6WIND Virtual Accelerator Plugin will enable such
features.
Once these limitations will be fixed, the 6WIND Virtual Accelerator Plugin
will still be available and able to leverage the Fuel 9 NFV capabilities.
On the master node open the ``/etc/fuel/astute.yaml`` file and verify that
the ``features_group`` section does not contain ``experimental``.
Installing 6WIND Virtual Accelerator Plugin
-------------------------------------------
@ -56,19 +67,19 @@ Installing 6WIND Virtual Accelerator Plugin
#. Copy the downloaded rpm to the Fuel Master node:
::
scp 6wind-virtual-accelerator-2.0-2.0.1-1.noarch.rpm <Fuel Master node ip>:/tmp/
scp 6wind-virtual-accelerator-3.0-3.0.0-1.noarch.rpm <Fuel Master node ip>:/tmp/
#. Log into the Fuel Master node and install the plugin
::
ssh <the Fuel Master node ip>
fuel plugins --install /tmp/6wind-virtual-accelerator-2.0-2.0.1-1.noarch.rpm
fuel plugins --install /tmp/6wind-virtual-accelerator-3.0-3.0.0-1.noarch.rpm
#. Now verify that the plugin is correctly installed
::
fuel plugins
3 | 6wind-virtual-accelerator | 2.0.1 | 3.0.0
3 | 6wind-virtual-accelerator | 3.0.0 | 4.0.0
..
@ -76,7 +87,7 @@ Installing 6WIND Virtual Accelerator Plugin
Configuring 6WIND Virtual Accelerator Plugin
--------------------------------------------
#. First you have to `create environment <https://docs.mirantis.com/openstack/fuel/fuel-8.0/fuel-user-guide.html#create-a-new-openstack-environment>`_ in Fuel Web UI.
#. First you have to `create environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment.html>`_ in Fuel Web UI.
.. image:: images/name_release.png
:width: 70%
@ -111,13 +122,12 @@ Configuring 6WIND Virtual Accelerator Plugin
* Specify the 6WIND Virtual Accelerator version you want to install.
You can keep the 'stable' default value if you want the latest
version, otherwise specify an explicit value (eg. 1.3).
Remember to use **at least version 1.3** for Fuel 8.
version, otherwise specify an explicit value (eg. 1.4).
Remember to use **at least version 1.4** for Fuel 9.
* Refer to next chapter for the description of Advanced Paramaters fields
and how to enable support for Mellanox NICs.
#. Add nodes and assign them the following roles:
* At least 1 Controller
@ -128,13 +138,19 @@ Configuring 6WIND Virtual Accelerator Plugin
.. image:: images/node-roles.png
:width: 100%
* When KVM is enabled it is possible to configure Hugepages and
CPU pinning on machines in the Node Attributes section (that will
show up when clicking on the small wheel image).
Plase leave these fields empty since the 6WIND Virtual Accelerator
will automatically compute the best possible configuration for you.
#. Verify nodes network connectivity (in the Fuel Web UI Network tab)
.. image:: images/connectivity.png
:width: 100%
#. Press **Deploy changes** to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-8.0/fuel-user-guide.html#deploy-an-openstack-environment>`_.
#. Press **Deploy changes** to `deploy the environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.

View File

@ -109,7 +109,7 @@ brctl, ovs-ofctl, ovs-vsctl, etc.
|va| is also validated with the Mirantis Openstack cloud operating system:
- Supports Mirantis Openstack 8.0
- Supports Mirantis Openstack 9.0
Supported platforms
-------------------

View File

@ -1,10 +1,5 @@
New features in plugin version 2.0.1
New features in plugin version 3.0.0
====================================
* Added support for 6WIND Virtual Accelerator 1.4
* Support for Fuel 9.0
* New option to provide the 6WIND Virtual Accelerator product version
to be installed.
* New option to install 6WIND Virtual Accelerator addon for Mellanox NICs
support.

View File

@ -86,7 +86,7 @@ provided by the Linux distribution.
To do this simply unselect the **Use updated external packages** checkbox.
Note, default libvirt and qemu packages on MOS 8.0 do not have all the features
Note, default libvirt and qemu packages on MOS 9.0 do not have all the features
required for proper 6WIND Virtual Accelerator integration. Thus we strongly
advise to keep the **Use updated external packages** enabled.
@ -166,7 +166,7 @@ correctly running (each of them should be **start/running**):
service virtual-accelerator status
service openvswitch-switch status
service neutron-plugin-openvswitch-agent status
service neutron-openvswitch-agent status
service libvirtd status
service nova-compute status
@ -183,6 +183,6 @@ The current implementation of the 6WIND Virtual Accelerator plugin uses a creden
package in base64 format for 6WIND software download.
This behavior should be replaced using a regular credentials package instead of
its base64 encoding.
Unfortunately a bug in Fuel (affecting both 7.0 and 8.0) does not make
Unfortunately a bug in Fuel (affecting 7.0, 8.0 and 9.0) does not make
possible to correctly retrieve this package from the upload utility.
`<https://bugs.launchpad.net/fuel/+bug/1545795>`_

View File

@ -9,10 +9,10 @@ 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 8.0.
the Virtual Accelerator on desired nodes (compute) running Mirantis Openstack 9.0.
This plugin uses the Fuel pluggable architecture and it must be compatible with
the version 8.0 of Mirantis OpenStack.
the version 9.0 of Mirantis OpenStack.
Problem description
===================
@ -107,7 +107,7 @@ Work Items
Dependencies
============
* Fuel 8.0
* Fuel 9.0
* Hypervisor with KVM capability
* Qemu with vhost-user and hugepage support