diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release/userguide/collectd.ves.userguide.rst | 1 | ||||
| -rw-r--r-- | docs/release/userguide/docker.userguide.rst | 168 |
2 files changed, 82 insertions, 87 deletions
diff --git a/docs/release/userguide/collectd.ves.userguide.rst b/docs/release/userguide/collectd.ves.userguide.rst index 29de46a3..f56acbc0 100644 --- a/docs/release/userguide/collectd.ves.userguide.rst +++ b/docs/release/userguide/collectd.ves.userguide.rst @@ -317,6 +317,7 @@ Start collectd process as a service as described in :ref:`install-collectd-as-a- .. note:: The list of the plugins can be extented depends on your needs. +.. _Setup VES Test Collector: Setup VES Test Collector ------------------------ diff --git a/docs/release/userguide/docker.userguide.rst b/docs/release/userguide/docker.userguide.rst index ea260821..fe7711aa 100644 --- a/docs/release/userguide/docker.userguide.rst +++ b/docs/release/userguide/docker.userguide.rst @@ -97,6 +97,66 @@ which it normalizes into VES format for sending to a VES collector. Please see d One Click Install with Ansible ------------------------------ +Proxy for package manager on host +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. note:: + This step has to be performed only if host is behind HTTP/HTTPS proxy + +Proxy URL have to be set in dedicated config file + +1. CentOS - /etc/yum.conf + +.. code:: bash + + proxy=http://your.proxy.domain:1234 + +2. Ubuntu - /etc/apt/apt.conf + +.. code:: bash + + Acquire::http::Proxy "http://your.proxy.domain:1234" + +After update of config file, apt mirrors have to be updated via 'apt-get update' + +.. code:: bash + + $ sudo apt-get update + +Proxy environment variables(for docker and pip) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. note:: + This step has to be performed only if host is behind HTTP/HTTPS proxy + +Configuring proxy for packaging system is not enough, also some proxy +environment variables have to be set in the system before ansible scripts +can be started. +Barometer configures docker proxy automatically via ansible task as a part +of 'one click install' process - user only has to provide proxy URL using common +shell environment variables and ansible will automatically configure proxies +for docker(to be able to fetch barometer images). Another component used by +ansible (e.g. pip is used for downloading python dependencies) will also benefit +from setting proxy variables properly in the system. + +Proxy variables used by ansible One Click Install: + * http_proxy + * https_proxy + * ftp_proxy + * no_proxy + +Variables mentioned above have to be visible for superuser (because most +actions involving ansible-barometer installation require root privileges). +Proxy variables are commonly defined in '/etc/environment' file (but any other +place is good as long as variables can be seen by commands using 'su'). + +Sample proxy configuration in /etc/environment: + +.. code:: bash + + http_proxy=http://your.proxy.domain:1234 + https_proxy=http://your.proxy.domain:1234 + ftp_proxy=http://your.proxy.domain:1234 + no_proxy=localhost + Install Ansible ^^^^^^^^^^^^^^^ .. note:: @@ -394,8 +454,9 @@ Replace <username> above with an appropriate user name. From : https://download.docker.com/linux/centos/gpg Is this ok [y/N]: y -Proxy Configuration: -^^^^^^^^^^^^^^^^^^^^ +Manual proxy configuration for docker +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. note:: This applies for both CentOS and Ubuntu. @@ -613,9 +674,7 @@ images from https://hub.docker.com/r/opnfv/barometer-influxdb/ and https://hub.d If you have pulled the pre-built barometer-influxdb and barometer-grafana images there is no requirement to complete steps outlined in sections `Build InfluxDB Docker Image`_ and `Build Grafana Docker 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`_. + `Run the Influxdb and Grafana Images`_ Build InfluxDB docker image ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -680,7 +739,8 @@ Run the InfluxDB docker image ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: bash - $ sudo docker run -tid -v /var/lib/influxdb:/var/lib/influxdb -p 8086:8086 -p 25826:25826 opnfv/barometer-influxdb + $ sudo docker run -tid -v /var/lib/influxdb:/var/lib/influxdb --net=host\ + --name bar-influxdb opnfv/barometer-influxdb Check your docker image is running @@ -702,16 +762,18 @@ Connecting to an influxdb instance running on local system and adding own custom .. code:: bash $ cd <BAROMETER_REPO_DIR> - $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana -v ${PWD}/docker/barometer-grafana/dashboards:/opt/grafana/dashboards \ - -p 3000:3000 opnfv/barometer-grafana + $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana \ + -v ${PWD}/docker/barometer-grafana/dashboards:/opt/grafana/dashboards \ + --name bar-grafana --net=host opnfv/barometer-grafana Connecting to an influxdb instance running on remote system with hostname of someserver and IP address of 192.168.121.111 .. code:: bash - $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana -p 3000:3000 -e \ - influxdb_host=someserver --add-host someserver:192.168.121.111 opnfv/barometer-grafana + $ sudo docker run -tid -v /var/lib/grafana:/var/lib/grafana --net=host -e \ + influxdb_host=someserver --add-host someserver:192.168.121.111 --name \ + bar-grafana opnfv/barometer-grafana Check your docker image is running @@ -749,7 +811,7 @@ images from https://hub.docker.com/r/opnfv/barometer-ves/ and https://hub.docke .. note:: If you have pulled the pre-built images there is no requirement to complete steps outlined in sections `Build Kafka Docker Image`_ and `Build VES Docker Image`_ and you can proceed directly to section - `Run Kafka Docker Image`_ If you wish to run the docker images via Docker Compose proceed directly to section `Docker Compose`_. + `Run Kafka Docker Image`_ Build Kafka docker image ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -873,6 +935,13 @@ file named custom.yaml $ sudo docker run -tid --net=host -v ${PWD}/custom.config:/opt/ves/config/ves_app_config.conf \ -v ${PWD}/yaml/:/opt/ves/yaml/ opnfv/barometer-ves custom.yaml +Run VES Test Collector application +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +VES Test Collector application can be used for displaying platform +wide metrics that are collected by barometer-ves container. +Setup instructions are located in: :ref:`Setup VES Test Collector` + Build and Run LocalAgent and Redis Docker Images ----------------------------------------------------- @@ -892,7 +961,7 @@ images from https://hub.docker.com/r/opnfv/barometer-localagent/ .. note:: If you have pulled the pre-built images there is no requirement to complete steps outlined in sections `Build LocalAgent Docker Image`_ and you can proceed directly to section - `Run LocalAgent Docker Image`_ If you wish to run the docker images via Docker Compose proceed directly to section `Docker Compose`_. + `Run LocalAgent Docker Image`_ Build LocalAgent docker image ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -979,81 +1048,6 @@ Run LocalAgent docker image with default configuration $ sudo docker cp infofetch:/threshold ./ $ sudo ln -s ${PWD}/threshold /usr/local/bin/ -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 ^^^^^^^^^^^ .. [1] https://docs.docker.com/engine/admin/systemd/#httphttps-proxy |