Skip to content

Commit dbb3070

Browse files
More beginner-oriented federation guide updates
1 parent 39dda42 commit dbb3070

File tree

3 files changed

+33
-12
lines changed

3 files changed

+33
-12
lines changed

docs/federation.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,10 @@ A federated exchange or queue can receive
7676
messages from one or more remote clusters called _upstreams_ (to be more precise: exchanges
7777
and queues that exist in remote clusters).
7878

79-
A federated exchange can route messages published upstream to a local queue. A federated
80-
queue lets a local consumer receive messages from an upstream queue when the remote queue
81-
itself does not have any consumers online.
79+
A federated exchange will "replay" a stream of messages published to its upstream counterpart, and publish them to a local queue or stream.
80+
81+
A federated queue lets a local consumer receive messages from an upstream queue when the remote queue
82+
itself does not have any local consumers online.
8283

8384
Federation links connect to upstreams largely the same way an application would. Therefore
8485
they can connect to a specific vhost, use TLS, use multiple
@@ -139,7 +140,7 @@ In practice, for simple use cases you can almost ignore the
139140
existence of upstream sets, since there is an implicitly-defined upstream set called `all`
140141
to which all upstreams are added.
141142

142-
Upstreams and upstream sets are both instances of [runtime parameters](./parameters).
143+
Upstreams and upstream sets are both defined using [runtime parameters](./parameters).
143144
Like exchanges and queues, each virtual host has its own distinct set of parameters and policies. For more
144145
generic information on parameters and policies, see the guide on
145146
[parameters and policies](./parameters).
@@ -167,13 +168,19 @@ one per tab:
167168
<Tabs groupId="shell-specific">
168169
<TabItem value="bash" label="bash" default>
169170
```bash
171+
# target.hostname is just an example, replace it with a URI
172+
# of the target node (usually a member of a remote node/cluster,
173+
# or a URI that connects to a different virtual host within the same cluster)
170174
rabbitmqctl set_parameter federation-upstream my-upstream \
171175
'{"uri":"amqp://target.hostname","expires":3600000}'
172176
```
173177
</TabItem>
174178

175179
<TabItem value="PowerShell" label="PowerShell">
176180
```PowerShell
181+
# target.hostname is just an example, replace it with a URI
182+
# of the target node (usually a member of a remote node/cluster,
183+
# or a URI that connects to a different virtual host within the same cluster)
177184
rabbitmqctl.bat set_parameter federation-upstream my-upstream `
178185
'"{""uri"":""amqp://target.hostname"",""expires"":3600000}"'
179186
```

versioned_docs/version-3.13/federation.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,10 @@ A federated exchange or queue can receive
7676
messages from one or more remote clusters called _upstreams_ (to be more precise: exchanges
7777
and queues that exist in remote clusters).
7878

79-
A federated exchange can route messages published upstream to a local queue. A federated
80-
queue lets a local consumer receive messages from an upstream queue when the remote queue
81-
itself does not have any consumers online.
79+
A federated exchange will "replay" a stream of messages published to its upstream counterpart, and publish them to a local queue or stream.
80+
81+
A federated queue lets a local consumer receive messages from an upstream queue when the remote queue
82+
itself does not have any local consumers online.
8283

8384
Federation links connect to upstreams largely the same way an application would. Therefore
8485
they can connect to a specific vhost, use TLS, use multiple
@@ -139,7 +140,7 @@ In practice, for simple use cases you can almost ignore the
139140
existence of upstream sets, since there is an implicitly-defined upstream set called `all`
140141
to which all upstreams are added.
141142

142-
Upstreams and upstream sets are both instances of [runtime parameters](./parameters).
143+
Upstreams and upstream sets are both defined using [runtime parameters](./parameters).
143144
Like exchanges and queues, each virtual host has its own distinct set of parameters and policies. For more
144145
generic information on parameters and policies, see the guide on
145146
[parameters and policies](./parameters).
@@ -167,13 +168,19 @@ one per tab:
167168
<Tabs groupId="shell-specific">
168169
<TabItem value="bash" label="bash" default>
169170
```bash
171+
# target.hostname is just an example, replace it with a URI
172+
# of the target node (usually a member of a remote node/cluster,
173+
# or a URI that connects to a different virtual host within the same cluster)
170174
rabbitmqctl set_parameter federation-upstream my-upstream \
171175
'{"uri":"amqp://target.hostname","expires":3600000}'
172176
```
173177
</TabItem>
174178

175179
<TabItem value="PowerShell" label="PowerShell">
176180
```PowerShell
181+
# target.hostname is just an example, replace it with a URI
182+
# of the target node (usually a member of a remote node/cluster,
183+
# or a URI that connects to a different virtual host within the same cluster)
177184
rabbitmqctl.bat set_parameter federation-upstream my-upstream `
178185
'"{""uri"":""amqp://target.hostname"",""expires"":3600000}"'
179186
```

versioned_docs/version-4.0/federation.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,10 @@ A federated exchange or queue can receive
7676
messages from one or more remote clusters called _upstreams_ (to be more precise: exchanges
7777
and queues that exist in remote clusters).
7878

79-
A federated exchange can route messages published upstream to a local queue. A federated
80-
queue lets a local consumer receive messages from an upstream queue when the remote queue
81-
itself does not have any consumers online.
79+
A federated exchange will "replay" a stream of messages published to its upstream counterpart, and publish them to a local queue or stream.
80+
81+
A federated queue lets a local consumer receive messages from an upstream queue when the remote queue
82+
itself does not have any local consumers online.
8283

8384
Federation links connect to upstreams largely the same way an application would. Therefore
8485
they can connect to a specific vhost, use TLS, use multiple
@@ -139,7 +140,7 @@ In practice, for simple use cases you can almost ignore the
139140
existence of upstream sets, since there is an implicitly-defined upstream set called `all`
140141
to which all upstreams are added.
141142

142-
Upstreams and upstream sets are both instances of [runtime parameters](./parameters).
143+
Upstreams and upstream sets are both defined using [runtime parameters](./parameters).
143144
Like exchanges and queues, each virtual host has its own distinct set of parameters and policies. For more
144145
generic information on parameters and policies, see the guide on
145146
[parameters and policies](./parameters).
@@ -167,13 +168,19 @@ one per tab:
167168
<Tabs groupId="shell-specific">
168169
<TabItem value="bash" label="bash" default>
169170
```bash
171+
# target.hostname is just an example, replace it with a URI
172+
# of the target node (usually a member of a remote node/cluster,
173+
# or a URI that connects to a different virtual host within the same cluster)
170174
rabbitmqctl set_parameter federation-upstream my-upstream \
171175
'{"uri":"amqp://target.hostname","expires":3600000}'
172176
```
173177
</TabItem>
174178

175179
<TabItem value="PowerShell" label="PowerShell">
176180
```PowerShell
181+
# target.hostname is just an example, replace it with a URI
182+
# of the target node (usually a member of a remote node/cluster,
183+
# or a URI that connects to a different virtual host within the same cluster)
177184
rabbitmqctl.bat set_parameter federation-upstream my-upstream `
178185
'"{""uri"":""amqp://target.hostname"",""expires"":3600000}"'
179186
```

0 commit comments

Comments
 (0)