[ansible][fedora] Update package name
[barometer.git] / docs / release / userguide / installguide.oneclick.rst
index d236b5b..78203a1 100644 (file)
@@ -231,6 +231,36 @@ Verify that key is added and password is not required to connect.
    example. For multinode installation keys need to be copied for each node:
    [collectd_hostname], [influxdb_hostname] etc.
 
+Build the Collectd containers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This is an optional step, if you do not wish to build the containers locally, please continue to `Download and run Collectd+Influxdb+Grafana containers`_.
+This step will build the container images locally, allowing for testing of new changes to collectd.
+This is particularly useful for the ``experimental`` flavour for testing PRs, and for building a ``collectd-6`` container.
+
+To run the playbook and build the containers, run::
+    sudo ansible-playbook docker/ansible/collectd_build.yml
+
+By default, all contaienrs will be built.
+Since this can take a while, it is recommended that you choose a flavor to build using tags::
+
+    sudo ansible-playbook docker/ansible/collectd_build.yml --tags='collectd-6,latest'
+
+The available tags are:
+
+* *stable* builds the ``barometer-collectd`` image
+* *latest* builds the ``barometer-collectd-latest`` image
+* *experimental* builds the ``barometer-collectd-experimental`` container, with optional PRs
+* *collectd-6* builds the ``baromter-collectd-6`` container, with optional PR(s)
+
+* *flask_test* builds a small webapp that displays the metrics sent via the write_http plugin
+
+.. note::
+   The flask_test tag must be explicitly enabled.
+   This can be done either through the ``--tags='flask_test'`` (to build just
+   this container) or with ``--tags=all`` to build this and all the other
+   containers as well.
+
 Download and run Collectd+Influxdb+Grafana containers
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -247,10 +277,10 @@ Check the three containers are running, the output of ``docker ps`` should be si
 .. code:: bash
 
     $ sudo docker ps
-    CONTAINER ID        IMAGE                      COMMAND                  CREATED             STATUS              PORTS               NAMES
-    a033aeea180d        opnfv/barometer-grafana    "/run.sh"                9 days ago          Up 7 minutes                            bar-grafana
-    1bca2e4562ab        opnfv/barometer-influxdb   "/entrypoint.sh in..."   9 days ago          Up 7 minutes                            bar-influxdb
-    daeeb68ad1d5        opnfv/barometer-collectd   "/run_collectd.sh ..."   9 days ago          Up 7 minutes                            bar-collectd
+    CONTAINER ID   IMAGE                       COMMAND                  CREATED             STATUS         PORTS     NAMES
+    4c2143fb6bbd   anuket/barometer-grafana    "/run.sh"                59 minutes ago      Up 4 minutes             bar-grafana
+    5e356cb1cb04   anuket/barometer-influxdb   "/entrypoint.sh infl…"   59 minutes ago      Up 4 minutes             bar-influxdb
+    2ddac8db21e2   anuket/barometer-collectd   "/run_collectd.sh"       About an hour ago   Up 4 minutes             bar-collectd
 
 To make some changes when a container is running run:
 
@@ -284,10 +314,10 @@ Check the containers are running, the output of ``docker ps`` should be similar
 
     $ sudo docker ps
     CONTAINER ID        IMAGE                      COMMAND                  CREATED             STATUS                     PORTS               NAMES
-    29035be2dab5        zookeeper:3.4.11           "/docker-entrypoint._"   7 minutes ago       Up 7 minutes                                   bar-zookeeper
-    eb8bba3c0b76        opnfv/barometer-ves        "./start_ves_app.s..."   6 minutes ago       Up 6 minutes                                   bar-ves
-    86702a96a68c        opnfv/barometer-kafka      "/src/start_kafka.sh"    6 minutes ago       Up 6 minutes                                   bar-kafka
-    daeeb68ad1d5        opnfv/barometer-collectd   "/run_collectd.sh ..."   6 minutes ago       Up 6 minutes                                   bar-collectd
+    d041d8fff849        zookeeper:3.4.11           "/docker-entrypoint.…"   2 minutes ago       Up 2 minutes                                   bar-zookeeper
+    da67b81274bc        anuket/barometer-ves       "./start_ves_app.sh …"   2 minutes ago       Up 2 minutes                                   bar-ves
+    2c25e0c79f93        anuket/barometer-kafka     "/src/start_kafka.sh"    2 minutes ago       Up 2 minutes                                   bar-kafka
+    b161260c90ed        anuket/barometer-collectd  "/run_collectd.sh"       2 minutes ago       Up 2 minutes                                   bar-collectd
 
 
 To make some changes when a container is running run:
@@ -319,8 +349,9 @@ the following plugins:
   ``ethstat``, ``ipc``, ``irq``, ``load``, ``memory``, ``numa``,
   ``processes``, ``swap``, ``turbostat``, ``uuid``, ``uptime``, ``exec``,
   ``hugepages``, ``intel_pmu``, ``ipmi``, ``write_kafka``, ``logfile``,
-  ``mcelog``, ``network``, ``intel_rdt``, ``rrdtool``, ``snmp_agent``,
-  ``syslog``, ``virt``, ``ovs_stats``, ``ovs_events``, ``dpdk_telemetry``
+  ``logparser``, ``mcelog``, ``network``, ``intel_rdt``, ``rrdtool``,
+  ``snmp_agent``, ``syslog``, ``virt``, ``ovs_stats``, ``ovs_events``,
+  ``dpdk_telemetry``.
 
 .. note::
    Some of the plugins are loaded depending on specific system requirements and can be omitted if
@@ -330,15 +361,6 @@ the following plugins:
 
    For instructions on how to disable certain plugins see the `List and description of tags used in ansible scripts`_ section.
 
-.. note::
-   The ``dpdkstat`` and ``dpdkevents`` plugins are disabled by default (in
-   favour of the ``dpdk_telemetry`` plugin) and need to be explicitly enabled
-   in order to use them:
-
-   .. code:: bash
-
-     $ sudo ansible-playbook -i default.inv collectd_service.yml --tags "all,dpdkstats,dpdkevents"
-
 List and description of tags used in ansible scripts
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -382,7 +404,7 @@ List of available tags:
   ``contextswitch``, ``cpu``, ``cpufreq``, ``df``, ``disk,`` ``ethstat``,
   ``ipc``, ``irq``, ``load``, ``memory``, ``numa``, ``processes``, ``swap``,
   ``turbostat``, ``uptime``, ``exec``, ``hugepages``, ``ipmi``, ``kafka``,
-  ``logfile``, ``mcelog``, ``network``, ``pmu``, ``rdt``, ``rrdtool``,
-  ``snmp``, ``syslog``, ``unixsock``, ``virt``, ``ovs_stats``, ``ovs_events``,
-  ``uuid``, ``dpdkevents``, ``dpdkstat``, ``dpdk_telemetry``.
+  ``logfile``, ``logparser``, ``mcelog``, ``network``, ``pmu``, ``rdt``,
+  ``rrdtool``, ``snmp``, ``syslog``, ``unixsock``, ``virt``, ``ovs_stats``,
+  ``ovs_events``, ``uuid``, ``dpdk_telemetry``.