1. DESCRIPTION
2. SYSTEM REQUIREMENTS
3. INSTALLATION NOTES - barometer-collectd
-4. INSTALLATION NOTES - barometer-collectd-master
+4. INSTALLATION NOTES - barometer-collectd-latest
5. ADDITIONAL STEPS
------------------------------------------------------------------------------
This Dockerfile provides instruction for building collect in isolated container.
There are currently two variants of collectd container:
- barometer-collectd - it is based on stable collect release
- - barometer-collectd-master - development container that is based on
+ - barometer-collectd-latest - development container that is based on
latest 'main' branch for collectd project. It contains all available
collectd plugins and features that are available on 'main' branch but
some issues with configuration or stability may occur
/opt/collectd/sbin/collectd -f
------------------------------------------------------------------------------
-4. INSTALLATION NOTES: barometer-collectd-master (development container)
+4. INSTALLATION NOTES: barometer-collectd-latest (development container)
-To build docker barometer-collectd-master container run (it is based on main branch from collectd):
-sudo docker build -f ./docker/barometer-collectd-master/Dockerfile .
+To build docker barometer-collectd-latest container run (it is based on main branch from collectd):
+sudo docker build -f ./docker/barometer-collectd-latest/Dockerfile .
from root barometer folder.
To run builded image run
sudo docker images # get docker image id
-sudo docker run -ti --net=host -v `pwd`/src/collectd/collectd_sample_configs-master:/opt/collectd/etc/collectd.conf.d \
+sudo docker run -ti --net=host -v `pwd`/src/collectd/collectd_sample_configs-latest:/opt/collectd/etc/collectd.conf.d \
-v /var/run:/var/run -v /tmp:/tmp --privileged <image id>
-NOTE: barometer-collectd-master container uses a different sample configurations files
-compared to regular barometer-collectd container (src/collectd/collectd_sample_configs-master)
+NOTE: barometer-collectd-latest container uses a different sample configurations files
+compared to regular barometer-collectd container (src/collectd/collectd_sample_configs-latest)
To make some changes run
-sudo docker run -ti --net=host -v `pwd`/src/collectd/collectd_sample_configs-master:/opt/collectd/etc/collectd.conf.d \
+sudo docker run -ti --net=host -v `pwd`/src/collectd/collectd_sample_configs-latest:/opt/collectd/etc/collectd.conf.d \
-v /var/run:/var/run -v /tmp:/tmp --privileged --entrypoint=/bin/bash <image id>
/opt/collectd/sbin/collectd -f
Before starting to build and run the Collectd container, understand the available
flavors of Collectd containers:
* barometer-collectd - stable release, based on collectd 5.11
- * barometer-collectd-master - release based on collectd 'main' branch
+ * barometer-collectd-latest - release based on collectd 'main' branch
* barometer-collectd-experimental - release based on collectd 'main'
branch that also includes set of experimental (not yet merged into upstream)
pull requests
Stable `barometer-collectd` container is intended for work in production
environment as it is based on latest collectd official release.
-`Barometer-collectd-master` and `barometer-collectd-experimental` containers
+`barometer-collectd-latest` and `barometer-collectd-experimental` containers
can be used in order to try new collectd features.
All flavors are located in `barometer` git repository - respective Dockerfiles
are stored in subdirectories of `docker/` directory
$ git clone https://gerrit.opnfv.org/gerrit/barometer
$ ls barometer/docker|grep collectd
barometer-collectd
- barometer-collectd-master
+ barometer-collectd-latest
barometer-collectd-experimental
.. note::
hello-world latest 05a3bd381fc2 4 weeks ago 1.84kB
.. note::
- If you do not plan to use collectd-master and collectd-experimental barometer
- containers, then you can proceed directly to section `Run the collectd stable docker image`_
+ If you do not plan to use `barometer-collectd-latest` and
+ `barometer-collectd-experimental` containers, then you can proceed directly
+ to section `Run the collectd stable docker image`_
-Build collectd-master container
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Build barometer-collectd-latest container
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: bash
$ cd <BAROMETER_REPO_DIR>
- $ sudo docker build -t opnfv/barometer-collectd-master \
+ $ sudo docker build -t opnfv/barometer-collectd-latest \
--build-arg http_proxy=`echo $http_proxy` \
--build-arg https_proxy=`echo $https_proxy` --network=host -f \
- docker/barometer-collectd-master/Dockerfile .
+ docker/barometer-collectd-latest/Dockerfile .
.. note::
- For `barometer-collectd-master` and `barometer-collectd-experimental` containers
+ For `barometer-collectd-latest` and `barometer-collectd-experimental` containers
proxy parameters should be passed only if system is behind an HTTP or HTTPS
proxy server (same as for stable collectd container)
--network=host -f docker/barometer-collectd-experimental/Dockerfile .
.. note::
- For `barometer-collectd-master` and `barometer-collectd-experimental` containers
+ For `barometer-collectd-latest` and `barometer-collectd-experimental` containers
proxy parameters should be passed only if system is behind an HTTP or HTTPS
proxy server (same as for stable collectd container)
sudo docker exec -ti <CONTAINER ID> /bin/bash
-Run the barometer-collectd-master docker image
+Run the barometer-collectd-latest docker image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Run command for `barometer-collectd-master` container is very similar to command
-used for stable container - the only differences are name of the image
-and location of the sample configuration files(as different version of collectd
-plugins requiring different configuration files)
+Run command for ``barometer-collectd-latest`` container is very similar to
+command used for stable container - the only differences are name of the image
+and location of the sample configuration files (as different version of
+collectd plugins requiring different configuration files)
.. code:: bash
$ cd <BAROMETER_REPO_DIR>
$ sudo docker run -ti --net=host -v \
- `pwd`/src/collectd/collectd_sample_configs-master:/opt/collectd/etc/collectd.conf.d \
+ `pwd`/src/collectd/collectd_sample_configs-latest:/opt/collectd/etc/collectd.conf.d \
-v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl \
- --privileged opnfv/barometer-collectd-master
+ --privileged opnfv/barometer-collectd-latest
.. note::
Barometer collectd docker images are sharing some directories with host
(e.g. /tmp) therefore only one of collectd barometer flavors can be run
- at a time. In other words, if you want to try `barometer-collectd-master` or
+ at a time. In other words, if you want to try `barometer-collectd-latest` or
`barometer-collectd-experimental` image, please stop instance of
`barometer-collectd(stable)` image first.
Run the barometer-collectd-experimental docker image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Barometer-collectd-experimental container shares default configuration files
-with 'barometer-collectd-master' equivalent but some of experimental pull
+with 'barometer-collectd-latest' equivalent but some of experimental pull
requests may require modified configuration. Additional configuration files that
are required specifically by experimental container can be found in
`docker/barometer-collectd-experimental/experimental-configs/`
directory. Content of this directory (all \*.conf files) should be copied to
-`src/collectd/collectd_sample_configs-master` directory before first run of
+``src/collectd/collectd_sample_configs-latest`` directory before first run of
experimental container.
.. code:: bash
$ cd <BAROMETER_REPO_DIR>
$ cp docker/barometer-collectd-experimental/experimental-configs/*.conf \
- src/collectd/collectd_sample_configs-master
+ src/collectd/collectd_sample_configs-latest
When configuration files are up to date for experimental container, it can be
-launched using following command (almost identical to run-command for 'master'
+launched using following command (almost identical to run-command for ``latest``
collectd container)
.. code:: bash
$ cd <BAROMETER_REPO_DIR>
$ sudo docker run -ti --net=host -v \
- `pwd`/src/collectd/collectd_sample_configs-master:/opt/collectd/etc/collectd.conf.d \
+ `pwd`/src/collectd/collectd_sample_configs-latest:/opt/collectd/etc/collectd.conf.d \
-v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl --privileged \
opnfv/barometer-collectd-experimental