From: Christian Trautman <ctrautma@redhat.com>
Date: Mon, 2 May 2016 13:30:15 +0000 (-0400)
Subject: hugepage_doc: Add hugepage configuration info to installation doc
X-Git-Tag: colorado.1.0~81^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F11%2F13511%2F2;p=vswitchperf.git

hugepage_doc: Add hugepage configuration info to installation doc

Adds some documentation to the installation guide on proper
hugepage configuration to run vsperf with dpdk and/or guests.

JIRA: VSPERF-256

Change-Id: I3b85fe7d69b00841844aa82ba8faf936d7e37825
Signed-off-by: Christian Trautman <ctrautma@redhat.com>
---

diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst
index 354979b0..d6161b9a 100755
--- a/docs/configguide/installation.rst
+++ b/docs/configguide/installation.rst
@@ -119,3 +119,42 @@ running any of the above. For example:
 .. _virtualenv: https://virtualenv.readthedocs.org/en/latest/
 .. _vloop-vnf-ubuntu-14.04_20160303: http://artifacts.opnfv.org/vswitchperf/vnf/vloop-vnf-ubuntu-14.04_20160303.qcow2
 .. _vloop-vnf-ubuntu-14.04_20151216: http://artifacts.opnfv.org/vswitchperf/vnf/vloop-vnf-ubuntu-14.04_20151216.qcow2
+
+Hugepage Configuration
+----------------------
+
+Systems running vsperf with either dpdk and/or tests with guests must configure
+hugepage amounts to support running these configurations. It is recommended
+to configure 1GB hugepages as the pagesize.
+
+The amount of hugepages needed depends on your configuration files in vsperf.
+Each guest image requires 4096 by default according to the default settings in
+the ``04_vnf.conf`` file.
+
+.. code:: bash
+
+    GUEST_MEMORY = ['4096', '4096']
+
+The dpdk startup parameters also require an amount of hugepages depending on
+your configuration in the ``02_vswitch.conf`` file.
+
+.. code:: bash
+
+    VSWITCHD_DPDK_ARGS = ['-c', '0x4', '-n', '4', '--socket-mem 1024,1024']
+
+With the --socket-mem argument set to use 1 hugepage on the specified sockets as
+seen above, the configuration will need 9 hugepages total to run all tests
+within vsperf if the pagesize is set correctly to 1GB.
+
+Depending on your OS selection configuration of hugepages may vary. Please refer
+to your OS documentation to set hugepages correctly. It is recommended to set
+the required amount of hugepages to be allocated by default on reboots.
+
+Information on hugepage requirements for dpdk can be found at
+http://dpdk.org/doc/guides/linux_gsg/sys_reqs.html
+
+You can review your hugepage amounts by executing the following command
+
+.. code:: bash
+
+    cat /proc/meminfo | grep Huge