This is an automated email from the ASF dual-hosted git repository.
sijie 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 adfbb0c [Docs]Add documentation for consumerless subscriptions and
their modes (#9125)
adfbb0c is described below
commit adfbb0c33e52a14b277157c5a2b6b90d15618331
Author: Michael Marshall <[email protected]>
AuthorDate: Thu Jan 7 22:21:47 2021 -0600
[Docs]Add documentation for consumerless subscriptions and their modes
(#9125)
### Motivation
This PR seeks to clarify subscriptions without consumers by adding new
documentation. In https://github.com/apache/pulsar/issues/8906, @merlimat
helped me understand these subscriptions, and this PR adds that knowledge to
the documentation.
[Here](https://github.com/apache/pulsar/issues/8906#issuecomment-742836792) is
the specific comment that provides the basis for this PR.
### Modifications
Adds documentation in the subscription mode section to describe how
subscription modes are defined and that they are undefined when there aren't
consumers.
This is only a documentation change.
---
site2/docs/concepts-messaging.md | 3 +++
site2/website/versioned_docs/version-2.7.0/concepts-messaging.md | 3 +++
site2/website/versioned_docs/version-2.7.1/concepts-messaging.md | 3 +++
3 files changed, 9 insertions(+)
diff --git a/site2/docs/concepts-messaging.md b/site2/docs/concepts-messaging.md
index c455b24..0a456f3 100644
--- a/site2/docs/concepts-messaging.md
+++ b/site2/docs/concepts-messaging.md
@@ -242,6 +242,9 @@ A subscription is a named configuration rule that
determines how messages are de
> * If you want to achieve "message queuing" among consumers, share the same
> subscription name among multiple consumers(shared, failover, key_shared).
> * If you want to achieve both effects simultaneously, combine exclusive
> subscription mode with other subscription modes for consumers.
+### Consumerless Subscriptions and Their Corresponding Modes
+When a subscription has no consumers, its subscription mode is undefined. A
subscription's mode is defined when a consumer connects to the subscription,
and the mode can be changed by restarting all consumers with a different
configuration.
+
### Exclusive
In *exclusive* mode, only a single consumer is allowed to attach to the
subscription. If multiple consumers subscribe to a topic using the same
subscription, an error occurs.
diff --git a/site2/website/versioned_docs/version-2.7.0/concepts-messaging.md
b/site2/website/versioned_docs/version-2.7.0/concepts-messaging.md
index 21557a4..4cb4b79 100644
--- a/site2/website/versioned_docs/version-2.7.0/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.7.0/concepts-messaging.md
@@ -243,6 +243,9 @@ A subscription is a named configuration rule that
determines how messages are de
> * If you want to achieve "message queuing" among consumers, share the same
> subscription name among multiple consumers(shared, failover, key_shared).
> * If you want to achieve both effects simultaneously, combine exclusive
> subscription mode with other subscription modes for consumers.
+### Consumerless Subscriptions and Their Corresponding Modes
+When a subscription has no consumers, its subscription mode is undefined. A
subscription's mode is defined when a consumer connects to the subscription,
and the mode can be changed by restarting all consumers with a different
configuration.
+
### Exclusive
In *exclusive* mode, only a single consumer is allowed to attach to the
subscription. If multiple consumers subscribe to a topic using the same
subscription, an error occurs.
diff --git a/site2/website/versioned_docs/version-2.7.1/concepts-messaging.md
b/site2/website/versioned_docs/version-2.7.1/concepts-messaging.md
index 1348f8c..3b8e246 100644
--- a/site2/website/versioned_docs/version-2.7.1/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.7.1/concepts-messaging.md
@@ -243,6 +243,9 @@ A subscription is a named configuration rule that
determines how messages are de
> * If you want to achieve "message queuing" among consumers, share the same
> subscription name among multiple consumers(shared, failover, key_shared).
> * If you want to achieve both effects simultaneously, combine exclusive
> subscription mode with other subscription modes for consumers.
+### Consumerless Subscriptions and Their Corresponding Modes
+When a subscription has no consumers, its subscription mode is undefined. A
subscription's mode is defined when a consumer connects to the subscription,
and the mode can be changed by restarting all consumers with a different
configuration.
+
### Exclusive
In *exclusive* mode, only a single consumer is allowed to attach to the
subscription. If multiple consumers subscribe to a topic using the same
subscription, an error occurs.
