diff options
| author |   Radoslaw Jablonski <radoslawx.jablonski@intel.com> | 2018-09-28 09:43:45 +0100 |
|---|---|---|
| committer | Radoslaw Jablonski <radoslawx.jablonski@intel.com> | 2018-10-04 10:06:04 +0100 |
| commit | 45d2ecd63cd9c5f2ee460f90b1a4bd5466457f7e (patch) | |
| tree | 8f01dec8a4974564bc96c1df865e877d72255cf2 | |
| parent | ada3bb5cda036c736b460b76552ce47dd8f40aa8 (diff) | |
docker.userguide: Fix docker run commands examples
Command example for running opnf-barometer-collectd and grafaana
images were using incorrect locations for configuration files.
Change-Id: I3f0648f810cc049ae1df4d742f2ed7b58b50b12a
Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com>
| -rw-r--r-- | docs/release/userguide/docker.userguide.rst | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/docs/release/userguide/docker.userguide.rst b/docs/release/userguide/docker.userguide.rst index 7582e67b..cc82e782 100644 --- a/docs/release/userguide/docker.userguide.rst +++ b/docs/release/userguide/docker.userguide.rst @@ -483,6 +483,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. @@ -506,14 +512,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 @@ -660,7 +670,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 |