aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGordon Kelly <gordon.kelly@intel.com>2018-01-23 14:54:09 +0000
committerMaryam Tahhan <maryam.tahhan@intel.com>2018-01-23 16:24:57 +0000
commit78fdcdc56a247328d6f84c45477bbea51bddf094 (patch)
tree7fc3fc56aea4892b5d6ebb09a8cf62395602c890
parent76466382916a657916a72d0ec66e24af4356a153 (diff)
docs: update docker userguide for running docker compose files
Change-Id: Ib41d6d475506ff3920bb914aeebf9dca4070fa8c Signed-off-by: gordonkelly <gordon.kelly@intel.com>
-rw-r--r--docs/release/userguide/docker.userguide.rst93
1 files changed, 87 insertions, 6 deletions
diff --git a/docs/release/userguide/docker.userguide.rst b/docs/release/userguide/docker.userguide.rst
index f0fa46e4..2a78bc95 100644
--- a/docs/release/userguide/docker.userguide.rst
+++ b/docs/release/userguide/docker.userguide.rst
@@ -312,7 +312,7 @@ environmental variables influxdb_host to IP or hostname of host on which influxd
Additional dashboards can be added to barometer-grafana by mapping a volume to /opt/grafana/dashboards.
Incase where a folder is mounted to this volume only files included in this folder will be visible
inside barometer-grafana. To ensure all default files are also loaded please ensure they are included in
-volume folder been mounted. Appropriate example are given in section ``Run the Grafana docker image``
+volume folder been mounted. Appropriate example are given in section `Run the Grafana docker image`_
Download the InfluxDB and Grafana docker image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -320,14 +320,22 @@ If you wish to use pre-built barometer project's influxdb and grafana images, yo
images from https://hub.docker.com/r/opnfv/barometer-influxdb/ and https://hub.docker.com/r/opnfv/barometer-grafana/
.. note::
- If your preference is to build images locally please see sections `Build the InfluxDB Image`_ and
- `Build the Grafana Image`_
+ If your preference is to build images locally please see sections `Build the InfluxDB Image`_ and
+ `Build the Grafana Image`_
.. code:: bash
$ docker pull opnfv/barometer-influxdb
$ docker pull opnfv/barometer-grafana
+.. note::
+ If you have pulled the pre-built barometer-influxdb and barometer-grafana images there is no
+ requirement to complete steps outlined in sections `Build the InfluxDB Image`_ and
+ `Build the Grafana Image`_ and you can proceed directly to section
+ `Run the Influxdb and Grafana Images`_ If you wish to run the barometer-influxdb and
+ barometer-grafana images via Docker Compose proceed directly to section
+ `Docker Compose`_.
+
Build the InfluxDB Image
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -384,7 +392,8 @@ Output should contain an influxdb image:
opnfv/barometer-grafana latest 05f2a3edd96b 3 hours ago 1.2GB
Run the Influxdb and Grafana Images
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------------
+
Run the InfluxDB docker image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: bash
@@ -403,7 +412,7 @@ Check your docker image is running
sudo docker ps
-Run the Grafana docker image
+Run the Grafana docker image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Connecting to an influxdb instance running on local system and adding own custom dashboards
@@ -430,9 +439,81 @@ Check your docker image is running
sudo docker ps
+Connect to <host_ip>:3000 with a browser and log into grafana: admin/admin
+
+Docker Compose
+--------------
+
+Install docker-compose
+^^^^^^^^^^^^^^^^^^^^^^
+
+On the node where you want to run influxdb + grafana or the node where you want to run the VES app
+zookeeper and Kafka containers together:
+
+.. note::
+ The default configuration for all these containers is to run on the localhost. If this is not
+ the model you want to use then please make the appropriate configuration changes before launching
+ the docker containers.
+
+1. Start by installing docker compose
+
+.. code:: bash
+
+ $ sudo curl -L https://github.com/docker/compose/releases/download/1.17.0/docker-compose-`uname -s`-`uname -m` -o /usr/bin/docker-compose
+
+.. note::
+ Use the latest Compose release number in the download command. The above command is an example,
+ and it may become out-of-date. To ensure you have the latest version, check the Compose repository
+ release page on GitHub.
+
+2. Apply executable permissions to the binary:
+
+.. code:: bash
+
+ $ sudo chmod +x /usr/bin/docker-compose
+
+3. Test the installation.
+
+.. code:: bash
+
+ $ sudo docker-compose --version
+
+Run the InfluxDB and Grafana containers using docker compose
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Launch containers:
+
+.. code:: bash
+
+ $ cd barometer/docker/compose/influxdb-grafana/
+ $ sudo docker-compose up -d
+
+Check your docker images are running
+
+.. code:: bash
+
+ $ sudo docker ps
+
+Connect to <host_ip>:3000 with a browser and log into grafana: admin/admin
+
+Run the Kafka, zookeeper and VES containers using docker compose
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Launch containers:
+
+.. code:: bash
+
+ $ cd barometer/docker/compose/ves/
+ $ sudo docker-compose up -d
+
+Check your docker images are running
+
+.. code:: bash
+
+ $ sudo docker ps
+
Testing the docker image
^^^^^^^^^^^^^^^^^^^^^^^^
-
TODO
References