Fix DMA docker image url in docker userguide
[barometer.git] / docs / release / userguide / docker.userguide.rst
index fe7711a..b180c65 100644 (file)
@@ -614,11 +614,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
@@ -942,31 +959,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 +1012,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 +1026,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