This is an automated email from the ASF dual-hosted git repository.
penghui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 1cc2563 update doc for multiple advertised listeners (#8810)
1cc2563 is described below
commit 1cc25633b78f99245abbe3c0404620d063d7089c
Author: HuanliMeng <[email protected]>
AuthorDate: Fri Dec 4 10:06:48 2020 +0800
update doc for multiple advertised listeners (#8810)
---
.../concepts-multiple-advertised-listeners.md | 39 ++++++++++++++++++++++
.../concepts-multiple-advertised-listeners.md | 39 ++++++++++++++++++++++
.../concepts-multiple-advertised-listeners.md | 39 ++++++++++++++++++++++
.../concepts-multiple-advertised-listeners.md | 39 ++++++++++++++++++++++
.../versioned_sidebars/version-2.6.0-sidebars.json | 3 +-
.../versioned_sidebars/version-2.6.1-sidebars.json | 3 +-
.../versioned_sidebars/version-2.6.2-sidebars.json | 3 +-
.../versioned_sidebars/version-2.7.0-sidebars.json | 3 +-
8 files changed, 164 insertions(+), 4 deletions(-)
diff --git
a/site2/website/versioned_docs/version-2.6.0/concepts-multiple-advertised-listeners.md
b/site2/website/versioned_docs/version-2.6.0/concepts-multiple-advertised-listeners.md
new file mode 100644
index 0000000..3d11d36
--- /dev/null
+++
b/site2/website/versioned_docs/version-2.6.0/concepts-multiple-advertised-listeners.md
@@ -0,0 +1,39 @@
+---
+id: version-2.6.0-concepts-multiple-advertised-listeners
+title: Multiple advertised listeners
+sidebar_label: Multiple advertised listeners
+original_id: concepts-multiple-advertised-listeners
+---
+
+When a Pulsar cluster is deployed in the production environment, it may
require to expose multiple advertised addresses for the broker. For example,
when you deploy a Pulsar cluster in Kubernetes and want other clients, which
are not in the same Kubernetes cluster, to connect to the Pulsar cluster, you
need to assign a broker URL to external clients. But clients in the same
Kubernetes cluster can still connect to the Pulsar cluster through the internal
network of Kubernetes.
+
+## Advertised listeners
+
+To ensure clients in both internal and external networks can connect to a
Pulsar cluster, Pulsar introduces `advertisedListeners` and
`internalListenerName` configuration options into the [broker configuration
file](reference-configuration.md#broker) to ensure that the broker supports
exposing multiple advertised listeners and support the separation of internal
and external network traffic.
+
+- The `advertisedListeners` is used to specify multiple advertised listeners.
The broker uses the listener as the broker identifier in the load manager and
the bundle owner data. The `advertisedListeners` is formatted as
`<listener_name>:pulsar://<host>:<port>,
<listener_name>:pulsar+ssl://<host>:<port>`. You can set up the
`advertisedListeners` like
+`advertisedListeners=internal:pulsar://192.168.1.11:6660,internal:pulsar+ssl://192.168.1.11:6651`.
+
+- The `internalListenerName` is used to specify the internal service URL that
the broker uses. You can specify the `internalListenerName` by choosing one of
the `advertisedListeners`. The broker uses the listener name of the first
advertised listener as the `internalListenerName` if the `internalListenerName`
is absent.
+
+After setting up the `advertisedListeners`, clients can choose one of the
listeners as the service URL to create a connection to the broker as long as
the network is accessible. However, if the client creates producers or consumer
on a topic, the client must send a lookup requests to the broker for getting
the owner broker, then connect to the owner broker to publish messages or
consume messages. Therefore, You must allow the client to get the corresponding
service URL with the same adve [...]
+
+## Use multiple advertised listeners
+
+This example shows how a Pulsar client uses multiple advertised listeners.
+
+1. Configure multiple advertised listeners in the broker configuration file.
+
+```shell
+advertisedListeners={listenerName}:pulsar://xxxx:6650,
+{listenerName}:pulsar+ssl://xxxx:6651
+```
+
+2. Specify the listener name for the client.
+
+```java
+PulsarClient client = PulsarClient.builder()
+ .serviceUrl("pulsar://xxxx:6650")
+ .listenerName("external")
+ .build();
+```
\ No newline at end of file
diff --git
a/site2/website/versioned_docs/version-2.6.1/concepts-multiple-advertised-listeners.md
b/site2/website/versioned_docs/version-2.6.1/concepts-multiple-advertised-listeners.md
new file mode 100644
index 0000000..7acfea6
--- /dev/null
+++
b/site2/website/versioned_docs/version-2.6.1/concepts-multiple-advertised-listeners.md
@@ -0,0 +1,39 @@
+---
+id: version-2.6.1-concepts-multiple-advertised-listeners
+title: Multiple advertised listeners
+sidebar_label: Multiple advertised listeners
+original_id: concepts-multiple-advertised-listeners
+---
+
+When a Pulsar cluster is deployed in the production environment, it may
require to expose multiple advertised addresses for the broker. For example,
when you deploy a Pulsar cluster in Kubernetes and want other clients, which
are not in the same Kubernetes cluster, to connect to the Pulsar cluster, you
need to assign a broker URL to external clients. But clients in the same
Kubernetes cluster can still connect to the Pulsar cluster through the internal
network of Kubernetes.
+
+## Advertised listeners
+
+To ensure clients in both internal and external networks can connect to a
Pulsar cluster, Pulsar introduces `advertisedListeners` and
`internalListenerName` configuration options into the [broker configuration
file](reference-configuration.md#broker) to ensure that the broker supports
exposing multiple advertised listeners and support the separation of internal
and external network traffic.
+
+- The `advertisedListeners` is used to specify multiple advertised listeners.
The broker uses the listener as the broker identifier in the load manager and
the bundle owner data. The `advertisedListeners` is formatted as
`<listener_name>:pulsar://<host>:<port>,
<listener_name>:pulsar+ssl://<host>:<port>`. You can set up the
`advertisedListeners` like
+`advertisedListeners=internal:pulsar://192.168.1.11:6660,internal:pulsar+ssl://192.168.1.11:6651`.
+
+- The `internalListenerName` is used to specify the internal service URL that
the broker uses. You can specify the `internalListenerName` by choosing one of
the `advertisedListeners`. The broker uses the listener name of the first
advertised listener as the `internalListenerName` if the `internalListenerName`
is absent.
+
+After setting up the `advertisedListeners`, clients can choose one of the
listeners as the service URL to create a connection to the broker as long as
the network is accessible. However, if the client creates producers or consumer
on a topic, the client must send a lookup requests to the broker for getting
the owner broker, then connect to the owner broker to publish messages or
consume messages. Therefore, You must allow the client to get the corresponding
service URL with the same adve [...]
+
+## Use multiple advertised listeners
+
+This example shows how a Pulsar client uses multiple advertised listeners.
+
+1. Configure multiple advertised listeners in the broker configuration file.
+
+```shell
+advertisedListeners={listenerName}:pulsar://xxxx:6650,
+{listenerName}:pulsar+ssl://xxxx:6651
+```
+
+2. Specify the listener name for the client.
+
+```java
+PulsarClient client = PulsarClient.builder()
+ .serviceUrl("pulsar://xxxx:6650")
+ .listenerName("external")
+ .build();
+```
\ No newline at end of file
diff --git
a/site2/website/versioned_docs/version-2.6.2/concepts-multiple-advertised-listeners.md
b/site2/website/versioned_docs/version-2.6.2/concepts-multiple-advertised-listeners.md
new file mode 100644
index 0000000..c9db42a
--- /dev/null
+++
b/site2/website/versioned_docs/version-2.6.2/concepts-multiple-advertised-listeners.md
@@ -0,0 +1,39 @@
+---
+id: version-2.6.2-concepts-multiple-advertised-listeners
+title: Multiple advertised listeners
+sidebar_label: Multiple advertised listeners
+original_id: concepts-multiple-advertised-listeners
+---
+
+When a Pulsar cluster is deployed in the production environment, it may
require to expose multiple advertised addresses for the broker. For example,
when you deploy a Pulsar cluster in Kubernetes and want other clients, which
are not in the same Kubernetes cluster, to connect to the Pulsar cluster, you
need to assign a broker URL to external clients. But clients in the same
Kubernetes cluster can still connect to the Pulsar cluster through the internal
network of Kubernetes.
+
+## Advertised listeners
+
+To ensure clients in both internal and external networks can connect to a
Pulsar cluster, Pulsar introduces `advertisedListeners` and
`internalListenerName` configuration options into the [broker configuration
file](reference-configuration.md#broker) to ensure that the broker supports
exposing multiple advertised listeners and support the separation of internal
and external network traffic.
+
+- The `advertisedListeners` is used to specify multiple advertised listeners.
The broker uses the listener as the broker identifier in the load manager and
the bundle owner data. The `advertisedListeners` is formatted as
`<listener_name>:pulsar://<host>:<port>,
<listener_name>:pulsar+ssl://<host>:<port>`. You can set up the
`advertisedListeners` like
+`advertisedListeners=internal:pulsar://192.168.1.11:6660,internal:pulsar+ssl://192.168.1.11:6651`.
+
+- The `internalListenerName` is used to specify the internal service URL that
the broker uses. You can specify the `internalListenerName` by choosing one of
the `advertisedListeners`. The broker uses the listener name of the first
advertised listener as the `internalListenerName` if the `internalListenerName`
is absent.
+
+After setting up the `advertisedListeners`, clients can choose one of the
listeners as the service URL to create a connection to the broker as long as
the network is accessible. However, if the client creates producers or consumer
on a topic, the client must send a lookup requests to the broker for getting
the owner broker, then connect to the owner broker to publish messages or
consume messages. Therefore, You must allow the client to get the corresponding
service URL with the same adve [...]
+
+## Use multiple advertised listeners
+
+This example shows how a Pulsar client uses multiple advertised listeners.
+
+1. Configure multiple advertised listeners in the broker configuration file.
+
+```shell
+advertisedListeners={listenerName}:pulsar://xxxx:6650,
+{listenerName}:pulsar+ssl://xxxx:6651
+```
+
+2. Specify the listener name for the client.
+
+```java
+PulsarClient client = PulsarClient.builder()
+ .serviceUrl("pulsar://xxxx:6650")
+ .listenerName("external")
+ .build();
+```
\ No newline at end of file
diff --git
a/site2/website/versioned_docs/version-2.7.0/concepts-multiple-advertised-listeners.md
b/site2/website/versioned_docs/version-2.7.0/concepts-multiple-advertised-listeners.md
new file mode 100644
index 0000000..2944758
--- /dev/null
+++
b/site2/website/versioned_docs/version-2.7.0/concepts-multiple-advertised-listeners.md
@@ -0,0 +1,39 @@
+---
+id: version-2.7.0-concepts-multiple-advertised-listeners
+title: Multiple advertised listeners
+sidebar_label: Multiple advertised listeners
+original_id: concepts-multiple-advertised-listeners
+---
+
+When a Pulsar cluster is deployed in the production environment, it may
require to expose multiple advertised addresses for the broker. For example,
when you deploy a Pulsar cluster in Kubernetes and want other clients, which
are not in the same Kubernetes cluster, to connect to the Pulsar cluster, you
need to assign a broker URL to external clients. But clients in the same
Kubernetes cluster can still connect to the Pulsar cluster through the internal
network of Kubernetes.
+
+## Advertised listeners
+
+To ensure clients in both internal and external networks can connect to a
Pulsar cluster, Pulsar introduces `advertisedListeners` and
`internalListenerName` configuration options into the [broker configuration
file](reference-configuration.md#broker) to ensure that the broker supports
exposing multiple advertised listeners and support the separation of internal
and external network traffic.
+
+- The `advertisedListeners` is used to specify multiple advertised listeners.
The broker uses the listener as the broker identifier in the load manager and
the bundle owner data. The `advertisedListeners` is formatted as
`<listener_name>:pulsar://<host>:<port>,
<listener_name>:pulsar+ssl://<host>:<port>`. You can set up the
`advertisedListeners` like
+`advertisedListeners=internal:pulsar://192.168.1.11:6660,internal:pulsar+ssl://192.168.1.11:6651`.
+
+- The `internalListenerName` is used to specify the internal service URL that
the broker uses. You can specify the `internalListenerName` by choosing one of
the `advertisedListeners`. The broker uses the listener name of the first
advertised listener as the `internalListenerName` if the `internalListenerName`
is absent.
+
+After setting up the `advertisedListeners`, clients can choose one of the
listeners as the service URL to create a connection to the broker as long as
the network is accessible. However, if the client creates producers or consumer
on a topic, the client must send a lookup requests to the broker for getting
the owner broker, then connect to the owner broker to publish messages or
consume messages. Therefore, You must allow the client to get the corresponding
service URL with the same adve [...]
+
+## Use multiple advertised listeners
+
+This example shows how a Pulsar client uses multiple advertised listeners.
+
+1. Configure multiple advertised listeners in the broker configuration file.
+
+```shell
+advertisedListeners={listenerName}:pulsar://xxxx:6650,
+{listenerName}:pulsar+ssl://xxxx:6651
+```
+
+2. Specify the listener name for the client.
+
+```java
+PulsarClient client = PulsarClient.builder()
+ .serviceUrl("pulsar://xxxx:6650")
+ .listenerName("external")
+ .build();
+```
\ No newline at end of file
diff --git a/site2/website/versioned_sidebars/version-2.6.0-sidebars.json
b/site2/website/versioned_sidebars/version-2.6.0-sidebars.json
index 6cd23e7..667bc7f 100644
--- a/site2/website/versioned_sidebars/version-2.6.0-sidebars.json
+++ b/site2/website/versioned_sidebars/version-2.6.0-sidebars.json
@@ -16,7 +16,8 @@
"version-2.6.0-concepts-multi-tenancy",
"version-2.6.0-concepts-authentication",
"version-2.6.0-concepts-topic-compaction",
- "version-2.6.0-concepts-tiered-storage"
+ "version-2.6.0-concepts-tiered-storage",
+ "version-2.6.0-concepts-multiple-advertised-listeners"
],
"Pulsar Schema": [
"version-2.6.0-schema-get-started",
diff --git a/site2/website/versioned_sidebars/version-2.6.1-sidebars.json
b/site2/website/versioned_sidebars/version-2.6.1-sidebars.json
index ab3b408..0552817 100644
--- a/site2/website/versioned_sidebars/version-2.6.1-sidebars.json
+++ b/site2/website/versioned_sidebars/version-2.6.1-sidebars.json
@@ -17,7 +17,8 @@
"version-2.6.1-concepts-authentication",
"version-2.6.1-concepts-topic-compaction",
"version-2.6.1-concepts-tiered-storage",
- "version-2.6.1-concepts-proxy-sni-routing"
+ "version-2.6.1-concepts-proxy-sni-routing",
+ "version-2.6.1-concepts-multiple-advertised-listeners"
],
"Pulsar Schema": [
"version-2.6.1-schema-get-started",
diff --git a/site2/website/versioned_sidebars/version-2.6.2-sidebars.json
b/site2/website/versioned_sidebars/version-2.6.2-sidebars.json
index 9aa16d0..c6a8f31 100644
--- a/site2/website/versioned_sidebars/version-2.6.2-sidebars.json
+++ b/site2/website/versioned_sidebars/version-2.6.2-sidebars.json
@@ -17,7 +17,8 @@
"version-2.6.2-concepts-authentication",
"version-2.6.2-concepts-topic-compaction",
"version-2.6.2-concepts-tiered-storage",
- "version-2.6.2-concepts-proxy-sni-routing"
+ "version-2.6.2-concepts-proxy-sni-routing",
+ "version-2.6.2-concepts-multiple-advertised-listeners"
],
"Pulsar Schema": [
"version-2.6.2-schema-get-started",
diff --git a/site2/website/versioned_sidebars/version-2.7.0-sidebars.json
b/site2/website/versioned_sidebars/version-2.7.0-sidebars.json
index a06f659..03d0844 100644
--- a/site2/website/versioned_sidebars/version-2.7.0-sidebars.json
+++ b/site2/website/versioned_sidebars/version-2.7.0-sidebars.json
@@ -14,7 +14,8 @@
"version-2.7.0-concepts-multi-tenancy",
"version-2.7.0-concepts-authentication",
"version-2.7.0-concepts-topic-compaction",
- "version-2.7.0-concepts-proxy-sni-routing"
+ "version-2.7.0-concepts-proxy-sni-routing",
+ "version-2.6.0-concepts-multiple-advertised-listeners"
],
"Pulsar Schema": [
"version-2.7.0-schema-get-started",
