[docs] Document SRIOV configuration options

Update Yardstick documentation with SRIOV options.

JIRA: YARDSTICK-1611

Change-Id: I823a0a40f23dc53fb5316d4cef456eaf97f94b15
Signed-off-by: Stepan Andrushko <stepanx.andrushko@intel.com>

diff --git a/docs/testing/user/userguide/13-nsb-installation.rst b/docs/testing/user/userguide/13-nsb-installation.rst
index 3a06be6..1b2d1e3 100644 (file)
--- a/docs/testing/user/userguide/13-nsb-installation.rst
+++ b/docs/testing/user/userguide/13-nsb-installation.rst
@@ -483,6 +483,15 @@ topology and update all the required fields.::
 Standalone Virtualization
 -------------------------
 
+VM can be deployed manually or by Yardstick. If parameter *vm_deploy* is set
+to `True` VM will be deployed by Yardstick. Otherwise VM should be deployed
+manually. Test case example, context section::
+
+    contexts:
+     ...
+     vm_deploy: True
+
+
 SR-IOV
 ^^^^^^
 
@@ -712,6 +721,93 @@ Update contexts section
          gateway_ip: '152.16.100.20'
 
 
+SRIOV configuration options
++++++++++++++++++++++++++++
+
+The only configuration option available for SRIOV is *vpci*. It is used as base
+address for VFs that are created during SRIOV test case execution.
+
+  .. code-block:: yaml+jinja
+
+    networks:
+      uplink_0:
+        phy_port: "0000:05:00.0"
+        vpci: "0000:00:07.0"
+        cidr: '152.16.100.10/24'
+        gateway_ip: '152.16.100.20'
+      downlink_0:
+        phy_port: "0000:05:00.1"
+        vpci: "0000:00:08.0"
+        cidr: '152.16.40.10/24'
+        gateway_ip: '152.16.100.20'
+
+.. _`VM image properties label`:
+
+VM image properties
+'''''''''''''''''''
+
+VM image properties example under *flavor* section:
+
+  .. code-block:: console
+
+      flavor:
+        images: <path>
+        ram: 8192
+        extra_specs:
+           machine_type: 'pc-i440fx-xenial'
+           hw:cpu_sockets: 1
+           hw:cpu_cores: 6
+           hw:cpu_threads: 2
+           hw_socket: 0
+           cputune: |
+             <cputune>
+               <vcpupin vcpu="0" cpuset="7"/>
+               <vcpupin vcpu="1" cpuset="8"/>
+               ...
+               <vcpupin vcpu="11" cpuset="18"/>
+               <emulatorpin cpuset="11"/>
+             </cputune>
+        user: ""
+        password: ""
+
+VM image properties description:
+
+  +-------------------------+-------------------------------------------------+
+  | Parameters              | Detail                                          |
+  +=========================+=================================================+
+  | images                  || Path to the VM image generated by              |
+  |                         |  ``nsb_setup.sh``                               |
+  |                         || Default path is ``/var/lib/libvirt/images/``   |
+  |                         || Default file name ``yardstick-nsb-image.img``  |
+  |                         |  or ``yardstick-image.img``                     |
+  +-------------------------+-------------------------------------------------+
+  | ram                     || Amount of RAM to be used for VM                |
+  |                         || Default is 4096 MB                             |
+  +-------------------------+-------------------------------------------------+
+  | hw:cpu_sockets          || Number of sockets provided to the guest VM     |
+  |                         || Default is 1                                   |
+  +-------------------------+-------------------------------------------------+
+  | hw:cpu_cores            || Number of cores provided to the guest VM       |
+  |                         || Default is 2                                   |
+  +-------------------------+-------------------------------------------------+
+  | hw:cpu_threads          || Number of threads provided to the guest VM     |
+  |                         || Default is 2                                   |
+  +-------------------------+-------------------------------------------------+
+  | hw_socket               || Generate vcpu cpuset from given HW socket      |
+  |                         || Default is 0                                   |
+  +-------------------------+-------------------------------------------------+
+  | cputune                 || Maps virtual cpu with logical cpu              |
+  +-------------------------+-------------------------------------------------+
+  | machine_type            || Machine type to be emulated in VM              |
+  |                         || Default is 'pc-i440fx-xenial'                  |
+  +-------------------------+-------------------------------------------------+
+  | user                    || User name to access the VM                     |
+  |                         || Default value is 'root'                        |
+  +-------------------------+-------------------------------------------------+
+  | password                || Password to access the VM                      |
+  +-------------------------+-------------------------------------------------+
+
+
 OVS-DPDK
 ^^^^^^^^
 
@@ -1043,59 +1139,7 @@ OVS-DPDK properties description:
 VM image properties
 '''''''''''''''''''
 
-VM image properties example under *flavor* section:
-
-  .. code-block:: console
-
-      flavor:
-        images: <path>
-        ram: 8192
-        extra_specs:
-           machine_type: 'pc-i440fx-xenial'
-           hw:cpu_sockets: 1
-           hw:cpu_cores: 6
-           hw:cpu_threads: 2
-           hw_socket: 0
-           cputune: |
-             <cputune>
-               <vcpupin vcpu="0" cpuset="7"/>
-               <vcpupin vcpu="1" cpuset="8"/>
-               ...
-               <vcpupin vcpu="11" cpuset="18"/>
-               <emulatorpin cpuset="11"/>
-             </cputune>
-
-VM image properties description:
-
-  +-------------------------+-------------------------------------------------+
-  | Parameters              | Detail                                          |
-  +=========================+=================================================+
-  | images                  || Path to the VM image generated by              |
-  |                         |  ``nsb_setup.sh``                               |
-  |                         || Default path is ``/var/lib/libvirt/images/``   |
-  |                         || Default file name ``yardstick-nsb-image.img``  |
-  |                         |  or ``yardstick-image.img``                     |
-  +-------------------------+-------------------------------------------------+
-  | ram                     || Amount of RAM to be used for VM                |
-  |                         || Default is 4096 MB                             |
-  +-------------------------+-------------------------------------------------+
-  | hw:cpu_sockets          || Number of sockets provided to the guest VM     |
-  |                         || Default is 1                                   |
-  +-------------------------+-------------------------------------------------+
-  | hw:cpu_cores            || Number of cores provided to the guest VM       |
-  |                         || Default is 2                                   |
-  +-------------------------+-------------------------------------------------+
-  | hw:cpu_threads          || Number of threads provided to the guest VM     |
-  |                         || Default is 2                                   |
-  +-------------------------+-------------------------------------------------+
-  | hw_socket               || Generate vcpu cpuset from given HW socket      |
-  |                         || Default is 0                                   |
-  +-------------------------+-------------------------------------------------+
-  | cputune                 || Maps virtual cpu with logical cpu              |
-  +-------------------------+-------------------------------------------------+
-  | machine_type            || Machine type to be emulated in VM              |
-  |                         || Default is 'pc-i440fx-xenial'                  |
-  +-------------------------+-------------------------------------------------+
+VM image properties are same as for SRIOV :ref:`VM image properties label`.
 
 
 OpenStack with SR-IOV support