aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRadoslaw Jablonski <radoslawx.jablonski@intel.com>2018-10-17 15:05:51 +0100
committerAaron Smith <aasmith@redhat.com>2018-11-12 14:17:28 +0000
commit7e40ee9957eae8885f85fb4f8bcf06087a7e9fc9 (patch)
treea9956ae95111df476f58dcd173f3b14123d1f2aa
parentcc13eb90eaed9489930e3299fb576b3e60f76843 (diff)
docker.userguide: Add a note about bar-collectd run without DPDK/RDT
Added a note with information what happens if RDT/DPDK dependency will be missing on host during manual starting bar-collectd container(with info what should be done in such scenario to start bar-collectd anyway) Change-Id: I11ba595e8925027c772920876c4bf2967f33de88 Signed-off-by: Radoslaw Jablonski <radoslawx.jablonski@intel.com> (cherry picked from commit 9f91de5d3e1c6d9b535db6a958e3598221b75d58)
-rw-r--r--docs/release/userguide/docker.userguide.rst21
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/release/userguide/docker.userguide.rst b/docs/release/userguide/docker.userguide.rst
index fe7711a..4947ec7 100644
--- a/docs/release/userguide/docker.userguide.rst
+++ b/docs/release/userguide/docker.userguide.rst
@@ -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