diff options
Diffstat (limited to 'docs/testing/user/configguide/tools.rst')
-rw-r--r-- | docs/testing/user/configguide/tools.rst | 52 |
1 files changed, 51 insertions, 1 deletions
diff --git a/docs/testing/user/configguide/tools.rst b/docs/testing/user/configguide/tools.rst index 907e86d2..72e515fa 100644 --- a/docs/testing/user/configguide/tools.rst +++ b/docs/testing/user/configguide/tools.rst @@ -46,13 +46,16 @@ Installation No installation is required for *pidstat*, whereas, collectd has to be installed separately. For installation of collectd, we recommend to follow the process described -in *OPNFV-Barometer* project, which can be found here `Barometer-Euphrates <http://docs.opnfv.org/en/stable-euphrates/submodules/barometer/docs/release/userguide/feature.userguide.html#building-all-barometer-upstreamed-plugins-from-scratch>`_ or the most +in *OPNFV-Barometer* project, which can be found here `Barometer <https://opnfv-barometer.readthedocs.io/en/latest/release/userguide>`_ recent release. VSPERF assumes that collectd is installed and configured to send metrics over localhost. The metrics sent should be for the following categories: CPU, Processes, Interface, OVS, DPDK, Intel-RDT. +For multicmd, apart from collectd, installation of PROX is also necessary. +Installation steps for PROX can be found here - `DPPD-PROX <https://github.com/opnfv/samplevnf/tree/master/VNFs/DPPD-PROX>`_ + Configuration ^^^^^^^^^^^^^ @@ -79,6 +82,13 @@ The *collectd* configuration option includes: * ``COLLECTD_INTELRDT_KEYS`` - Interesting metrics from Intel-RDT * ``COLLECTD_INTERFACE_XKEYS`` - Metrics to exclude from Interface * ``COLLECTD_INTELRDT_XKEYS`` - Metrics to exclude from Intel-RDT +* ``MC_COLLECTD_CSV`` - Path where collectd writes its metrics as CSV. +* ``MC_COLLECTD_CMD`` - Path where Collectd is installed +* ``MC_PROX_HOME`` - Path where PROX-IRQ is installed. +* ``MC_PROX_CMD`` - Command to run PROX-IRQ +* ``MC_PROX_OUT`` - Output file generated by PROX-IRQ stats collector. +* ``MC_CRON_OUT`` - Output file path of the command run through CROND +* ``MC_BEAT_CFILE`` - Filebeat configuration file path. .. _`Load Generators`: @@ -175,3 +185,43 @@ VSPERF provides following configuration options, for user to define and enforce * ``VNF_CA`` - [min-cache-value, max-cache-value] for VNF * ``PMD_CA`` - [min-cache-value, max-cache-value] for PMD * ``NOISEVM_CA`` - [min-cache-value, max-cache-value] for Noisy VM + +VSPERF Containers +----------------- + +VSPERF containers are found in tools/docker folder. + +RESULTS CONTAINER +^^^^^^^^^^^^^^^^^ + +The results container includes multiple services - ELK Stack, Barometer-Grafana, OPNFV-TestAPI & Jupyter. + +Pre-Deployment Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Set the limit on mmap counts equal to 262144 or more. + You can do this by the command - ``sysctl -w vm.max_map_count = 262144``. + Or to set it permanently, update the ``vm.max_map_count`` field in ``/etc/sysctl.conf``. + +2. You may want to modify the IP address from 0.0.0.0 to appropriate host-ip in ``docker-compose.yml`` + +3. Please add dashboards folder from OPNFV-Barometer-Grafana into the grafana folder. It can be found in `Barometer Grafana <https://github.com/opnfv/barometer/tree/master/docker/barometer-grafana` + +Build +~~~~~ + +Run ``docker-compose build`` command to build the container. + +Run +~~~ + +Run the container with ``docker-compose up`` command. + +Post-Deployment Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The directory ``resultsdb`` contains the source from Dovetail/Dovetail-webportal project. +Once the results container is deployed, please run the python script as follows, to ensure that results can be +pushed and queried correctly - ``python init_db.py host_ip_address testapi_port``. +For example, if the host on which the container is running is 10.10.120.22, and container is exposing 8000 as the port, +the command should be: ``python init_db.py 10.10.120.22 8000`` |