aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/userguide
diff options
context:
space:
mode:
authorAaron Smith <aasmith@redhat.com>2018-10-05 11:46:43 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-10-05 11:46:43 +0000
commit9ac248a08de1f197bafbabbf43175b30ab19ec32 (patch)
tree57c69f139042bafad0a49afc900fc92aa3a118f7 /docs/release/userguide
parent28bfd38af164d1b7983c57a0683636bc9a0781fc (diff)
parent45d2ecd63cd9c5f2ee460f90b1a4bd5466457f7e (diff)
Merge "docker.userguide: Fix docker run commands examples"
Diffstat (limited to 'docs/release/userguide')
-rw-r--r--docs/release/userguide/docker.userguide.rst25
1 files changed, 18 insertions, 7 deletions
diff --git a/docs/release/userguide/docker.userguide.rst b/docs/release/userguide/docker.userguide.rst
index 79f2db1c..ea260821 100644
--- a/docs/release/userguide/docker.userguide.rst
+++ b/docs/release/userguide/docker.userguide.rst
@@ -514,6 +514,12 @@ Build the collectd docker image
--build-arg https_proxy=`echo $https_proxy` -f Dockerfile .
.. note::
+ Main directory of barometer source code (directory that contains 'docker',
+ 'docs', 'src' and systems sub-directories) will be referred as
+ ``<BAROMETER_REPO_DIR>``
+
+
+.. note::
In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs to be
passed only if system is behind an HTTP or HTTPS proxy server.
@@ -537,14 +543,18 @@ Run the collectd docker image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: bash
- $ sudo docker run -tid --net=host -v `pwd`/../src/collectd_sample_configs:/opt/collectd/etc/collectd.conf.d \
- -v /var/run:/var/run -v /tmp:/tmp --privileged opnfv/barometer-collectd /run_collectd.sh
+ $ cd <BAROMETER_REPO_DIR>
+ $ sudo docker run -ti --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
.. note::
- The docker collectd image contains configuration for all the collectd plugins. In the command
- above we are overriding /opt/collectd/etc/collectd.conf.d by mounting a host directory
- `pwd`/../src/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*.
+ The docker collectd image contains configuration for all the collectd
+ 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*.
Sample configurations can be found at:
https://github.com/opnfv/barometer/tree/master/src/collectd/collectd_sample_configs
@@ -691,7 +701,8 @@ Connecting to an influxdb instance running on local system and adding own custom
.. code:: bash
- $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana -v ${PWD}/dashboards:/opt/grafana/dashboards \
+ $ cd <BAROMETER_REPO_DIR>
+ $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana -v ${PWD}/docker/barometer-grafana/dashboards:/opt/grafana/dashboards \
-p 3000:3000 opnfv/barometer-grafana
Connecting to an influxdb instance running on remote system with hostname of someserver and IP address