6wind-virtual-accelerator-plugin: documentation improvements

This patch enriches documentation and adds two new sections to list both
plugin limitations and new features (compared to previous versions).

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

Change-Id: I13f0cf52f30a7b60492c466e9adcf5fa2bc6fa98

doc/source/index.rst

@@ -8,6 +8,8 @@ Guide to the 6WIND Virtual Accelerator plugin for Fuel 7.0
     :numbered:
 
     introduction
+    new_features
+    limitations
     installation
     user-guide
     appendix

doc/source/installation.rst

@@ -31,7 +31,7 @@ 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
-#.   Deploy on compute node(s) with **at least 4GB of RAM and 2 cpus**
+#.   Deploy on compute node(s) with **at least 4GB of RAM and 2 CPU cores**
 #.   Internet connectivity on Master node (since the plugin will download software from 6WIND remote repositories)
 
 This version of plugin supports VLAN and VxLAN as networking tunneling option.
@@ -112,7 +112,7 @@ Configuring 6WIND Virtual Accelerator Plugin
     *   At least 1 Controller
 
     *   At least one node with both Compute and 6WIND Virtual Accelerator roles.
-        Make sure that the chosen node has **at least 2 cpus and 6 GB of RAM**
+        Make sure that the chosen node has **at least 2 CPU cores and 6 GB of RAM**
 
     .. image:: images/node-roles.png
        :width: 100%

doc/source/limitations.rst

@@ -0,0 +1,7 @@
+Limitations
+===========
+
+*   Plugin only supports KVM as hypervisor
+
+*   Nodes using 6WIND Virtual Accelerator role needs at least 2 CPU cores and
+    6 GB of RAM

doc/source/new_features.rst

@@ -0,0 +1,17 @@
+New features in plugin version 1.0.4
+====================================
+
+*   Added support for 6WIND Virtual Accelerator 1.3.2
+
+*   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

doc/source/user-guide.rst

@@ -28,12 +28,28 @@ 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
-for more information on the meaning of these fields.
+
+In particular you can modify the following:
+
+    *  `FP_MEMORY`
+
+       This parameter defines the amount of memory (in MB) you want to reserve
+       for Virtual Accelerator. Sample values are 1024, 512 or 'auto'.
+
+    *  `VM_MEMORY`
+
+       This parameter defines the total amount of memory (in MB) you want to
+       reserve for accelerated virtual machines.
+       Sample values are 2048, 4096, 'auto'.
+
+For all these parameters you can always set value to 'auto' (default value).
+In this case the plugin will compute the most suitable value according to
+your system resources.
 
 
-If you already have a Virtual Accelerator configuration file,
-you can upload it to the nodes having the 6WIND Virtual Accelerator role enabled.
+In some cases you may already have a Virtual Accelerator configuration file.
+You can upload it to the nodes having the 6WIND Virtual Accelerator role enabled
+using the dedicated `External configuration file for VA` field.
 Note, this file will replace the default Virtual Accelerator configuration file
 and overload all the defined configuration paramaters.
 
@@ -64,6 +80,25 @@ 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
 advise to keep the **Use updated external packages** enabled.
 
+Configure hugepages support for virtual machines
+------------------------------------------------
+
+In order to benefit from 6WIND Virtual Accelerator high performance networking,
+hugepages support needs to be enabled in Nova flavors.
+The plugin does not perform this configuration since it should be still
+possible to spawn virtual machines that don't need network acceleration.
+
+For this reason end-users have to explicitly configure the Nova flavors they
+want to use when launching virtual machines for fast networking.
+In order to that it is enough to enable hugepages support in the desired Nova
+flavor.
+
+On the controller node type the following command to configure a given flavor:
+
+    ::
+
+        nova flavor-key flavor set hw:mem_page_size=large
+
 Sanity checks after deployment
 ------------------------------
 

environment_config.yaml

@@ -24,7 +24,7 @@ attributes:
   fp_mem:
     value: 'auto'
     label: 'FP_MEMORY'
-    description: 'defines how much memory is used by VA'
+    description: 'defines the amount of memory used by Virtual Accelerator (in MB)'
     weight: 40
     type: "text"
     restrictions:
@@ -34,7 +34,7 @@ attributes:
   vm_mem:
     value: 'auto'
     label: 'VM_MEMORY'
-    description: 'defines the memory available for vms'
+    description: 'defines the amount of memory available for accelerated vms (in MB)'
     weight: 40
     type: "text"
     restrictions: