From d49c6ba0cc7f5892c65c67afdaa1ee77ce3aa182 Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Wed, 21 Apr 2021 14:37:13 +0100 Subject: [docker] Add collectd-6 * Add instruction to docs/ for using docker/barometer-collectd-experimental/Dockerfile to build collectd version 6 * Add a new COLLECTD_FLAVOR to src/collectd/Makefile to configure tags for a collectd 6 build. * Allow passing COLLECTD_CONFIG_CMD_ARGS to the collectd build For testing with new plugins for collectd-6, as un-ported plugins are disabled by default. This new option lets the ./configure command be run with extra args, e.g. --enable-cpu --enable-, which means that plugin can be enabled for the PR that is being tested. * Update flavor_image_name selection to include collectd-6 Change-Id: I55ee0bbcb5d89357b1ef11ab17c5b029603ecdf7 Signed-off-by: Emma Foley --- docs/release/userguide/installguide.docker.rst | 38 ++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) (limited to 'docs/release/userguide') diff --git a/docs/release/userguide/installguide.docker.rst b/docs/release/userguide/installguide.docker.rst index ca113c65..f44ac994 100644 --- a/docs/release/userguide/installguide.docker.rst +++ b/docs/release/userguide/installguide.docker.rst @@ -382,6 +382,44 @@ COLLECTD_PULL_REQUESTS should be a comma-delimited string of pull request IDs. proxy parameters should be passed only if system is behind an HTTP or HTTPS proxy server (same as for stable collectd container) +Build collectd-6 +^^^^^^^^^^^^^^^^ + +The barometer-collectd-experimental Dockerfile can be used to build +collectd-6.0, which is currently under development. In order to do this, the +``COLLECTD_FLAVOR`` build arg can be passed to the docker build command. +The optional ``COLLECTD_PULL_REQUESTS`` arg can be passed as well, to test +proposed patches to collectd. + +.. code:: bash + + $ cd + $ sudo docker build -t opnfv/barometer-collectd-6 \ + --build-arg COLLECTD_FLAVOR=collectd-6 \ + --build-arg COLLECTD_PULL_REQUESTS=1234,5678 \ + --network=host -f docker/barometer-collectd-experimental/Dockerfile . + +The instructions for running the collectd-6 container are the same as for the +collectd-experimental container. + +There are a few useful build args that can be used to further customise the +collectd-6 build:: + +* COLLECTD_CONFIG_CMD_ARGS + For testing with new plugins for collectd-6, as un-ported plugins are + disabled by default. + This new option lets the ./configure command be run with extra args, + e.g. --enable-cpu --enable-, which means that + plugin can be enabled for the PR that is being tested. + +* COLLECTD_TAG + This overrides the default tag selected by the flavors, and allows checking + out out an arbitrary branch (e.g. PR branch instead of using the + ``COLLECTD_PULL_REQUESTS`` arg, which rebases each PR on top of the + nominal branch. + To check out a PR, use the following args with the docker build command: + ``--build-arg COLLECTD_TAG=pull//head`` + Run the collectd stable docker image ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: bash -- cgit 1.2.3-korg