Skip to content

Commit a035d73

Browse files
Minor updates based on recent community questions
1 parent 663d343 commit a035d73

File tree

6 files changed

+57
-21
lines changed

6 files changed

+57
-21
lines changed

docs/clustering.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,21 @@ that focuses on peer discovery and cluster formation automation-related topics.
4343

4444
[VMware Tanzu RabbitMQ](https://docs.vmware.com/en/VMware-RabbitMQ-for-Kubernetes/index.html) provides an [Intra-cluster Compression](https://docs.vmware.com/en/VMware-Tanzu-RabbitMQ-for-Kubernetes/3.13/tanzu-rabbitmq-kubernetes/clustering-compression-rabbitmq.html) feature.
4545

46-
A RabbitMQ cluster is a logical grouping of one or
47-
several nodes, each sharing users, virtual hosts,
48-
queues, exchanges, bindings, runtime parameters and other distributed state.
46+
47+
## What is a Cluster?
48+
49+
A RabbitMQ cluster is a logical grouping of one or more (three, five, seven, or more) nodes,
50+
each sharing users, virtual hosts, queues, streams, exchanges, bindings, runtime parameters and other distributed state.
51+
52+
For a cluster to be formed, nodes must be configured in a certain way and satisfy
53+
a number of [requirements](#cluster-formation-requirements) such as open port access.
54+
55+
After cluster formation, all nodes in a cluster are aware of other cluster members.
56+
57+
Client applications can be aware or not be aware of the fact that there are multiple cluster nodes,
58+
and connect to any of them, or, depending on the protocol used, a subset of them. For example,
59+
RabbitMQ Stream Protocol clients [can connect to multiple nodes at once](https://www.rabbitmq.com/blog/2021/07/23/connecting-to-streams).
60+
This is covered in more details [later in this guide](#clustering-and-clients).
4961

5062

5163
## Cluster Formation {#cluster-formation}
@@ -61,7 +73,7 @@ A RabbitMQ cluster can be formed in a number of ways:
6173
* Declaratively using [etcd-based discovery](https://github.com/rabbitmq/rabbitmq-peer-discovery-etcd) (via a plugin)
6274
* Manually with `rabbitmqctl`
6375

64-
Please refer to the [Cluster Formation guide](./cluster-formation) for details.
76+
These mechanisms are covered in more details in the [Cluster Formation guide](./cluster-formation).
6577

6678
The composition of a cluster can be altered dynamically.
6779
All RabbitMQ brokers start out as running on a single
@@ -133,7 +145,7 @@ To use FQDNs, see `RABBITMQ_USE_LONGNAME` in the [Configuration guide](./configu
133145
See [Node Names](#node-names) above.
134146

135147

136-
## Port Access {#ports}
148+
## Ports That Must Be Opened for Clustering and Replication {#ports}
137149

138150
RabbitMQ nodes [bind to ports](./networking#ports) (open server TCP sockets) in order to accept client and CLI tool connections.
139151
Other processes and tools such as SELinux may prevent RabbitMQ from binding to a port. When that happens,

docs/federation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ of exchanges and queues:
3939

4040
## Overview {#overview}
4141

42-
The high-level goal of the Federation plugin is to transmit messages between brokers without
43-
requiring clustering. This is useful for a number of reasons.
42+
The high-level goal of the Federation plugin is to replicate or move messages between brokers that have
43+
the plugin enabled but do not belong to the same cluster. This is useful for a number of reasons.
4444

4545
### Loose Coupling of Nodes or Clusters
4646

versioned_docs/version-3.13/clustering.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,21 @@ that focuses on peer discovery and cluster formation automation-related topics.
4343

4444
[VMware Tanzu RabbitMQ](https://docs.vmware.com/en/VMware-RabbitMQ-for-Kubernetes/index.html) provides an [Intra-cluster Compression](https://docs.vmware.com/en/VMware-Tanzu-RabbitMQ-for-Kubernetes/3.13/tanzu-rabbitmq-kubernetes/clustering-compression-rabbitmq.html) feature.
4545

46-
A RabbitMQ cluster is a logical grouping of one or
47-
several nodes, each sharing users, virtual hosts,
48-
queues, exchanges, bindings, runtime parameters and other distributed state.
46+
47+
## What is a Cluster?
48+
49+
A RabbitMQ cluster is a logical grouping of one or more (three, five, seven, or more) nodes,
50+
each sharing users, virtual hosts, queues, streams, exchanges, bindings, runtime parameters and other distributed state.
51+
52+
For a cluster to be formed, nodes must be configured in a certain way and satisfy
53+
a number of [requirements](#cluster-formation-requirements) such as open port access.
54+
55+
After cluster formation, all nodes in a cluster are aware of other cluster members.
56+
57+
Client applications can be aware or not be aware of the fact that there are multiple cluster nodes,
58+
and connect to any of them, or, depending on the protocol used, a subset of them. For example,
59+
RabbitMQ Stream Protocol clients [can connect to multiple nodes at once](https://www.rabbitmq.com/blog/2021/07/23/connecting-to-streams).
60+
This is covered in more details [later in this guide](#clustering-and-clients).
4961

5062

5163
## Cluster Formation {#cluster-formation}
@@ -61,7 +73,7 @@ A RabbitMQ cluster can be formed in a number of ways:
6173
* Declaratively using [etcd-based discovery](https://github.com/rabbitmq/rabbitmq-peer-discovery-etcd) (via a plugin)
6274
* Manually with `rabbitmqctl`
6375

64-
Please refer to the [Cluster Formation guide](./cluster-formation) for details.
76+
These mechanisms are covered in more details in the [Cluster Formation guide](./cluster-formation).
6577

6678
The composition of a cluster can be altered dynamically.
6779
All RabbitMQ brokers start out as running on a single
@@ -133,7 +145,7 @@ To use FQDNs, see `RABBITMQ_USE_LONGNAME` in the [Configuration guide](./configu
133145
See [Node Names](#node-names) above.
134146

135147

136-
## Port Access {#ports}
148+
## Ports That Must Be Opened for Clustering and Replication {#ports}
137149

138150
RabbitMQ nodes [bind to ports](./networking#ports) (open server TCP sockets) in order to accept client and CLI tool connections.
139151
Other processes and tools such as SELinux may prevent RabbitMQ from binding to a port. When that happens,

versioned_docs/version-3.13/federation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ of exchanges and queues:
3939

4040
## Overview {#overview}
4141

42-
The high-level goal of the Federation plugin is to transmit messages between brokers without
43-
requiring clustering. This is useful for a number of reasons.
42+
The high-level goal of the Federation plugin is to replicate or move messages between brokers that have
43+
the plugin enabled but do not belong to the same cluster. This is useful for a number of reasons.
4444

4545
### Loose Coupling of Nodes or Clusters
4646

versioned_docs/version-4.0/clustering.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,21 @@ that focuses on peer discovery and cluster formation automation-related topics.
4343

4444
[VMware Tanzu RabbitMQ](https://docs.vmware.com/en/VMware-RabbitMQ-for-Kubernetes/index.html) provides an [Intra-cluster Compression](https://docs.vmware.com/en/VMware-Tanzu-RabbitMQ-for-Kubernetes/3.13/tanzu-rabbitmq-kubernetes/clustering-compression-rabbitmq.html) feature.
4545

46-
A RabbitMQ cluster is a logical grouping of one or
47-
several nodes, each sharing users, virtual hosts,
48-
queues, exchanges, bindings, runtime parameters and other distributed state.
46+
47+
## What is a Cluster?
48+
49+
A RabbitMQ cluster is a logical grouping of one or more (three, five, seven, or more) nodes,
50+
each sharing users, virtual hosts, queues, streams, exchanges, bindings, runtime parameters and other distributed state.
51+
52+
For a cluster to be formed, nodes must be configured in a certain way and satisfy
53+
a number of [requirements](#cluster-formation-requirements) such as open port access.
54+
55+
After cluster formation, all nodes in a cluster are aware of other cluster members.
56+
57+
Client applications can be aware or not be aware of the fact that there are multiple cluster nodes,
58+
and connect to any of them, or, depending on the protocol used, a subset of them. For example,
59+
RabbitMQ Stream Protocol clients [can connect to multiple nodes at once](https://www.rabbitmq.com/blog/2021/07/23/connecting-to-streams).
60+
This is covered in more details [later in this guide](#clustering-and-clients).
4961

5062

5163
## Cluster Formation {#cluster-formation}
@@ -61,7 +73,7 @@ A RabbitMQ cluster can be formed in a number of ways:
6173
* Declaratively using [etcd-based discovery](https://github.com/rabbitmq/rabbitmq-peer-discovery-etcd) (via a plugin)
6274
* Manually with `rabbitmqctl`
6375

64-
Please refer to the [Cluster Formation guide](./cluster-formation) for details.
76+
These mechanisms are covered in more details in the [Cluster Formation guide](./cluster-formation).
6577

6678
The composition of a cluster can be altered dynamically.
6779
All RabbitMQ brokers start out as running on a single
@@ -133,7 +145,7 @@ To use FQDNs, see `RABBITMQ_USE_LONGNAME` in the [Configuration guide](./configu
133145
See [Node Names](#node-names) above.
134146

135147

136-
## Port Access {#ports}
148+
## Ports That Must Be Opened for Clustering and Replication {#ports}
137149

138150
RabbitMQ nodes [bind to ports](./networking#ports) (open server TCP sockets) in order to accept client and CLI tool connections.
139151
Other processes and tools such as SELinux may prevent RabbitMQ from binding to a port. When that happens,

versioned_docs/version-4.0/federation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ of exchanges and queues:
3939

4040
## Overview {#overview}
4141

42-
The high-level goal of the Federation plugin is to transmit messages between brokers without
43-
requiring clustering. This is useful for a number of reasons.
42+
The high-level goal of the Federation plugin is to replicate or move messages between brokers that have
43+
the plugin enabled but do not belong to the same cluster. This is useful for a number of reasons.
4444

4545
### Loose Coupling of Nodes or Clusters
4646

0 commit comments

Comments
 (0)