This is an automated email from the ASF dual-hosted git repository.
mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 99c0ed2 Issue 1416: Docs about garbage collection are
inaccurate/lacking (#2049)
99c0ed2 is described below
commit 99c0ed2d9309ae272a049852889827d227a87882
Author: Sijie Guo <[email protected]>
AuthorDate: Fri Jun 29 15:30:36 2018 -0700
Issue 1416: Docs about garbage collection are inaccurate/lacking (#2049)
*Motivation*
Fixes #1416. Improve documentation around garbage collecting topic in
[GeoReplication](http://pulsar.apache.org/docs/latest/admin/GeoReplication/#creating-global-namespaces)
documentation page.
*Solution*
- explicitly callout topics only being deleted when no messages are kept
for retention.
- callout the flag to disable garabge collecting inactive topics.
---
site/docs/latest/admin/GeoReplication.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/site/docs/latest/admin/GeoReplication.md
b/site/docs/latest/admin/GeoReplication.md
index 4acc658..7abc25a 100644
--- a/site/docs/latest/admin/GeoReplication.md
+++ b/site/docs/latest/admin/GeoReplication.md
@@ -137,6 +137,8 @@ Each cluster reports its own local stats, including
incoming and outgoing replic
Given that global topics exist in multiple regions, it's not possible to
directly delete a global topic. Instead, you should rely on automatic topic
garbage collection.
-In Pulsar, a topic is automatically deleted when it's no longer used, that is
to say, when no producers or consumers are connected *and* there are no
subscriptions. For global topics, each region will use a fault-tolerant
mechanism to decide when it's safe to delete the topic locally.
+In Pulsar, a topic is automatically deleted when it's no longer used, that is
to say, when no producers or consumers are connected *and* there are no
subscriptions *and* no more messages are kept for retention. For global topics,
each region will use a fault-tolerant mechanism to decide when it's safe to
delete the topic locally.
+
+You can explicitly disable topic garbage collection by setting
`brokerDeleteInactiveTopicsEnabled` to `false` in your [broker
configuration](../../reference/Configuration/#Broker-ckhlfn).
To delete a global topic, close all producers and consumers on the topic and
delete all its local subscriptions in every replication cluster. When Pulsar
determines that no valid subscription for the topic remains across the system,
it will garbage collect the topic.
