michalxo commented on code in PR #4938: URL: https://github.com/apache/activemq-artemis/pull/4938#discussion_r1604760101
########## docs/user-manual/federation-address.adoc: ########## @@ -112,96 +111,97 @@ Sample Address Federation setup: </federations> ---- -In the above setup downstream broker `eu-north-1` is configured to connect to two upstream brokers `eu-east-1` and `eu-east-2`, the credentials used for both connections to both brokers in this sample are shared, you can set user and password at the upstream level should they be different per upstream. +In the above setup, downstream broker `eu-north-1` is configured to connect to two upstream brokers `eu-east-1` and `eu-west-1`. Credentials used for both connections to brokers in this sample are shared. +Should they be different per upstream, you can alter credentials at the upstream level. -Both upstreams are configured with the same address-policy `news-address-federation`, that is selecting addresses which match any of the include criteria, but will exclude anything that starts `queue.news.sport`. +Both upstreams are configured with the same address-policy `news-address-federation`, that is selecting addresses which match any of the include criteria and exclude anything that starts `queue.news.sport`. *It is important that federation name is globally unique.* -Let's take a look at all the `address-policy` parameters in turn, in order of priority. +==== Priority ordered address-policy parameters name:: All address-policies must have a unique name in the server. + include:: -The address-match pattern to include addresses. -Multiple of these can be set. -If none are set all addresses are matched. +The address-match pattern to include addresses. Multiple of these can be set. If none are set all addresses are matched. + exclude:: -The address-match pattern to exclude addresses. -Multiple of these can be set. +The address-match pattern to exclude addresses. Multiple of these can be set. + max-hops:: -The number of hops that a message can have made for it to be federated, see <<topology-patterns,Topology Patterns>> above for more details. +The maximum number of hops that message can perform across federated addresses. See <<topology-patterns,Topology Patterns>> above for details. auto-delete:: For address federation, the downstream dynamically creates a durable queue on the upstream address. -This is used to mark if the upstream queue should be deleted once downstream disconnects, and the delay and message count params have been met. -This is useful if you want to automate the clean up, though you may wish to disable this if you want messages to queued for the downstream when disconnect no matter what. +This is used to mark if the upstream queue should be deleted once downstream disconnects and the delay and message count params have been met. It is useful in automation of the cleanup. You may wish to disable this, if you want messages to be queued for the downstream when disconnect no matter what. auto-delete-delay:: -The amount of time in milliseconds after the downstream broker has disconnected before the upstream queue can be eligable for `auto-delete`. +The amount of time in milliseconds after the downstream broker has disconnected, before the upstream queue can be eligible for `auto-delete`. auto-delete-message-count:: -The amount number messages in the upstream queue that the message count must be equal or below before the downstream broker has disconnected before the upstream queue can be eligable for `auto-delete`. +Maximum number of messages allowed in the upstream queue to be eligible for `auto-delete`, after the downstream broker has disconnected. transformer-ref:: -The ref name for a transformer (see transformer config) that you may wish to configure to transform the message on federation transfer. +Reference name of a transformer (see transformer config) that you may wish to configure to transform the message on federation transfer. enable-divert-bindings:: -Setting to true will enable divert bindings to be listened for demand. -If there is a divert binding with an address that matches the included addresses for the stream, any queue bindings that match the forward address of the divert will create demand. -Default is `false`. +Setting to `true` will enable divert bindings to be listened for demand. +If there is a divert binding with an address that matches the included addresses for the stream, any queue bindings that match the forward address of the divert will create demand. Default is `false`. NOTE: `address-policy` and `queue-policy` elements can be defined in the same federation and be linked to the same upstream. -Now look at all the `transformer` parameters in turn, in order of priority: +==== Priority ordered transformer parameters name:: -This must be a unique name in the server, and is used to ref the transformer in `address-policy` and `queue-policy` +Unique name in the server used to reference the transformer in `address-policy` and `queue-policy`. transformer-class-name:: -An optional transformer-class-name can be specified. +An optional `transformer-class-name` can be specified. Review Comment: Agree. I will remove whole sentence. It follows later `If specified, then the ...` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
