zuul-jobs/roles/emit-ara-html/README.rst
David Moreau Simard 40ef3c084e
Deprecate the emit-ara-html role
This adds a deprecation notice to the README and a debug task that
prints a deprecation notice.
The role is still expected to work but will eventually be removed in
favor of the ara-report role.

This deprecation will be announced on openstack-dev and zuul-announce.

Depends-On: https://review.openstack.org/#/c/557818/
Change-Id: If25e7c7b93cfd1588233fec299a31ad3ce3a873f
2018-03-29 16:29:20 -04:00

1.2 KiB

THIS ROLE IS DEPRECATED, please use the ara-report role instead. ara-report provides the same default behavior with the generation of a HTML report and provides additional functionality that can be used to dynamically load databases for improved performance and scalability.

Have ARA generate html logs if ARA and ARA data are both present.

Role Variables

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.

Whether to compress the ARA HTML output or not. Defaults to true.

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.