diff options
author | Emma Foley <efoley@redhat.com> | 2021-12-17 13:07:53 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@opnfv.org> | 2021-12-17 13:07:53 +0000 |
commit | 18206d429dd42701fc21f82c5dbc323e8b7b2eb5 (patch) | |
tree | 76954f5145b1937e32d00e11faf8944e9b7ca1da /docs/release/userguide | |
parent | 1c7fea25a4084bafb52158c915e803b473ffbca0 (diff) | |
parent | 5cc8e3c94bdf62c5fd9838e4987d4e670d36f9ed (diff) |
Merge changes from topic "collectd_6_testing"
* changes:
Add a playbook that tests collectd 6 vs collectd5
[docker][ansible] Add a playbook for building the containers
Create a flask app to show metrics from collectd
Diffstat (limited to 'docs/release/userguide')
-rw-r--r-- | docs/release/userguide/installguide.oneclick.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/release/userguide/installguide.oneclick.rst b/docs/release/userguide/installguide.oneclick.rst index ef3624cb..78203a12 100644 --- a/docs/release/userguide/installguide.oneclick.rst +++ b/docs/release/userguide/installguide.oneclick.rst @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |