README.md

check-compose

check-compose is a simple script for running various informational checks on a Fedora release or 'compose'. It will check for expected images that are missing and check for openQA test jobs for the compose and print some information on their status, if the system where the check is running is correctly configured to talk to an openQA server. Two fedmsg consumers that listen for 'compose complete' messages and run check-compose on the new composes are also included, one for production, one for testing.

Requirements

Python libraries:

If openqa_client is not available, openQA job checking will not be done. If fedmsg is not available, you will not be able to use the fedmsg consumer.

Installation

Install the required external Python libraries, then run python setup.py install. The fedmsg consumer config keys are checkcomp_consumer.prod.enabled and checkcomp_consumer.test.enabled. The test consumer listens for dev not prod messages and does not validate signatures (so it will consume messages sent by fedmsg-dg-replay), and does not send email regardless of what the check-compose configuration says; the report is printed to console, so if you run fedmsg-hub at a terminal you will see the report there, if you run it as a system service it should appear in the system logs (under fedmsg-hub service). The production consumer listens for prod messages and will respect the check-compose configuration file settings (so it will send out emails if you have email-from and email-to configured).

Configuration

check-compose will read configuration from /etc/check-compose.conf or ~/.config/check-compose.conf (with the latter taking priority if both exist). See check-compose.conf.sample for information on what you can set there. These and other options can also be set with command line arguments: arguments override config file settings, if passed.

License

check-compose is released under the GPL, version 3 or later. See COPYING and the header of check-compose itself.