Merge "docker.userguide: Fix instruction for installing ansible"
[barometer.git] / docs / release / userguide / docker.userguide.rst
index fe7711a..520a72b 100644 (file)
@@ -170,7 +170,7 @@ To install Ansible 2.6.3 on Ubuntu:
 
     $ sudo apt-get install python
     $ sudo apt-get install python-pip
-    $ sudo pip install 'ansible==2.6.3'
+    $ sudo -H pip install 'ansible==2.6.3'
 
 The following steps have been verified with Ansible 2.6.3 on Centos 7.5.
 To install Ansible 2.6.3 on Centos:
@@ -180,7 +180,7 @@ To install Ansible 2.6.3 on Centos:
     $ sudo yum install python
     $ sudo yum install epel-release
     $ sudo yum install python-pip
-    $ sudo pip install 'ansible==2.6.3'
+    $ sudo -H pip install 'ansible==2.6.3'
 
 Clone barometer repo
 ^^^^^^^^^^^^^^^^^^^^
@@ -259,7 +259,8 @@ The example is for localhost.
 
 .. code:: bash
 
-    $ sudo ssh-copy-id root@localhost
+    $ sudo -i
+    $ ssh-copy-id root@localhost
 
 Verify that key is added and password is not required to connect.
 
@@ -281,7 +282,7 @@ through more details.
 
 .. code:: bash
 
-    $ sudo ansible-playbook -i default.inv collectd_service.yml
+    $ sudo -H ansible-playbook -i default.inv collectd_service.yml
 
 Check the three containers are running, the output of docker ps should be similar to:
 
@@ -572,7 +573,7 @@ Build the collectd docker image
     $ git clone https://gerrit.opnfv.org/gerrit/barometer
     $ cd barometer/docker/barometer-collectd
     $ sudo docker build -t opnfv/barometer-collectd --build-arg http_proxy=`echo $http_proxy` \
-      --build-arg https_proxy=`echo $https_proxy` -f Dockerfile .
+      --build-arg https_proxy=`echo $https_proxy` --network=host -f Dockerfile .
 
 .. note::
    Main directory of barometer source code (directory that contains 'docker',
@@ -614,11 +615,28 @@ Run the collectd docker image
    plugins. In the command above we are overriding
    /opt/collectd/etc/collectd.conf.d by mounting a host directory
    src/collectd/collectd_sample_configs that contains only the sample
-   configurations we are interested in running. *It's important to do
-   this if you don't have DPDK, or RDT installed on the host*.
+   configurations we are interested in running.
+
+   *If some dependencies for plugins listed in configuration directory
+   aren't met, then collectd startup may fail(collectd tries to
+   initialize plugins configurations for all given config files that can
+   be found in shared configs directory and may fail if some dependency
+   is missing).*
+
+   If `DPDK` or `RDT` can't be installed on host, then corresponding config
+   files should be removed from shared configuration directory
+   (`<BAROMETER_REPO_DIR>/src/collectd/collectd_sample_configs/`) prior
+   to starting barometer-collectd container. By example: in case of missing
+   `DPDK` functionality on the host, `dpdkstat.conf` and `dpdkevents.conf`
+   should be removed.
+
    Sample configurations can be found at:
    https://github.com/opnfv/barometer/tree/master/src/collectd/collectd_sample_configs
 
+   List of barometer-collectd dependencies on host for various plugins
+   can be found at:
+   https://wiki.opnfv.org/display/fastpath/Barometer-collectd+host+dependencies
+
 Check your docker image is running
 
 .. code:: bash
@@ -685,7 +703,7 @@ Build influxdb image from Dockerfile
 
   $ cd barometer/docker/barometer-influxdb
   $ sudo docker build -t opnfv/barometer-influxdb --build-arg http_proxy=`echo $http_proxy` \
-    --build-arg https_proxy=`echo $https_proxy` -f Dockerfile .
+    --build-arg https_proxy=`echo $https_proxy` --network=host -f Dockerfile .
 
 .. note::
    In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs to
@@ -754,6 +772,58 @@ To make some changes when the container is running run:
 
    sudo docker exec -ti <CONTAINER ID> /bin/bash
 
