docs: add missing configurations #1000
Conversation
The BROKER_EXCHANGE was not explicitly defined. This missing configuration leads the service to fall back to the default exchange and messages are ignored.
|
Hey, @jbygdell I was wondering if you might have some time to review this documentation change? 😊 Thank you! |
There was a problem hiding this comment.
I think the updates looks good and helpful! All the variables you list under "Required settings" are not strictly required, though. It might be worth mentioning, for example, that clientkey and clientcert are only required when TLS is enabled.
It would also be nice if the variables listed under "Required settings" were described under the respective sections (eg if BROKER_VHOST, BROKER_ROUTINGERROR etc were described here). (Perhaps this is out of scope for this PR, in that case we could open a new issue for that?)
| - `DB_CLIENTCERT`= | ||
| - `DB_CLIENTKEY`= |
There was a problem hiding this comment.
only if tls in enabled.
| - `BROKER_VERIFYPEER`= | ||
| - `BROKER_CACERT`= | ||
| - `BROKER_CLIENTCERT`= | ||
| - `BROKER_CLIENTKEY`= |
There was a problem hiding this comment.
only if tls is enabled
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
| @@ -62,6 +62,7 @@ These settings control how `finalize` connects to the RabbitMQ message broker. | |||
| - `BROKER_USER`: username to connect to RabbitMQ | |||
| - `BROKER_PASSWORD`: password to connect to RabbitMQ | |||
| - `BROKER_PREFETCHCOUNT`: Number of messages to pull from the message server at the time (default to `2`) | |||
| - `BROKER_EXCHANGE`= the exchange name (i.e., `sda`) | |||
There was a problem hiding this comment.
| - `BROKER_EXCHANGE`= the exchange name (i.e., `sda`) | |
| - `BROKER_EXCHANGE`: the exchange name (i.e., `sda`) |
Follow the existing syntax
There was a problem hiding this comment.
The setting BROKER_EXCHANGE is only needed if the MQ is configured in that way.
Do not use the preconfigured MQ and DB as templates since they are not designed to be used in a production setting.
| - `BROKER_QUEUE`= | ||
| - `BROKER_EXCHANGE`= | ||
| - `BROKER_ROUTINGKEY`= | ||
| - `BROKER_ROUTINGERROR`= |
There was a problem hiding this comment.
| - `BROKER_ROUTINGERROR`= |
ROUTINGERROR is being deprecated
| @@ -49,6 +49,23 @@ These settings control how `intercept` connects to the RabbitMQ message broker. | |||
| - `BROKER_QUEUE`: message queue to read messages from (commonly: `from_cega`) | |||
| - `BROKER_USER`: username to connect to RabbitMQ | |||
| - `BROKER_PASSWORD`: password to connect to RabbitMQ | |||
| - `BROKER_VHOST`= the virtual host of the exchange (i.e., `test`) | |||
There was a problem hiding this comment.
| - `BROKER_VHOST`= the virtual host of the exchange (i.e., `test`) | |
| - `BROKER_VHOST`= the virtual host to connect to |
| - `BROKER_VERIFYPEER`= | ||
| - `BROKER_CACERT`= | ||
| - `BROKER_CLIENTCERT`= | ||
| - `BROKER_CLIENTKEY`= |
| - `DB_CLIENTCERT`= | ||
| - `DB_CLIENTKEY`= |
There was a problem hiding this comment.
| - `DB_CLIENTCERT`= | |
| - `DB_CLIENTKEY`= | |
| - `DB_CLIENTCERT`= | |
| - `DB_CLIENTKEY`= | |
| - `DB_CACERT`= |
Only if DB_SSLMODE= is anything than disable
Related issue(s) and PR(s)
(None)
Description
The
BROKER_EXCHANGEwas not explicitly defined. This missing configuration leads service(s) to fall back to the default exchange (an empty string""), and messages are ignored. Since the default exchange is a simple direct exchange, we dont get advanced routing features like those provided by topic or fanout exchanges.We had trouble running the setup because of this missing configuration. Rabbitmq does not complaint anything without it. Hence,no routing. If no queue name matches the routing key, the message is discarded (unless a dead-letter exchange is configured)
How to test
N/A