Add docs explaining mqtt topic layout
This commit adds an explanation of how mqtt topics are set for gerrit events to the README. This should help any consumers of the MQTT event stream figure out how things are organized. Change-Id: I0db6f5d38e11cee18b6a5ced9566966d2cb09add
This commit is contained in:
parent
8a4a69afef
commit
5c2a34d237
15
README.rst
15
README.rst
|
@ -11,6 +11,21 @@ on the topic: base_topic/foo/commented-added
|
|||
By default germqtt is setup as a daemon however if you need to run it
|
||||
interactively you can use the *--foreground* option to do this.
|
||||
|
||||
MQTT Topics
|
||||
===========
|
||||
germqtt will push gerrit events to topics broken by project and event type.
|
||||
The formula used is::
|
||||
|
||||
<base topic>/<project>/<event type>
|
||||
|
||||
For example, if gerrit emits a *comment-added* event for the *openstack/nova*
|
||||
project germqtt will push that event to the topic::
|
||||
|
||||
gerrit/openstack/nova/comment-added
|
||||
|
||||
assuming the base topic is configured to be gerrit. For more information on
|
||||
topics in MQTT refer to: https://mosquitto.org/man/mqtt-7.html
|
||||
|
||||
Configuration
|
||||
=============
|
||||
There are a few required pieces of information to make germqtt work properly.
|
||||
|
|
Loading…
Reference in New Issue