bd8d814230
The messaging is not really part of compose settings. It is an infrastructure part. As such, it should really be set up as part of pungi invocation, not compose configuration. The documentation is updated to reflect this. Some updates to the documentation are done as well: listing messages about ISOs and minor formatting updates. The test_compose.sh script can now accept additional command line options and pass them on to pungi-koji to simplify testing. Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com>
40 lines
1.3 KiB
ReStructuredText
40 lines
1.3 KiB
ReStructuredText
.. _messaging:
|
|
|
|
Progress notification
|
|
=====================
|
|
|
|
*Pungi* has the ability to emit notification messages about progress and
|
|
general status of the compose. These can be used to e.g. send messages to
|
|
*fedmsg*. This is implemented by actually calling a separate script.
|
|
|
|
The script will be called with one argument describing action that just
|
|
happened. A JSON-encoded object will be passed to standard input to provide
|
|
more information about the event. At the very least, the object will contain a
|
|
``compose_id`` key.
|
|
|
|
Currently these messages are sent:
|
|
|
|
* ``status-change`` -- when composing starts, finishes or fails; a ``status``
|
|
key is provided to indicate details
|
|
* ``phase-start`` -- on start of a phase
|
|
* ``phase-stop`` -- when phase is finished
|
|
* ``createiso-targets`` -- with a list of images to be created
|
|
* ``createiso-imagedone`` -- when any single image is finished
|
|
* ``createiso-imagefail`` -- when any single image fails to create
|
|
|
|
For phase related messages ``phase_name`` key is provided as well.
|
|
|
|
The script is invoked in compose directory and can read other information
|
|
there.
|
|
|
|
A ``pungi-fedmsg-notification`` script is provided and understands this
|
|
interface.
|
|
|
|
Setting it up
|
|
-------------
|
|
|
|
The script should be provided as a command line argument
|
|
``--notification-script``. ::
|
|
|
|
--notification_script=pungi-fedmsg-notification
|