1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) <optionally add copywriters name>
4 .. _barometer-docker-userguide:
6 ====================================
7 OPNFV Barometer Docker Install Guide
8 ====================================
14 The intention of this user guide is to outline how to install and test the Barometer project's
15 docker images. The `OPNFV docker hub <https://hub.docker.com/u/opnfv/?page=1>`_ contains 5 docker
16 images from the Barometer project:
18 1. `Collectd docker image <https://hub.docker.com/r/opnfv/barometer-collectd/>`_
19 2. `Influxdb docker image <https://hub.docker.com/r/opnfv/barometer-influxdb/>`_
20 3. `Grafana docker image <https://hub.docker.com/r/opnfv/barometer-grafana/>`_
21 4. `Kafka docker image <https://hub.docker.com/r/opnfv/barometer-kafka/>`_
22 5. `VES application docker image <https://hub.docker.com/r/opnfv/barometer-ves/>`_
24 For description of images please see section `Barometer Docker Images Description`_
26 For steps to build and run Collectd image please see section `Build and Run Collectd Docker Image`_
28 For steps to build and run InfluxDB and Grafana images please see section `Build and Run InfluxDB and Grafana Docker Images`_
30 For steps to build and run VES and Kafka images please see section `Build and Run VES and Kafka Docker Images`_
32 For overview of running VES application with Kafka please see the :ref:`VES Application User Guide <barometer-ves-userguide>`
34 For an alternative installation method using ansible, please see the :ref:`Barometer One Click Install Guide <barometer-oneclick-userguide>`.
36 Barometer Docker Images Description
37 -----------------------------------
39 .. Describe the specific features and how it is realised in the scenario in a brief manner
40 .. to ensure the user understand the context for the user guide instructions to follow.
42 Barometer Collectd Image
43 ^^^^^^^^^^^^^^^^^^^^^^^^
44 The barometer collectd docker image gives you a collectd installation that includes all
45 the barometer plugins.
48 The Dockerfile is available in the docker/barometer-collectd directory in the barometer repo.
49 The Dockerfile builds a CentOS 7 docker image.
50 The container MUST be run as a privileged container.
52 Collectd is a daemon which collects system performance statistics periodically
53 and provides a variety of mechanisms to publish the collected metrics. It
54 supports more than 90 different input and output plugins. Input plugins
55 retrieve metrics and publish them to the collectd deamon, while output plugins
56 publish the data they receive to an end point. Collectd also has infrastructure
57 to support thresholding and notification.
59 Collectd docker image has enabled the following collectd plugins (in addition
60 to the standard collectd plugins):
63 * Open vSwitch events Plugin
64 * Open vSwitch stats Plugin
72 Plugins and third party applications in Barometer repository that will be available in the
75 * Open vSwitch PMD stats
76 * ONAP VES application
81 InfluxDB + Grafana Docker Images
82 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
84 The Barometer project's InfluxDB and Grafana docker images are 2 docker images that database and graph
85 statistics reported by the Barometer collectd docker. InfluxDB is an open-source time series database
86 tool which stores the data from collectd for future analysis via Grafana, which is a open-source
87 metrics anlytics and visualisation suite which can be accessed through any browser.
89 VES + Kafka Docker Images
90 ^^^^^^^^^^^^^^^^^^^^^^^^^
92 The Barometer project's VES application and Kafka docker images are based on a CentOS 7 image. Kafka
93 docker image has a dependancy on `Zookeeper <https://zookeeper.apache.org/>`_. Kafka must be able to
94 connect and register with an instance of Zookeeper that is either running on local or remote host.
95 Kafka recieves and stores metrics recieved from Collectd. VES application pulls latest metrics from Kafka
96 which it normalizes into VES format for sending to a VES collector. Please see details in
97 :ref:`VES Application User Guide <barometer-ves-userguide>`
101 .. Describe the specific capabilities and usage for <XYZ> feature.
102 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
105 The below sections provide steps for manual installation and configuration
106 of docker images. They are not neccessary if docker images were installed with
107 use of Ansible-Playbook.
112 * sudo permissions are required to install docker.
113 * These instructions are for Ubuntu 16.10
119 $ sudo apt-get install curl
120 $ sudo curl -fsSL https://get.docker.com/ | sh
121 $ sudo usermod -aG docker <username>
122 $ sudo systemctl status docker
124 Replace <username> above with an appropriate user name.
129 * sudo permissions are required to install docker.
130 * These instructions are for CentOS 7
136 $ sudo yum remove docker docker-common docker-selinux docker-engine
137 $ sudo yum install -y yum-utils device-mapper-persistent-data lvm2
138 $ sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
139 $ sudo yum-config-manager --enable docker-ce-edge
140 $ sudo yum-config-manager --enable docker-ce-test
141 $ sudo yum install docker-ce
142 $ sudo usermod -aG docker <username>
143 $ sudo systemctl status docker
145 Replace <username> above with an appropriate user name.
148 If this is the first time you are installing a package from a recently added
149 repository, you will be prompted to accept the GPG key, and the key’s
150 fingerprint will be shown. Verify that the fingerprint is correct, and if so,
151 accept the key. The fingerprint should match060A 61C5 1B55 8A7F 742B 77AA C52F
154 Retrieving key from https://download.docker.com/linux/centos/gpg
155 Importing GPG key 0x621E9F35:
157 Userid : "Docker Release (CE rpm) <docker@docker.com>"
158 Fingerprint: 060a 61c5 1b55 8a7f 742b 77aa c52f eb6b 621e 9f35
159 From : https://download.docker.com/linux/centos/gpg
162 Manual proxy configuration for docker
163 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166 This applies for both CentOS and Ubuntu.
168 If you are behind an HTTP or HTTPS proxy server, you will need to add this
169 configuration in the Docker systemd service file.
171 1. Create a systemd drop-in directory for the docker service:
175 $ sudo mkdir -p /etc/systemd/system/docker.service.d
178 called /etc/systemd/system/docker.service.d/http-proxy.conf that adds
179 the HTTP_PROXY environment variable:
184 Environment="HTTP_PROXY=http://proxy.example.com:80/"
186 Or, if you are behind an HTTPS proxy server, create a file
187 called /etc/systemd/system/docker.service.d/https-proxy.conf that adds
188 the HTTPS_PROXY environment variable:
193 Environment="HTTPS_PROXY=https://proxy.example.com:443/"
195 Or create a single file with all the proxy configurations:
196 /etc/systemd/system/docker.service.d/proxy.conf
201 Environment="HTTP_PROXY=http://proxy.example.com:80/"
202 Environment="HTTPS_PROXY=https://proxy.example.com:443/"
203 Environment="FTP_PROXY=ftp://proxy.example.com:443/"
204 Environment="NO_PROXY=localhost"
210 $ sudo systemctl daemon-reload
216 $ sudo systemctl restart docker
218 5. Check docker environment variables:
222 sudo systemctl show --property=Environment docker
224 Test docker installation
225 ^^^^^^^^^^^^^^^^^^^^^^^^
227 This applies for both CentOS and Ubuntu.
231 $ sudo docker run hello-world
233 The output should be something like:
237 Trying to pull docker.io/library/hello-world...Getting image source signatures
238 Copying blob 0e03bdcc26d7 done
239 Copying config bf756fb1ae done
240 Writing manifest to image destination
244 This message shows that your installation appears to be working correctly.
246 To generate this message, Docker took the following steps:
247 1. The Docker client contacted the Docker daemon.
248 2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
249 3. The Docker daemon created a new container from that image which runs the
250 executable that produces the output you are currently reading.
251 4. The Docker daemon streamed that output to the Docker client, which sent it
254 To try something more ambitious, you can run an Ubuntu container with:
255 $ docker run -it ubuntu bash
257 Share images, automate workflows, and more with a free Docker ID:
258 https://hub.docker.com/
260 For more examples and ideas, visit:
261 https://docs.docker.com/get-started/
263 Build and Run Collectd Docker Image
264 -----------------------------------
266 Collectd-barometer flavors
267 ^^^^^^^^^^^^^^^^^^^^^^^^^^
269 Before starting to build and run the Collectd container, understand the available
270 flavors of Collectd containers:
271 * barometer-collectd - stable release, based on collectd 5.11
272 * barometer-collectd-latest - release based on collectd 'main' branch
273 * barometer-collectd-experimental - release based on collectd 'main'
274 branch that also includes set of experimental (not yet merged into upstream)
278 Experimental container is not tested across various OS'es and the stability
279 of the container can change. Usage of experimental flavor is at users risk.
281 Stable `barometer-collectd` container is intended for work in production
282 environment as it is based on latest collectd official release.
283 `barometer-collectd-latest` and `barometer-collectd-experimental` containers
284 can be used in order to try new collectd features.
285 All flavors are located in `barometer` git repository - respective Dockerfiles
286 are stored in subdirectories of `docker/` directory
291 $ git clone https://gerrit.opnfv.org/gerrit/barometer
292 $ ls barometer/docker|grep collectd
294 barometer-collectd-latest
295 barometer-collectd-experimental
298 Main directory of barometer source code (directory that contains 'docker',
299 'docs', 'src' and systems sub-directories) will be referred as
300 ``<BAROMETER_REPO_DIR>``
302 Download the collectd docker image
303 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
304 If you wish to use a pre-built barometer image, you can pull the barometer
305 image from https://hub.docker.com/r/opnfv/barometer-collectd/
309 $ docker pull opnfv/barometer-collectd
311 Build stable collectd container
312 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
316 $ cd <BAROMETER_REPO_DIR>/docker/barometer-collectd
317 $ sudo docker build -t opnfv/barometer-collectd --build-arg http_proxy=`echo $http_proxy` \
318 --build-arg https_proxy=`echo $https_proxy` --network=host -f Dockerfile .
321 In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs to be
322 passed only if system is behind an HTTP or HTTPS proxy server.
324 Check the docker images:
330 Output should contain a barometer-collectd image:
334 REPOSITORY TAG IMAGE ID CREATED SIZE
335 opnfv/barometer-collectd latest 05f2a3edd96b 3 hours ago 1.2GB
336 centos 7 196e0ce0c9fb 4 weeks ago 197MB
337 centos latest 196e0ce0c9fb 4 weeks ago 197MB
338 hello-world latest 05a3bd381fc2 4 weeks ago 1.84kB
341 If you do not plan to use `barometer-collectd-latest` and
342 `barometer-collectd-experimental` containers, then you can proceed directly
343 to section `Run the collectd stable docker image`_
346 Build barometer-collectd-latest container
347 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
351 $ cd <BAROMETER_REPO_DIR>
352 $ sudo docker build -t opnfv/barometer-collectd-latest \
353 --build-arg http_proxy=`echo $http_proxy` \
354 --build-arg https_proxy=`echo $https_proxy` --network=host -f \
355 docker/barometer-collectd-latest/Dockerfile .
358 For `barometer-collectd-latest` and `barometer-collectd-experimental` containers
359 proxy parameters should be passed only if system is behind an HTTP or HTTPS
360 proxy server (same as for stable collectd container)
362 Build collectd-experimental container
363 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
367 $ cd <BAROMETER_REPO_DIR>
368 $ sudo docker build -t opnfv/barometer-collectd-experimental \
369 --build-arg http_proxy=`echo $http_proxy` \
370 --build-arg https_proxy=`echo $https_proxy` \
371 --network=host -f docker/barometer-collectd-experimental/Dockerfile .
374 For `barometer-collectd-latest` and `barometer-collectd-experimental` containers
375 proxy parameters should be passed only if system is behind an HTTP or HTTPS
376 proxy server (same as for stable collectd container)
378 Run the collectd stable docker image
379 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
382 $ cd <BAROMETER_REPO_DIR>
383 $ sudo docker run -ti --net=host -v \
384 `pwd`/src/collectd/collectd_sample_configs:/opt/collectd/etc/collectd.conf.d \
385 -v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl \
386 --privileged opnfv/barometer-collectd
389 The docker collectd image contains configuration for all the collectd
390 plugins. In the command above we are overriding
391 /opt/collectd/etc/collectd.conf.d by mounting a host directory
392 src/collectd/collectd_sample_configs that contains only the sample
393 configurations we are interested in running.
395 *If some dependencies for plugins listed in configuration directory
396 aren't met, then collectd startup may fail(collectd tries to
397 initialize plugins configurations for all given config files that can
398 be found in shared configs directory and may fail if some dependency
401 If `DPDK` or `RDT` can't be installed on host, then corresponding config
402 files should be removed from shared configuration directory
403 (`<BAROMETER_REPO_DIR>/src/collectd/collectd_sample_configs/`) prior
404 to starting barometer-collectd container. By example: in case of missing
405 `DPDK` functionality on the host, `dpdkstat.conf` and `dpdkevents.conf`
408 Sample configurations can be found at:
409 https://github.com/opnfv/barometer/tree/master/src/collectd/collectd_sample_configs
411 List of barometer-collectd dependencies on host for various plugins
413 https://wiki.opnfv.org/display/fastpath/Barometer-collectd+host+dependencies
415 The Resource Control file system (/sys/fs/resctrl) can be bound from host to
416 container only if this directory exists on the host system. Otherwise omit
417 the '-v /sys/fs/resctrl:/sys/fs/resctrl' part in docker run command.
418 More information about resctrl can be found at:
419 https://github.com/intel/intel-cmt-cat/wiki/resctrl
421 Check your docker image is running
427 To make some changes when the container is running run:
431 sudo docker exec -ti <CONTAINER ID> /bin/bash
433 Run the barometer-collectd-latest docker image
434 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
435 Run command for ``barometer-collectd-latest`` container is very similar to
436 command used for stable container - the only differences are name of the image
437 and location of the sample configuration files (as different version of
438 collectd plugins requiring different configuration files)
443 $ cd <BAROMETER_REPO_DIR>
444 $ sudo docker run -ti --net=host -v \
445 `pwd`/src/collectd/collectd_sample_configs-latest:/opt/collectd/etc/collectd.conf.d \
446 -v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl \
447 --privileged opnfv/barometer-collectd-latest
450 Barometer collectd docker images are sharing some directories with host
451 (e.g. /tmp) therefore only one of collectd barometer flavors can be run
452 at a time. In other words, if you want to try `barometer-collectd-latest` or
453 `barometer-collectd-experimental` image, please stop instance of
454 `barometer-collectd(stable)` image first.
456 The Resource Control file system (/sys/fs/resctrl) can be bound from host to
457 container only if this directory exists on the host system. Otherwise omit
458 the '-v /sys/fs/resctrl:/sys/fs/resctrl' part in docker run command.
459 More information about resctrl can be found at:
460 https://github.com/intel/intel-cmt-cat/wiki/resctrl
462 Run the barometer-collectd-experimental docker image
463 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
464 Barometer-collectd-experimental container shares default configuration files
465 with 'barometer-collectd-latest' equivalent but some of experimental pull
466 requests may require modified configuration. Additional configuration files that
467 are required specifically by experimental container can be found in
468 `docker/barometer-collectd-experimental/experimental-configs/`
469 directory. Content of this directory (all \*.conf files) should be copied to
470 ``src/collectd/collectd_sample_configs-latest`` directory before first run of
471 experimental container.
475 $ cd <BAROMETER_REPO_DIR>
476 $ cp docker/barometer-collectd-experimental/experimental-configs/*.conf \
477 src/collectd/collectd_sample_configs-latest
479 When configuration files are up to date for experimental container, it can be
480 launched using following command (almost identical to run-command for ``latest``
485 $ cd <BAROMETER_REPO_DIR>
486 $ sudo docker run -ti --net=host -v \
487 `pwd`/src/collectd/collectd_sample_configs-latest:/opt/collectd/etc/collectd.conf.d \
488 -v /var/run:/var/run -v /tmp:/tmp -v /sys/fs/resctrl:/sys/fs/resctrl --privileged \
489 opnfv/barometer-collectd-experimental
492 The Resource Control file system (/sys/fs/resctrl) can be bound from host to
493 container only if this directory exists on the host system. Otherwise omit
494 the '-v /sys/fs/resctrl:/sys/fs/resctrl' part in docker run command.
495 More information about resctrl can be found at:
496 https://github.com/intel/intel-cmt-cat/wiki/resctrl
499 Build and Run InfluxDB and Grafana docker images
500 ------------------------------------------------
504 The barometer-influxdb image is based on the influxdb:1.3.7 image from the influxdb dockerhub. To
505 view detils on the base image please visit
506 `https://hub.docker.com/_/influxdb/ <https://hub.docker.com/_/influxdb/>`_ Page includes details of
507 exposed ports and configurable enviromental variables of the base image.
509 The barometer-grafana image is based on grafana:4.6.3 image from the grafana dockerhub. To view
510 details on the base image please visit
511 `https://hub.docker.com/r/grafana/grafana/ <https://hub.docker.com/r/grafana/grafana/>`_ Page
512 includes details on exposed ports and configurable enviromental variables of the base image.
514 The barometer-grafana image includes pre-configured source and dashboards to display statistics exposed
515 by the barometer-collectd image. The default datasource is an influxdb database running on localhost
516 but the address of the influxdb server can be modified when launching the image by setting the
517 environmental variables influxdb_host to IP or hostname of host on which influxdb server is running.
519 Additional dashboards can be added to barometer-grafana by mapping a volume to /opt/grafana/dashboards.
520 Incase where a folder is mounted to this volume only files included in this folder will be visible
521 inside barometer-grafana. To ensure all default files are also loaded please ensure they are included in
522 volume folder been mounted. Appropriate example are given in section `Run the Grafana docker image`_
524 Download the InfluxDB and Grafana docker images
525 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
526 If you wish to use pre-built barometer project's influxdb and grafana images, you can pull the
527 images from https://hub.docker.com/r/opnfv/barometer-influxdb/ and https://hub.docker.com/r/opnfv/barometer-grafana/
530 If your preference is to build images locally please see sections `Build InfluxDB Docker Image`_ and
531 `Build Grafana Docker Image`_
535 $ docker pull opnfv/barometer-influxdb
536 $ docker pull opnfv/barometer-grafana
539 If you have pulled the pre-built barometer-influxdb and barometer-grafana images there is no
540 requirement to complete steps outlined in sections `Build InfluxDB Docker Image`_ and
541 `Build Grafana Docker Image`_ and you can proceed directly to section
542 `Run the Influxdb and Grafana Images`_
544 Build InfluxDB docker image
545 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
547 Build influxdb image from Dockerfile
551 $ cd barometer/docker/barometer-influxdb
552 $ sudo docker build -t opnfv/barometer-influxdb --build-arg http_proxy=`echo $http_proxy` \
553 --build-arg https_proxy=`echo $https_proxy` --network=host -f Dockerfile .
556 In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs to
557 be passed only if system is behind an HTTP or HTTPS proxy server.
559 Check the docker images:
565 Output should contain an influxdb image:
569 REPOSITORY TAG IMAGE ID CREATED SIZE
570 opnfv/barometer-influxdb latest 1e4623a59fe5 3 days ago 191MB
572 Build Grafana docker image
573 ^^^^^^^^^^^^^^^^^^^^^^^^^^
575 Build Grafana image from Dockerfile
579 $ cd barometer/docker/barometer-grafana
580 $ sudo docker build -t opnfv/barometer-grafana --build-arg http_proxy=`echo $http_proxy` \
581 --build-arg https_proxy=`echo $https_proxy` -f Dockerfile .
584 In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs to
585 be passed only if system is behind an HTTP or HTTPS proxy server.
587 Check the docker images:
593 Output should contain an influxdb image:
597 REPOSITORY TAG IMAGE ID CREATED SIZE
598 opnfv/barometer-grafana latest 05f2a3edd96b 3 hours ago 1.2GB
600 Run the Influxdb and Grafana Images
601 -----------------------------------
603 Run the InfluxDB docker image
604 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
607 $ sudo docker run -tid -v /var/lib/influxdb:/var/lib/influxdb --net=host\
608 --name bar-influxdb opnfv/barometer-influxdb
610 Check your docker image is running
616 To make some changes when the container is running run:
620 sudo docker exec -ti <CONTAINER ID> /bin/bash
622 When both collectd and InfluxDB containers are located
623 on the same host, then no additional configuration have to be added and you
624 can proceed directly to `Run the Grafana docker image`_ section.
626 Modify collectd to support InfluxDB on another host
627 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
628 If InfluxDB and collectd containers are located on separate hosts, then
629 additional configuration have to be done in ``collectd`` container - it
630 normally sends data using network plugin to 'localhost/127.0.0.1' therefore
631 changing output location is required:
633 1. Stop and remove running bar-collectd container (if it is running)
637 $ sudo docker ps #to get collectd container name
638 $ sudo docker rm -f <COLLECTD_CONTAINER_NAME>
640 2. Go to location where shared collectd config files are stored
644 $ cd <BAROMETER_REPO_DIR>
645 $ cd src/collectd/collectd_sample_configs
647 3. Edit content of ``network.conf`` file.
648 By default this file looks like that:
654 Server "127.0.0.1" "25826"
657 ``127.0.0.1`` string has to be replaced with the IP address of host where
658 InfluxDB container is running (e.g. ``192.168.121.111``). Edit this using your
659 favorite text editor.
661 4. Start again collectd container like it is described in
662 `Run the collectd stable docker image`_ chapter
666 $ cd <BAROMETER_REPO_DIR>
667 $ sudo docker run -ti --name bar-collectd --net=host -v \
668 `pwd`/src/collectd/collectd_sample_configs:/opt/collectd/etc/collectd.conf.d \
669 -v /var/run:/var/run -v /tmp:/tmp --privileged opnfv/barometer-collectd
671 Now collectd container will be sending data to InfluxDB container located on
672 remote Host pointed by IP configured in step 3.
674 Run the Grafana docker image
675 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
677 Connecting to an influxdb instance running on local system and adding own custom dashboards
681 $ cd <BAROMETER_REPO_DIR>
682 $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana \
683 -v ${PWD}/docker/barometer-grafana/dashboards:/opt/grafana/dashboards \
684 --name bar-grafana --net=host opnfv/barometer-grafana
686 Connecting to an influxdb instance running on remote system with hostname of someserver and IP address
691 $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana --net=host -e \
692 influxdb_host=someserver --add-host someserver:192.168.121.111 --name \
693 bar-grafana opnfv/barometer-grafana
695 Check your docker image is running
701 To make some changes when the container is running run:
705 sudo docker exec -ti <CONTAINER ID> /bin/bash
707 Connect to <host_ip>:3000 with a browser and log into grafana: admin/admin
709 Cleanup of influxdb/grafana configuration
710 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
712 When user wants to remove current grafana and influxdb configuration,
713 folowing actions have to be performed
715 1. Stop and remove running influxdb and grafana containers
719 sudo docker rm -f bar-grafana bar-influxdb
721 2. Remove shared influxdb and grafana folders from the Host
725 sudo rm -rf /var/lib/grafana
726 sudo rm -rf /var/lib/influxdb
729 Shared folders are storing configuration of grafana and influxdb
730 containers. In case of changing influxdb or grafana configuration
731 (e.g. moving influxdb to another host) it is good to perform cleanup
732 on shared folders to not affect new setup with an old configuration.
734 Build and Run VES and Kafka Docker Images
735 -----------------------------------------
737 Download VES and Kafka docker images
738 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
740 If you wish to use pre-built barometer project's VES and kafka images, you can pull the
741 images from https://hub.docker.com/r/opnfv/barometer-ves/ and https://hub.docker.com/r/opnfv/barometer-kafka/
744 If your preference is to build images locally please see sections `Build the Kafka Image`_ and
749 $ docker pull opnfv/barometer-kafka
750 $ docker pull opnfv/barometer-ves
753 If you have pulled the pre-built images there is no requirement to complete steps outlined
754 in sections `Build Kafka Docker Image`_ and `Build VES Docker Image`_ and you can proceed directly to section
755 `Run Kafka Docker Image`_
757 Build Kafka docker image
758 ^^^^^^^^^^^^^^^^^^^^^^^^
760 Build Kafka docker image:
764 $ cd barometer/docker/barometer-kafka
765 $ sudo docker build -t opnfv/barometer-kafka --build-arg http_proxy=`echo $http_proxy` \
766 --build-arg https_proxy=`echo $https_proxy` -f Dockerfile .
769 In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs
770 to be passed only if system is behind an HTTP or HTTPS proxy server.
772 Check the docker images:
778 Output should contain a barometer image:
782 REPOSITORY TAG IMAGE ID CREATED SIZE
783 opnfv/barometer-kafka latest 05f2a3edd96b 3 hours ago 1.2GB
785 Build VES docker image
786 ^^^^^^^^^^^^^^^^^^^^^^
788 Build VES application docker image:
792 $ cd barometer/docker/barometer-ves
793 $ sudo docker build -t opnfv/barometer-ves --build-arg http_proxy=`echo $http_proxy` \
794 --build-arg https_proxy=`echo $https_proxy` -f Dockerfile .
797 In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs
798 to be passed only if system is behind an HTTP or HTTPS proxy server.
800 Check the docker images:
806 Output should contain a barometer image:
810 REPOSITORY TAG IMAGE ID CREATED SIZE
811 opnfv/barometer-ves latest 05f2a3edd96b 3 hours ago 1.2GB
813 Run Kafka docker image
814 ^^^^^^^^^^^^^^^^^^^^^^
817 Before running Kafka an instance of Zookeeper must be running for the Kafka broker to register
818 with. Zookeeper can be running locally or on a remote platform. Kafka's broker_id and address of
819 its zookeeper instance can be configured by setting values for environmental variables 'broker_id'
820 and 'zookeeper_node'. In instance where 'broker_id' and/or 'zookeeper_node' is not set the default
821 setting of broker_id=0 and zookeeper_node=localhost is used. In intance where Zookeeper is running
822 on same node as Kafka and there is a one to one relationship between Zookeeper and Kafka, default
823 setting can be used. The docker argument `add-host` adds hostname and IP address to
824 /etc/hosts file in container
826 Run zookeeper docker image:
830 $ sudo docker run -tid --net=host -p 2181:2181 zookeeper:3.4.11
832 Run kafka docker image which connects with a zookeeper instance running on same node with a 1:1 relationship
836 $ sudo docker run -tid --net=host -p 9092:9092 opnfv/barometer-kafka
839 Run kafka docker image which connects with a zookeeper instance running on a node with IP address of
840 192.168.121.111 using broker ID of 1
844 $ sudo docker run -tid --net=host -p 9092:9092 --env broker_id=1 --env zookeeper_node=zookeeper --add-host \
845 zookeeper:192.168.121.111 opnfv/barometer-kafka
847 Run VES Application docker image
848 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
850 VES application uses configuration file ves_app_config.conf from directory
851 barometer/3rd_party/collectd-ves-app/ves_app/config/ and host.yaml file from
852 barometer/3rd_party/collectd-ves-app/ves_app/yaml/ by default. If you wish to use a custom config
853 file it should be mounted to mount point /opt/ves/config/ves_app_config.conf. To use an alternative yaml
854 file from folder barometer/3rd_party/collectd-ves-app/ves_app/yaml the name of the yaml file to use
855 should be passed as an additional command. If you wish to use a custom file the file should be
856 mounted to mount point /opt/ves/yaml/ Please see examples below
858 Run VES docker image with default configuration
862 $ sudo docker run -tid --net=host opnfv/barometer-ves
864 Run VES docker image with guest.yaml files from barometer/3rd_party/collectd-ves-app/ves_app/yaml/
868 $ sudo docker run -tid --net=host opnfv/barometer-ves guest.yaml
871 Run VES docker image with using custom config and yaml files. In example below yaml/ folder cotains
872 file named custom.yaml
876 $ sudo docker run -tid --net=host -v ${PWD}/custom.config:/opt/ves/config/ves_app_config.conf \
877 -v ${PWD}/yaml/:/opt/ves/yaml/ opnfv/barometer-ves custom.yaml
879 Run VES Test Collector application
880 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
882 VES Test Collector application can be used for displaying platform
883 wide metrics that are collected by barometer-ves container.
884 Setup instructions are located in: :ref:`Setup VES Test Collector`
886 Build and Run DMA and Redis Docker Images
887 -----------------------------------------
889 Download DMA docker images
890 ^^^^^^^^^^^^^^^^^^^^^^^^^^
892 If you wish to use pre-built barometer project's DMA images, you can pull the
893 images from https://hub.docker.com/r/opnfv/barometer-dma/
896 If your preference is to build images locally please see sections `Build DMA Docker Image`_
900 $ docker pull opnfv/barometer-dma
903 If you have pulled the pre-built images there is no requirement to complete steps outlined
904 in sections `Build DMA Docker Image`_ and you can proceed directly to section
905 `Run DMA Docker Image`_
907 Build DMA docker image
908 ^^^^^^^^^^^^^^^^^^^^^^
910 Build DMA docker image:
914 $ cd barometer/docker/barometer-dma
915 $ sudo docker build -t opnfv/barometer-dma --build-arg http_proxy=`echo $http_proxy` \
916 --build-arg https_proxy=`echo $https_proxy` -f Dockerfile .
919 In the above mentioned ``docker build`` command, http_proxy & https_proxy arguments needs
920 to be passed only if system is behind an HTTP or HTTPS proxy server.
922 Check the docker images:
928 Output should contain a barometer image:
932 REPOSITORY TAG IMAGE ID CREATED SIZE
933 opnfv/barometer-dma latest 2f14fbdbd498 3 hours ago 941 MB
935 Run Redis docker image
936 ^^^^^^^^^^^^^^^^^^^^^^
939 Before running DMA, Redis must be running.
941 Run Redis docker image:
945 $ sudo docker run -tid -p 6379:6379 --name barometer-redis redis
947 Check your docker image is running
957 Run DMA docker image with default configuration
961 $ cd barometer/docker/barometer-dma
962 $ sudo mkdir /etc/barometer-dma
963 $ sudo cp ../../src/dma/examples/config.toml /etc/barometer-dma/
964 $ sudo vi /etc/barometer-dma/config.toml
965 (edit amqp_password and os_password:OpenStack admin password)
968 (When there is no key for SSH access authentication)
970 (Press Enter until done)
971 (Backup if necessary)
972 # cp ~/.ssh/authorized_keys ~/.ssh/authorized_keys_org
973 # cat ~/.ssh/authorized_keys_org ~/.ssh/id_rsa.pub \
974 > ~/.ssh/authorized_keys
977 $ sudo docker run -tid --net=host --name server \
978 -v /etc/barometer-dma:/etc/barometer-dma \
979 -v /root/.ssh/id_rsa:/root/.ssh/id_rsa \
980 -v /etc/collectd/collectd.conf.d:/etc/collectd/collectd.conf.d \
981 opnfv/barometer-dma /server
983 $ sudo docker run -tid --net=host --name infofetch \
984 -v /etc/barometer-dma:/etc/barometer-dma \
985 -v /var/run/libvirt:/var/run/libvirt \
986 opnfv/barometer-dma /infofetch
988 (Execute when installing the threshold evaluation binary)
989 $ sudo docker cp infofetch:/threshold ./
990 $ sudo ln -s ${PWD}/threshold /usr/local/bin/
994 .. [1] https://docs.docker.com/config/daemon/systemd/#httphttps-proxy
995 .. [2] https://docs.docker.com/engine/install/centos/#install-using-the-repository
996 .. [3] https://docs.docker.com/engine/userguide/