6wind-plugin-virtual-accelerator: update doc for Fuel 8 support

This commit updates documentation to describe how to install and configure
the 6WIND Virtual Accelerator plugin for Fuel 8.

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

doc/source/conf.py

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

doc/source/index.rst

@@ -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 8.0
 ==========================================================
 
 .. toctree::

doc/source/installation.rst

@@ -4,7 +4,7 @@ Installation Guide
 Prerequisites
 -------------
 
-This guide assumes that you have `installed Fuel <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
+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>`_
 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 7.0 (version 7.0.0)
+This plugin is intended to be installed on nodes running Fuel 8.0 (version 8.0.0)
 Verify this typing the following command:
     ::
 
@@ -56,19 +56,19 @@ Installing 6WIND Virtual Accelerator Plugin
 #.  Copy the downloaded rpm to the Fuel Master node:
     ::
 
-        scp 6wind-virtual-accelerator-1.0-1.0.4-1.noarch.rpm  <Fuel Master node ip>:/tmp/
+        scp 6wind-virtual-accelerator-2.0-2.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-1.0-1.0.4-1.noarch.rpm
+        fuel plugins --install /tmp/6wind-virtual-accelerator-2.0-2.0.0-1.noarch.rpm
 
 #.  Now verify that the plugin is correctly installed
     ::
 
         fuel plugins
-        3  | 6wind-virtual-accelerator | 1.0.4   | 3.0.0
+        3  | 6wind-virtual-accelerator | 2.0.0   | 3.0.0
 
     ..
 
@@ -76,12 +76,12 @@ Installing 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.
+#.  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.
 
     .. image:: images/name_release.png
        :width: 70%
 
-#.  Please select KVM hypervisor type for your environment.
+#.  Please select QEMU-KVM hypervisor type for your environment.
 
     .. image:: images/hypervisor.png
        :width: 80%
@@ -92,7 +92,12 @@ Configuring 6WIND Virtual Accelerator Plugin
     .. image:: images/network.png
        :width: 80%
 
-#.  Activate the plugin in the Fuel Web UI Settings tab
+#.  Select KVM as compute hypervisor type in the Fuel Settings tab
+
+    .. image:: images/kvm.png
+       :width: 90%
+
+#.  Activate the plugin in the Fuel Settings tab
 
     .. image:: images/activation.png
        :width: 90%
@@ -123,8 +128,7 @@ Configuring 6WIND Virtual Accelerator Plugin
     .. image:: images/connectivity.png
        :width: 100%
 
-#.  Press **Deploy changes** to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#
-    deploy-changes>`_.
+#.  Press **Deploy changes** to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-8.0/fuel-user-guide.html#deploy-an-openstack-environment>`_.
 
 
 

doc/source/introduction.rst

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

doc/source/new_features.rst

@@ -1,17 +1,8 @@
-New features in plugin version 1.0.4
+New features in plugin version 2.0.0
 ====================================
 
-*   Added support for 6WIND Virtual Accelerator 1.3.2
+*   Support for Fuel 8.0
 
-*   Support for VxLAN tunneling
-
-*   Removed apparmor libvirt profile configuration for hugepages
-
-*   VLAN interface for Private network no more needs to use a dedicated NIC
-
-*   Removed a plugin advanced parameter (CORE_PER_PORT) now deprecated
-
-*   Changed default value for FP_MEMORY advanced parameter.
-    It is now set to 'auto'.
-
-*   Documentation update to describe new features
+*   New option to enable Host CPU emulation in guests.
+    It is now possible to use the plugin to configure Openstack to
+    boot instances that need emulation of hypervisor CPU.

doc/source/user-guide.rst

@@ -76,7 +76,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 7.0 do not have all the features
+Note, default libvirt and qemu packages on MOS 8.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.
 
@@ -146,7 +146,7 @@ its Openstack extensions have been correctly installed.
 
     ::
 
-        aptitude show 6wind-openstack-extensions| grep State
+        aptitude show 6wind-openstack-extensions | grep State
 
 
 If this check is successful, verify that that ALL the following services are
@@ -173,6 +173,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 7.0 does not make possible to correctly retrieve
-this package from the upload utility.
+Unfortunately a bug in Fuel (affecting both 7.0 and 8.0) does not make
+possible to correctly retrieve this package from the upload utility.
 `<https://bugs.launchpad.net/fuel/+bug/1545795>`_

spec/spec-1.0.rst

@@ -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 7.0.
+the Virtual Accelerator on desired nodes (compute) running Mirantis Openstack 8.0.
 
 This plugin uses the Fuel pluggable architecture and it must be compatible with
-(at least) the version 7.0 of Mirantis OpenStack.
+the version 8.0 of Mirantis OpenStack.
 
 Problem description
 ===================
@@ -107,7 +107,7 @@ Work Items
 Dependencies
 ============
 
-* Fuel 7.0
+* Fuel 8.0
 * Hypervisor with KVM capability
 * Qemu with vhost-user and hugepage support
 
@@ -130,5 +130,5 @@ Documentation Impact
 References
 ==========
 
-* Fuel 7.0 Plug-in Guide https://docs.mirantis.com/openstack/fuel/fuel-7.0/plugin-dev.html
+* Fuel Plugins Guide https://wiki.openstack.org/wiki/Fuel/Plugins
 * 6WIND Virtual Accelerator product info http://www.6wind.com/products/6wind-virtual-accelerator/