openstack/kolla-ansible
Code Issues Proposed changes

CI: Add back ARA logging

Browse Source 
Up till now the ARA plugin has been pinned to a very old version,
and is no longer functional.

This installs a much newer version of ARA and adds a README file
to guide developers on how to view the sqlite file.

The ARA plugin is installed by default, but not activated. This
is intended to catch a small amount of regressions and
integration failures.

Developers can enable the plugin by adding the string `#ara`
to their commit message. This avoids extra load on the CI.

Change-Id: Id8328e374c9590b1363026fa2b2b24e191183987
This commit is contained in:
Jan Gutter
2023-08-10 19:29:33 +01:00
parent 26ba26cd18
commit 73dcad3263
5 changed files with 102 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc/source/contributor/ci.rst
View File

@@ -2,5 +2,29 @@
Continuous Integration (CI) & Testing
=====================================
This page is a placeholder for information on the Kolla Ansible Continuous
Integration (CI) & testing setup.
Kolla-Ansible uses
`Zuul <https://zuul.openstack.org/buildsets?project=openstack%2Fkolla-ansible&branch=master&pipeline=check>`__
for continuous integration. Similar to testing performed using
`devstack <https://docs.openstack.org/devstack/latest/>`__, Kolla-Ansible is
capable of integrating and testing pre-merged dependencies from many other
projects.
Debugging with ARA in CI
~~~~~~~~~~~~~~~~~~~~~~~~
Frequently, the need arises to obtain more verbose ansible logging in CI.
`ARA <https://ara.recordsansible.org/>`__ is an ansible plugin that collects a
large amount of execution information and can render it into a browser
friendly format.
This plugin is not enabled by default because there is a per-task overhead.
However, it's possible to trigger it when trying to debug a failing job.
By adding the text `#ara` to the git commit message of the review, the CI jobs
will enable the plugin and generate a sqlite database containing comprehensive
logging. It's possible to render an HTML version of this by using
`#ara_verbose`. Generating the HTML is not very efficient, however, and
consumes a large amount of logging resources.
Please note that git usually strips lines beginning with `#` from the commit
message. This can be avoided by preceding the string with a space.