From d691cc89e106d710f4d36bc3998501415588e2e1 Mon Sep 17 00:00:00 2001
From: "Sridhar K. N. Rao" <sridhar.rao@spirent.com>
Date: Tue, 11 Jun 2019 12:53:58 +0530
Subject: Docker: VSPERF Results Container.

This patch adds docker-compose.yml and related config files
for creating a results container. The container hosts following
services:
1. Barometer Grafana.
2. Barometer Influxdb.
2. ELK Stack.
3. OPNFV TestAPI.
4. Jupyter Notebook with VSPERF testresults-analysis.

Removed dashboard files, which can be obtained from barometer-grafana.
Added comment in tools.rst under pre-deployment

Retained only vpserf-cases and vsperf in cases.json and projects.json

Changed barometer-influxdb to influxdb:latest.

Added README.md file.

Added environment variable setting to disable token for jupyter

JIRA: VSPERF-602

Change-Id: I37a1391a1f34f834ce0d46def75a9f3454e09772
Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
---
 docs/testing/user/configguide/tools.rst | 40 +++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

(limited to 'docs/testing/user/configguide')

diff --git a/docs/testing/user/configguide/tools.rst b/docs/testing/user/configguide/tools.rst
index fbc0c71a..362bfca8 100644
--- a/docs/testing/user/configguide/tools.rst
+++ b/docs/testing/user/configguide/tools.rst
@@ -185,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``
-- 
cgit 1.2.3-korg