Skip to content

Commit 9a61bb5

Browse files
committed
Mention advertised_tls_ keys in plain connection section
1 parent 9b1841d commit 9a61bb5

File tree

4 files changed

+24
-32
lines changed

4 files changed

+24
-32
lines changed

docs/stream.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -190,15 +190,12 @@ How consumer credit flow is exposed to applications depends on the client librar
190190

191191
### Advertised Host and Port {#advertised-host-port}
192192

193-
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given
194-
set of streams are located in the cluster. This way the client can choose to connect to the appropriate node
195-
to interact with the streams: the leader node to publish, a replica to consume. By default, nodes return their
196-
hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster
197-
nodes and the clients, cluster nodes and/or clients running in containers, etc).
193+
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given set of streams are located in the cluster.
194+
This way the client can choose to connect to the appropriate node to interact with the streams: the leader node to publish, a replica to consume.
195+
By default, nodes return their hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster nodes and the clients, cluster nodes and/or clients running in containers, etc).
198196

199-
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked
200-
the topology of streams. One can set those settings according to their infrastructure, so that clients can connect
201-
to cluster nodes:
197+
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked the topology of streams.
198+
One can set those settings according to their infrastructure, so that clients can connect to cluster nodes:
202199

203200
```ini
204201
stream.advertised_host = rabbitmq-1
@@ -207,6 +204,7 @@ stream.advertised_port = 12345
207204

208205
The [Connecting to Streams](/blog/2021/07/23/connecting-to-streams) blog post covers why the `advertised_host` and `advertised_port` settings are necessary in some deployments.
209206

207+
The configuration entries have [TLS counterparts](#tls) (`advertised_tls_host` and `advertised_tls_port`).
210208

211209
### Maximum Frame Size {#frame-size}
212210

versioned_docs/version-3.13/stream.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -190,15 +190,12 @@ How consumer credit flow is exposed to applications depends on the client librar
190190

191191
### Advertised Host and Port {#advertised-host-port}
192192

193-
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given
194-
set of streams are located in the cluster. This way the client can choose to connect to the appropriate node
195-
to interact with the streams: the leader node to publish, a replica to consume. By default, nodes return their
196-
hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster
197-
nodes and the clients, cluster nodes and/or clients running in containers, etc).
193+
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given set of streams are located in the cluster.
194+
This way the client can choose to connect to the appropriate node to interact with the streams: the leader node to publish, a replica to consume.
195+
By default, nodes return their hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster nodes and the clients, cluster nodes and/or clients running in containers, etc).
198196

199-
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked
200-
the topology of streams. One can set those settings according to their infrastructure, so that clients can connect
201-
to cluster nodes:
197+
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked the topology of streams.
198+
One can set those settings according to their infrastructure, so that clients can connect to cluster nodes:
202199

203200
```ini
204201
stream.advertised_host = rabbitmq-1
@@ -207,6 +204,7 @@ stream.advertised_port = 12345
207204

208205
The [Connecting to Streams](/blog/2021/07/23/connecting-to-streams) blog post covers why the `advertised_host` and `advertised_port` settings are necessary in some deployments.
209206

207+
The configuration entries have [TLS counterparts](#tls) (`advertised_tls_host` and `advertised_tls_port`).
210208

211209
### Maximum Frame Size {#frame-size}
212210

versioned_docs/version-4.0/stream.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -191,15 +191,12 @@ How consumer credit flow is exposed to applications depends on the client librar
191191

192192
### Advertised Host and Port {#advertised-host-port}
193193

194-
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given
195-
set of streams are located in the cluster. This way the client can choose to connect to the appropriate node
196-
to interact with the streams: the leader node to publish, a replica to consume. By default, nodes return their
197-
hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster
198-
nodes and the clients, cluster nodes and/or clients running in containers, etc).
194+
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given set of streams are located in the cluster.
195+
This way the client can choose to connect to the appropriate node to interact with the streams: the leader node to publish, a replica to consume.
196+
By default, nodes return their hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster nodes and the clients, cluster nodes and/or clients running in containers, etc).
199197

200-
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked
201-
the topology of streams. One can set those settings according to their infrastructure, so that clients can connect
202-
to cluster nodes:
198+
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked the topology of streams.
199+
One can set those settings according to their infrastructure, so that clients can connect to cluster nodes:
203200

204201
```ini
205202
stream.advertised_host = rabbitmq-1
@@ -208,6 +205,7 @@ stream.advertised_port = 12345
208205

209206
The [Connecting to Streams](/blog/2021/07/23/connecting-to-streams) blog post covers why the `advertised_host` and `advertised_port` settings are necessary in some deployments.
210207

208+
The configuration entries have [TLS counterparts](#tls) (`advertised_tls_host` and `advertised_tls_port`).
211209

212210
### Maximum Frame Size {#frame-size}
213211

versioned_docs/version-4.1/stream.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -190,15 +190,12 @@ How consumer credit flow is exposed to applications depends on the client librar
190190

191191
### Advertised Host and Port {#advertised-host-port}
192192

193-
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given
194-
set of streams are located in the cluster. This way the client can choose to connect to the appropriate node
195-
to interact with the streams: the leader node to publish, a replica to consume. By default, nodes return their
196-
hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster
197-
nodes and the clients, cluster nodes and/or clients running in containers, etc).
193+
The stream protocol allows to discover the topology of streams, that is where the leader and replicas for a given set of streams are located in the cluster.
194+
This way the client can choose to connect to the appropriate node to interact with the streams: the leader node to publish, a replica to consume.
195+
By default, nodes return their hostname and listener port, which may be fine for most situations, but not always (proxy sitting between the cluster nodes and the clients, cluster nodes and/or clients running in containers, etc).
198196

199-
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked
200-
the topology of streams. One can set those settings according to their infrastructure, so that clients can connect
201-
to cluster nodes:
197+
The `advertised_host` and `advertised_port` keys allow to specify which information a broker node returns when asked the topology of streams.
198+
One can set those settings according to their infrastructure, so that clients can connect to cluster nodes:
202199

203200
```ini
204201
stream.advertised_host = rabbitmq-1
@@ -207,6 +204,7 @@ stream.advertised_port = 12345
207204

208205
The [Connecting to Streams](/blog/2021/07/23/connecting-to-streams) blog post covers why the `advertised_host` and `advertised_port` settings are necessary in some deployments.
209206

207+
The configuration entries have [TLS counterparts](#tls) (`advertised_tls_host` and `advertised_tls_port`).
210208

211209
### Maximum Frame Size {#frame-size}
212210

0 commit comments

Comments
 (0)