zuul-jobs/roles/emit-ara-html/README.rst
David Moreau-Simard 6569f07107
Add the ability to generate an ARA report only on job failure
This changes the 'ara_generate_html' toggle to provide three options:
- true (always generate a report)
- false (never generate a report)
- 'failure' (only generate a report on failure, based on zuul_success)

This defaults to true and can be changed on a job basis.

Change-Id: I9a6a3c999b7656b1f5b25b0cb6c2baa63d7857b2
2017-10-12 17:43:41 -04:00

31 lines
902 B
ReStructuredText

Have ARA generate html logs if ARA and ARA data are both present.
**Role Variables**
.. zuul:rolevar:: ara_generate_html
Whether to generate a static ARA HTML report or not.
Possible values:
- ``true`` (always generate a report)
- ``false`` (never generate a report)
- ``failure`` (only generate a report on failure)
Defaults to ``true``.
.. zuul:rolevar:: ara_compress_html
Whether to compress the ARA HTML output or not.
Defaults to ``true``.
.. zuul:rolevar:: ara_save_database
Whether the ARA sqlite database should be saved as part of the logs.
Defaults to ``false``.
.. tip::
Make sure the web server is configured to set the required mimetypes_ in
order to serve gzipped content properly.
.. _mimetypes: https://git.openstack.org/cgit/openstack-infra/puppet-openstackci/tree/templates/logs.vhost.erb?id=5fe1f3d2d5e40c2458721e7dcf8631d62ea2525f#n24