diff options
author | Emma Foley <efoley@redhat.com> | 2021-04-23 19:46:57 +0100 |
---|---|---|
committer | Emma Foley <efoley@redhat.com> | 2021-12-17 09:48:20 +0000 |
commit | f3051b17dfc6e45f6cec50940c560e4cbb1d3774 (patch) | |
tree | 5705509ba0455e37fb84e999a5fc8a534575038e /docs | |
parent | c79ce380d9f8d3e582a1e7b13e1ce116312f5c64 (diff) |
[docker][ansible] Add a playbook for building the containers
To run the playbook and build the containers, run::
sudo ansible-playbook docker/ansible/collectd_build.yml
Change-Id: I60e044f09c8da53f6d5a56d2aaa7b837b19a0b0b
Signed-off-by: Emma Foley <efoley@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/release/release-notes/notes/ansible-build-containers-b4a4cc9cb70f83b3.yaml | 11 | ||||
-rw-r--r-- | docs/release/userguide/installguide.oneclick.rst | 30 |
2 files changed, 41 insertions, 0 deletions
diff --git a/docs/release/release-notes/notes/ansible-build-containers-b4a4cc9cb70f83b3.yaml b/docs/release/release-notes/notes/ansible-build-containers-b4a4cc9cb70f83b3.yaml new file mode 100644 index 00000000..aae4b999 --- /dev/null +++ b/docs/release/release-notes/notes/ansible-build-containers-b4a4cc9cb70f83b3.yaml @@ -0,0 +1,11 @@ +release_summary: > + Add ansible playbook for building the containers locally. +ansible: + - | + Added a playbook and role for building the collectd containers locally. + This automates the actions described in the docker install guide. The + ``barometer-collectd``, ``barometer-collectd-latest`` and the + ``barometer-collectd-experimental`` containers are now easier to build + locally. The ``barometer-collectd-6`` and + ``barometer-collectd-experimental`` containers can also be built with + arbirtary PRs applied, to aid in testing locally. 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |