relvalconsumer 2.0.0

Requirements

Python libraries:

• fedora-messaging

• fedfind

• wikitcms

• mwclient

The hawkey library is also required. This is only available on Fedora and RHEL and is only available from official package repositories, it is not available from Pypi.

Optionally also relval itself, to run image size check tests on the created events.

Installation

Install the required external Python libraries, then use setuptools to install, e.g.:

python3 setup.py install

You will also typically need to do:

dnf install fedora-messaging python3-hawkey

Configuration

A sample configuration file which is set up to listen for real compose events on the production fedora-messaging bus is provided as relvalconsumer.toml. To use this, you must at least change the queue name from 00000000-0000-0000-0000-000000000000 to a unique and private string; the official recommendation is to use a UUID generated by uuidgen. Then place the file in /etc/fedora-messaging.

You can then enable and start the consumer as a systemd service:

sudo systemctl enable fm-consumer@relvalconsumer
sudo systemctl start fm-consumer@relvalconsumer

Test and production modes

A configuration setting, relval_prod, decides whether the consumer operates in ‘production’ or ‘test’ mode. This is set in the consumer configuration file’s consumer_config section. In test mode:

• The consumer creates events on the staging wiki (not production wiki)

• The announcement email is logged rather than being mailed out

In this mode it is fairly safe to play around with the consumer. You will need a local fedora-messaging broker instance to be able to trigger the consumer at will, though. Depending on how you set that up, you may also need to change the routing_keys from .prod. to .dev. or similar.

For ‘production’:

• The consumer creates events on the production wiki

• The consumer sends email notifications to public mailing lists

PLEASE do not enable the production consumer unless you’re absolutely sure it’s your job to create the official events.

License

relvalconsumer is released under the GPL, version 3 or later. See COPYING and the header of relvalconsumer.py itself.

Contributing

Issues and pull requests can be filed in Pagure. Pull requests must be signed off (use the -s git argument). By signing off your pull request you are agreeing to the Developer’s Certificate of Origin:

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.