Fix the Makefile for intel-cmt-cat so it can be build without errors on

[barometer.git] / docs / release / userguide / installguide.docker.rst

diff --git a/docs/release/userguide/installguide.docker.rst b/docs/release/userguide/installguide.docker.rst
index 7312a9f..f3b889e 100644 (file)
--- a/docs/release/userguide/installguide.docker.rst
+++ b/docs/release/userguide/installguide.docker.rst
@@ -377,7 +377,8 @@ Run the collectd stable docker image
    $ 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
+   -v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl \
+   --privileged opnfv/barometer-collectd
 
 .. note::
    The docker collectd image contains configuration for all the collectd
@@ -406,6 +407,12 @@ Run the collectd stable docker image
    can be found at:
    https://wiki.opnfv.org/display/fastpath/Barometer-collectd+host+dependencies
 
+   The Resource Control file system (/sys/fs/resctrl) can be bound from host to
+   container only if this directory exists on the host system. Otherwise omit
+   the '-v /sys/fs/resctrl:/sys/fs/resctrl' part in docker run command.
+   More information about resctrl can be found at:
+   https://github.com/intel/intel-cmt-cat/wiki/resctrl
+
 Check your docker image is running
 
 .. code:: bash
@@ -431,7 +438,8 @@ plugins requiring different configuration files)
    $ cd <BAROMETER_REPO_DIR>
    $ sudo docker run -ti --net=host -v \
    `pwd`/src/collectd/collectd_sample_configs-master:/opt/collectd/etc/collectd.conf.d \
-   -v /var/run:/var/run -v /tmp:/tmp --privileged opnfv/barometer-collectd-master
+   -v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl \
+   --privileged opnfv/barometer-collectd-master
 
 .. note::
    Barometer collectd docker images are sharing some directories with host
@@ -440,6 +448,12 @@ plugins requiring different configuration files)
    `barometer-collectd-experimental` image, please stop instance of
    `barometer-collectd(stable)` image first.
 
+   The Resource Control file system (/sys/fs/resctrl) can be bound from host to
+   container only if this directory exists on the host system. Otherwise omit
+   the '-v /sys/fs/resctrl:/sys/fs/resctrl' part in docker run command.
+   More information about resctrl can be found at:
+   https://github.com/intel/intel-cmt-cat/wiki/resctrl
+
 Run the barometer-collectd-experimental docker image
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Barometer-collectd-experimental container shares default configuration files
@@ -466,9 +480,16 @@ collectd container)
    $ cd <BAROMETER_REPO_DIR>
    $ sudo docker run -ti --net=host -v \
    `pwd`/src/collectd/collectd_sample_configs-master:/opt/collectd/etc/collectd.conf.d \
-   -v /var/run:/var/run -v /tmp:/tmp --privileged \
+   -v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl --privileged \
    opnfv/barometer-collectd-experimental
 
+.. note::
+   The Resource Control file system (/sys/fs/resctrl) can be bound from host to
+   container only if this directory exists on the host system. Otherwise omit
+   the '-v /sys/fs/resctrl:/sys/fs/resctrl' part in docker run command.
+   More information about resctrl can be found at:
+   https://github.com/intel/intel-cmt-cat/wiki/resctrl
+
 
 Build and Run InfluxDB and Grafana docker images
 ------------------------------------------------