+When both collectd and InfluxDB containers are located
+on the same host, then no additional configuration have to be added and you
+can proceed directly to `Run the Grafana docker image`_ section.
+
+Modify collectd to support InfluxDB on another host
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If InfluxDB and collectd containers are located on separate hosts, then
+additional configuration have to be done in ``collectd`` container - it
+normally sends data using network plugin to 'localhost/127.0.0.1' therefore
+changing output location is required:
+
+1. Stop and remove running bar-collectd container (if it is running)
+
+   .. code:: bash
+
+      $ sudo docker ps #to get collectd container name
+      $ sudo docker rm -f <COLLECTD_CONTAINER_NAME>
+
+2. Go to location where shared collectd config files are stored
+
+   .. code:: bash
+
+      $ cd <BAROMETER_REPO_DIR>
+      $ cd src/collectd/collectd_sample_configs
+
+3. Edit content of ``network.conf`` file.
+   By default this file looks like that:
+
+   .. code::
+
+      LoadPlugin  network
+      <Plugin network>
+      Server "127.0.0.1" "25826"
+      </Plugin>
+
+   ``127.0.0.1`` string has to be replaced with the IP address of host where
+   InfluxDB container is running (e.g. ``192.168.121.111``). Edit this using your
+   favorite text editor.
+
+4. Start again collectd container like it is described in
+   `Run the collectd docker image`_ chapter
+
+   .. code:: bash
+
+      $ cd <BAROMETER_REPO_DIR>
+      $ sudo docker run -ti --name bar-collectd --net=host -v \
+      `pwd`/src/collectd/collectd_sample_configs:/opt/collectd/etc/collectd.conf.d \
+      -v /var/run:/var/run -v /tmp:/tmp --privileged opnfv/barometer-collectd
+
+Now collectd container will be sending data to InfluxDB container located on
+remote Host pointed by IP configured in step 3.
+
 Run the Grafana docker image
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -789,6 +859,30 @@ To make some changes when the container is running run:
 
 Connect to <host_ip>:3000 with a browser and log into grafana: admin/admin
 
+Cleanup of influxdb/grafana configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When user wants to remove current grafana and influxdb configuration,
+folowing actions have to be performed
+
+1. Stop and remove running influxdb and grafana containers
+
+.. code:: bash
+
+   sudo docker rm -f bar-grafana bar-influxdb
+
+2. Remove shared influxdb and grafana folders from the Host
+
+.. code:: bash
+
+   sudo rm -rf /var/lib/grafana
+   sudo rm -rf /var/lib/influxdb
+
+.. note::
+   Shared folders are storing configuration of grafana and influxdb
+   containers. In case of changing influxdb or grafana configuration
+   (e.g. moving influxdb to another host) it is good to perform cleanup
+   on shared folders to not affect new setup with an old configuration.
 
 Build and Run VES and Kafka Docker Images
 ------------------------------------------
@@ -942,31 +1036,31 @@ VES Test Collector application can be used for displaying platform
 wide metrics that are collected by barometer-ves container.
 Setup instructions are located in: :ref:`Setup VES Test Collector`
 
-Build and Run LocalAgent and Redis Docker Images
+Build and Run DMA and Redis Docker Images
 -----------------------------------------------------
 
-Download LocalAgent docker images
+Download DMA docker images
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If you wish to use pre-built barometer project's LocalAgent images, you can pull the
-images from https://hub.docker.com/r/opnfv/barometer-localagent/
+If you wish to use pre-built barometer project's DMA images, you can pull the
+images from https://hub.docker.com/r/opnfv/barometer-dma/
 
 .. note::
-   If your preference is to build images locally please see sections `Build LocalAgent Docker Image`_
+   If your preference is to build images locally please see sections `Build DMA Docker Image`_
 
 .. code:: bash
 
-    $ docker pull opnfv/barometer-localagent
+    $ docker pull opnfv/barometer-dma
 
 .. note::
    If you have pulled the pre-built images there is no requirement to complete steps outlined
-   in sections `Build LocalAgent Docker Image`_ and you can proceed directly to section
-   `Run LocalAgent Docker Image`_
+   in sections `Build DMA Docker Image`_ and you can proceed directly to section
+   `Run DMA Docker Image`_
 
-Build LocalAgent docker image
+Build DMA docker image
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Build LocalAgent docker image:
+Build DMA docker image:
 
 .. code:: bash
 
@@ -995,7 +1089,7 @@ Run Redis docker image
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. note::
-   Before running LocalAgent, Redis must be running.
+   Before running DMA, Redis must be running.
 
 Run Redis docker image:
 
@@ -1009,11 +1103,11 @@ Check your docker image is running
 
    sudo docker ps
 
-Run LocalAgent docker image
+Run DMA docker image
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. note::
 
-Run LocalAgent docker image with default configuration
+Run DMA docker image with default configuration
 
 .. code:: bash