loopabull-tasks/README.rst
Pierre-Yves Chibon 21a582d885 Add a blob about non-zero return code
Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>
2018-08-10 15:41:57 +02:00

33 lines
1.1 KiB
ReStructuredText

===============
loopabull-tasks
===============
`loopabull`_ is an event loop driven `Ansible`_ `playbook`_ execution engine.
In other words, it triggers Ansible playbooks automatically when receiving a
correspond `fedmsg`_ message.
This repository stores the ansible playbooks and their related scripts used by
the `Fedora`_ `Infrastructure`_ team.
Good Practice
-------------
* Keep in mind that a playbook can be ran by multiple workers simultaneously,
therefore it is advised to keep all blocking tasks out of this repository (for
example: avoid installing packages)
* Do not have your script return a non-zero error code. If a playbook fails
(returns a non-zero return code) loopabull will stop the worker. So use the
non-zero return code carefully so as to not kill all the workers and break
loopabull
.. _Ansible: https://github.com/ansible/ansible
.. _fedmsg: http://www.fedmsg.com/en/latest/
.. _Fedora: https://getfedora.org/
.. _Infrastructure: https://fedoraproject.org/wiki/Infrastructure
.. _loopabull: https://github.com/maxamillion/loopabull
.. _playbook: http://docs.ansible.com/ansible/playbooks.html