You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by li...@apache.org on 2023/04/12 02:26:41 UTC
[pulsar-site] branch main updated: [improve][doc] Add instructions for enabling replicated subscription (#510)
This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 86f46e8d00d [improve][doc] Add instructions for enabling replicated subscription (#510)
86f46e8d00d is described below
commit 86f46e8d00d0502ecaa38b2f8fa7ab0096192d19
Author: Anonymitaet <50...@users.noreply.github.com>
AuthorDate: Wed Apr 12 10:26:35 2023 +0800
[improve][doc] Add instructions for enabling replicated subscription (#510)
---
docs/administration-geo.md | 20 ++++++++++++--------
docs/client-libraries-cluster-level-failover.md | 2 +-
versioned_docs/version-2.10.x/administration-geo.md | 18 ++++++++++--------
.../version-2.10.x/client-libraries-java.md | 2 +-
versioned_docs/version-2.11.x/administration-geo.md | 20 ++++++++++++--------
.../version-2.11.x/client-libraries-java.md | 2 +-
6 files changed, 37 insertions(+), 27 deletions(-)
diff --git a/docs/administration-geo.md b/docs/administration-geo.md
index 9a5c7978559..21df5bc8540 100644
--- a/docs/administration-geo.md
+++ b/docs/administration-geo.md
@@ -214,15 +214,19 @@ In case of failover, a consumer can restart consuming from the failure point in
### Enable replicated subscription
-Replicated subscription is disabled by default. You can enable replicated subscriptions when creating a consumer.
+If you want to use replicated subscriptions in Pulsar:
-```java
-Consumer<String> consumer = client.newConsumer(Schema.STRING)
- .topic("my-topic")
- .subscriptionName("my-subscription")
- .replicateSubscriptionState(true)
- .subscribe();
-```
+- For broker side: set `enableReplicatedSubscriptions` to `true` in [`broker.conf`](https://github.com/apache/pulsar/blob/470b674016c8718f2dfd0a0f93cf02d49af0fead/conf/broker.conf#L592).
+
+- For consumer side: replicated subscription is disabled by default. You can enable replicated subscriptions when creating a consumer.
+
+ ```java
+ Consumer<String> consumer = client.newConsumer(Schema.STRING)
+ .topic("my-topic")
+ .subscriptionName("my-subscription")
+ .replicateSubscriptionState(true)
+ .subscribe();
+ ```
### Advantages
diff --git a/docs/client-libraries-cluster-level-failover.md b/docs/client-libraries-cluster-level-failover.md
index e9be45ecd34..667deefc63a 100644
--- a/docs/client-libraries-cluster-level-failover.md
+++ b/docs/client-libraries-cluster-level-failover.md
@@ -26,7 +26,7 @@ For more information about cluster-level failover, including concepts, benefits,
* The number of BookKeeper nodes should be equal to or greater than the ensemble quorum.
* The number of ZooKeeper nodes should be equal to or greater than 3.
* **Turn on geo-replication** between the primary cluster and any dependent cluster (primary to backup or backup to backup) to prevent data loss.
-* Set `replicateSubscriptionState` to `true` when creating consumers.
+* [Enable replicated subscription](administration-geo.md#enable-replicated-subscription).
## Configure cluster-level failover
diff --git a/versioned_docs/version-2.10.x/administration-geo.md b/versioned_docs/version-2.10.x/administration-geo.md
index a8729c68378..892af4555f4 100644
--- a/versioned_docs/version-2.10.x/administration-geo.md
+++ b/versioned_docs/version-2.10.x/administration-geo.md
@@ -229,17 +229,19 @@ In case of failover, a consumer can restart consuming from the failure point in
### Enable replicated subscription
-Replicated subscription is disabled by default. You can enable replicated subscription when creating a consumer.
+If you want to use replicated subscriptions in Pulsar:
-```java
+- For broker side: set `enableReplicatedSubscriptions` to `true` in [`broker.conf`](https://github.com/apache/pulsar/blob/470b674016c8718f2dfd0a0f93cf02d49af0fead/conf/broker.conf#L592).
-Consumer<String> consumer = client.newConsumer(Schema.STRING)
- .topic("my-topic")
- .subscriptionName("my-subscription")
- .replicateSubscriptionState(true)
- .subscribe();
+- For consumer side: replicated subscription is disabled by default. You can enable replicated subscriptions when creating a consumer.
-```
+ ```java
+ Consumer<String> consumer = client.newConsumer(Schema.STRING)
+ .topic("my-topic")
+ .subscriptionName("my-subscription")
+ .replicateSubscriptionState(true)
+ .subscribe();
+ ```
### Advantages
diff --git a/versioned_docs/version-2.10.x/client-libraries-java.md b/versioned_docs/version-2.10.x/client-libraries-java.md
index b19dc269ed0..12230feb12d 100644
--- a/versioned_docs/version-2.10.x/client-libraries-java.md
+++ b/versioned_docs/version-2.10.x/client-libraries-java.md
@@ -331,7 +331,7 @@ This section guides you through every step on how to configure cluster-level fai
* **Turn on geo-replication** between the primary cluster and any dependent cluster (primary to backup or backup to backup) to prevent data loss.
-* Set `replicateSubscriptionState` to `true` when creating consumers.
+* [Enable replicated subscription](administration-geo.md#enable-replicated-subscription).
````mdx-code-block
<Tabs
diff --git a/versioned_docs/version-2.11.x/administration-geo.md b/versioned_docs/version-2.11.x/administration-geo.md
index 498025fa28c..b7c70ec2dff 100644
--- a/versioned_docs/version-2.11.x/administration-geo.md
+++ b/versioned_docs/version-2.11.x/administration-geo.md
@@ -214,15 +214,19 @@ In case of failover, a consumer can restart consuming from the failure point in
### Enable replicated subscription
-Replicated subscription is disabled by default. You can enable replicated subscriptions when creating a consumer.
+If you want to use replicated subscriptions in Pulsar:
-```java
-Consumer<String> consumer = client.newConsumer(Schema.STRING)
- .topic("my-topic")
- .subscriptionName("my-subscription")
- .replicateSubscriptionState(true)
- .subscribe();
-```
+- For broker side: set `enableReplicatedSubscriptions` to `true` in [`broker.conf`](https://github.com/apache/pulsar/blob/470b674016c8718f2dfd0a0f93cf02d49af0fead/conf/broker.conf#L592).
+
+- For consumer side: replicated subscription is disabled by default. You can enable replicated subscriptions when creating a consumer.
+
+ ```java
+ Consumer<String> consumer = client.newConsumer(Schema.STRING)
+ .topic("my-topic")
+ .subscriptionName("my-subscription")
+ .replicateSubscriptionState(true)
+ .subscribe();
+ ```
### Advantages
diff --git a/versioned_docs/version-2.11.x/client-libraries-java.md b/versioned_docs/version-2.11.x/client-libraries-java.md
index c95434be966..dfbd64180c4 100644
--- a/versioned_docs/version-2.11.x/client-libraries-java.md
+++ b/versioned_docs/version-2.11.x/client-libraries-java.md
@@ -1193,7 +1193,7 @@ For more concepts and reference information about cluster-level failover, includ
* **Turn on geo-replication** between the primary cluster and any dependent cluster (primary to backup or backup to backup) to prevent data loss.
-* Set `replicateSubscriptionState` to `true` when creating consumers.
+* [Enable replicated subscription](administration-geo.md#enable-replicated-subscription).
````mdx-code-block
<Tabs groupId="failover-choice"