You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by mm...@apache.org on 2018/05/02 19:54:25 UTC
[incubator-pulsar] branch asf-site updated: Updated site at
revision 8056df5
This is an automated email from the ASF dual-hosted git repository.
mmerli pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 38b40a3 Updated site at revision 8056df5
38b40a3 is described below
commit 38b40a3b5a6d03b00ecf5237fe1204794b772038
Author: jenkins <bu...@apache.org>
AuthorDate: Wed May 2 19:54:18 2018 +0000
Updated site at revision 8056df5
---
content/api/admin/allclasses-frame.html | 3 +
content/api/admin/allclasses-noframe.html | 3 +
content/api/admin/deprecated-list.html | 4 +-
content/api/admin/index-all.html | 67 +-
.../org/apache/pulsar/client/admin/Functions.html | 4 +-
.../admin/LongRunningProcessStatus.Status.html | 366 +
.../client/admin/LongRunningProcessStatus.html | 354 +
.../org/apache/pulsar/client/admin/Lookup.html | 4 +-
.../pulsar/client/admin/NonPersistentTopics.html | 4 +-
.../pulsar/client/admin/OffloadProcessStatus.html | 358 +
.../pulsar/client/admin/PersistentTopics.html | 10 +-
.../pulsar/client/admin/PulsarAdminBuilder.html | 30 +-
.../org/apache/pulsar/client/admin/Topics.html | 231 +-
.../apache/pulsar/client/admin/package-frame.html | 6 +
.../pulsar/client/admin/package-summary.html | 31 +-
.../apache/pulsar/client/admin/package-tree.html | 17 +
content/api/admin/overview-tree.html | 6 +
content/contact/index.html | 2 +
content/css/style.css | 7 +-
.../docs/latest/adaptors/KafkaWrapper/index.html | 50 +-
.../docs/latest/adaptors/PulsarSpark/index.html | 54 +-
.../docs/latest/adaptors/PulsarStorm/index.html | 48 +-
content/docs/latest/admin-api/brokers/index.html | 34 +-
content/docs/latest/admin-api/clusters/index.html | 34 +-
.../docs/latest/admin-api/namespaces/index.html | 32 +-
.../admin-api/non-persistent-topics/index.html | 32 +-
content/docs/latest/admin-api/overview/index.html | 64 +-
.../latest/admin-api/partitioned-topics/index.html | 36 +-
.../docs/latest/admin-api/permissions/index.html | 32 +-
.../latest/admin-api/persistent-topics/index.html | 34 +-
.../Dashboard => admin-api/tenants}/index.html | 115 +-
content/docs/latest/admin/Authz/index.html | 84 +-
content/docs/latest/admin/Dashboard/index.html | 32 +-
.../docs/latest/admin/GeoReplication/index.html | 32 +-
.../brokers => admin/LoadDistribution}/index.html | 278 +-
content/docs/latest/admin/Proxy/index.html | 34 +-
content/docs/latest/admin/Stats/index.html | 32 +-
.../latest/admin/ZooKeeperBookKeeper/index.html | 130 +-
content/docs/latest/clients/Cpp/index.html | 102 +-
content/docs/latest/clients/Java/index.html | 211 +-
content/docs/latest/clients/Python/index.html | 46 +-
content/docs/latest/clients/WebSocket/index.html | 52 +-
.../docs/latest/cookbooks/Encryption/index.html | 60 +-
.../latest/cookbooks/PartitionedTopics/index.html | 78 +-
.../latest/cookbooks/RetentionExpiry/index.html | 68 +-
.../cookbooks/message-deduplication/index.html | 56 +-
.../docs/latest/cookbooks/message-queue/index.html | 72 +-
.../cookbooks/non-persistent-messaging/index.html | 34 +-
.../docs/latest/deployment/Kubernetes/index.html | 50 +-
.../docs/latest/deployment/Monitoring/index.html | 32 +-
.../docs/latest/deployment/aws-cluster/index.html | 66 +-
content/docs/latest/deployment/cluster/index.html | 74 +-
content/docs/latest/deployment/dcos/index.html | 32 +-
content/docs/latest/deployment/instance/index.html | 186 +-
content/docs/latest/functions/api/index.html | 32 +-
.../docs/latest/functions/deployment/index.html | 32 +-
.../docs/latest/functions/guarantees/index.html | 32 +-
content/docs/latest/functions/metrics/index.html | 32 +-
content/docs/latest/functions/overview/index.html | 32 +-
.../docs/latest/functions/quickstart/index.html | 32 +-
.../docs/latest/getting-started/Clients/index.html | 32 +-
.../ConceptsAndArchitecture/index.html | 409 +-
.../latest/getting-started/LocalCluster/index.html | 75 +-
.../Pulsar-2.0}/index.html | 281 +-
.../docs/latest/getting-started/docker/index.html | 50 +-
.../docs/latest/project/BinaryProtocol/index.html | 44 +-
content/docs/latest/project/Codebase/index.html | 32 +-
.../ModularLoadManager}/index.html | 452 +-
.../docs/latest/project/SimulationTools/index.html | 38 +-
content/docs/latest/reference/CliTools/index.html | 868 +-
.../docs/latest/reference/Configuration/index.html | 94 +-
content/docs/latest/reference/RestApi/index.html | 15644 ++++++++++++++++++-
content/download/index.html | 12 +-
content/events/current-event/index.html | 2 +
content/img/exclusive-subscriptions.png | Bin 0 -> 59440 bytes
content/img/partitioning.png | Bin 0 -> 125576 bytes
content/img/pulsar-service-discovery.png | Bin 0 -> 65898 bytes
content/img/pulsar-subscription-modes.png | Bin 0 -> 66178 bytes
content/img/pulsar-system-architecture.png | Bin 0 -> 309560 bytes
content/img/shared-subscriptions.png | Bin 0 -> 68922 bytes
content/index.html | 2 +
content/ja/adaptors/PulsarSpark/index.html | 24 +-
content/ja/adaptors/PulsarStorm/index.html | 18 +-
content/ja/admin/AdminInterface/index.html | 44 +-
content/ja/admin/Authz/index.html | 66 +-
content/ja/admin/ClustersBrokers/index.html | 42 +-
content/ja/admin/Dashboard/index.html | 2 +
content/ja/admin/GeoReplication/index.html | 2 +
content/ja/admin/ModularLoadManager/index.html | 2 +
content/ja/admin/PropertiesNamespaces/index.html | 30 +-
content/ja/admin/Stats/index.html | 2 +
content/ja/admin/ZooKeeperBookKeeper/index.html | 58 +-
content/ja/advanced/PartitionedTopics/index.html | 32 +-
content/ja/advanced/RetentionExpiry/index.html | 30 +-
content/ja/clients/Cpp/index.html | 26 +-
content/ja/clients/Java/index.html | 26 +-
content/ja/clients/Python/index.html | 18 +-
content/ja/clients/WebSocket/index.html | 20 +
content/ja/deployment/InstanceSetup/index.html | 20 +-
content/ja/deployment/Kubernetes/index.html | 18 +-
content/ja/deployment/Monitoring/index.html | 2 +
content/ja/getting-started/Clients/index.html | 2 +
.../ConceptsAndArchitecture/index.html | 24 +-
content/ja/getting-started/LocalCluster/index.html | 14 +
content/ja/project/BinaryProtocol/index.html | 18 +-
content/ja/project/Codebase/index.html | 2 +
content/ja/project/SimulationTools/index.html | 8 +
content/ja/reference/CliTools/index.html | 850 +-
content/ja/reference/Configuration/index.html | 58 +-
content/ja/reference/RestApi/index.html | 15622 +++++++++++++++++-
content/release-notes/index.html | 754 +
content/resources/index.html | 2 +
content/team/index.html | 2 +
113 files changed, 37406 insertions(+), 2572 deletions(-)
diff --git a/content/api/admin/allclasses-frame.html b/content/api/admin/allclasses-frame.html
index 6d8340d..bbd347a 100644
--- a/content/api/admin/allclasses-frame.html
+++ b/content/api/admin/allclasses-frame.html
@@ -34,6 +34,8 @@
<li><a href="org/apache/pulsar/common/policies/data/FailureDomain.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">FailureDomain</a></li>
<li><a href="org/apache/pulsar/client/admin/Functions.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">Functions</span></a></li>
<li><a href="org/apache/pulsar/common/policies/data/LocalPolicies.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">LocalPolicies</a></li>
+<li><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin" target="classFrame">LongRunningProcessStatus</a></li>
+<li><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin" target="classFrame">LongRunningProcessStatus.Status</a></li>
<li><a href="org/apache/pulsar/client/admin/Lookup.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">Lookup</span></a></li>
<li><a href="org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html" title="class in org.apache.pulsar.common.policies.impl" target="classFrame">MinAvailablePolicy</a></li>
<li><a href="org/apache/pulsar/common/policies/data/NamespaceIsolationData.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">NamespaceIsolationData</a></li>
@@ -47,6 +49,7 @@
<li><a href="org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">NonPersistentSubscriptionStats</a></li>
<li><a href="org/apache/pulsar/client/admin/NonPersistentTopics.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">NonPersistentTopics</span></a></li>
<li><a href="org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">NonPersistentTopicStats</a></li>
+<li><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin" target="classFrame">OffloadProcessStatus</a></li>
<li><a href="org/apache/pulsar/common/policies/data/PartitionedTopicStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PartitionedTopicStats</a></li>
<li><a href="org/apache/pulsar/common/policies/data/PersistencePolicies.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PersistencePolicies</a></li>
<li><a href="org/apache/pulsar/common/policies/data/PersistentOfflineTopicStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PersistentOfflineTopicStats</a></li>
diff --git a/content/api/admin/allclasses-noframe.html b/content/api/admin/allclasses-noframe.html
index d0645ac..14c87bf 100644
--- a/content/api/admin/allclasses-noframe.html
+++ b/content/api/admin/allclasses-noframe.html
@@ -34,6 +34,8 @@
<li><a href="org/apache/pulsar/common/policies/data/FailureDomain.html" title="class in org.apache.pulsar.common.policies.data">FailureDomain</a></li>
<li><a href="org/apache/pulsar/client/admin/Functions.html" title="interface in org.apache.pulsar.client.admin"><span class="interfaceName">Functions</span></a></li>
<li><a href="org/apache/pulsar/common/policies/data/LocalPolicies.html" title="class in org.apache.pulsar.common.policies.data">LocalPolicies</a></li>
+<li><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></li>
+<li><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></li>
<li><a href="org/apache/pulsar/client/admin/Lookup.html" title="interface in org.apache.pulsar.client.admin"><span class="interfaceName">Lookup</span></a></li>
<li><a href="org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html" title="class in org.apache.pulsar.common.policies.impl">MinAvailablePolicy</a></li>
<li><a href="org/apache/pulsar/common/policies/data/NamespaceIsolationData.html" title="class in org.apache.pulsar.common.policies.data">NamespaceIsolationData</a></li>
@@ -47,6 +49,7 @@
<li><a href="org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data">NonPersistentSubscriptionStats</a></li>
<li><a href="org/apache/pulsar/client/admin/NonPersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="interfaceName">NonPersistentTopics</span></a></li>
<li><a href="org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data">NonPersistentTopicStats</a></li>
+<li><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></li>
<li><a href="org/apache/pulsar/common/policies/data/PartitionedTopicStats.html" title="class in org.apache.pulsar.common.policies.data">PartitionedTopicStats</a></li>
<li><a href="org/apache/pulsar/common/policies/data/PersistencePolicies.html" title="class in org.apache.pulsar.common.policies.data">PersistencePolicies</a></li>
<li><a href="org/apache/pulsar/common/policies/data/PersistentOfflineTopicStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentOfflineTopicStats</a></li>
diff --git a/content/api/admin/deprecated-list.html b/content/api/admin/deprecated-list.html
index b4c6c35..660e832 100644
--- a/content/api/admin/deprecated-list.html
+++ b/content/api/admin/deprecated-list.html
@@ -93,9 +93,7 @@
</td>
</tr>
<tr class="rowColor">
-<td class="colOne"><a href="org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin">org.apache.pulsar.client.admin.PersistentTopics</a>
-<div class="block"><span class="deprecationComment">since 2.0. See <a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin"><code>Topics</code></a></span></div>
-</td>
+<td class="colOne"><a href="org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin">org.apache.pulsar.client.admin.PersistentTopics</a></td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">org.apache.pulsar.client.admin.Properties</a>
diff --git a/content/api/admin/index-all.html b/content/api/admin/index-all.html
index 9916ee7..3261654 100644
--- a/content/api/admin/index-all.html
+++ b/content/api/admin/index-all.html
@@ -429,11 +429,15 @@
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/Policies.html#defaultBundle--">defaultBundle()</a></span> - Static method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data">Policies</a></dt>
<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#delete-java.lang.String-boolean-">delete(String, boolean)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
+<dd>
+<div class="block">Delete a topic.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#delete-java.lang.String-">delete(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
<dd>
<div class="block">Delete a topic.</div>
</dd>
-<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#deleteAsync-java.lang.String-">deleteAsync(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#deleteAsync-java.lang.String-boolean-">deleteAsync(String, boolean)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
<dd>
<div class="block">Delete a topic asynchronously.</div>
</dd>
@@ -467,11 +471,15 @@
<dd>
<div class="block">Delete a namespace isolation policy for a cluster</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopic-java.lang.String-boolean-">deletePartitionedTopic(String, boolean)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
+<dd>
+<div class="block">Delete a partitioned topic.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopic-java.lang.String-">deletePartitionedTopic(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
<dd>
<div class="block">Delete a partitioned topic.</div>
</dd>
-<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopicAsync-java.lang.String-">deletePartitionedTopicAsync(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopicAsync-java.lang.String-boolean-">deletePartitionedTopicAsync(String, boolean)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
<dd>
<div class="block">Delete a partitioned topic asynchronously.</div>
</dd>
@@ -518,6 +526,10 @@
</a>
<h2 class="title">E</h2>
<dl>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PulsarAdminBuilder.html#enableTlsHostnameVerification-boolean-">enableTlsHostnameVerification(boolean)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin">PulsarAdminBuilder</a></dt>
+<dd>
+<div class="block">It allows to validate hostname verification when client connects to broker over TLS.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/Policies.html#encryption_required">encryption_required</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data">Policies</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentOfflineTopicStats.LedgerDetails.html#entries">entries</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentOfflineTopicStats.LedgerDetails.html" title="class in org.apache.pulsar.common.policies.data">PersistentOfflineTopicStats.LedgerDetails</a></dt>
@@ -606,6 +618,18 @@
</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/Policies.html#FIRST_BOUNDARY">FIRST_BOUNDARY</a></span> - Static variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data">Policies</a></dt>
<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html#firstUnoffloadedMessage">firstUnoffloadedMessage</a></span> - Variable in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></dt>
+<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html#forError-java.lang.String-">forError(String)</a></span> - Static method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></dt>
+<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html#forError-java.lang.String-">forError(String)</a></span> - Static method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></dt>
+<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html#forStatus-org.apache.pulsar.client.admin.LongRunningProcessStatus.Status-">forStatus(LongRunningProcessStatus.Status)</a></span> - Static method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></dt>
+<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html#forStatus-org.apache.pulsar.client.admin.LongRunningProcessStatus.Status-">forStatus(LongRunningProcessStatus.Status)</a></span> - Static method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></dt>
+<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html#forSuccess-MessageIdImpl-">forSuccess(MessageIdImpl)</a></span> - Static method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></dt>
+<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/AutoFailoverPolicyType.html#fromString-java.lang.String-">fromString(String)</a></span> - Static method in enum org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/AutoFailoverPolicyType.html" title="enum in org.apache.pulsar.common.policies.data">AutoFailoverPolicyType</a></dt>
<dd> </dd>
<dt><a href="org/apache/pulsar/client/admin/Functions.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Functions</span></a> - Interface in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt>
@@ -1142,6 +1166,8 @@
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html#lastConfirmedEntry">lastConfirmedEntry</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats</a></dt>
<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html#lastError">lastError</a></span> - Variable in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></dt>
+<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html#lastLedgerCreatedTimestamp">lastLedgerCreatedTimestamp</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html#lastLedgerCreationFailureTimestamp">lastLedgerCreationFailureTimestamp</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats</a></dt>
@@ -1164,6 +1190,14 @@
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/LocalPolicies.html#LocalPolicies--">LocalPolicies()</a></span> - Constructor for class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/LocalPolicies.html" title="class in org.apache.pulsar.common.policies.data">LocalPolicies</a></dt>
<dd> </dd>
+<dt><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">LongRunningProcessStatus</span></a> - Class in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt>
+<dd>
+<div class="block">Status of long running process.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html#LongRunningProcessStatus--">LongRunningProcessStatus()</a></span> - Constructor for class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></dt>
+<dd> </dd>
+<dt><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin"><span class="typeNameLink">LongRunningProcessStatus.Status</span></a> - Enum in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt>
+<dd> </dd>
<dt><a href="org/apache/pulsar/client/admin/Lookup.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Lookup</span></a> - Interface in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt>
<dd>
<div class="block">This is an interface class to allow using command line tool to quickly lookup the broker serving the topic.</div>
@@ -1393,6 +1427,16 @@
</a>
<h2 class="title">O</h2>
<dl>
+<dt><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">OffloadProcessStatus</span></a> - Class in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt>
+<dd>
+<div class="block">Status of offload process.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html#OffloadProcessStatus--">OffloadProcessStatus()</a></span> - Constructor for class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></dt>
+<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#offloadStatus-java.lang.String-">offloadStatus(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
+<dd>
+<div class="block">Check the status of an ongoing offloading operation for a topic.</div>
+</dd>
<dt><a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a> - package org.apache.pulsar.client.admin</dt>
<dd> </dd>
<dt><a href="org/apache/pulsar/common/policies/package-summary.html">org.apache.pulsar.common.policies</a> - package org.apache.pulsar.common.policies</dt>
@@ -1465,9 +1509,7 @@
<dd> </dd>
<dt><a href="org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">PersistentTopics</span></a> - Interface in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt>
<dd>
-<div class="block"><span class="deprecatedLabel">Deprecated.</span>
-<div class="block"><span class="deprecationComment">since 2.0. See <a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin"><code>Topics</code></a></span></div>
-</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PulsarAdmin.html#persistentTopics--">persistentTopics()</a></span> - Method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin">PulsarAdmin</a></dt>
<dd>
@@ -1893,6 +1935,8 @@
<dd>
<div class="block">timestamp when stat was generated</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html#status">status</a></span> - Variable in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></dt>
+<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentOfflineTopicStats.html#storageSize">storageSize</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentOfflineTopicStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentOfflineTopicStats</a></dt>
<dd>
<div class="block">Space used to store the messages for the topic.</div>
@@ -2009,6 +2053,10 @@
<dd>
<div class="block">Triggers the function by writing to the input topic.</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Topics.html#triggerOffload-java.lang.String-MessageId-">triggerOffload(String, MessageId)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dt>
+<dd>
+<div class="block">Trigger offloading messages in topic to longterm storage.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/SubscriptionStats.html#type">type</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/SubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data">SubscriptionStats</a></dt>
<dd>
<div class="block">whether this subscription is Exclusive or Shared or Failover</div>
@@ -2122,6 +2170,10 @@
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/NamespaceIsolationData.html#validate--">validate()</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/NamespaceIsolationData.html" title="class in org.apache.pulsar.common.policies.data">NamespaceIsolationData</a></dt>
<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></dt>
+<dd>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/AuthAction.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/AuthAction.html" title="enum in org.apache.pulsar.common.policies.data">AuthAction</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
@@ -2146,6 +2198,11 @@
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#values--">values()</a></span> - Static method in enum org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></dt>
+<dd>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/AuthAction.html#values--">values()</a></span> - Static method in enum org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/AuthAction.html" title="enum in org.apache.pulsar.common.policies.data">AuthAction</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
diff --git a/content/api/admin/org/apache/pulsar/client/admin/Functions.html b/content/api/admin/org/apache/pulsar/client/admin/Functions.html
index a51de06..a40ef7a 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/Functions.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/Functions.html
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/pulsar/client/admin/Clusters.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/pulsar/client/admin/Lookup.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/Functions.html" target="_top">Frames</a></li>
@@ -438,7 +438,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/pulsar/client/admin/Clusters.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/pulsar/client/admin/Lookup.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/Functions.html" target="_top">Frames</a></li>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html b/content/api/admin/org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html
new file mode 100644
index 0000000..abddbf5
--- /dev/null
+++ b/content/api/admin/org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html
@@ -0,0 +1,366 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>LongRunningProcessStatus.Status (Pulsar Admin Java API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="LongRunningProcessStatus.Status (Pulsar Admin Java API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":9,"i1":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/Lookup.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" target="_top">Frames</a></li>
+<li><a href="LongRunningProcessStatus.Status.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.pulsar.client.admin</div>
+<h2 title="Enum LongRunningProcessStatus.Status" class="title">Enum LongRunningProcessStatus.Status</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>Object</li>
+<li>
+<ul class="inheritance">
+<li>Enum<<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a>></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.pulsar.client.admin.LongRunningProcessStatus.Status</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>Serializable, Comparable<<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a>></dd>
+</dl>
+<dl>
+<dt>Enclosing class:</dt>
+<dd><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public static enum <span class="typeNameLabel">LongRunningProcessStatus.Status</span>
+extends Enum<<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a>></pre>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ENUM CONSTANT SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum.constant.summary">
+<!-- -->
+</a>
+<h3>Enum Constant Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
+<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Enum Constant and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#ERROR">ERROR</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#NOT_RUN">NOT_RUN</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#RUNNING">RUNNING</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#SUCCESS">SUCCESS</a></span></code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#valueOf-java.lang.String-">valueOf</a></span>(String name)</code>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html#values--">values</a></span>()</code>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.Enum">
+<!-- -->
+</a>
+<h3>Methods inherited from class Enum</h3>
+<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class Object</h3>
+<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ENUM CONSTANT DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum.constant.detail">
+<!-- -->
+</a>
+<h3>Enum Constant Detail</h3>
+<a name="NOT_RUN">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>NOT_RUN</h4>
+<pre>public static final <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> NOT_RUN</pre>
+</li>
+</ul>
+<a name="RUNNING">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>RUNNING</h4>
+<pre>public static final <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> RUNNING</pre>
+</li>
+</ul>
+<a name="SUCCESS">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SUCCESS</h4>
+<pre>public static final <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> SUCCESS</pre>
+</li>
+</ul>
+<a name="ERROR">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>ERROR</h4>
+<pre>public static final <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> ERROR</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="values--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>values</h4>
+<pre>public static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a>[] values()</pre>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+<pre>
+for (LongRunningProcessStatus.Status c : LongRunningProcessStatus.Status.values())
+ System.out.println(c);
+</pre></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an array containing the constants of this enum type, in the order they are declared</dd>
+</dl>
+</li>
+</ul>
+<a name="valueOf-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>valueOf</h4>
+<pre>public static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> valueOf(String name)</pre>
+<div class="block">Returns the enum constant of this type with the specified name.
+The string must match <i>exactly</i> an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - the name of the enum constant to be returned.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the enum constant with the specified name</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
+<dd><code>NullPointerException</code> - if the argument is null</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/Lookup.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" target="_top">Frames</a></li>
+<li><a href="LongRunningProcessStatus.Status.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/LongRunningProcessStatus.html b/content/api/admin/org/apache/pulsar/client/admin/LongRunningProcessStatus.html
new file mode 100644
index 0000000..bbcd844
--- /dev/null
+++ b/content/api/admin/org/apache/pulsar/client/admin/LongRunningProcessStatus.html
@@ -0,0 +1,354 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>LongRunningProcessStatus (Pulsar Admin Java API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="LongRunningProcessStatus (Pulsar Admin Java API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":9,"i1":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/pulsar/client/admin/Functions.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/LongRunningProcessStatus.html" target="_top">Frames</a></li>
+<li><a href="LongRunningProcessStatus.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested.class.summary">Nested</a> | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.pulsar.client.admin</div>
+<h2 title="Class LongRunningProcessStatus" class="title">Class LongRunningProcessStatus</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.pulsar.client.admin.LongRunningProcessStatus</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">LongRunningProcessStatus</span>
+extends Object</pre>
+<div class="block">Status of long running process.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested.class.summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
+<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static class </code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></span></code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html#lastError">lastError</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html#status">status</a></span></code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html#LongRunningProcessStatus--">LongRunningProcessStatus</a></span>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html#forError-java.lang.String-">forError</a></span>(String lastError)</code> </td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html#forStatus-org.apache.pulsar.client.admin.LongRunningProcessStatus.Status-">forStatus</a></span>(<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> status)</code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="status">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>status</h4>
+<pre>public <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> status</pre>
+</li>
+</ul>
+<a name="lastError">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>lastError</h4>
+<pre>public String lastError</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="LongRunningProcessStatus--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>LongRunningProcessStatus</h4>
+<pre>public LongRunningProcessStatus()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="forStatus-org.apache.pulsar.client.admin.LongRunningProcessStatus.Status-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>forStatus</h4>
+<pre>public static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a> forStatus(<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> status)</pre>
+</li>
+</ul>
+<a name="forError-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>forError</h4>
+<pre>public static <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a> forError(String lastError)</pre>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/pulsar/client/admin/Functions.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/LongRunningProcessStatus.html" target="_top">Frames</a></li>
+<li><a href="LongRunningProcessStatus.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested.class.summary">Nested</a> | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/Lookup.html b/content/api/admin/org/apache/pulsar/client/admin/Lookup.html
index 6bde5ec..74f0845 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/Lookup.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/Lookup.html
@@ -47,7 +47,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/pulsar/client/admin/Functions.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
@@ -210,7 +210,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/pulsar/client/admin/Functions.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
diff --git a/content/api/admin/org/apache/pulsar/client/admin/NonPersistentTopics.html b/content/api/admin/org/apache/pulsar/client/admin/NonPersistentTopics.html
index 41fac4f..36eae6b 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/NonPersistentTopics.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/NonPersistentTopics.html
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/NonPersistentTopics.html" target="_top">Frames</a></li>
@@ -609,7 +609,7 @@ public interface <span class="typeNameLabel">NonPersistentTopics</span></pre>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/NonPersistentTopics.html" target="_top">Frames</a></li>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/OffloadProcessStatus.html b/content/api/admin/org/apache/pulsar/client/admin/OffloadProcessStatus.html
new file mode 100644
index 0000000..7a34608
--- /dev/null
+++ b/content/api/admin/org/apache/pulsar/client/admin/OffloadProcessStatus.html
@@ -0,0 +1,358 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>OffloadProcessStatus (Pulsar Admin Java API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="OffloadProcessStatus (Pulsar Admin Java API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":9,"i1":9,"i2":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/pulsar/client/admin/NonPersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/OffloadProcessStatus.html" target="_top">Frames</a></li>
+<li><a href="OffloadProcessStatus.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested.classes.inherited.from.class.org.apache.pulsar.client.admin.LongRunningProcessStatus">Nested</a> | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.pulsar.client.admin</div>
+<h2 title="Class OffloadProcessStatus" class="title">Class OffloadProcessStatus</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">org.apache.pulsar.client.admin.LongRunningProcessStatus</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.pulsar.client.admin.OffloadProcessStatus</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">OffloadProcessStatus</span>
+extends <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></pre>
+<div class="block">Status of offload process.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested.class.summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.pulsar.client.admin.LongRunningProcessStatus">
+<!-- -->
+</a>
+<h3>Nested classes/interfaces inherited from class org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></h3>
+<code><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>MessageIdImpl</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html#firstUnoffloadedMessage">firstUnoffloadedMessage</a></span></code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.pulsar.client.admin.LongRunningProcessStatus">
+<!-- -->
+</a>
+<h3>Fields inherited from class org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></h3>
+<code><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html#lastError">lastError</a>, <a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html#status">status</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html#OffloadProcessStatus--">OffloadProcessStatus</a></span>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html#forError-java.lang.String-">forError</a></span>(String lastError)</code> </td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html#forStatus-org.apache.pulsar.client.admin.LongRunningProcessStatus.Status-">forStatus</a></span>(<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> status)</code> </td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html#forSuccess-MessageIdImpl-">forSuccess</a></span>(MessageIdImpl messageId)</code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="firstUnoffloadedMessage">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>firstUnoffloadedMessage</h4>
+<pre>public MessageIdImpl firstUnoffloadedMessage</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="OffloadProcessStatus--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>OffloadProcessStatus</h4>
+<pre>public OffloadProcessStatus()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="forStatus-org.apache.pulsar.client.admin.LongRunningProcessStatus.Status-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>forStatus</h4>
+<pre>public static <a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a> forStatus(<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a> status)</pre>
+</li>
+</ul>
+<a name="forError-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>forError</h4>
+<pre>public static <a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a> forError(String lastError)</pre>
+</li>
+</ul>
+<a name="forSuccess-MessageIdImpl-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>forSuccess</h4>
+<pre>public static <a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a> forSuccess(MessageIdImpl messageId)</pre>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/pulsar/client/admin/NonPersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/OffloadProcessStatus.html" target="_top">Frames</a></li>
+<li><a href="OffloadProcessStatus.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested.classes.inherited.from.class.org.apache.pulsar.client.admin.LongRunningProcessStatus">Nested</a> | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html b/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html
index c47991c..81b41fa 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html
@@ -41,7 +41,7 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/pulsar/client/admin/NonPersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
@@ -96,9 +96,7 @@
<dd><a href="../../../../../org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></dd>
</dl>
<hr>
-<div class="block"><span class="deprecatedLabel">Deprecated.</span>
-<div class="block"><span class="deprecationComment">since 2.0. See <a href="../../../../../org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin"><code>Topics</code></a></span></div>
-</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<br>
<pre>@Deprecated
public interface <span class="typeNameLabel">PersistentTopics</span>
@@ -120,7 +118,7 @@ extends <a href="../../../../../org/apache/pulsar/client/admin/Topics.html" titl
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/Topics.html" title="interface in org.apache.pulsar.client.admin">Topics</a></h3>
-<code><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#compactionStatus-java.lang.String-">compactionStatus</a>, <a href="../../../../../org/apache/pulsar/client/admin/Topics.html#createPartitionedTopic-java.lang.String-int-">createPartitionedTopic</a>, <a href="../../../../../org/apache/pulsar/client/admin/Topics.html#createPartitionedTopicAsync-java.lang.String-int-">createPartitionedTopicAsync</a>, <a href="../../../../../org/apache/pulsar/client/admin/Topics.html#cr [...]
+<code><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#compactionStatus-java.lang.String-">compactionStatus</a>, <a href="../../../../../org/apache/pulsar/client/admin/Topics.html#createPartitionedTopic-java.lang.String-int-">createPartitionedTopic</a>, <a href="../../../../../org/apache/pulsar/client/admin/Topics.html#createPartitionedTopicAsync-java.lang.String-int-">createPartitionedTopicAsync</a>, <a href="../../../../../org/apache/pulsar/client/admin/Topics.html#cr [...]
</ul>
</li>
</ul>
@@ -149,7 +147,7 @@ extends <a href="../../../../../org/apache/pulsar/client/admin/Topics.html" titl
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/pulsar/client/admin/NonPersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
diff --git a/content/api/admin/org/apache/pulsar/client/admin/PulsarAdminBuilder.html b/content/api/admin/org/apache/pulsar/client/admin/PulsarAdminBuilder.html
index 94349a3..a244406 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/PulsarAdminBuilder.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/PulsarAdminBuilder.html
@@ -17,7 +17,7 @@
catch(err) {
}
//-->
-var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
+var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -157,11 +157,17 @@ var activeTableTab = "activeTableTab";
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin">PulsarAdminBuilder</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html#enableTlsHostnameVerification-boolean-">enableTlsHostnameVerification</a></span>(boolean enableTlsHostnameVerification)</code>
+<div class="block">It allows to validate hostname verification when client connects to broker over TLS.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin">PulsarAdminBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html#serviceHttpUrl-java.lang.String-">serviceHttpUrl</a></span>(String serviceHttpUrl)</code>
<div class="block">Set the Pulsar service HTTP URL for the admin endpoint (eg.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin">PulsarAdminBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html#tlsTrustCertsFilePath-java.lang.String-">tlsTrustCertsFilePath</a></span>(String tlsTrustCertsFilePath)</code>
<div class="block">Set the path to the trusted TLS certificate file</div>
@@ -353,7 +359,7 @@ var activeTableTab = "activeTableTab";
<a name="allowTlsInsecureConnection-boolean-">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>allowTlsInsecureConnection</h4>
<pre><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin">PulsarAdminBuilder</a> allowTlsInsecureConnection(boolean allowTlsInsecureConnection)</pre>
@@ -364,6 +370,24 @@ var activeTableTab = "activeTableTab";
</dl>
</li>
</ul>
+<a name="enableTlsHostnameVerification-boolean-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>enableTlsHostnameVerification</h4>
+<pre><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin">PulsarAdminBuilder</a> enableTlsHostnameVerification(boolean enableTlsHostnameVerification)</pre>
+<div class="block">It allows to validate hostname verification when client connects to broker over TLS. It validates incoming x509
+ certificate and matches provided hostname(CN/SAN) with expected broker's host name. It follows RFC 2818, 3.1.
+ Server Identity hostname verification.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>enableTlsHostnameVerification</code> - </dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="https://tools.ietf.org/html/rfc2818">rfc2818</a></dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
</li>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/Topics.html b/content/api/admin/org/apache/pulsar/client/admin/Topics.html
index 5d1e886..f885333 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/Topics.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/Topics.html
@@ -17,7 +17,7 @@
catch(err) {
}
//-->
-var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6};
+var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -123,7 +123,7 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
-<td class="colFirst"><code>CompactionStatus</code></td>
+<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#compactionStatus-java.lang.String-">compactionStatus</a></span>(String topic)</code>
<div class="block">Check the status of an ongoing compaction for a topic.</div>
</td>
@@ -165,38 +165,54 @@ var activeTableTab = "activeTableTab";
</td>
</tr>
<tr id="i6" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#delete-java.lang.String-boolean-">delete</a></span>(String topic,
+ boolean force)</code>
+<div class="block">Delete a topic.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deleteAsync-java.lang.String-">deleteAsync</a></span>(String topic)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deleteAsync-java.lang.String-boolean-">deleteAsync</a></span>(String topic,
+ boolean force)</code>
<div class="block">Delete a topic asynchronously.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopic-java.lang.String-">deletePartitionedTopic</a></span>(String topic)</code>
<div class="block">Delete a partitioned topic.</div>
</td>
</tr>
-<tr id="i8" class="altColor">
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopic-java.lang.String-boolean-">deletePartitionedTopic</a></span>(String topic,
+ boolean force)</code>
+<div class="block">Delete a partitioned topic.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopicAsync-java.lang.String-">deletePartitionedTopicAsync</a></span>(String topic)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deletePartitionedTopicAsync-java.lang.String-boolean-">deletePartitionedTopicAsync</a></span>(String topic,
+ boolean force)</code>
<div class="block">Delete a partitioned topic asynchronously.</div>
</td>
</tr>
-<tr id="i9" class="rowColor">
+<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deleteSubscription-java.lang.String-java.lang.String-">deleteSubscription</a></span>(String topic,
String subName)</code>
<div class="block">Delete a subscription.</div>
</td>
</tr>
-<tr id="i10" class="altColor">
+<tr id="i12" class="altColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#deleteSubscriptionAsync-java.lang.String-java.lang.String-">deleteSubscriptionAsync</a></span>(String topic,
String subName)</code>
<div class="block">Delete a subscription asynchronously.</div>
</td>
</tr>
-<tr id="i11" class="rowColor">
+<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#expireMessages-java.lang.String-java.lang.String-long-">expireMessages</a></span>(String topic,
String subscriptionName,
@@ -204,7 +220,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription</div>
</td>
</tr>
-<tr id="i12" class="altColor">
+<tr id="i14" class="altColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#expireMessagesAsync-java.lang.String-java.lang.String-long-">expireMessagesAsync</a></span>(String topic,
String subscriptionName,
@@ -212,7 +228,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously</div>
</td>
</tr>
-<tr id="i13" class="rowColor">
+<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#expireMessagesForAllSubscriptions-java.lang.String-long-">expireMessagesForAllSubscriptions</a></span>(String topic,
long expireTimeInSeconds)</code>
@@ -220,7 +236,7 @@ var activeTableTab = "activeTableTab";
persistent-topic</div>
</td>
</tr>
-<tr id="i14" class="altColor">
+<tr id="i16" class="altColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#expireMessagesForAllSubscriptionsAsync-java.lang.String-long-">expireMessagesForAllSubscriptionsAsync</a></span>(String topic,
long expireTimeInSeconds)</code>
@@ -228,113 +244,113 @@ var activeTableTab = "activeTableTab";
persistent-topic asynchronously</div>
</td>
</tr>
-<tr id="i15" class="rowColor">
+<tr id="i17" class="rowColor">
<td class="colFirst"><code>JsonObject</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getInternalInfo-java.lang.String-">getInternalInfo</a></span>(String topic)</code>
<div class="block">Get a JSON representation of the topic metadata stored in ZooKeeper</div>
</td>
</tr>
-<tr id="i16" class="altColor">
+<tr id="i18" class="altColor">
<td class="colFirst"><code>CompletableFuture<JsonObject></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getInternalInfoAsync-java.lang.String-">getInternalInfoAsync</a></span>(String topic)</code>
<div class="block">Get a JSON representation of the topic metadata stored in ZooKeeper</div>
</td>
</tr>
-<tr id="i17" class="rowColor">
+<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getInternalStats-java.lang.String-">getInternalStats</a></span>(String topic)</code>
<div class="block">Get the internal stats for the topic.</div>
</td>
</tr>
-<tr id="i18" class="altColor">
+<tr id="i20" class="altColor">
<td class="colFirst"><code>CompletableFuture<<a href="../../../../../org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getInternalStatsAsync-java.lang.String-">getInternalStatsAsync</a></span>(String topic)</code>
<div class="block">Get the internal stats for the topic asynchronously.</div>
</td>
</tr>
-<tr id="i19" class="rowColor">
+<tr id="i21" class="rowColor">
<td class="colFirst"><code>List<String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getList-java.lang.String-">getList</a></span>(String namespace)</code>
<div class="block">Get the list of topics under a namespace.</div>
</td>
</tr>
-<tr id="i20" class="altColor">
+<tr id="i22" class="altColor">
<td class="colFirst"><code>List<String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getListInBundle-java.lang.String-java.lang.String-">getListInBundle</a></span>(String namespace,
String bundleRange)</code>
<div class="block">Get list of topics exist into given bundle</div>
</td>
</tr>
-<tr id="i21" class="rowColor">
+<tr id="i23" class="rowColor">
<td class="colFirst"><code>CompletableFuture<List<String>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getListInBundleAsync-java.lang.String-java.lang.String-">getListInBundleAsync</a></span>(String namespace,
String bundleRange)</code>
<div class="block">Get list of topics exist into given bundle asynchronously.</div>
</td>
</tr>
-<tr id="i22" class="altColor">
+<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/common/policies/data/PartitionedTopicStats.html" title="class in org.apache.pulsar.common.policies.data">PartitionedTopicStats</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getPartitionedStats-java.lang.String-boolean-">getPartitionedStats</a></span>(String topic,
boolean perPartition)</code>
<div class="block">Get the stats for the partitioned topic</div>
</td>
</tr>
-<tr id="i23" class="rowColor">
+<tr id="i25" class="rowColor">
<td class="colFirst"><code>CompletableFuture<<a href="../../../../../org/apache/pulsar/common/policies/data/PartitionedTopicStats.html" title="class in org.apache.pulsar.common.policies.data">PartitionedTopicStats</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getPartitionedStatsAsync-java.lang.String-boolean-">getPartitionedStatsAsync</a></span>(String topic,
boolean perPartition)</code>
<div class="block">Get the stats for the partitioned topic asynchronously</div>
</td>
</tr>
-<tr id="i24" class="altColor">
+<tr id="i26" class="altColor">
<td class="colFirst"><code>List<String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getPartitionedTopicList-java.lang.String-">getPartitionedTopicList</a></span>(String namespace)</code>
<div class="block">Get the list of partitioned topics under a namespace.</div>
</td>
</tr>
-<tr id="i25" class="rowColor">
+<tr id="i27" class="rowColor">
<td class="colFirst"><code>PartitionedTopicMetadata</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getPartitionedTopicMetadata-java.lang.String-">getPartitionedTopicMetadata</a></span>(String topic)</code>
<div class="block">Get metadata of a partitioned topic.</div>
</td>
</tr>
-<tr id="i26" class="altColor">
+<tr id="i28" class="altColor">
<td class="colFirst"><code>CompletableFuture<PartitionedTopicMetadata></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getPartitionedTopicMetadataAsync-java.lang.String-">getPartitionedTopicMetadataAsync</a></span>(String topic)</code>
<div class="block">Get metadata of a partitioned topic asynchronously.</div>
</td>
</tr>
-<tr id="i27" class="rowColor">
+<tr id="i29" class="rowColor">
<td class="colFirst"><code>Map<String,Set<<a href="../../../../../org/apache/pulsar/common/policies/data/AuthAction.html" title="enum in org.apache.pulsar.common.policies.data">AuthAction</a>>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getPermissions-java.lang.String-">getPermissions</a></span>(String topic)</code>
<div class="block">Get permissions on a topic.</div>
</td>
</tr>
-<tr id="i28" class="altColor">
+<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/common/policies/data/TopicStats.html" title="class in org.apache.pulsar.common.policies.data">TopicStats</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getStats-java.lang.String-">getStats</a></span>(String topic)</code>
<div class="block">Get the stats for the topic.</div>
</td>
</tr>
-<tr id="i29" class="rowColor">
+<tr id="i31" class="rowColor">
<td class="colFirst"><code>CompletableFuture<<a href="../../../../../org/apache/pulsar/common/policies/data/TopicStats.html" title="class in org.apache.pulsar.common.policies.data">TopicStats</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getStatsAsync-java.lang.String-">getStatsAsync</a></span>(String topic)</code>
<div class="block">Get the stats for the topic asynchronously.</div>
</td>
</tr>
-<tr id="i30" class="altColor">
+<tr id="i32" class="altColor">
<td class="colFirst"><code>List<String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getSubscriptions-java.lang.String-">getSubscriptions</a></span>(String topic)</code>
<div class="block">Get the list of subscriptions.</div>
</td>
</tr>
-<tr id="i31" class="rowColor">
+<tr id="i33" class="rowColor">
<td class="colFirst"><code>CompletableFuture<List<String>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#getSubscriptionsAsync-java.lang.String-">getSubscriptionsAsync</a></span>(String topic)</code>
<div class="block">Get the list of subscriptions asynchronously.</div>
</td>
</tr>
-<tr id="i32" class="altColor">
+<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#grantPermission-java.lang.String-java.lang.String-java.util.Set-">grantPermission</a></span>(String topic,
String role,
@@ -342,7 +358,13 @@ var activeTableTab = "activeTableTab";
<div class="block">Grant permission on a topic.</div>
</td>
</tr>
-<tr id="i33" class="rowColor">
+<tr id="i35" class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#offloadStatus-java.lang.String-">offloadStatus</a></span>(String topic)</code>
+<div class="block">Check the status of an ongoing offloading operation for a topic.</div>
+</td>
+</tr>
+<tr id="i36" class="altColor">
<td class="colFirst"><code>List<<any>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#peekMessages-java.lang.String-java.lang.String-int-">peekMessages</a></span>(String topic,
String subName,
@@ -350,7 +372,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Peek messages from a topic subscription</div>
</td>
</tr>
-<tr id="i34" class="altColor">
+<tr id="i37" class="rowColor">
<td class="colFirst"><code>CompletableFuture<List<<any>>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#peekMessagesAsync-java.lang.String-java.lang.String-int-">peekMessagesAsync</a></span>(String topic,
String subName,
@@ -358,7 +380,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Peek messages from a topic subscription asynchronously</div>
</td>
</tr>
-<tr id="i35" class="rowColor">
+<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#resetCursor-java.lang.String-java.lang.String-long-">resetCursor</a></span>(String topic,
String subName,
@@ -366,7 +388,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Reset cursor position on a topic subscription</div>
</td>
</tr>
-<tr id="i36" class="altColor">
+<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#resetCursor-java.lang.String-java.lang.String-MessageId-">resetCursor</a></span>(String topic,
String subName,
@@ -374,7 +396,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Reset cursor position on a topic subscription</div>
</td>
</tr>
-<tr id="i37" class="rowColor">
+<tr id="i40" class="altColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#resetCursorAsync-java.lang.String-java.lang.String-long-">resetCursorAsync</a></span>(String topic,
String subName,
@@ -382,7 +404,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Reset cursor position on a topic subscription</div>
</td>
</tr>
-<tr id="i38" class="altColor">
+<tr id="i41" class="rowColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#resetCursorAsync-java.lang.String-java.lang.String-MessageId-">resetCursorAsync</a></span>(String topic,
String subName,
@@ -390,28 +412,28 @@ var activeTableTab = "activeTableTab";
<div class="block">Reset cursor position on a topic subscription</div>
</td>
</tr>
-<tr id="i39" class="rowColor">
+<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#revokePermissions-java.lang.String-java.lang.String-">revokePermissions</a></span>(String topic,
String role)</code>
<div class="block">Revoke permissions on a topic.</div>
</td>
</tr>
-<tr id="i40" class="altColor">
+<tr id="i43" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#skipAllMessages-java.lang.String-java.lang.String-">skipAllMessages</a></span>(String topic,
String subName)</code>
<div class="block">Skip all messages on a topic subscription.</div>
</td>
</tr>
-<tr id="i41" class="rowColor">
+<tr id="i44" class="altColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#skipAllMessagesAsync-java.lang.String-java.lang.String-">skipAllMessagesAsync</a></span>(String topic,
String subName)</code>
<div class="block">Skip all messages on a topic subscription asynchronously.</div>
</td>
</tr>
-<tr id="i42" class="altColor">
+<tr id="i45" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#skipMessages-java.lang.String-java.lang.String-long-">skipMessages</a></span>(String topic,
String subName,
@@ -419,7 +441,7 @@ var activeTableTab = "activeTableTab";
<div class="block">Skip messages on a topic subscription.</div>
</td>
</tr>
-<tr id="i43" class="rowColor">
+<tr id="i46" class="altColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#skipMessagesAsync-java.lang.String-java.lang.String-long-">skipMessagesAsync</a></span>(String topic,
String subName,
@@ -427,38 +449,45 @@ var activeTableTab = "activeTableTab";
<div class="block">Skip messages on a topic subscription asynchronously.</div>
</td>
</tr>
-<tr id="i44" class="altColor">
+<tr id="i47" class="rowColor">
<td class="colFirst"><code>CompletableFuture<MessageId></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#terminateTopicAsync-java.lang.String-">terminateTopicAsync</a></span>(String topic)</code>
<div class="block">Terminate the topic and prevent any more messages being published on it.</div>
</td>
</tr>
-<tr id="i45" class="rowColor">
+<tr id="i48" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#triggerCompaction-java.lang.String-">triggerCompaction</a></span>(String topic)</code>
<div class="block">Trigger compaction to run for a topic.</div>
</td>
</tr>
-<tr id="i46" class="altColor">
+<tr id="i49" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#triggerOffload-java.lang.String-MessageId-">triggerOffload</a></span>(String topic,
+ MessageId messageId)</code>
+<div class="block">Trigger offloading messages in topic to longterm storage.</div>
+</td>
+</tr>
+<tr id="i50" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#unload-java.lang.String-">unload</a></span>(String topic)</code>
<div class="block">Unload a topic.</div>
</td>
</tr>
-<tr id="i47" class="rowColor">
+<tr id="i51" class="rowColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#unloadAsync-java.lang.String-">unloadAsync</a></span>(String topic)</code>
<div class="block">Unload a topic asynchronously.</div>
</td>
</tr>
-<tr id="i48" class="altColor">
+<tr id="i52" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#updatePartitionedTopic-java.lang.String-int-">updatePartitionedTopic</a></span>(String topic,
int numPartitions)</code>
<div class="block">Update number of partitions of a non-global partitioned topic.</div>
</td>
</tr>
-<tr id="i49" class="rowColor">
+<tr id="i53" class="rowColor">
<td class="colFirst"><code>CompletableFuture<Void></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Topics.html#updatePartitionedTopicAsync-java.lang.String-int-">updatePartitionedTopicAsync</a></span>(String topic,
int numPartitions)</code>
@@ -794,6 +823,28 @@ var activeTableTab = "activeTableTab";
</dl>
</li>
</ul>
+<a name="deletePartitionedTopic-java.lang.String-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>deletePartitionedTopic</h4>
+<pre>void deletePartitionedTopic(String topic,
+ boolean force)
+ throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre>
+<div class="block">Delete a partitioned topic.
+ <p>
+ It will also delete all the partitions of the topic if it exists.
+ <p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>topic</code> - Topic name</dd>
+<dd><code>force</code> - Delete topic forcefully</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code></dd>
+</dl>
+</li>
+</ul>
<a name="deletePartitionedTopic-java.lang.String-">
<!-- -->
</a>
@@ -814,13 +865,14 @@ var activeTableTab = "activeTableTab";
</dl>
</li>
</ul>
-<a name="deletePartitionedTopicAsync-java.lang.String-">
+<a name="deletePartitionedTopicAsync-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletePartitionedTopicAsync</h4>
-<pre>CompletableFuture<Void> deletePartitionedTopicAsync(String topic)</pre>
+<pre>CompletableFuture<Void> deletePartitionedTopicAsync(String topic,
+ boolean force)</pre>
<div class="block">Delete a partitioned topic asynchronously.
<p>
It will also delete all the partitions of the topic if it exists.
@@ -828,11 +880,37 @@ var activeTableTab = "activeTableTab";
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topic</code> - Topic name</dd>
+<dd><code>force</code> - Delete topic forcefully</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a future that can be used to track when the partitioned topic is deleted</dd>
</dl>
</li>
</ul>
+<a name="delete-java.lang.String-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>delete</h4>
+<pre>void delete(String topic,
+ boolean force)
+ throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre>
+<div class="block">Delete a topic.
+ <p>
+ Delete a topic. The topic cannot be deleted if force flag is disable and there's any active subscription or producer connected to the it. Force flag deletes topic forcefully by closing all active producers and consumers.
+ <p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>topic</code> - Topic name</dd>
+<dd><code>force</code> - Delete topic forcefully</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd>
+<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Topic does not exist</dd>
+<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.PreconditionFailedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.PreconditionFailedException</a></code> - Topic has active subscriptions or producers</dd>
+<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd>
+</dl>
+</li>
+</ul>
<a name="delete-java.lang.String-">
<!-- -->
</a>
@@ -856,21 +934,24 @@ var activeTableTab = "activeTableTab";
</dl>
</li>
</ul>
-<a name="deleteAsync-java.lang.String-">
+<a name="deleteAsync-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAsync</h4>
-<pre>CompletableFuture<Void> deleteAsync(String topic)</pre>
+<pre>CompletableFuture<Void> deleteAsync(String topic,
+ boolean force)</pre>
<div class="block">Delete a topic asynchronously.
<p>
- Delete a topic asynchronously. The topic cannot be deleted if there's any active subscription or producer
- connected to the it.
+ Delete a topic asynchronously. The topic cannot be deleted if force flag is disable and there's any active
+ subscription or producer connected to the it. Force flag deletes topic forcefully by closing all active producers
+ and consumers.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topic</code> - topic name</dd>
+<dd><code>force</code> - Delete topic forcefully</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a future that can be used to track when the topic is deleted</dd>
</dl>
@@ -1649,11 +1730,11 @@ var activeTableTab = "activeTableTab";
<a name="compactionStatus-java.lang.String-">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>compactionStatus</h4>
-<pre>CompactionStatus compactionStatus(String topic)
- throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre>
+<pre><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a> compactionStatus(String topic)
+ throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre>
<div class="block">Check the status of an ongoing compaction for a topic.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1663,6 +1744,44 @@ var activeTableTab = "activeTableTab";
</dl>
</li>
</ul>
+<a name="triggerOffload-java.lang.String-MessageId-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>triggerOffload</h4>
+<pre>void triggerOffload(String topic,
+ MessageId messageId)
+ throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre>
+<div class="block">Trigger offloading messages in topic to longterm storage.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>topic</code> - the topic to offload</dd>
+<dd><code>messageId</code> - ID of maximum message which should be offloaded</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="offloadStatus-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>offloadStatus</h4>
+<pre><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a> offloadStatus(String topic)
+ throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre>
+<div class="block">Check the status of an ongoing offloading operation for a topic.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>topic</code> - the topic being offloaded</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the status of the offload operation</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code></dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
</li>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/package-frame.html b/content/api/admin/org/apache/pulsar/client/admin/package-frame.html
index f3634cf..21a8222 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/package-frame.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/package-frame.html
@@ -28,8 +28,14 @@
</ul>
<h2 title="Classes">Classes</h2>
<ul title="Classes">
+<li><a href="LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin" target="classFrame">LongRunningProcessStatus</a></li>
+<li><a href="OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin" target="classFrame">OffloadProcessStatus</a></li>
<li><a href="PulsarAdmin.html" title="class in org.apache.pulsar.client.admin" target="classFrame">PulsarAdmin</a></li>
</ul>
+<h2 title="Enums">Enums</h2>
+<ul title="Enums">
+<li><a href="LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin" target="classFrame">LongRunningProcessStatus.Status</a></li>
+</ul>
<h2 title="Exceptions">Exceptions</h2>
<ul title="Exceptions">
<li><a href="PulsarAdminException.html" title="class in org.apache.pulsar.client.admin" target="classFrame">PulsarAdminException</a></li>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/package-summary.html b/content/api/admin/org/apache/pulsar/client/admin/package-summary.html
index f77fcb2..eaf27e3 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/package-summary.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/package-summary.html
@@ -124,9 +124,7 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin">PersistentTopics</a></td>
-<td class="colLast">Deprecated
-<div class="block"><span class="deprecationComment">since 2.0.</span></div>
-</td>
+<td class="colLast">Deprecated</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></td>
@@ -166,6 +164,18 @@
</tr>
<tbody>
<tr class="altColor">
+<td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin">LongRunningProcessStatus</a></td>
+<td class="colLast">
+<div class="block">Status of long running process.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin">OffloadProcessStatus</a></td>
+<td class="colLast">
+<div class="block">Status of offload process.</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin">PulsarAdmin</a></td>
<td class="colLast">
<div class="block">Pulsar client admin API client.</div>
@@ -175,6 +185,21 @@
</table>
</li>
<li class="blockList">
+<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
+<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Enum</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin">LongRunningProcessStatus.Status</a></td>
+<td class="colLast"> </td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
<tr>
diff --git a/content/api/admin/org/apache/pulsar/client/admin/package-tree.html b/content/api/admin/org/apache/pulsar/client/admin/package-tree.html
index bf044eb..156b883 100644
--- a/content/api/admin/org/apache/pulsar/client/admin/package-tree.html
+++ b/content/api/admin/org/apache/pulsar/client/admin/package-tree.html
@@ -79,6 +79,11 @@
<ul>
<li type="circle">Object
<ul>
+<li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">LongRunningProcessStatus</span></a>
+<ul>
+<li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">OffloadProcessStatus</span></a></li>
+</ul>
+</li>
<li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">PulsarAdmin</span></a> (implements Closeable)</li>
<li type="circle">Throwable (implements Serializable)
<ul>
@@ -123,6 +128,18 @@
</ul>
</li>
</ul>
+<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
+<ul>
+<li type="circle">Object
+<ul>
+<li type="circle">Enum<E> (implements Comparable<T>, Serializable)
+<ul>
+<li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin"><span class="typeNameLink">LongRunningProcessStatus.Status</span></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
diff --git a/content/api/admin/overview-tree.html b/content/api/admin/overview-tree.html
index 6a9a213..355c9eb 100644
--- a/content/api/admin/overview-tree.html
+++ b/content/api/admin/overview-tree.html
@@ -100,6 +100,11 @@
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/ErrorData.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">ErrorData</span></a></li>
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/FailureDomain.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">FailureDomain</span></a></li>
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/LocalPolicies.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">LocalPolicies</span></a></li>
+<li type="circle">org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">LongRunningProcessStatus</span></a>
+<ul>
+<li type="circle">org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/OffloadProcessStatus.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">OffloadProcessStatus</span></a></li>
+</ul>
+</li>
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/NamespaceIsolationData.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">NamespaceIsolationData</span></a></li>
<li type="circle">org.apache.pulsar.common.policies.impl.<a href="org/apache/pulsar/common/policies/impl/NamespaceIsolationPolicies.html" title="class in org.apache.pulsar.common.policies.impl"><span class="typeNameLink">NamespaceIsolationPolicies</span></a></li>
<li type="circle">org.apache.pulsar.common.policies.impl.<a href="org/apache/pulsar/common/policies/impl/NamespaceIsolationPolicyImpl.html" title="class in org.apache.pulsar.common.policies.impl"><span class="typeNameLink">NamespaceIsolationPolicyImpl</span></a> (implements org.apache.pulsar.common.policies.<a href="org/apache/pulsar/common/policies/NamespaceIsolationPolicy.html" title="interface in org.apache.pulsar.common.policies">NamespaceIsolationPolicy</a>)</li>
@@ -193,6 +198,7 @@
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/BacklogQuota.BacklogQuotaType.html" title="enum in org.apache.pulsar.common.policies.data"><span class="typeNameLink">BacklogQuota.BacklogQuotaType</span></a></li>
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/BacklogQuota.RetentionPolicy.html" title="enum in org.apache.pulsar.common.policies.data"><span class="typeNameLink">BacklogQuota.RetentionPolicy</span></a></li>
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/BrokerAssignment.html" title="enum in org.apache.pulsar.common.policies.data"><span class="typeNameLink">BrokerAssignment</span></a></li>
+<li type="circle">org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html" title="enum in org.apache.pulsar.client.admin"><span class="typeNameLink">LongRunningProcessStatus.Status</span></a></li>
<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html" title="enum in org.apache.pulsar.common.policies.data"><span class="typeNameLink">SubscriptionAuthMode</span></a></li>
</ul>
</li>
diff --git a/content/contact/index.html b/content/contact/index.html
index f587686..2d76c49 100644
--- a/content/contact/index.html
+++ b/content/contact/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
diff --git a/content/css/style.css b/content/css/style.css
index da07630..096fb31 100644
--- a/content/css/style.css
+++ b/content/css/style.css
@@ -9460,9 +9460,10 @@ span.popover-term {
.rest-api-container article section.content .topic, .rest-api-container article section.content .fqfn, .docs-container article section.content .topic, .docs-container article section.content .fqfn {
color: #bcc5c5;
background-color: #232937;
- font-size: 1rem;
+ font-size: 1.25rem;
font-family: "Inconsolata", monospace;
- padding: 10px 0 10px 20px;
+ font-weight: 700;
+ padding: .5rem 0 .5rem 1rem;
border-radius: 0; }
.rest-api-container article section.content .topic .property, .rest-api-container article section.content .topic .tenant, .rest-api-container article section.content .fqfn .property, .rest-api-container article section.content .fqfn .tenant, .docs-container article section.content .topic .property, .docs-container article section.content .topic .tenant, .docs-container article section.content .fqfn .property, .docs-container article section.content .fqfn .tenant {
color: #b1cc00; }
@@ -9472,7 +9473,7 @@ span.popover-term {
color: #3797db; }
.rest-api-container article section.content .topic .t, .rest-api-container article section.content .fqfn .t, .docs-container article section.content .topic .t, .docs-container article section.content .fqfn .t {
color: #d33682; }
- .rest-api-container article section.content .topic + p, .rest-api-container article section.content .fqfn + p, .docs-container article section.content .topic + p, .docs-container article section.content .fqfn + p {
+ .rest-api-container article section.content .topic ~ p, .rest-api-container article section.content .topic ~ h2, .rest-api-container article section.content .topic ~ h3, .rest-api-container article section.content .topic ~ h4, .rest-api-container article section.content .topic ~ h5, .rest-api-container article section.content .fqfn ~ p, .rest-api-container article section.content .fqfn ~ h2, .rest-api-container article section.content .fqfn ~ h3, .rest-api-container article section.c [...]
margin-top: 20px; }
.rest-api-container article section.content .highlighter-rouge, .docs-container article section.content .highlighter-rouge {
font-family: "Inconsolata", monospace;
diff --git a/content/docs/latest/adaptors/KafkaWrapper/index.html b/content/docs/latest/adaptors/KafkaWrapper/index.html
index 1161609..e74b62c 100644
--- a/content/docs/latest/adaptors/KafkaWrapper/index.html
+++ b/content/docs/latest/adaptors/KafkaWrapper/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -1032,6 +1048,12 @@
+
+
+
+
+
+
</ul>
</div>
</div>
@@ -1246,6 +1268,12 @@
+
+
+
+
+
+
</ul>
</div>
</div>
@@ -1460,6 +1488,12 @@
+
+
+
+
+
+
</ul>
</div>
</div>
@@ -1511,17 +1545,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/adaptors/PulsarSpark/index.html b/content/docs/latest/adaptors/PulsarSpark/index.html
index 7077078..af6ab0a 100644
--- a/content/docs/latest/adaptors/PulsarSpark/index.html
+++ b/content/docs/latest/adaptors/PulsarSpark/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -935,6 +951,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -1149,6 +1171,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -1287,6 +1315,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1367,6 +1397,10 @@
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -1435,9 +1469,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1447,11 +1481,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1521,17 +1555,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/adaptors/PulsarStorm/index.html b/content/docs/latest/adaptors/PulsarStorm/index.html
index bb0e8b8..7aef3e4 100644
--- a/content/docs/latest/adaptors/PulsarStorm/index.html
+++ b/content/docs/latest/adaptors/PulsarStorm/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -939,6 +955,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarStorm/">Pulsar adaptor for Apache Storm</a></li>
@@ -1073,6 +1095,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1153,6 +1177,10 @@
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -1221,9 +1249,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1233,11 +1261,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1307,17 +1335,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin-api/brokers/index.html b/content/docs/latest/admin-api/brokers/index.html
index 3ed0990..4efc745 100644
--- a/content/docs/latest/admin-api/brokers/index.html
+++ b/content/docs/latest/admin-api/brokers/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1006,7 +1022,7 @@
<p>One way to configure a Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">broker</span> is to supply a <a href="../../reference/Con [...]
-<p>But since all broker configuration in Pulsar is stored in <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span>, configuration values can also be dynamically u [...]
+<p>But since all broker configuration in Pulsar is stored in <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span>, configuration values can also be [...]
<ul>
<li>The <a href="../../reference/CliTools#pulsar-admin-brokers"><code class="highlighter-rouge">brokers</code></a> command for the <a href="../../reference/CliTools#pulsar-admin"><code class="highlighter-rouge">pulsar-admin</code></a> tool has a variety of subcommands that enable you to manipulate a broker’s configuration dynamically, enabling you to <a href="#update-dynamic-configuration">update config values</a> and more.</li>
diff --git a/content/docs/latest/admin-api/clusters/index.html b/content/docs/latest/admin-api/clusters/index.html
index cbc40bd..3e5f5c2 100644
--- a/content/docs/latest/admin-api/clusters/index.html
+++ b/content/docs/latest/admin-api/clusters/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -904,7 +920,7 @@
-->
-<p>Pulsar clusters consist of one or more Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span>, one or more <span class=" [...]
+<p>Pulsar clusters consist of one or more Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span>, one or more <span class=" [...]
<p>Clusters can be managed via:</p>
diff --git a/content/docs/latest/admin-api/namespaces/index.html b/content/docs/latest/admin-api/namespaces/index.html
index fcb6950..8985195 100644
--- a/content/docs/latest/admin-api/namespaces/index.html
+++ b/content/docs/latest/admin-api/namespaces/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin-api/non-persistent-topics/index.html b/content/docs/latest/admin-api/non-persistent-topics/index.html
index 5e4e915..572de60 100644
--- a/content/docs/latest/admin-api/non-persistent-topics/index.html
+++ b/content/docs/latest/admin-api/non-persistent-topics/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin-api/overview/index.html b/content/docs/latest/admin-api/overview/index.html
index 70d6a80..a88b72b 100644
--- a/content/docs/latest/admin-api/overview/index.html
+++ b/content/docs/latest/admin-api/overview/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -859,6 +875,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -931,6 +949,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -957,9 +977,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1027,9 +1047,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1097,6 +1119,8 @@
+
+
<li><a href="/docs/latest/reference/CliTools/">Pulsar command-line tools</a></li>
@@ -1264,6 +1288,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1459,6 +1487,8 @@
+
+
<li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1478,6 +1508,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1519,6 +1553,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1599,6 +1635,10 @@
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -1667,9 +1707,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1679,11 +1719,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1753,17 +1793,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin-api/partitioned-topics/index.html b/content/docs/latest/admin-api/partitioned-topics/index.html
index 5ec5982..b2f71b0 100644
--- a/content/docs/latest/admin-api/partitioned-topics/index.html
+++ b/content/docs/latest/admin-api/partitioned-topics/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -929,7 +945,7 @@
-->
<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<h2 id="partitioned-topics-resources">Partitioned topics resources</h2>
@@ -980,7 +996,7 @@
-->
<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<h3 id="create">Create</h3>
diff --git a/content/docs/latest/admin-api/permissions/index.html b/content/docs/latest/admin-api/permissions/index.html
index 54a13f3..81807af 100644
--- a/content/docs/latest/admin-api/permissions/index.html
+++ b/content/docs/latest/admin-api/permissions/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin-api/persistent-topics/index.html b/content/docs/latest/admin-api/persistent-topics/index.html
index e5780d8..3ee1230 100644
--- a/content/docs/latest/admin-api/persistent-topics/index.html
+++ b/content/docs/latest/admin-api/persistent-topics/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -929,7 +945,7 @@
-->
<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<h2 id="persistent-topics-resources">Persistent topics resources</h2>
diff --git a/content/docs/latest/admin/Dashboard/index.html b/content/docs/latest/admin-api/tenants/index.html
similarity index 86%
copy from content/docs/latest/admin/Dashboard/index.html
copy to content/docs/latest/admin-api/tenants/index.html
index e58e44c..e4604be 100644
--- a/content/docs/latest/admin/Dashboard/index.html
+++ b/content/docs/latest/admin-api/tenants/index.html
@@ -43,7 +43,7 @@
under the License.
-->
-<title>The Pulsar dashboard</title>
+<title>Managing tenants</title>
<meta charset="utf-8">
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -818,7 +834,7 @@
<article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
<section class="docs-header">
<h1 class="docs-title">
- The Pulsar dashboard
+ Managing tenants
</h1>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -904,36 +920,81 @@
-->
-<p>The Pulsar dashboard is a web application that enables users to monitor current stats for all <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topics</span> in tabular form.</p>
+<p>Tenants, like namespaces, can be managed using the <a href="../../admin-api/overview">admin API</a>. There are currently two configurable aspects of tenants:</p>
-<p>The dashboard is a data collector that polls stats from all the <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span> in a Pul [...]
+<ul>
+ <li>Admin roles</li>
+ <li>Allowed clusters</li>
+</ul>
-<p>A <a href="https://www.djangoproject.com">Django</a> web app is used to render the collected data.</p>
+<h2 id="tenant-resources">Tenant resources</h2>
-<h2 id="install">Install</h2>
+<h3 id="list">List</h3>
-<p>The easiest way to use the dashboard is to run it inside a <a href="https://www.docker.com/products/docker">Docker</a> container. A <a href="https://github.com/apache/incubator-pulsar/tree/master/dashboard/Dockerfile"><code class="highlighter-rouge">Dockerfile</code></a> to generate the image is provided.</p>
+<h4 id="pulsar-admin">pulsar-admin</h4>
-<p>To generate the Docker image:</p>
+<p>You can list all of the tenants associated with an <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> using the <a href="../../reference/CliTools#pulsar-admin-tenants-list"><code class="highlighter-rouge">list</code></a> subcommand:</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>docker build <span class="nt">-t</span> pulsar-dashboard dashboard
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin tenants list
</code></pre></div></div>
-<p>To run the dashboard:</p>
+<p>That will return a simple list, like this:</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ SERVICE_URL</span><span class="o">=</span>http://broker.example.com:8080/
-<span class="nv">$ </span>docker run <span class="nt">-p</span> 80:80 <span class="se">\</span>
- <span class="nt">-e</span> <span class="nv">SERVICE_URL</span><span class="o">=</span><span class="nv">$SERVICE_URL</span> <span class="se">\</span>
- apachepulsar/pulsar-dashboard
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>my-tenant-1
+my-tenant-2
</code></pre></div></div>
-<p>You need to specify only one service URL for a Pulsar cluster. Internally, the collector will figure out all the existing clusters and the brokers from where it needs to pull the metrics. If you’re connecting the dashboard to Pulsar running in <span class="popover-term" tabindex="0" title="What is a standalone Pulsar broker?" data-placement="top" data-content="A lightweight Pulsar broker in which all components run in a single Java Virtual Machine (JVM) process. Standalone clusters ca [...]
+<h3 id="create">Create</h3>
+
+<h4 id="pulsar-admin-1">pulsar-admin</h4>
+
+<p>You can create a new tenant using the <a href="../../reference/CliTools#pulsar-admin-tenants-create"><code class="highlighter-rouge">create</code></a> subcommand:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin tenants create my-tenant
+</code></pre></div></div>
+
+<p>When creating a tenant, you can assign admin roles using the <code class="highlighter-rouge">-r</code>/<code class="highlighter-rouge">--admin-roles</code> flag. You can specify multiple roles as a comma-separated list. Here are some examples:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin tenants create my-tenant <span class="se">\</span>
+ <span class="nt">--admin-roles</span> role1,role2,role3
+
+<span class="nv">$ </span>pulsar-admin tenants create my-tenant <span class="se">\</span>
+ <span class="nt">-r</span> role1
+</code></pre></div></div>
+
+<h3 id="get-configuration">Get configuration</h3>
+
+<h4 id="pulsar-admin-2">pulsar-admin</h4>
+
+<p>You can see a tenant’s configuration as a JSON object using the <a href="../../reference/CliTools#pulsar-admin-tenants-get"><code class="highlighter-rouge">get</code></a> subcommand and specifying the name of the tenant:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin tenants get my-tenant
+<span class="o">{</span>
+ <span class="s2">"adminRoles"</span>: <span class="o">[</span>
+ <span class="s2">"admin1"</span>,
+ <span class="s2">"admin2"</span>
+ <span class="o">]</span>,
+ <span class="s2">"allowedClusters"</span>: <span class="o">[</span>
+ <span class="s2">"cl1"</span>,
+ <span class="s2">"cl2"</span>
+ <span class="o">]</span>
+<span class="o">}</span>
+</code></pre></div></div>
+
+<h3 id="delete">Delete</h3>
+
+<h4 id="pulsar-adnin">pulsar-adnin</h4>
+
+<p>You can delete a tenant using the <a href="../../reference/CliTools#pulsar-admin-tenants-delete"><code class="highlighter-rouge">delete</code></a> subcommand and specifying the tenant name:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin tenants delete my-tenant
+</code></pre></div></div>
-<p>Once the Docker container is running, the web dashboard will be accessible via <code class="highlighter-rouge">localhost</code> or whichever host is being used by Docker.</p>
+<h3 id="updating">Updating</h3>
-<h3 id="known-issues">Known issues</h3>
+<h4 id="pulsar-admin-3">pulsar-admin</h4>
-<p>Pulsar <a href="../../admin/Authz#authentication-providers">authentication</a> is not supported at this point. The dashboard’s data collector does not pass any authentication-related data and will be denied access if the Pulsar broker requires authentication.</p>
+<p>You can update a tenant’s configuration using the <a href="../../reference/CliTools#pulsar-admin-tenants-update"><code class="highlighter-rouge">update</code></a> subcommand</p>
</section>
</article>
@@ -941,7 +1002,7 @@
<nav class="toc-bar hidden-md-down col-lg-2">
<div id="toc">
- <h4>The Pulsar dashboard</h4>
+ <h4>Managing tenants</h4>
</div>
</nav>
diff --git a/content/docs/latest/admin/Authz/index.html b/content/docs/latest/admin/Authz/index.html
index 4d40fb1..ec7e9f7 100644
--- a/content/docs/latest/admin/Authz/index.html
+++ b/content/docs/latest/admin/Authz/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -859,6 +875,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -931,6 +949,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -957,9 +977,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1027,9 +1047,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1089,6 +1111,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1262,6 +1286,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1303,6 +1331,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1476,6 +1506,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1517,6 +1551,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1690,6 +1726,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1731,6 +1771,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1904,6 +1946,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1945,6 +1991,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -2025,6 +2073,10 @@
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -2093,9 +2145,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -2105,11 +2157,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -2169,6 +2221,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -2344,6 +2398,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -2395,17 +2453,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -2808,7 +2866,7 @@
-->
<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<h2 id="managing-permissions">Managing permissions</h2>
diff --git a/content/docs/latest/admin/Dashboard/index.html b/content/docs/latest/admin/Dashboard/index.html
index e58e44c..1769e8d 100644
--- a/content/docs/latest/admin/Dashboard/index.html
+++ b/content/docs/latest/admin/Dashboard/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin/GeoReplication/index.html b/content/docs/latest/admin/GeoReplication/index.html
index 0e49966..a017117 100644
--- a/content/docs/latest/admin/GeoReplication/index.html
+++ b/content/docs/latest/admin/GeoReplication/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin-api/brokers/index.html b/content/docs/latest/admin/LoadDistribution/index.html
similarity index 70%
copy from content/docs/latest/admin-api/brokers/index.html
copy to content/docs/latest/admin/LoadDistribution/index.html
index 3ed0990..daf5b04 100644
--- a/content/docs/latest/admin-api/brokers/index.html
+++ b/content/docs/latest/admin/LoadDistribution/index.html
@@ -43,7 +43,7 @@
under the License.
-->
-<title>Managing brokers</title>
+<title>Pulsar load distribution</title>
<meta charset="utf-8">
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -818,7 +834,7 @@
<article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
<section class="docs-header">
<h1 class="docs-title">
- Managing brokers
+ Pulsar load distribution
</h1>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -904,184 +920,214 @@
-->
-<p>Pulsar brokers consist of two components:</p>
+<h2 id="load-distribution-across-pulsar-brokers">Load distribution across Pulsar brokers</h2>
-<ol>
- <li>An HTTP server exposing a <a href="../../reference/RestApi">REST interface</a> administration and <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topic</span> lookup.</li>
- <li>A dispatcher that handles all Pulsar <span class="popover-term" tabindex="0" title="What is a message in Pulsar?" data-placement="top" data-content="A" data-toggle="popover" data-trigger="focus">message</span> transfers.</li>
-</ol>
+<p>Pulsar is an horizontally scalable messaging system, so it is a core requirement that the traffic
+in a logical cluster must be spread across all the available Pulsar brokers, as evenly as possible.</p>
-<p><span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">Brokers</span> can be managed via:</p>
+<p>In most cases, this is true out of the box and one shouldn’t worry about it. There are, though,
+multiple settings and tools to control the traffic distribution and they require a bit of
+context to understand how the traffic is managed in Pulsar.</p>
-<ul>
- <li>The <a href="../../reference/CliTools#pulsar-admin-brokers"><code class="highlighter-rouge">brokers</code></a> command of the <a href="../../reference/CliTools#pulsar-admin"><code class="highlighter-rouge">pulsar-admin</code></a> tool</li>
- <li>The <code class="highlighter-rouge">/admin/brokers</code> endpoint of the admin <a href="../../reference/RestApi">REST API</a></li>
- <li>The <code class="highlighter-rouge">brokers</code> method of the <a target="_blank" href="/api/admin/org/apache/pulsar/client/admin/PulsarAdmin.html"><code class="highlighter-rouge">PulsarAdmin</code></a> object in the <a href="../../clients/Java">Java API</a></li>
-</ul>
+<h2 id="pulsar-load-manager-architecture">Pulsar load manager architecture</h2>
-<p>In addition to being configurable when you start them up, brokers can also be <a href="#dynamic-broker-configuration">dynamically configured</a>.</p>
+<h3 id="dynamic-assignment-of-topics-to-brokers">Dynamic assignment of topics to brokers</h3>
-<!--
+<p>Topics are dynamically assigned to brokers based on the load conditions of all brokers in the
+cluster.</p>
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
+<p>When a clients starts using new topics that are not assigned to any broker, it will trigger a
+process that, given the load conditions, it will choose the best suited broker to acquire ownership
+of such topic.</p>
- http://www.apache.org/licenses/LICENSE-2.0
+<p>In case of partitioned topics, different partitions might be assigned to different brokers. We talk
+about “topic” in this context to mean either a non-partitioned topic or one partition of a topic.</p>
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
+<p>The assignment is “dynamic” because it can change very quickly. For example, if the broker owning
+the topic crashes, the topic will be reassigned immediately to another broker. Another scenario is
+that the broker owning the topic becomes overloaded. In this case too, the topic will be
+reassigned to a less loaded broker.</p>
--->
-<div class="admonition">
- <div class="info">
-
-
-<p>See the <a href="../../reference/Configuration#broker">Configuration</a> page for a full listing of broker-specific configuration parameters.</p>
+<p>The dynamic assignment is made possible by the stateless nature of brokers. This also ensure that
+we can quickly expand or shrink the cluster based on usage.</p>
- </div>
-</div>
+<h3 id="assignment-granularity">Assignment granularity</h3>
-<h2 id="brokers-resources">Brokers resources</h2>
+<p>The assignment of topics/partitions to brokers is not done at the individual level. The reason for
+it is to amortize the amount of information that we need to keep track (eg. which topics are
+assigned to a particular broker, what’s the load on topics for a broker and similar).</p>
-<h3 id="list-active-brokers">List active brokers</h3>
+<p>Instead of individual topic/partition assignment, each broker takes ownership of a subset of the
+topics for a namespace. This subset is called a “<em>bundle</em>” and effectively it’s a sharding
+mechanism.</p>
-<p>Fetch all available active brokers that are serving traffic.</p>
+<p>The namespace is the “administrative” unit: many config knobs or operations are done at the
+namespace level.</p>
-<h4 id="pulsar-admin">pulsar-admin</h4>
+<p>For assignment, a namespaces is sharded into a list of “bundles”, with each bundle comprising
+a portion of overall hash range of the namespace.</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin brokers list use
-</code></pre></div></div>
+<p>Topics are assigned to a particular bundle by taking the hash of the topic name and seeing in which
+bundle the hash falls into.</p>
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>broker1.use.org.com:8080
-</code></pre></div></div>
+<p>Each bundle is independent of the others and thus is independently assigned to different brokers.</p>
-<h6 id="rest">REST</h6>
+<h3 id="creating-namespaces-and-bundles">Creating namespaces and bundles</h3>
-<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/brokers/<span class="endpoint">:cluster</span></code></pre></div>
+<p>When creating a new namespace, it will set to use the default number of bundles. This is set in
+<code class="highlighter-rouge">conf/broker.conf</code>:</p>
-<p><a href="../../reference/RestApi#/admin/brokers/:cluster">More info</a></p>
+<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># When a namespace is created without specifying the number of bundle, this
+# value will be used as the default
+</span><span class="py">defaultNumberOfNamespaceBundles</span><span class="p">=</span><span class="s">4</span>
+</code></pre></div></div>
-<h6 id="java">Java</h6>
+<p>One can either change the system default, or override it when creating a new namespace:</p>
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">admin</span><span class="o">.</span><span class="na">brokers</span><span class="o">().</span><span class="na">getActiveBrokers</span><span class="o">(</span><span class="n">clusterName</span><span class="o">)</span>
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-admin namespaces create my-tenant/my-namespace <span class="nt">--clusters</span> us-west <span class="nt">--bundles</span> 16
</code></pre></div></div>
-<h4 id="list-of-namespaces-owned-by-a-given-broker">list of namespaces owned by a given broker</h4>
+<p>With this command, we’re creating a namespace with 16 initial bundles. Therefore the topics for
+this namespaces can immediately be spread across up to 16 brokers.</p>
-<p>It finds all namespaces which are owned and served by a given broker.</p>
+<p>In general, if the expected traffic and number of topics is known in advance, it’s a good idea to
+start with a reasonable number of bundles instead of waiting for the system to auto-correct the
+distribution.</p>
-<h6 id="cli">CLI</h6>
+<p>On a same note, it is normally beneficial to start with more bundles than number of brokers,
+primarily because of the hashing nature of the distribution of topics into bundles. For example,
+for a namespace with 1000 topics, using something like 64 bundles will achieve a good distribution
+of traffic across 16 brokers.</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin brokers namespaces use <span class="se">\</span>
- <span class="nt">--url</span> broker1.use.org.com:8080
-</code></pre></div></div>
+<h3 id="unloading-topics-and-bundles">Unloading topics and bundles</h3>
-<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
- </span><span class="s2">"my-property/use/my-ns/0x00000000_0xffffffff"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="s2">"broker_assignment"</span><span class="p">:</span><span class="w"> </span><span class="s2">"shared"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"is_controlled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
- </span><span class="s2">"is_active"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
- </span><span class="p">}</span><span class="w">
-</span><span class="p">}</span><span class="w">
-</span></code></pre></div></div>
-<h6 id="rest-1">REST</h6>
+<p>In Pulsar there is an admin operation of “unloading” a topic. Unloading means to close the topics,
+release ownership and reassign the topics to a new broker, based on current load.</p>
-<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/brokers/<span class="endpoint">:cluster</span>/<span class="endpoint">:broker</span>:/ownedNamespaces</code></pre></div>
+<p>When unload happens, the client will experience a small latency blip, typically in the order of
+tens of milliseconds, while the topic is reassigned.</p>
-<h6 id="java-1">Java</h6>
+<p>Unloading is the mechanism used by the load-manager to perform the load shedding, but it can
+also be triggered manually, for example to correct the assignments and redistribute traffic
+even before having any broker overloaded.</p>
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">admin</span><span class="o">.</span><span class="na">brokers</span><span class="o">().</span><span class="na">getOwnedNamespaces</span><span class="o">(</span><span class="n">cluster</span><span class="o">,</span><span class="n">brokerUrl</span><span class="o">);</span>
+<p>Unloading a topic has no effect on the assignment, but it will just close and reopen the
+particular topic:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pulsar-admin topics unload persistent://tenant/namespace/topic
</code></pre></div></div>
-<h3 id="dynamic-broker-configuration">Dynamic broker configuration</h3>
+<p>To unload all topics for a namespace and trigger reassignments:</p>
-<p>One way to configure a Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">broker</span> is to supply a <a href="../../reference/Con [...]
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pulsar-admin namespaces unload tenant/namespace
+</code></pre></div></div>
-<p>But since all broker configuration in Pulsar is stored in <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span>, configuration values can also be dynamically u [...]
+<h3 id="namespace-bundles-splitting">Namespace bundles splitting</h3>
-<ul>
- <li>The <a href="../../reference/CliTools#pulsar-admin-brokers"><code class="highlighter-rouge">brokers</code></a> command for the <a href="../../reference/CliTools#pulsar-admin"><code class="highlighter-rouge">pulsar-admin</code></a> tool has a variety of subcommands that enable you to manipulate a broker’s configuration dynamically, enabling you to <a href="#update-dynamic-configuration">update config values</a> and more.</li>
- <li>In the Pulsar admin <a href="../../reference/RestApi">REST API</a>, dynamic configuration is managed through the <code class="highlighter-rouge">/admin/brokers/configuration</code> endpoint.</li>
-</ul>
+<p>Since the load for the topics in a bundle might change over time, or could just be hard to predict
+upfront, bundles can be split in 2 by brokers. The new smaller bundles can then be reassigned
+to different brokers.</p>
-<h3 id="update-dynamic-configuration">Update dynamic configuration</h3>
+<p>The splitting happens based on some tunable thresholds. Any existing bundle that exceeds any
+of the threshold is a candidate to be split. By default the newly split bundles are also
+immediately offloaded to other brokers, to facilitate the traffic distribution.</p>
-<h4 id="pulsar-admin-1">pulsar-admin</h4>
+<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># enable/disable namespace bundle auto split
+</span><span class="py">loadBalancerAutoBundleSplitEnabled</span><span class="p">=</span><span class="s">true</span>
-<p>The <a href="../../reference/CliTools#pulsar-admin-brokers-update-dynamic-config"><code class="highlighter-rouge">update-dynamic-config</code></a> subcommand will update existing configuration. It takes two arguments: the name of the parameter and the new value. Here’s an example for the <a href="../../reference/Configuration#broker-brokerShutdownTimeoutMs"><code class="highlighter-rouge">brokerShutdownTimeoutMs</code></a> parameter:</p>
+<span class="c"># enable/disable automatic unloading of split bundles
+</span><span class="py">loadBalancerAutoUnloadSplitBundlesEnabled</span><span class="p">=</span><span class="s">true</span>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin brokers update-dynamic-config brokerShutdownTimeoutMs 100
-</code></pre></div></div>
+<span class="c"># maximum topics in a bundle, otherwise bundle split will be triggered
+</span><span class="py">loadBalancerNamespaceBundleMaxTopics</span><span class="p">=</span><span class="s">1000</span>
-<h4 id="rest-api">REST API</h4>
+<span class="c"># maximum sessions (producers + consumers) in a bundle, otherwise bundle split will be triggered
+</span><span class="py">loadBalancerNamespaceBundleMaxSessions</span><span class="p">=</span><span class="s">1000</span>
-<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method post">POST</code><code class="url">/admin/brokers/configuration/<span class="endpoint">:configName</span>/<span class="endpoint">:configValue</span></code></pre></div>
+<span class="c"># maximum msgRate (in + out) in a bundle, otherwise bundle split will be triggered
+</span><span class="py">loadBalancerNamespaceBundleMaxMsgRate</span><span class="p">=</span><span class="s">30000</span>
-<p><a href="../../reference/RestApi#/admin/brokers/configuration/:configName/:configValue">More info</a></p>
+<span class="c"># maximum bandwidth (in + out) in a bundle, otherwise bundle split will be triggered
+</span><span class="py">loadBalancerNamespaceBundleMaxBandwidthMbytes</span><span class="p">=</span><span class="s">100</span>
-<h4 id="java-2">Java</h4>
-
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">admin</span><span class="o">.</span><span class="na">brokers</span><span class="o">().</span><span class="na">updateDynamicConfiguration</span><span class="o">(</span><span class="n">configName</span><span class="o">,</span> <span class="n">configValue</span><span class="o">);</span>
+<span class="c"># maximum number of bundles in a namespace (for auto-split)
+</span><span class="py">loadBalancerNamespaceMaximumBundles</span><span class="p">=</span><span class="s">128</span>
</code></pre></div></div>
-<h3 id="list-updated-values">List updated values</h3>
+<h3 id="automatic-load-shedding">Automatic load shedding</h3>
-<p>Fetch a list of all potentially updatable configuration parameters.</p>
+<p>In Pulsar’s load manager there is support for automatic load shedding. This means that whenever
+the system recognized a particular broker is overloaded, it will force some traffic to be
+reassigned to less loaded brokers.</p>
-<h4 id="pulsar-admin-2">pulsar-admin</h4>
+<p>When a broker is identifies as overloaded, it will force to “unload” a subset of the bundles, the
+ones with higher traffic, that make up for the overload percentage.</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin brokers list-dynamic-config
-brokerShutdownTimeoutMs
-</code></pre></div></div>
+<p>For example, the default threshold is 85% and if a broker is over quota at 95% CPU usage, then
+it will unload the percent difference plus a 5% margin: <code class="highlighter-rouge">(95% - 85%) + 5% = 15%</code>.</p>
-<h4 id="rest-api-1">REST API</h4>
+<p>Given the selection of bundles to offload is based on traffic (as a proxy measure for cpu, network
+and memory), broker will unload bundles for at least 15% of traffic.</p>
-<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/brokers/configuration</code></pre></div>
+<p>The automatic load shedding is enabled by default and can be disabled with this setting:</p>
-<p><a href="../../reference/RestApi#/admin/brokers/configuration">More info</a></p>
+<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Enable/disable automatic bundle unloading for load-shedding
+</span><span class="py">loadBalancerSheddingEnabled</span><span class="p">=</span><span class="s">true</span>
+</code></pre></div></div>
-<h4 id="java-3">Java</h4>
+<p>There are additional settings that apply to shedding:</p>
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">admin</span><span class="o">.</span><span class="na">brokers</span><span class="o">().</span><span class="na">getDynamicConfigurationNames</span><span class="o">();</span>
+<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Load shedding interval. Broker periodically checks whether some traffic should be offload from
+# some over-loaded broker to other under-loaded brokers
+</span><span class="py">loadBalancerSheddingIntervalMinutes</span><span class="p">=</span><span class="s">1</span>
+
+<span class="c"># Prevent the same topics to be shed and moved to other brokers more that once within this timeframe
+</span><span class="py">loadBalancerSheddingGracePeriodMinutes</span><span class="p">=</span><span class="s">30</span>
</code></pre></div></div>
-<h3 id="list-all">List all</h3>
+<h4 id="broker-overload-thresholds">Broker overload thresholds</h4>
-<p>Fetch a list of all parameters that have been dynamically updated.</p>
+<p>The determinations of when a broker is overloaded is based on threshold of CPU, network and
+memory usage. Whenever either of those metrics reaches the threshold, it will trigger the shedding
+(if enabled).</p>
-<h4 id="pulsar-admin-3">pulsar-admin</h4>
+<p>By default, overload threshold is set at 85%:</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin brokers get-all-dynamic-config
-brokerShutdownTimeoutMs:100
+<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Usage threshold to determine a broker as over-loaded
+</span><span class="py">loadBalancerBrokerOverloadedThresholdPercentage</span><span class="p">=</span><span class="s">85</span>
</code></pre></div></div>
-<h4 id="rest-api-2">REST API</h4>
+<p>The usage stats are gathered by Pulsar from the system metrics.</p>
-<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/brokers/configuration/values</code></pre></div>
+<p>In case of network utilization, in some cases the network interface speed reported by Linux is
+not correct and needs to be manually overridden. This is the case in AWS EC2 instances with 1Gbps
+NIC speed for which the OS report 10Gbps speed.</p>
-<p><a href="../../reference/RestApi#/admin/brokers/configuration/values">More info</a></p>
+<p>Because of the incorrect max speed, the Pulsar load manager might think the broker has not
+reached the NIC capacity, while in fact it’s already using all the bandwidth and the traffic is
+being slowed down.</p>
-<h4 id="java-4">Java</h4>
+<p>There is a setting to correct the max NIC speed:</p>
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">admin</span><span class="o">.</span><span class="na">brokers</span><span class="o">().</span><span class="na">getAllDynamicConfigurations</span><span class="o">();</span>
+<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Override the auto-detection of the network interfaces max speed.
+# This option is useful in some environments (eg: EC2 VMs) where the max speed
+# reported by Linux is not reflecting the real bandwidth available to the broker.
+# Since the network usage is employed by the load manager to decide when a broker
+# is overloaded, it is important to make sure the info is correct or override it
+# with the right value here. The configured value can be a double (eg: 0.8) and that
+# can be used to trigger load-shedding even before hitting on NIC limits.
+</span><span class="py">loadBalancerOverrideBrokerNicSpeedGbps</span><span class="p">=</span>
</code></pre></div></div>
+<p>When the value is empty, Pulsar will use the value reported by the OS.</p>
+
</section>
</article>
<nav class="toc-bar hidden-md-down col-lg-2">
<div id="toc">
- <h4>Managing brokers</h4>
+ <h4>Pulsar load distribution</h4>
</div>
</nav>
diff --git a/content/docs/latest/admin/Proxy/index.html b/content/docs/latest/admin/Proxy/index.html
index aee989d..9d532e1 100644
--- a/content/docs/latest/admin/Proxy/index.html
+++ b/content/docs/latest/admin/Proxy/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -908,7 +924,7 @@
<h2 id="running-the-proxy">Running the proxy</h2>
-<p>In order to run the Pulsar proxy, you need to have both a local and global <a href="https://zookeeper.apache.org">ZooKeeper</a> quorum set up for use by your Pulsar cluster. For instructions, see <a href="../../deployment/cluster">this document</a>. Once you have ZooKeeper set up and have connection strings for both ZooKeeper quorums, you can use the <a href="../../reference/CliTools#pulsar-proxy"><code class="highlighter-rouge">proxy</code></a> command of the <a href="../../reference [...]
+<p>In order to run the Pulsar proxy, you need to have both a local <a href="https://zookeeper.apache.org">ZooKeeper</a> and <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) is a ZooKeeper quorum that is used for configuration-specific tasks. A multi-cluster Pulsar installation requires just one configuration store across all clusters." data-toggle="popove [...]
<p>To start the proxy:</p>
diff --git a/content/docs/latest/admin/Stats/index.html b/content/docs/latest/admin/Stats/index.html
index ed0b572..b50ea7f 100644
--- a/content/docs/latest/admin/Stats/index.html
+++ b/content/docs/latest/admin/Stats/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/admin/ZooKeeperBookKeeper/index.html b/content/docs/latest/admin/ZooKeeperBookKeeper/index.html
index 477558a..350f49a 100644
--- a/content/docs/latest/admin/ZooKeeperBookKeeper/index.html
+++ b/content/docs/latest/admin/ZooKeeperBookKeeper/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -976,7 +992,7 @@
<p>ZooKeeper manages a variety of essential coordination- and configuration-related tasks for Pulsar.</p>
-<p>Deploying a Pulsar instance requires you to stand up one local <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster <em>per Pulsar <span class="popove [...]
+<p>Deploying a Pulsar instance requires you to stand up one local <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster <em>per Pulsar <span [...]
<p>To begin, add all ZooKeeper servers to the quorum configuration specified in the <a href="../../reference/Configuration#zookeeper"><code class="highlighter-rouge">conf/zookeeper.conf</code></a> file. Add a <code class="highlighter-rouge">server.N</code> line for each node in the cluster to the configuration, where <code class="highlighter-rouge">N</code> is the number of the ZooKeeper node. Here’s an example for a three-node cluster:</p>
@@ -1029,45 +1045,17 @@
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-daemon start zookeeper
</code></pre></div></div>
-<h3 id="deploying-global-zookeeper">Deploying global ZooKeeper</h3>
-
-<p>The ZooKeeper cluster configured and started up in the section above is a <em>local</em> ZooKeeper cluster used to manage a single Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> [...]
-
-<p>If you’re deploying a <a href="#single-cluster-pulsar-instance">single-cluster</a> instance, then you will not need a separate cluster for global ZooKeeper. If, however, you’re deploying a <a href="#multi-cluster-pulsar-instance">multi-cluster</a> instance, then you should stand up a separate ZooKeeper cluster for instance-level tasks.</p>
+<h3 id="configuration-store">Deploying the configuration store</h3>
-<!--
+<p>The ZooKeeper cluster configured and started up in the section above is a <em>local</em> ZooKeeper cluster used to manage a single Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> [...]
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-
-<div class="admonition">
- <div class="">
-
-
- </div>
-</div>
+<p>If you’re deploying a <a href="#single-cluster-pulsar-instance">single-cluster</a> instance, then you will not need a separate cluster for the configuration store. If, however, you’re deploying a <a href="#multi-cluster-pulsar-instance">multi-cluster</a> instance, then you should stand up a separate ZooKeeper cluster for configuration tasks.</p>
<h4 id="single-cluster-pulsar-instance">Single-cluster Pulsar instance</h4>
-<p>If your Pulsar <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> will consist of just one cluster, then you can deploy <span class="popover-term" tabindex="0" title="What is global ZooKeeper?" data-placement="top" data-content="A ZooKeeper cluster that Pulsar uses for instance-wide, rather than cluster-sp [...]
+<p>If your Pulsar <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> will consist of just one cluster, then you can deploy a <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) i [...]
-<p>To deploy global ZooKeeper in a single-cluster instance, add the same ZooKeeper servers used by the local quorom to the configuration file in <a href="../../reference/Configuration#global-zookeeper"><code class="highlighter-rouge">conf/global_zookeeper.conf</code></a> using the same method for <a href="#local-zookeeper">local ZooKeeper</a>, but make sure to use a different port (2181 is the default for ZooKeeper). Here’s an example that uses port 2184 for a three-node ZooKeeper cluster:</p>
+<p>To deploy a ZooKeeper configuration store in a single-cluster instance, add the same ZooKeeper servers used by the local quorom to the configuration file in <a href="../../reference/Configuration#configuration-store"><code class="highlighter-rouge">conf/global_zookeeper.conf</code></a> using the same method for <a href="#local-zookeeper">local ZooKeeper</a>, but make sure to use a different port (2181 is the default for ZooKeeper). Here’s an example that uses port 2184 for a three-nod [...]
<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="py">clientPort</span><span class="p">=</span><span class="s">2184</span>
<span class="py">server.1</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2185:2186</span>
@@ -1266,62 +1254,6 @@ of these regions is unreachable.</p>
</thead>
<tbody>
- <tr id="global-zookeeper-tickTime">
- <td>tickTime</td>
- <td>The number of milliseconds of each tick
-</td>
- <td>2000</td>
- </tr>
-
- <tr id="global-zookeeper-initLimit">
- <td>initLimit</td>
- <td>The number of ticks that the initial synchronization phase can take
-</td>
- <td>10</td>
- </tr>
-
- <tr id="global-zookeeper-syncLimit">
- <td>syncLimit</td>
- <td>The number of ticks that can pass between sending a request and getting an acknowledgement
-</td>
- <td>5</td>
- </tr>
-
- <tr id="global-zookeeper-dataDir">
- <td>dataDir</td>
- <td>the directory where the snapshot is stored.
-</td>
- <td>data/global-zookeeper</td>
- </tr>
-
- <tr id="global-zookeeper-clientPort">
- <td>clientPort</td>
- <td>the port at which the clients will connect
-</td>
- <td>2184</td>
- </tr>
-
- <tr id="global-zookeeper-maxClientCnxns">
- <td>maxClientCnxns</td>
- <td>the maximum number of client connections. increase this if you need to handle more clients
-</td>
- <td>60</td>
- </tr>
-
- <tr id="global-zookeeper-autopurge.snapRetainCount">
- <td>autopurge.snapRetainCount</td>
- <td>The number of snapshots to retain in dataDir. For more info see <a href="http://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_maintenance">here</a>.
-</td>
- <td>3</td>
- </tr>
-
- <tr id="global-zookeeper-autopurge.purgeInterval">
- <td>autopurge.purgeInterval</td>
- <td>Purge task interval in hours. Set to “0” to disable auto purge feature
-</td>
- <td>1</td>
- </tr>
-
</tbody>
</table>
@@ -1580,7 +1512,7 @@ designed to use multiple devices:</p>
<p><img src="/img/pulsar_system_architecture.png" alt="ZooKeeper and BookKeeper" /></p>
-<p>Each Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> consists of one or more message <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-c [...]
+<p>Each Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> consists of one or more message <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-c [...]
</section>
</article>
diff --git a/content/docs/latest/clients/Cpp/index.html b/content/docs/latest/clients/Cpp/index.html
index f8f47fd..cc618b9 100644
--- a/content/docs/latest/clients/Cpp/index.html
+++ b/content/docs/latest/clients/Cpp/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -867,6 +883,8 @@
+
+
<li><a href="/docs/latest/reference/CliTools/">Pulsar command-line tools</a></li>
@@ -949,6 +967,10 @@
+
+
+
+
<li><a href="/docs/latest/clients/Python/">The Pulsar Python client</a></li>
@@ -1079,6 +1101,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1254,6 +1278,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1305,17 +1333,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1490,64 +1518,6 @@
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pulsar+ssl://pulsar.us-west.example.com:6651
</code></pre></div></div>
-<h3 id="global-vs-cluster-specific-topics">Global vs. cluster-specific topics</h3>
-
-<p>Pulsar <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topics</span> can be either cluster specific or global. Cluster-specific topic URLs have this structure:</p>
-
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
-</section>
-
-<p>If the topic that a client needs to publish to or consume from is specific to a cluster, the client will need to use the broker service URL that you assigned to that cluster when <a href="../../deployment/InstanceSetup#cluster-metadata-initialization">initializing its metadata</a>.</p>
-
-<p>If the topic is global, however, the URL for the topic will look like this:</p>
-
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">global</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
-</section>
-
-<p>In that case, your client can use the broker service URL for <em>any</em> cluster in the <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> and Pulsar’s internal service discovery system will handle the rest.</p>
-
<h2 id="consumer">Consumer</h2>
<div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Client</span> <span class="n">client</span><span class="p">(</span><span class="s">"pulsar://localhost:6650"</span><span class="p">);</span>
diff --git a/content/docs/latest/clients/Java/index.html b/content/docs/latest/clients/Java/index.html
index 6594c55..7b5aa33 100644
--- a/content/docs/latest/clients/Java/index.html
+++ b/content/docs/latest/clients/Java/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -867,6 +883,8 @@
+
+
<li><a href="/docs/latest/reference/CliTools/">Pulsar command-line tools</a></li>
@@ -949,6 +967,10 @@
+
+
+
+
<li><a href="/docs/latest/clients/Python/">The Pulsar Python client</a></li>
@@ -1079,6 +1101,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1159,6 +1183,10 @@
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -1227,9 +1255,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1239,11 +1267,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1313,17 +1341,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1348,9 +1376,7 @@
-->
-<p>The Pulsar Java client can be used both to create Java <span class="popover-term" tabindex="0" title="What is a producer?" data-placement="top" data-content="A process that publishes messages to a Pulsar topic." data-toggle="popover" data-trigger="focus">producers</span> and <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and processes messages published to that topic by [...]
-
-<p>The current version of the Java client is <strong>1.22.0-incubating</strong>.</p>
+<p>The Pulsar Java client can be used both to create Java <span class="popover-term" tabindex="0" title="What is a producer?" data-placement="top" data-content="A process that publishes messages to a Pulsar topic." data-toggle="popover" data-trigger="focus">producers</span>, <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and processes messages published to that topic by pro [...]
<p>Javadoc for the Pulsar client is divided up into two domains, by package:</p>
@@ -1448,64 +1474,6 @@
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pulsar+ssl://pulsar.us-west.example.com:6651
</code></pre></div></div>
-<h3 id="global-vs-cluster-specific-topics">Global vs. cluster-specific topics</h3>
-
-<p>Pulsar <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topics</span> can be either cluster specific or global. Cluster-specific topic URLs have this structure:</p>
-
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
-</section>
-
-<p>If the topic that a client needs to publish to or consume from is specific to a cluster, the client will need to use the broker service URL that you assigned to that cluster when <a href="../../deployment/InstanceSetup#cluster-metadata-initialization">initializing its metadata</a>.</p>
-
-<p>If the topic is global, however, the URL for the topic will look like this:</p>
-
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">global</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
-</section>
-
-<p>In that case, your client can use the broker service URL for <em>any</em> cluster in the <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> and Pulsar’s internal service discovery system will handle the rest.</p>
-
<h2 id="client-configuration">Client configuration</h2>
<p>You can instantiate a <a target="_blank" href="/api/client/org/apache/pulsar/client/api/PulsarClient.html"><code class="highlighter-rouge">PulsarClient</code></a> object using just a URL for the target Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo- [...]
@@ -1583,20 +1551,36 @@
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">String</span> <span class="n">topic</span> <span class="o">=</span> <span class="s">"persistent://sample/standalone/ns1/my-topic"</span><span class="o">;</span>
-<span class="n">Producer</span> <span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newProducer</span><span class="o">()</span>
+<span class="n">Producer</span> <span class="n">producer</span><span class="o"><</span><span class="kt">byte</span><span class="o">[]></span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newProducer</span><span class="o">()</span>
<span class="o">.</span><span class="na">topic</span><span class="o">(</span><span class="n">topic</span><span class="o">)</span>
<span class="o">.</span><span class="na">create</span><span class="o">();</span>
</code></pre></div></div>
<p>You can then send messages to the broker and topic you specified:</p>
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">// Publish 10 messages to the topic</span>
-<span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="mi">10</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
- <span class="n">Message</span><span class="o"><</span><span class="kt">byte</span><span class="o">[]></span> <span class="n">msg</span> <span class="o">=</span> <span class="n">MessageBuilder</span><span class="o">.</span><span class="na">create</span><span class="o">()</span>
- <span class="o">.</span><span class="na">setContent</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"Message number %d"</span><span class="o">,</span> <span class="n">i</span><span class="o">).</span><span class="na">getBytes</span><span class="o">())</span>
- <span class="o">.</span><span class="na">build</span><span class="o">();</span>
- <span class="n">producer</span><span class="o">.</span><span class="na">send</span><span class="o">(</span><span class="n">msg</span><span class="o">);</span>
-<span class="o">}</span>
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">org.apache.pulsar.client.api.MessageBuilder</span><span class="o">;</span>
+
+<span class="kn">import</span> <span class="nn">java.util.stream.IntStream</span><span class="o">;</span>
+
+<span class="n">MessageBuilder</span><span class="o"><</span><span class="kt">byte</span><span class="o">[]></span> <span class="n">msgBuilder</span> <span class="o">=</span> <span class="n">MessageBuilder</span><span class="o">.</span><span class="na">create</span><span class="o">();</span>
+
+<span class="c1">// Publish 10 messages to the topic</span>
+<span class="n">IntStream</span><span class="o">.</span><span class="na">range</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="mi">11</span><span class="o">).</span><span class="na">forEach</span><span class="o">(</span><span class="n">i</span> <span class="o">-></span> <span class="o">{</span>
+ <span class="n">msgBuilder</span><span class="o">.</span><span class="na">setContent</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"Message number %d"</span><span class="o">,</span> <span class="n">i</span><span class="o">).</span><span class="na">getBytes</span><span class="o">());</span>
+
+ <span class="k">try</span> <span class="o">{</span>
+ <span class="n">producer</span><span class="o">.</span><span class="na">send</span><span class="o">(</span><span class="n">msgBuilder</span><span class="o">);</span>
+ <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">PulsarClientException</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">e</span><span class="o">.</span><span class="na">printStackTrace</span><span class="o">();</span>
+ <span class="o">}</span>
+<span class="o">});</span>
+</code></pre></div></div>
+
+<p>By default, producers produce messages that consist of byte arrays. You can produce different types, however, by specifying a message <a href="#schemas">schema</a>.</p>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Producer</span><span class="o"><</span><span class="n">String</span><span class="o">></span> <span class="n">stringProducer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newProducer</span><span class="o">(</span><span class="k">new</span> <span class="n">StringSchema</span><span class="o">())</span>
+ <span class="o">.</span><span class="na">topic</span><span class="o">(</span><span class="n">topic</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">create</span><span class="o">();</span>
</code></pre></div></div>
<!--
@@ -1630,11 +1614,9 @@
<span class="n">client</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</code></pre></div></div>
-<p>Closer operations can also be asynchronous:</p>
+<p>Close operations can also be asynchronous:</p>
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">producer</span><span class="o">.</span><span class="na">asyncClose</span><span class="o">();</span>
-<span class="n">consumer</span><span class="o">.</span><span class="na">asyncClose</span><span class="o">();</span>
-<span class="n">clioent</span><span class="o">.</span><span class="na">asyncClose</span><span class="o">();</span>
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">producer</span><span class="o">.</span><span class="na">closeAsync</span><span class="o">().</span><span class="na">thenRun</span><span class="o">(()</span> <span class="o">-></span> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Producer closed"< [...]
</code></pre></div></div>
</div>
@@ -1644,7 +1626,7 @@
<p>If you instantiate a <code class="highlighter-rouge">Producer</code> object specifying only a topic name, as in the example above, the producer will use the default configuration. To use a non-default configuration, there’s a variety of configurable parameters that you can set. For a full listing, see the Javadoc for the <a target="_blank" href="/api/client/org/apache/pulsar/client/api/ProducerBuilder.html"><code class="highlighter-rouge">ProducerBuilder</code></a> class. Here’s an ex [...]
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Producer</span> <span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newProducer</span><span class="o">()</span>
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Producer</span><span class="o"><</span><span class="kt">byte</span><span class="o">[]></span> <span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newProducer</span><span class="o">()</span>
<span class="o">.</span><span class="na">topic</span><span class="o">(</span><span class="n">topic</span><span class="o">)</span>
<span class="o">.</span><span class="na">enableBatching</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">sendTimeout</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="n">TimeUnit</span><span class="o">.</span><span class="na">SECONDS</span><span class="o">)</span>
@@ -1658,14 +1640,17 @@
<h3 id="async-send">Async send</h3>
-<p>You can publish messages <a href="../../getting-started/ConceptsAndArchitecture#send-modes">asynchronously</a> using the Java client. With async send, the producer will put the message in a blocking queue and return immediately. The client library will then send the message to the <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST in [...]
+<p>You can also publish messages <a href="../../getting-started/ConceptsAndArchitecture#send-modes">asynchronously</a> using the Java client. With async send, the producer will put the message in a blocking queue and return immediately. The client library will then send the message to the <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a RE [...]
<p>Here’s an example async send operation:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">CompletableFuture</span><span class="o"><</span><span class="n">MessageId</span><span class="o">></span> <span class="n">future</span> <span class="o">=</span> <span class="n">producer</span><span class="o">.</span><span class="na">sendAsync</span><span class="o">(</span><span class="s">"my-async-message"</span><span class="o">.</span><span class="na">getBytes</span><spa [...]
+<span class="n">future</span><span class="o">.</span><span class="na">thenAccept</span><span class="o">(</span><span class="n">msgId</span> <span class="o">-></span> <span class="o">{</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">printf</span><span class="o">(</span><span class="s">"Message with ID %s successfully sent"</span><span class="o">,</span> <span class="k">new</span> <span class="n">String</span><span class="o">(</span><span class="n">msgId</span><span class="o">.</span><span class="na">toByteArray</span><span class="o">());</span>
+<span class="o">});</span>
</code></pre></div></div>
-<p>Async send operations return a <a target="_blank" href="/api/client/org/apache/pulsar/client/api/MessageId.html"><code class="highlighter-rouge">MessageId</code></a> wrapped in a <a href="http://www.baeldung.com/java-completablefuture"><code class="highlighter-rouge">CompletableFuture</code></a>.</p>
+<p>As you can see from the example above, async send operations return a <a target="_blank" href="/api/client/org/apache/pulsar/client/api/MessageId.html"><code class="highlighter-rouge">MessageId</code></a> wrapped in a <a href="http://www.baeldung.com/java-completablefuture"><code class="highlighter-rouge">CompletableFuture</code></a>.</p>
<h2 id="consumers">Consumers</h2>
@@ -1673,16 +1658,15 @@
<p>Once you’ve instantiated a <a target="_blank" href="/api/client/org/apache/pulsar/client/api/PulsarClient.html"><code class="highlighter-rouge">PulsarClient</code></a> object, you can create a <a target="_blank" href="/api/client/org/apache/pulsar/client/api/Consumer.html"><code class="highlighter-rouge">Consumer</code></a> by specifying a <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published [...]
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">String</span> <span class="n">topic</span> <span class="o">=</span> <span class="s">"persistent://sample/standalone/ns1/my-topic"</span><span class="o">;</span> <span class="c1">// from above</span>
-<span class="n">String</span> <span class="n">subscription</span> <span class="o">=</span> <span class="s">"my-subscription"</span><span class="o">;</span>
-<span class="n">Consumer</span> <span class="n">consumer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newConsumer</span><span class="o">()</span>
- <span class="o">.</span><span class="na">subscriptionName</span><span class="o">(</span><span class="s">"my-subscription-1"</span><span class="o">)</span>
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Consumer</span> <span class="n">consumer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newConsumer</span><span class="o">()</span>
+ <span class="o">.</span><span class="na">topic</span><span class="o">(</span><span class="s">"my-topic"</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">subscriptionName</span><span class="o">(</span><span class="s">"my-subscription"</span><span class="o">)</span>
<span class="o">.</span><span class="na">subscribe</span><span class="o">();</span>
</code></pre></div></div>
<p>The <code class="highlighter-rouge">subscribe</code> method will automatically subscribe the consumer to the specified topic and subscription. One way to make the consumer listen on the topic is to set up a <code class="highlighter-rouge">while</code> loop. In this example loop, the consumer listens for messages, prints the contents of any message that’s received, and then <span class="popover-term" tabindex="0" title="What is an acknowledgement (ack)?" data-placement="top" data-conte [...]
-<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">while</span> <span class="o">(</span><span class="kc">true</span><span class="o">)</span> <span class="o">{</span>
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">do</span> <span class="o">{</span>
<span class="c1">// Wait for a message</span>
<span class="n">Message</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">consumer</span><span class="o">.</span><span class="na">receive</span><span class="o">();</span>
@@ -1690,7 +1674,7 @@
<span class="c1">// Acknowledge the message so that it can be deleted by the message broker</span>
<span class="n">consumer</span><span class="o">.</span><span class="na">acknowledge</span><span class="o">(</span><span class="n">msg</span><span class="o">);</span>
-<span class="o">}</span>
+<span class="o">}</span> <span class="k">while</span> <span class="o">(</span><span class="kc">true</span><span class="o">);</span>
</code></pre></div></div>
<h3 id="configuring-consumers">Configuring consumers</h3>
@@ -1700,8 +1684,8 @@
<p>Here’s an example configuration:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Consumer</span> <span class="n">consumer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newConsumer</span><span class="o">()</span>
- <span class="o">.</span><span class="na">topic</span><span class="o">(</span><span class="n">topic</span><span class="o">)</span>
- <span class="o">.</span><span class="na">subscriptionName</span><span class="o">(</span><span class="n">subscription</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">topic</span><span class="o">(</span><span class="s">"my-topic"</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">subscriptionName</span><span class="o">(</span><span class="s">"my-subscription"</span><span class="o">)</span>
<span class="o">.</span><span class="na">ackTimeout</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="n">TimeUnit</span><span class="o">.</span><span class="na">SECONDS</span><span class="o">)</span>
<span class="o">.</span><span class="na">subscriptionType</span><span class="o">(</span><span class="n">SubscriptionType</span><span class="o">.</span><span class="na">Exclusive</span><span class="o">)</span>
<span class="o">.</span><span class="na">subscribe</span><span class="o">();</span>
@@ -1731,18 +1715,18 @@
<span class="kn">import</span> <span class="nn">java.util.List</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">java.util.regex.Pattern</span><span class="o">;</span>
-<span class="n">ConsumerBuilder</span> <span class="n">bldr</span> <span class="o">=</span> <span class="n">pulsarClient</span><span class="o">.</span><span class="na">newConsumer</span><span class="o">()</span>
+<span class="n">ConsumerBuilder</span> <span class="n">consumerBuilder</span> <span class="o">=</span> <span class="n">pulsarClient</span><span class="o">.</span><span class="na">newConsumer</span><span class="o">()</span>
<span class="o">.</span><span class="na">subscriptionName</span><span class="o">(</span><span class="n">subscription</span><span class="o">);</span>
<span class="c1">// Subscribe to all topics in a namespace</span>
<span class="n">Pattern</span> <span class="n">allTopicsInNamespace</span> <span class="o">=</span> <span class="n">Pattern</span><span class="o">.</span><span class="na">compile</span><span class="o">(</span><span class="s">"persistent://sample/standalone/ns1/.*"</span><span class="o">);</span>
-<span class="n">Consumer</span> <span class="n">allTopicsConsumer</span> <span class="o">=</span> <span class="n">bldr</span>
+<span class="n">Consumer</span> <span class="n">allTopicsConsumer</span> <span class="o">=</span> <span class="n">consumerBuilder</span>
<span class="o">.</span><span class="na">topicsPattern</span><span class="o">(</span><span class="n">allTopicsInNamespace</span><span class="o">)</span>
<span class="o">.</span><span class="na">subscribe</span><span class="o">();</span>
<span class="c1">// Subscribe to a subsets of topics in a namespace, based on regex</span>
<span class="n">Pattern</span> <span class="n">someTopicsInNamespace</span> <span class="o">=</span> <span class="n">Pattern</span><span class="o">.</span><span class="na">compile</span><span class="o">(</span><span class="s">"persistent://sample/standalone/ns1/foo.*"</span><span class="o">);</span>
-<span class="n">Consumer</span> <span class="n">allTopicsConsumer</span> <span class="o">=</span> <span class="n">bldr</span>
+<span class="n">Consumer</span> <span class="n">allTopicsConsumer</span> <span class="o">=</span> <span class="n">consumerBuilder</span>
<span class="o">.</span><span class="na">topicsPattern</span><span class="o">(</span><span class="n">someTopicsInNamespace</span><span class="o">)</span>
<span class="o">.</span><span class="na">subscribe</span><span class="o">();</span>
</code></pre></div></div>
@@ -1755,12 +1739,12 @@
<span class="s">"persistent://sample/standalone/ns3/topic-3"</span>
<span class="o">);</span>
-<span class="n">Consumer</span> <span class="n">multiTopicConsumer</span> <span class="o">=</span> <span class="n">bldr</span>
+<span class="n">Consumer</span> <span class="n">multiTopicConsumer</span> <span class="o">=</span> <span class="n">consumerBuilder</span>
<span class="o">.</span><span class="na">topics</span><span class="o">(</span><span class="n">topics</span><span class="o">)</span>
<span class="o">.</span><span class="na">subscribe</span><span class="o">();</span>
<span class="c1">// Alternatively:</span>
-<span class="n">Consumer</span> <span class="n">multiTopicConsumer</span> <span class="o">=</span> <span class="n">bldr</span>
+<span class="n">Consumer</span> <span class="n">multiTopicConsumer</span> <span class="o">=</span> <span class="n">consumerBuilder</span>
<span class="o">.</span><span class="na">topics</span><span class="o">(</span>
<span class="s">"persistent://sample/standalone/ns1/topic-1"</span><span class="o">,</span>
<span class="s">"persistent://sample/standalone/ns2/topic-2"</span><span class="o">,</span>
@@ -1772,12 +1756,35 @@
<p>You can also subscribe to multiple topics asynchronously using the <code class="highlighter-rouge">subscribeAsync</code> method rather than the synchronous <code class="highlighter-rouge">subscribe</code> method. Here’s an example:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Pattern</span> <span class="n">allTopicsInNamespace</span> <span class="o">=</span> <span class="n">Pattern</span><span class="o">.</span><span class="na">compile</span><span class="o">(</span><span class="s">"persistent://sample/standalone/ns1/.*"</span><span class="o">);</span>
-<span class="n">CompletableFuture</span><span class="o"><</span><span class="n">Consumer</span><span class="o">></span> <span class="n">consumer</span> <span class="o">=</span> <span class="n">bldr</span>
+<span class="n">consumerBuilder</span>
<span class="o">.</span><span class="na">topics</span><span class="o">(</span><span class="n">topics</span><span class="o">)</span>
- <span class="o">.</span><span class="na">subscribeAsync</span><span class="o">();</span>
+ <span class="o">.</span><span class="na">subscribeAsync</span><span class="o">()</span>
+ <span class="o">.</span><span class="na">thenAccept</span><span class="o">(</span><span class="n">consumer</span> <span class="o">-></span> <span class="o">{</span>
+ <span class="k">do</span> <span class="o">{</span>
+ <span class="k">try</span> <span class="o">{</span>
+ <span class="n">Message</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">consumer</span><span class="o">.</span><span class="na">receive</span><span class="o">();</span>
+ <span class="c1">// Do something with the received message</span>
+ <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">PulsarClientException</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">e</span><span class="o">.</span><span class="na">printStackTrace</span><span class="o">();</span>
+ <span class="o">}</span>
+ <span class="o">}</span> <span class="k">while</span> <span class="o">(</span><span class="kc">true</span><span class="o">);</span>
+ <span class="o">});</span>
+</code></pre></div></div>
+
+<h2 id="schemas">Message schemas</h2>
+
+<p>In Pulsar, all message data consists of byte arrays. Message <strong>schemas</strong> enable you to use other types of data when constructing and handling messages (from simple types like strings to more complex, application-specific types). If you construct, say, a <a href="#producers">producer</a> without specifying a schema, then the producer can only produce messages of type <code class="highlighter-rouge">byte[]</code>. Here’s an example:</p>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Producer</span> <span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">newProducer</span><span class="o">()</span>
+ <span class="o">.</span><span class="na">topic</span><span class="o">(</span><span class="n">topic</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">create</span><span class="o">();</span>
</code></pre></div></div>
-<h2 id="reader-interface">Reader interface</h2>
+<p>The producer above is equivalent to a <code class="highlighter-rouge">Producer<byte[]></code> (in fact, you should always explicitly specify the type). If you’d like</p>
+
+<p>The same schema-based logic applies to <a href="#consumers">consumers</a> and <a href="#readers">readers</a>.</p>
+
+<h2 id="readers">Reader interface</h2>
<p>With the <a href="../../getting-started/ConceptsAndArchitecture#reader-interface">reader interface</a>, Pulsar clients can “manually position” themselves within a topic, reading all messages from a specified message onward. The Pulsar API for Java enables you to create <a target="_blank" href="/api/client/org/apache/pulsar/client/api/Reader.html"><code class="highlighter-rouge">Reader</code></a> objects by specifying a <span class="popover-term" tabindex="0" title="What is a topic?" [...]
diff --git a/content/docs/latest/clients/Python/index.html b/content/docs/latest/clients/Python/index.html
index b226ef3..b70c474 100644
--- a/content/docs/latest/clients/Python/index.html
+++ b/content/docs/latest/clients/Python/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -867,6 +883,8 @@
+
+
<li><a href="/docs/latest/reference/CliTools/">Pulsar command-line tools</a></li>
@@ -949,6 +967,10 @@
+
+
+
+
<li><a href="/docs/latest/clients/Python/">The Pulsar Python client</a></li>
@@ -1163,6 +1185,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/clients/Python/">The Pulsar Python client</a></li>
@@ -1223,9 +1251,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1307,17 +1335,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/clients/WebSocket/index.html b/content/docs/latest/clients/WebSocket/index.html
index 9ee1287..27dbaf0 100644
--- a/content/docs/latest/clients/WebSocket/index.html
+++ b/content/docs/latest/clients/WebSocket/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -963,6 +979,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/clients/WebSocket/">Pulsar's WebSocket API</a></li>
@@ -1177,6 +1199,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/clients/WebSocket/">Pulsar's WebSocket API</a></li>
@@ -1371,6 +1399,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/clients/Python/">The Pulsar Python client</a></li>
@@ -1431,9 +1465,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1515,17 +1549,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/cookbooks/Encryption/index.html b/content/docs/latest/cookbooks/Encryption/index.html
index f5e143a..ba10654 100644
--- a/content/docs/latest/cookbooks/Encryption/index.html
+++ b/content/docs/latest/cookbooks/Encryption/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -1032,6 +1048,12 @@
+
+
+
+
+
+
</ul>
</div>
</div>
@@ -1246,6 +1268,12 @@
+
+
+
+
+
+
</ul>
</div>
</div>
@@ -1357,6 +1385,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1365,6 +1397,8 @@
+ <li><a href="/docs/latest/getting-started/Pulsar-2.0/">Pulsar 2.0</a></li>
+
@@ -1464,6 +1498,8 @@
+
+
</ul>
</div>
</div>
@@ -1575,6 +1611,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1601,9 +1641,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1686,6 +1726,8 @@
+
+
</ul>
</div>
</div>
@@ -1737,17 +1779,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/cookbooks/PartitionedTopics/index.html b/content/docs/latest/cookbooks/PartitionedTopics/index.html
index 8ecee13..9215077 100644
--- a/content/docs/latest/cookbooks/PartitionedTopics/index.html
+++ b/content/docs/latest/cookbooks/PartitionedTopics/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -927,6 +943,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1032,6 +1052,8 @@
+
+
</ul>
</div>
</div>
@@ -1141,6 +1163,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1246,6 +1272,8 @@
+
+
</ul>
</div>
</div>
@@ -1287,6 +1315,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1359,6 +1389,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1385,9 +1417,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1455,9 +1487,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1587,6 +1621,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1595,6 +1633,8 @@
+ <li><a href="/docs/latest/getting-started/Pulsar-2.0/">Pulsar 2.0</a></li>
+
@@ -1694,6 +1734,8 @@
+
+
</ul>
</div>
</div>
@@ -1805,6 +1847,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1831,9 +1877,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1916,6 +1962,8 @@
+
+
</ul>
</div>
</div>
@@ -1967,17 +2015,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -2250,7 +2298,7 @@
-->
<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<h3 id="create">Create</h3>
@@ -2914,13 +2962,13 @@ persistent://property/cluster/namespace/topic
<p>The diagram below illustrates this:</p>
-<p><img src="/img/pulsar_partitioned_topic.jpg" alt="Partitioned Topic" /></p>
+<p><img src="/img/partitioning.png" width="70%" /></p>
-<p>Here, the topic <strong>T1</strong> has five partitions (<strong>P0</strong> through <strong>P4</strong>) split across three brokers. Because there are more partitions than brokers, two brokers handle two partitions a piece, while the third handles only one (again, Pulsar handles this distribution of partitions automatically).</p>
+<p>Here, the topic <strong>Topic1</strong> has five partitions (<strong>P0</strong> through <strong>P4</strong>) split across three brokers. Because there are more partitions than brokers, two brokers handle two partitions a piece, while the third handles only one (again, Pulsar handles this distribution of partitions automatically).</p>
<p>Messages for this topic are broadcast to two <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and processes messages published to that topic by producers." data-toggle="popover" data-trigger="focus">consumers</span>. The <a href="#routing-modes">routing mode</a> determines both which broker handles each partition, while the <a href="../../getting-started/ConceptsAndArchite [...]
-<p>Decisions about routing and subscription modes can be made separately in most cases. Throughput concerns should guide partitioning/routing decisions while subscription decisions should be guided by application semantics.</p>
+<p>Decisions about routing and subscription modes can be made separately in most cases. In general, throughput concerns should guide partitioning/routing decisions while subscription decisions should be guided by application semantics.</p>
<p>There is no difference between partitioned topics and normal topics in terms of how subscription modes work, as partitioning only determines what happens between when a message is published by a <span class="popover-term" tabindex="0" title="What is a producer?" data-placement="top" data-content="A process that publishes messages to a Pulsar topic." data-toggle="popover" data-trigger="focus">producer</span> and processed and <span class="popover-term" tabindex="0" title="What is an ac [...]
diff --git a/content/docs/latest/cookbooks/RetentionExpiry/index.html b/content/docs/latest/cookbooks/RetentionExpiry/index.html
index a63dc3e..852cc4e 100644
--- a/content/docs/latest/cookbooks/RetentionExpiry/index.html
+++ b/content/docs/latest/cookbooks/RetentionExpiry/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -859,6 +875,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -931,6 +949,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -957,9 +977,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1027,9 +1047,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1181,6 +1203,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1395,6 +1423,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1609,6 +1643,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1801,6 +1841,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1827,9 +1871,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1912,6 +1956,8 @@
+
+
</ul>
</div>
</div>
@@ -1963,17 +2009,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/cookbooks/message-deduplication/index.html b/content/docs/latest/cookbooks/message-deduplication/index.html
index 3cc33a1..6ca08ef 100644
--- a/content/docs/latest/cookbooks/message-deduplication/index.html
+++ b/content/docs/latest/cookbooks/message-deduplication/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -859,6 +875,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -931,6 +949,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -957,9 +977,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1027,9 +1047,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1111,6 +1133,8 @@
+
+
<li><a href="/docs/latest/getting-started/ConceptsAndArchitecture/">Pulsar concepts and architecture</a></li>
@@ -1231,6 +1255,8 @@
+
+
<li><a href="/docs/latest/cookbooks/message-deduplication/">Message deduplication</a></li>
@@ -1264,6 +1290,8 @@
+
+
</ul>
</div>
</div>
@@ -1375,6 +1403,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1401,9 +1433,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1486,6 +1518,8 @@
+
+
</ul>
</div>
</div>
@@ -1537,17 +1571,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/cookbooks/message-queue/index.html b/content/docs/latest/cookbooks/message-queue/index.html
index 16f1d37..7b0ee60 100644
--- a/content/docs/latest/cookbooks/message-queue/index.html
+++ b/content/docs/latest/cookbooks/message-queue/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -929,6 +945,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -937,6 +957,8 @@
+ <li><a href="/docs/latest/getting-started/Pulsar-2.0/">Pulsar 2.0</a></li>
+
@@ -1036,6 +1058,8 @@
+
+
</ul>
</div>
</div>
@@ -1077,6 +1101,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -1157,6 +1183,10 @@
+
+
+
+
<li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
@@ -1225,9 +1255,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1237,11 +1267,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1385,6 +1415,12 @@
+
+
+
+
+
+
<li><a href="/docs/latest/clients/Python/">The Pulsar Python client</a></li>
@@ -1445,9 +1481,9 @@
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
- <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1661,6 +1697,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
@@ -1692,6 +1732,8 @@
+
+
</ul>
</div>
</div>
@@ -1803,6 +1845,10 @@
+
+
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -1829,9 +1875,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1914,6 +1960,8 @@
+
+
</ul>
</div>
</div>
@@ -1965,17 +2013,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/cookbooks/non-persistent-messaging/index.html b/content/docs/latest/cookbooks/non-persistent-messaging/index.html
index 60a0711..c8151e3 100644
--- a/content/docs/latest/cookbooks/non-persistent-messaging/index.html
+++ b/content/docs/latest/cookbooks/non-persistent-messaging/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -962,7 +978,7 @@
-->
<section class="topic">
- non-persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ non-persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<!--
diff --git a/content/docs/latest/deployment/Kubernetes/index.html b/content/docs/latest/deployment/Kubernetes/index.html
index 568da32..baed45a 100644
--- a/content/docs/latest/deployment/Kubernetes/index.html
+++ b/content/docs/latest/deployment/Kubernetes/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -911,6 +927,8 @@
+
+
<li><a href="/docs/latest/deployment/Kubernetes/">Deploying Pulsar on Kubernetes</a></li>
@@ -1032,6 +1050,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1125,6 +1147,8 @@
+
+
<li><a href="/docs/latest/deployment/Kubernetes/">Deploying Pulsar on Kubernetes</a></li>
@@ -1246,6 +1270,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1297,17 +1325,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1338,7 +1366,7 @@
<ul>
<li>A two-<span class="popover-term" tabindex="0" title="What is a bookie?" data-placement="top" data-content="Bookie is just a nickname for an individual BookKeeper server." data-toggle="popover" data-trigger="focus">bookie</span> <span class="popover-term" tabindex="0" title="What is BookKeeper?" data-placement="top" data-content="Apache BookKeeper is a persistent log storage system that Pulsar uses to store message data." data-toggle="popover" data-trigger="focus">BookKeeper</span> [...]
- <li>A three-node <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster</li>
+ <li>A three-node <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster</li>
<li>A three-<span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">broker</span> Pulsar <span class="popover-term" tabindex="0" title="What is [...]
<li>A <a href="">monitoring stack</a> consisting of <a href="https://prometheus.io/">Prometheus</a>, <a href="https://grafana.com">Grafana</a>, and the <a href="../../admin/Dashboard">Pulsar dashboard</a></li>
<li>A <a href="https://kubernetes.io/docs/concepts/workloads/pods/pod/">pod</a> from which you can run administrative commands using the <a href="../../reference/CliTools#pulsar-admin"><code class="highlighter-rouge">pulsar-admin</code></a> CLI tool</li>
@@ -1494,7 +1522,7 @@ NAME STATUS AGE VERSION
<h3 id="zookeeper">ZooKeeper</h3>
-<p>You <em>must</em> deploy <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> as the first Pulsar component, as it is a dependency for the others.</p>
+<p>You <em>must</em> deploy <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> as the first Pulsar component, as it is a dependency for the others.</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>kubectl apply <span class="nt">-f</span> zookeeper.yaml
</code></pre></div></div>
@@ -1639,7 +1667,7 @@ ns
<h4 id="grafana">Grafana</h4>
-<p>In your Kubernetes cluster, you can use <a href="https://grafana.com">Grafana</a> to view dashbaords for Pulsar <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespaces</span> (message rates, latency, and storage), JVM stats, <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a ser [...]
+<p>In your Kubernetes cluster, you can use <a href="https://grafana.com">Grafana</a> to view dashbaords for Pulsar <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespaces</span> (message rates, latency, and storage), JVM stats, <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a ser [...]
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>kubectl port-forward <span class="se">\</span>
<span class="k">$(</span>kubectl get pods <span class="nt">-l</span> <span class="nv">component</span><span class="o">=</span>grafana <span class="nt">-o</span> <span class="nv">jsonpath</span><span class="o">=</span><span class="s1">'{.items[*].metadata.name}'</span><span class="k">)</span> 3000
diff --git a/content/docs/latest/deployment/Monitoring/index.html b/content/docs/latest/deployment/Monitoring/index.html
index 2368b94..9648ad1 100644
--- a/content/docs/latest/deployment/Monitoring/index.html
+++ b/content/docs/latest/deployment/Monitoring/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/deployment/aws-cluster/index.html b/content/docs/latest/deployment/aws-cluster/index.html
index d3d8fc0..26655e6 100644
--- a/content/docs/latest/deployment/aws-cluster/index.html
+++ b/content/docs/latest/deployment/aws-cluster/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -859,6 +875,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -931,6 +949,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -957,9 +977,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1027,9 +1047,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1203,6 +1225,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/aws-cluster/">Deploying a Pulsar cluster on AWS using Terraform and Ansible</a></li>
@@ -1266,6 +1292,8 @@
+
+
</ul>
</div>
</div>
@@ -1421,6 +1449,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/aws-cluster/">Deploying a Pulsar cluster on AWS using Terraform and Ansible</a></li>
@@ -1482,6 +1514,8 @@
+
+
</ul>
</div>
</div>
@@ -1637,6 +1671,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/aws-cluster/">Deploying a Pulsar cluster on AWS using Terraform and Ansible</a></li>
@@ -1696,6 +1734,8 @@
+
+
</ul>
</div>
</div>
@@ -1851,6 +1891,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/aws-cluster/">Deploying a Pulsar cluster on AWS using Terraform and Ansible</a></li>
@@ -1910,6 +1954,8 @@
+
+
</ul>
</div>
</div>
@@ -1961,17 +2007,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/deployment/cluster/index.html b/content/docs/latest/deployment/cluster/index.html
index 3c3ba83..624988c 100644
--- a/content/docs/latest/deployment/cluster/index.html
+++ b/content/docs/latest/deployment/cluster/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -859,6 +875,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -931,6 +949,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -957,9 +977,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1027,9 +1047,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1203,6 +1225,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/aws-cluster/">Deploying a Pulsar cluster on AWS using Terraform and Ansible</a></li>
@@ -1266,6 +1292,8 @@
+
+
</ul>
</div>
</div>
@@ -1421,6 +1449,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/aws-cluster/">Deploying a Pulsar cluster on AWS using Terraform and Ansible</a></li>
@@ -1482,6 +1514,8 @@
+
+
</ul>
</div>
</div>
@@ -1641,6 +1675,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/cluster/">Deploying a Pulsar cluster on bare metal</a></li>
@@ -1698,6 +1736,8 @@
+
+
</ul>
</div>
</div>
@@ -1749,17 +1789,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1932,7 +1972,7 @@
</tr>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">data</code></td>
- <td style="text-align: left">The data storage directory used by <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> and <span class="popover-term" tabinde [...]
+ <td style="text-align: left">The data storage directory used by <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> and <span class="popover- [...]
</tr>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">lib</code></td>
@@ -2009,7 +2049,7 @@
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar initialize-cluster-metadata <span class="se">\</span>
<span class="nt">--cluster</span> pulsar-cluster-1 <span class="se">\</span>
<span class="nt">--zookeeper</span> zk1.us-west.example.com:2181 <span class="se">\</span>
- <span class="nt">--global-zookeeper</span> zk1.us-west.example.com:2181 <span class="se">\</span>
+ <span class="nt">--configuration-store</span> zk1.us-west.example.com:2181 <span class="se">\</span>
<span class="nt">--web-service-url</span> http://pulsar.us-west.example.com:8080 <span class="se">\</span>
<span class="nt">--web-service-url-tls</span> https://pulsar.us-west.example.com:8443 <span class="se">\</span>
<span class="nt">--broker-service-url</span> pulsar://pulsar.us-west.example.com:6650 <span class="se">\</span>
@@ -2035,8 +2075,8 @@
<td style="text-align: left">A “local” ZooKeeper connection string for the cluster. This connection string only needs to include <em>one</em> machine in the ZooKeeper cluster.</td>
</tr>
<tr>
- <td style="text-align: left"><code class="highlighter-rouge">--global-zookeeper</code></td>
- <td style="text-align: left">The “global” ZooKeeper connection string for the entire instance. As with the <code class="highlighter-rouge">--zookeeper</code> flag, this connection string only needs to include <em>one</em> machine in the ZooKeeper cluster.</td>
+ <td style="text-align: left"><code class="highlighter-rouge">--configuration-store</code></td>
+ <td style="text-align: left">The <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) is a ZooKeeper quorum that is used for configuration-specific tasks. A multi-cluster Pulsar installation requires just one configuration store across all clusters." data-toggle="popover" data-trigger="focus">configuration store</span> connection string for the entire i [...]
</tr>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">--web-service-url</code></td>
@@ -2091,12 +2131,10 @@
<p>Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span> are the last thing you need to deploy in your Pulsar cluster. Bro [...]
-<p>The most important element of broker configuration is ensuring that that each broker is aware of the ZooKeeper cluster that you’ve deployed. Make sure that the <a href="../../../reference/Configuration#broker-zookeeperServers"><code class="highlighter-rouge">zookeeperServers</code></a> and <a href="../../../reference/Configuration#broker-globalZookeeperServers"><code class="highlighter-rouge">globalZookeeperServers</code></a> parameters.
-In this case, since we only have 1 cluster and no global ZooKeeper setup, the <code class="highlighter-rouge">globalZookeeperServers</code>
-will point to the same <code class="highlighter-rouge">zookeeperServers</code>.</p>
+<p>The most important element of broker configuration is ensuring that that each broker is aware of the ZooKeeper cluster that you’ve deployed. Make sure that the <a href="../../../reference/Configuration#broker-zookeeperServers"><code class="highlighter-rouge">zookeeperServers</code></a> and <a href="../../../reference/Configuration#broker-configurationStoreServers"><code class="highlighter-rouge">configurationStoreServers</code></a> parameters. In this case, since we only have 1 cluste [...]
<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="py">zookeeperServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181</span>
-<span class="py">globalZookeeperServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181</span>
+<span class="py">configurationStoreServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181</span>
</code></pre></div></div>
<p>You also need to specify the cluster name (matching the name that you provided when <a href="#initializing-cluster-metadata">initializing the cluster’s metadata</a>:</p>
diff --git a/content/docs/latest/deployment/dcos/index.html b/content/docs/latest/deployment/dcos/index.html
index bfaf05f..c6b8e57 100644
--- a/content/docs/latest/deployment/dcos/index.html
+++ b/content/docs/latest/deployment/dcos/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/deployment/instance/index.html b/content/docs/latest/deployment/instance/index.html
index 0cba7e7..e8db871 100644
--- a/content/docs/latest/deployment/instance/index.html
+++ b/content/docs/latest/deployment/instance/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -859,6 +875,8 @@
+
+
<li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
@@ -931,6 +949,8 @@
+
+
<li><a href="/docs/latest/cookbooks/PartitionedTopics/">Partitioned topics</a></li>
@@ -957,9 +977,9 @@
- <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
+ <li><a href="/docs/latest/cookbooks/RetentionExpiry/">Message retention and expiry</a></li>
@@ -1027,9 +1047,11 @@
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
- <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
@@ -1203,6 +1225,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/aws-cluster/">Deploying a Pulsar cluster on AWS using Terraform and Ansible</a></li>
@@ -1266,6 +1292,8 @@
+
+
</ul>
</div>
</div>
@@ -1445,6 +1473,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/instance/">Deploying a Pulsar instance on bare metal</a></li>
@@ -1480,6 +1512,8 @@
+
+
</ul>
</div>
</div>
@@ -1639,6 +1673,10 @@
+
+
+
+
<li><a href="/docs/latest/deployment/cluster/">Deploying a Pulsar cluster on bare metal</a></li>
@@ -1696,6 +1734,8 @@
+
+
</ul>
</div>
</div>
@@ -1747,17 +1787,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1813,7 +1853,7 @@
<p>A Pulsar <em>instance</em> consists of multiple Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">clusters</span> working in unison. Clusters can be distributed across data centers or geographica [...]
<ul>
- <li>Deploying two separate <a href="#deploying-zookeeper">ZooKeeper</a> quorums: a <a href="#deploying-local-zookeeper">local</a> quorum for each cluster in the instance and a <a href="#deploying-global-zookeeper">global</a> quorum for instance-wide tasks</li>
+ <li>Deploying two separate <a href="#deploying-zookeeper">ZooKeeper</a> quorums: a <a href="#deploying-local-zookeeper">local</a> quorum for each cluster in the instance and a <a href="#configuration-store">configuration store</a> quorum for instance-wide tasks</li>
<li>Initializing <a href="#cluster-metadata-initialization">cluster metadata</a> for each cluster</li>
<li>Deploying a <a href="#deploying-bookkeeper">BookKeeper cluster</a> of <span class="popover-term" tabindex="0" title="What is a bookie?" data-placement="top" data-content="Bookie is just a nickname for an individual BookKeeper server." data-toggle="popover" data-trigger="focus">bookies</span> in each Pulsar cluster</li>
<li>Deploying <a href="#deploying-brokers">brokers</a> in each Pulsar cluster</li>
@@ -1925,6 +1965,10 @@
<td style="text-align: left">Configuration files for Pulsar, including for <a href="../../reference/Configuration#broker">broker configuration</a>, <a href="../../reference/Configuration#zookeeper">ZooKeeper configuration</a>, and more</td>
</tr>
<tr>
+ <td style="text-align: left"><code class="highlighter-rouge">examples</code></td>
+ <td style="text-align: left">A Java JAR file containing example <a href="../../functions/overview">Pulsar Functions</a></td>
+ </tr>
+ <tr>
<td style="text-align: left"><code class="highlighter-rouge">lib</code></td>
<td style="text-align: left">The <a href="https://en.wikipedia.org/wiki/JAR_(file_format)">JAR</a> files used by Pulsar</td>
</tr>
@@ -1947,7 +1991,11 @@
<tbody>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">data</code></td>
- <td style="text-align: left">The data storage directory used by <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> and <span class="popover-term" tabinde [...]
+ <td style="text-align: left">The data storage directory used by <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> and <span class="popover- [...]
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">instances</code></td>
+ <td style="text-align: left">Artifacts created for <a href="../../functions/overview">Pulsar Functions</a></td>
</tr>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">logs</code></td>
@@ -1990,7 +2038,7 @@
<p>ZooKeeper manages a variety of essential coordination- and configuration-related tasks for Pulsar.</p>
-<p>Deploying a Pulsar instance requires you to stand up one local <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster <em>per Pulsar <span class="popove [...]
+<p>Deploying a Pulsar instance requires you to stand up one local <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster <em>per Pulsar <span [...]
<p>To begin, add all ZooKeeper servers to the quorum configuration specified in the <a href="../../reference/Configuration#zookeeper"><code class="highlighter-rouge">conf/zookeeper.conf</code></a> file. Add a <code class="highlighter-rouge">server.N</code> line for each node in the cluster to the configuration, where <code class="highlighter-rouge">N</code> is the number of the ZooKeeper node. Here’s an example for a three-node cluster:</p>
@@ -2043,45 +2091,17 @@
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-daemon start zookeeper
</code></pre></div></div>
-<h3 id="deploying-global-zookeeper">Deploying global ZooKeeper</h3>
-
-<p>The ZooKeeper cluster configured and started up in the section above is a <em>local</em> ZooKeeper cluster used to manage a single Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> [...]
+<h3 id="configuration-store">Deploying the configuration store</h3>
-<p>If you’re deploying a <a href="#single-cluster-pulsar-instance">single-cluster</a> instance, then you will not need a separate cluster for global ZooKeeper. If, however, you’re deploying a <a href="#multi-cluster-pulsar-instance">multi-cluster</a> instance, then you should stand up a separate ZooKeeper cluster for instance-level tasks.</p>
+<p>The ZooKeeper cluster configured and started up in the section above is a <em>local</em> ZooKeeper cluster used to manage a single Pulsar <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> [...]
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-
-<div class="admonition">
- <div class="">
-
-
- </div>
-</div>
+<p>If you’re deploying a <a href="#single-cluster-pulsar-instance">single-cluster</a> instance, then you will not need a separate cluster for the configuration store. If, however, you’re deploying a <a href="#multi-cluster-pulsar-instance">multi-cluster</a> instance, then you should stand up a separate ZooKeeper cluster for configuration tasks.</p>
<h4 id="single-cluster-pulsar-instance">Single-cluster Pulsar instance</h4>
-<p>If your Pulsar <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> will consist of just one cluster, then you can deploy <span class="popover-term" tabindex="0" title="What is global ZooKeeper?" data-placement="top" data-content="A ZooKeeper cluster that Pulsar uses for instance-wide, rather than cluster-sp [...]
+<p>If your Pulsar <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> will consist of just one cluster, then you can deploy a <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) i [...]
-<p>To deploy global ZooKeeper in a single-cluster instance, add the same ZooKeeper servers used by the local quorom to the configuration file in <a href="../../reference/Configuration#global-zookeeper"><code class="highlighter-rouge">conf/global_zookeeper.conf</code></a> using the same method for <a href="#local-zookeeper">local ZooKeeper</a>, but make sure to use a different port (2181 is the default for ZooKeeper). Here’s an example that uses port 2184 for a three-node ZooKeeper cluster:</p>
+<p>To deploy a ZooKeeper configuration store in a single-cluster instance, add the same ZooKeeper servers used by the local quorom to the configuration file in <a href="../../reference/Configuration#configuration-store"><code class="highlighter-rouge">conf/global_zookeeper.conf</code></a> using the same method for <a href="#local-zookeeper">local ZooKeeper</a>, but make sure to use a different port (2181 is the default for ZooKeeper). Here’s an example that uses port 2184 for a three-nod [...]
<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="py">clientPort</span><span class="p">=</span><span class="s">2184</span>
<span class="py">server.1</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2185:2186</span>
@@ -2149,14 +2169,14 @@ of these regions is unreachable.</p>
<h2 id="cluster-metadata-initialization">Cluster metadata initialization</h2>
-<p>Once you’ve set up local and global ZooKeeper for your instance, there is some metadata that needs to be written to ZooKeeper for each cluster in your instance. It only needs to be written once.</p>
+<p>Once you’ve set up the cluster-specific ZooKeeper and <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) is a ZooKeeper quorum that is used for configuration-specific tasks. A multi-cluster Pulsar installation requires just one configuration store across all clusters." data-toggle="popover" data-trigger="focus">configuration store</span> quorums for your [...]
<p>You can initialize this metadata using the <a href="../../reference/CliTools#pulsar-initialize-cluster-metadata"><code class="highlighter-rouge">initialize-cluster-metadata</code></a> command of the <a href="../../reference/CliTools#pulsar"><code class="highlighter-rouge">pulsar</code></a> CLI tool. Here’s an example:</p>
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar initialize-cluster-metadata <span class="se">\</span>
<span class="nt">--cluster</span> us-west <span class="se">\</span>
<span class="nt">--zookeeper</span> zk1.us-west.example.com:2181 <span class="se">\</span>
- <span class="nt">--global-zookeeper</span> zk1.us-west.example.com:2184 <span class="se">\</span>
+ <span class="nt">--configuration-store</span> zk1.us-west.example.com:2184 <span class="se">\</span>
<span class="nt">--web-service-url</span> http://pulsar.us-west.example.com:8080/ <span class="se">\</span>
<span class="nt">--web-service-url-tls</span> https://pulsar.us-west.example.com:8443/ <span class="se">\</span>
<span class="nt">--broker-service-url</span> pulsar://pulsar.us-west.example.com:6650/ <span class="se">\</span>
@@ -2168,41 +2188,11 @@ of these regions is unreachable.</p>
<ul>
<li>The name of the cluster</li>
<li>The local ZooKeeper connection string for the cluster</li>
- <li>The global ZooKeeper connection string for the entire instance</li>
+ <li>The <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) is a ZooKeeper quorum that is used for configuration-specific tasks. A multi-cluster Pulsar installation requires just one configuration store across all clusters." data-toggle="popover" data-trigger="focus">configuration store</span> connection string for the entire instance</li>
<li>The web service URL for the cluster</li>
<li>A broker service URL enabling interaction with the <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span> in the cluster</li>
</ul>
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-<div class="admonition">
- <div class="info">
- <span class="admonition-title"><p>Global cluster</p>
-</span>
-
-<p>In each Pulsar instance, there is a <code class="highlighter-rouge">global</code> cluster that you can administer just like other clusters. The <code class="highlighter-rouge">global</code> cluster enables you to do things like create global topics.</p>
-
- </div>
-</div>
-
<p>If you’re using <a href="../../admin/Authz#tls-client-auth">TLS</a>, you’ll also need to specify a TLS web service URL for the cluster as well as a TLS broker service URL for the brokers in the cluster.</p>
<p>Make sure to run <code class="highlighter-rouge">initialize-cluster-metadata</code> for each cluster in your instance.</p>
@@ -2279,7 +2269,7 @@ designed to use multiple devices:</p>
<p>Brokers can be configured using the <a href="../../reference/Configuration#broker"><code class="highlighter-rouge">conf/broker.conf</code></a> configuration file.</p>
-<p>The most important element of broker configuration is ensuring that each broker is aware of its local ZooKeeper quorum as well as the global ZooKeeper quorum. Make sure that you set the <a href="../../reference/Configuration#broker-zookeeperServers"><code class="highlighter-rouge">zookeeperServers</code></a> parameter to reflect the local quorum and the <a href="../../reference/Configuration#broker-globalZookeeperServers"><code class="highlighter-rouge">globalZookeeperServers</code></ [...]
+<p>The most important element of broker configuration is ensuring that each broker is aware of its local ZooKeeper quorum as well as the global ZooKeeper quorum. Make sure that you set the <a href="../../reference/Configuration#broker-zookeeperServers"><code class="highlighter-rouge">zookeeperServers</code></a> parameter to reflect the local quorum and the <a href="../../reference/Configuration#broker-configurationStoreServers"><code class="highlighter-rouge">configurationStoreServers</c [...]
<p>You also need to specify the name of the <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> to which the broker belongs using the <a href="../../reference/Configuration#broker-clusterName" [...]
@@ -2288,8 +2278,8 @@ designed to use multiple devices:</p>
<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Local ZooKeeper servers
</span><span class="py">zookeeperServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181</span>
-<span class="c"># Global Zookeeper quorum connection string.
-</span><span class="py">globalZookeeperServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2184,zk2.us-west.example.com:2184,zk3.us-west.example.com:2184</span>
+<span class="c"># Configuration store quorum connection string.
+</span><span class="py">configurationStoreServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2184,zk2.us-west.example.com:2184,zk3.us-west.example.com:2184</span>
<span class="py">clusterName</span><span class="p">=</span><span class="s">us-west</span>
</code></pre></div></div>
@@ -2369,15 +2359,15 @@ designed to use multiple devices:</p>
<h3 id="service-discovery-setup">Service discovery setup</h3>
-<p>The service discovery mechanism included with Pulsar maintains a list of active brokers, stored in <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span>, and s [...]
+<p>The service discovery mechanism included with Pulsar maintains a list of active brokers, stored in <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper< [...]
-<p>To get started setting up Pulsar’s built-in service discovery, you need to change a few parameters in the <a href="../../reference/Configuration#service-discovery"><code class="highlighter-rouge">conf/discovery.conf</code></a> configuration file. Set the <a href="../../reference/Configuration#service-discovery-zookeeperServers"><code class="highlighter-rouge">zookeeperServers</code></a> parameter to the global ZooKeeper quorum connection string and the <a href="../../reference/Configu [...]
+<p>To get started setting up Pulsar’s built-in service discovery, you need to change a few parameters in the <a href="../../reference/Configuration#service-discovery"><code class="highlighter-rouge">conf/discovery.conf</code></a> configuration file. Set the <a href="../../reference/Configuration#service-discovery-zookeeperServers"><code class="highlighter-rouge">zookeeperServers</code></a> parameter to the cluster’s ZooKeeper quorum connection string and the <a href="../../reference/Conf [...]
<div class="language-properties highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Zookeeper quorum connection string
</span><span class="py">zookeeperServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2181,zk2.us-west.example.com:2181,zk3.us-west.example.com:2181</span>
-<span class="c"># Global zookeeper quorum connection string
-</span><span class="py">globalZookeeperServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2184,zk2.us-west.example.com:2184,zk3.us-west.example.com:2184</span>
+<span class="c"># Global configuration store connection string
+</span><span class="py">configurationStoreServers</span><span class="p">=</span><span class="s">zk1.us-west.example.com:2184,zk2.us-west.example.com:2184,zk3.us-west.example.com:2184</span>
</code></pre></div></div>
<p>To start the discovery service:</p>
@@ -2396,24 +2386,22 @@ designed to use multiple devices:</p>
<h2 id="provisioning-new-tenants">Provisioning new tenants</h2>
-<p>Pulsar was built as a fundamentally <span class="popover-term" tabindex="0" title="What is multi-tenancy?" data-placement="top" data-content="The ability to isolate namespaces, specify quotas, and configure authentication and authorization on a per-property basis." data-toggle="popover" data-trigger="focus">multi-tenant</span> system. New tenants can be provisioned as Pulsar <span class="popover-term" tabindex="0" title="What is a property?" data-placement="top" data-content="A Pulsar [...]
+<p>Pulsar was built as a fundamentally <span class="popover-term" tabindex="0" title="What is multi-tenancy?" data-placement="top" data-content="The ability to isolate namespaces, specify quotas, and configure authentication and authorization on a per-property basis." data-toggle="popover" data-trigger="focus">multi-tenant</span> system.</p>
-<p>To allow a new tenant to use the system, we need to create a new <span class="popover-term" tabindex="0" title="What is a property?" data-placement="top" data-content="A Pulsar tenant." data-toggle="popover" data-trigger="focus">property</span>. You can create a new property using the <a href="../../reference/CliTools#pulsar-admin-properties-create"><code class="highlighter-rouge">pulsar-admin</code></a> CLI tool:</p>
+<p>To allow a new <span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-content="An administrative unit for allocating capacity and enforcing an authentication/authorization scheme. Tenants in Pulsar are managed at the property level." data-toggle="popover" data-trigger="focus">tenant</span> to use the system, we need to create a new one. You can create a new tenant using the <a href="../../reference/CliTools#pulsar-admin-tenants-create"><code class= [...]
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-admin properties create test-prop <span class="se">\</span>
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-admin tenants create test-tentant <span class="se">\</span>
<span class="nt">--allowed-clusters</span> us-west <span class="se">\</span>
<span class="nt">--admin-roles</span> test-admin-role
</code></pre></div></div>
-<p>This will allow users who identify with role <code class="highlighter-rouge">test-admin-role</code> to administer the configuration for the property <code class="highlighter-rouge">test</code> which will only be allowed to use the cluster <code class="highlighter-rouge">us-west</code>. From now on, this tenant will be able to self-manage its resources.</p>
+<p>This will allow users who identify with role <code class="highlighter-rouge">test-admin-role</code> to administer the configuration for the tenant <code class="highlighter-rouge">test</code> which will only be allowed to use the cluster <code class="highlighter-rouge">us-west</code>. From now on, this tenant will be able to self-manage its resources.</p>
-<p>Once a tenant has been created, you will need to create <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespaces</span> for topics within that property.</p>
+<p>Once a tenant has been created, you will need to create <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespaces</span> for topics within that tenant.</p>
-<p>The first step is to create a namespace. A namespace is an administrative unit
-that can contain many topic. Common practice is to create a namespace for each
-different use case from a single tenant.</p>
+<p>The first step is to create a namespace. A namespace is an administrative unit that can contain many topics. A common practice is to create a namespace for each different use case from a single tenant.</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-admin namespaces create test-prop/us-west/ns1
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-admin namespaces create test-tenant/ns1
</code></pre></div></div>
<h5 id="testing-producer-and-consumer">Testing producer and consumer</h5>
@@ -2447,24 +2435,24 @@ created the first time a producer or a consumer tries to use them.</p>
-->
<section class="topic">
- persistent://<span class="property">test-prop</span>/<span class="cluster">us-west</span>/<span class="namespace">ns1</span>/<span class="t">my-topic</span>
+ persistent://<span class="property">test-tenant</span>/<span class="namespace">ns1</span>/<span class="t">my-topic</span>
</section>
<p>Start a consumer that will create a subscription on the topic and will wait
for messages:</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-perf consume persistent://test-prop/us-west/ns1/my-topic
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-perf consume persistent://test-tenant/us-west/ns1/my-topic
</code></pre></div></div>
<p>Start a producer that publishes messages at a fixed rate and report stats every
10 seconds:</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-perf produce persistent://test-prop/us-west/ns1/my-topic
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-perf produce persistent://test-tenant/us-west/ns1/my-topic
</code></pre></div></div>
<p>To report the topic stats:</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-admin persistent stats persistent://test-prop/us-west/ns1/my-topic
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-admin persistent stats persistent://test-tenant/us-west/ns1/my-topic
</code></pre></div></div>
</section>
diff --git a/content/docs/latest/functions/api/index.html b/content/docs/latest/functions/api/index.html
index 2f3259a..978fc85 100644
--- a/content/docs/latest/functions/api/index.html
+++ b/content/docs/latest/functions/api/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/functions/deployment/index.html b/content/docs/latest/functions/deployment/index.html
index 671f351..a3f472b 100644
--- a/content/docs/latest/functions/deployment/index.html
+++ b/content/docs/latest/functions/deployment/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/functions/guarantees/index.html b/content/docs/latest/functions/guarantees/index.html
index 6c64046..cbe0d61 100644
--- a/content/docs/latest/functions/guarantees/index.html
+++ b/content/docs/latest/functions/guarantees/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/functions/metrics/index.html b/content/docs/latest/functions/metrics/index.html
index fbd5ae0..2f71cf2 100644
--- a/content/docs/latest/functions/metrics/index.html
+++ b/content/docs/latest/functions/metrics/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/functions/overview/index.html b/content/docs/latest/functions/overview/index.html
index 3380ecc..0a1faf4 100644
--- a/content/docs/latest/functions/overview/index.html
+++ b/content/docs/latest/functions/overview/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/functions/quickstart/index.html b/content/docs/latest/functions/quickstart/index.html
index 71aa19e..59cfc8c 100644
--- a/content/docs/latest/functions/quickstart/index.html
+++ b/content/docs/latest/functions/quickstart/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/getting-started/Clients/index.html b/content/docs/latest/getting-started/Clients/index.html
index 307df33..868005d 100644
--- a/content/docs/latest/getting-started/Clients/index.html
+++ b/content/docs/latest/getting-started/Clients/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -869,17 +885,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
diff --git a/content/docs/latest/getting-started/ConceptsAndArchitecture/index.html b/content/docs/latest/getting-started/ConceptsAndArchitecture/index.html
index 6743477..61015a8 100644
--- a/content/docs/latest/getting-started/ConceptsAndArchitecture/index.html
+++ b/content/docs/latest/getting-started/ConceptsAndArchitecture/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -881,6 +897,8 @@
+
+
<li><a href="/docs/latest/getting-started/ConceptsAndArchitecture/">Pulsar concepts and architecture</a></li>
@@ -1032,6 +1050,10 @@
+
+
+
+
</ul>
</div>
</div>
@@ -1095,6 +1117,8 @@
+
+
<li><a href="/docs/latest/getting-started/ConceptsAndArchitecture/">Pulsar concepts and architecture</a></li>
@@ -1215,6 +1239,8 @@
+
+
<li><a href="/docs/latest/cookbooks/message-deduplication/">Message deduplication</a></li>
@@ -1248,6 +1274,8 @@
+
+
</ul>
</div>
</div>
@@ -1299,17 +1327,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1460,7 +1488,7 @@
<h3 id="topics">Topics</h3>
-<p>As in other pub-sub systems, topics in Pulsar are named channels for transmitting messages from producers to consumers. Topic names are URLs that have a well-defined structure:</p>
+<p>As in other pub-sub systems, topics in Pulsar are named channels for transmitting messages from <span class="popover-term" tabindex="0" title="What is a producer?" data-placement="top" data-content="A process that publishes messages to a Pulsar topic." data-toggle="popover" data-trigger="focus">producers</span> to <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and proces [...]
<!--
@@ -1483,7 +1511,7 @@
-->
<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ {persistent|non-persistent}://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<table>
@@ -1495,20 +1523,16 @@
</thead>
<tbody>
<tr>
- <td style="text-align: left"><code class="highlighter-rouge">persistent</code></td>
- <td style="text-align: left">It identifies type of topic. Pulsar supports two kind of topics: persistent and non-persistent. In persistent topic, all messages are durably <a href="#persistent-storage">persisted</a> on disk (that means on multiple disks unless the <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for adm [...]
+ <td style="text-align: left"><code class="highlighter-rouge">persistent</code> / <code class="highlighter-rouge">non-persistent</code></td>
+ <td style="text-align: left">This identifies the type of topic. Pulsar supports two kind of topics: <a href="#persistent-storage">persistent</a> and <a href="#non-persistent-topics">non-persistent</a> (persistent is the default, so if you don’t specify a type the topic will be persistent). With persistent topics, all messages are durably <a href="#persistent-storage">persisted</a> on disk (that means on multiple disks unless the <span class="popover-term" tabindex="0" title="What i [...]
</tr>
<tr>
- <td style="text-align: left"><code class="highlighter-rouge">property</code></td>
+ <td style="text-align: left"><code class="highlighter-rouge">tenant</code></td>
<td style="text-align: left">The topic’s <span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-content="An administrative unit for allocating capacity and enforcing an authentication/authorization scheme. Tenants in Pulsar are managed at the property level." data-toggle="popover" data-trigger="focus">tenant</span> within the instance. Tenants are essential to <span class="popover-term" tabindex="0" title="What is multi-tenancy?" data-placement= [...]
</tr>
<tr>
- <td style="text-align: left"><code class="highlighter-rouge">cluster</code></td>
- <td style="text-align: left">Where the topic is located. Typically there will be one <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span> for each geographical region or data center.</td>
- </tr>
- <tr>
<td style="text-align: left"><code class="highlighter-rouge">namespace</code></td>
- <td style="text-align: left">The administrative unit of the topic, which acts as a grouping mechanism for related topics. Most topic configuration is performed at the <a href="#namespace">namespace</a> level. Each property (tenant) can have multiple namespaces.</td>
+ <td style="text-align: left">The administrative unit of the topic, which acts as a grouping mechanism for related topics. Most topic configuration is performed at the <a href="#namespace">namespace</a> level. Each tenant can have multiple namespaces.</td>
</tr>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">topic</code></td>
@@ -1546,17 +1570,35 @@
</div>
</div>
-<h3 id="namespace">Namespace</h3>
+<h3 id="namespaces">Namespaces</h3>
-<p>A namespace is a logical nomenclature within a property. A property can create multiple namespaces via <a href="../../admin-api/namespaces#create">admin API</a>. For instance, a property with different applications can create a separate namespace for each application. A namespace allows the application to create and manage a hierarchy of topics.
-For e.g. <code class="highlighter-rouge">my-property/my-cluster/my-property-app1</code> is a namespace for the application <code class="highlighter-rouge">my-property-app1</code> in cluster <code class="highlighter-rouge">my-cluster</code> for <code class="highlighter-rouge">my-property</code>.
-Application can create any number of <a href="#topics">topics</a> under the namespace.</p>
+<p>A namespace is a logical nomenclature within a tenant. A tenant can create multiple namespaces via the <a href="../../admin-api/namespaces#create">admin API</a>. For instance, a tenant with different applications can create a separate namespace for each application. A namespace allows the application to create and manage a hierarchy of topics. The topic <code class="highlighter-rouge">my-tenant/app1</code> is a namespace for the application <code class="highlighter-rouge">app1</code> [...]
<h3 id="subscription-modes">Subscription modes</h3>
<p>A subscription is a named configuration rule that determines how messages are delivered to <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and processes messages published to that topic by producers." data-toggle="popover" data-trigger="focus">consumers</span>. There are three available subscription modes in Pulsar: <a href="#exclusive">exclusive</a>, <a href="#shared">sh [...]
-<p><img src="/img/pulsar_subscriptions.jpg" alt="Subscription Modes" /></p>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/pulsar-subscription-modes.png" width="80%" alt="Subscription modes" /></p>
<h4 id="exclusive">Exclusive</h4>
@@ -1564,7 +1606,55 @@ Application can create any number of <a href="#topics">topics</a> under the name
<p>In the diagram above, only <strong>Consumer-A</strong> is allowed to consume messages.</p>
-<p>Exclusive mode is the default subscription mode.</p>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<div class="admonition">
+ <div class="info">
+
+ <p>Exclusive mode is the default subscription mode.</p>
+
+ </div>
+</div>
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/exclusive-subscriptions.png" width="80%" alt="Exclusive subscriptions" /></p>
<h4 id="shared">Shared</h4>
@@ -1607,6 +1697,28 @@ Application can create any number of <a href="#topics">topics</a> under the name
</div>
</div>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/shared-subscriptions.png" width="80%" alt="Shared subscriptions" /></p>
+
<h4 id="failover">Failover</h4>
<p>In <em>failover</em> mode, multiple consumers can attach to the same subscription. The consumers will be lexically sorted by the consumer’s name and the first consumer will initially be the only one receiving messages. This consumer is called the <em>master consumer</em>.</p>
@@ -1615,6 +1727,28 @@ Application can create any number of <a href="#topics">topics</a> under the name
<p>In the diagram above, Consumer-C-1 is the master consumer while Consumer-C-2 would be the next in line to receive messages if Consumer-C-2 disconnected.</p>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/failover-subscriptions.png" width="80%" alt="Shared subscriptions" /></p>
+
<h3 id="multi-topic-subscriptions">Multi-topic subscriptions</h3>
<p>When a <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and processes messages published to that topic by producers." data-toggle="popover" data-trigger="focus">consumer</span> subscribes to a Pulsar <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published by producers to consumers w [...]
@@ -1736,13 +1870,13 @@ Application can create any number of <a href="#topics">topics</a> under the name
<p>The diagram below illustrates this:</p>
-<p><img src="/img/pulsar_partitioned_topic.jpg" alt="Partitioned Topic" /></p>
+<p><img src="/img/partitioning.png" width="70%" /></p>
-<p>Here, the topic <strong>T1</strong> has five partitions (<strong>P0</strong> through <strong>P4</strong>) split across three brokers. Because there are more partitions than brokers, two brokers handle two partitions a piece, while the third handles only one (again, Pulsar handles this distribution of partitions automatically).</p>
+<p>Here, the topic <strong>Topic1</strong> has five partitions (<strong>P0</strong> through <strong>P4</strong>) split across three brokers. Because there are more partitions than brokers, two brokers handle two partitions a piece, while the third handles only one (again, Pulsar handles this distribution of partitions automatically).</p>
<p>Messages for this topic are broadcast to two <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and processes messages published to that topic by producers." data-toggle="popover" data-trigger="focus">consumers</span>. The <a href="#routing-modes">routing mode</a> determines both which broker handles each partition, while the <a href="../../getting-started/ConceptsAndArchite [...]
-<p>Decisions about routing and subscription modes can be made separately in most cases. Throughput concerns should guide partitioning/routing decisions while subscription decisions should be guided by application semantics.</p>
+<p>Decisions about routing and subscription modes can be made separately in most cases. In general, throughput concerns should guide partitioning/routing decisions while subscription decisions should be guided by application semantics.</p>
<p>There is no difference between partitioned topics and normal topics in terms of how subscription modes work, as partitioning only determines what happens between when a message is published by a <span class="popover-term" tabindex="0" title="What is a producer?" data-placement="top" data-content="A process that publishes messages to a Pulsar topic." data-toggle="popover" data-trigger="focus">producer</span> and processed and <span class="popover-term" tabindex="0" title="What is an ac [...]
@@ -1833,7 +1967,7 @@ Application can create any number of <a href="#topics">topics</a> under the name
-->
<section class="topic">
- non-persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ non-persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
<!--
@@ -1937,16 +2071,36 @@ enableNonPersistentTopics=true
<p>In a Pulsar cluster:</p>
<ul>
- <li>One or more <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span> handles and load balances incoming messages from <span cl [...]
+ <li>One or more <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span> handles and load balances incoming messages from <span cl [...]
<li>A <span class="popover-term" tabindex="0" title="What is BookKeeper?" data-placement="top" data-content="Apache BookKeeper is a persistent log storage system that Pulsar uses to store message data." data-toggle="popover" data-trigger="focus">BookKeeper</span> cluster consisting of one more or more <span class="popover-term" tabindex="0" title="What is a bookie?" data-placement="top" data-content="Bookie is just a nickname for an individual BookKeeper server." data-toggle="popover" [...]
- <li>A <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster specific to that cluster handles</li>
+ <li>A <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> cluster specific to that cluster handles</li>
</ul>
<p>The diagram below provides an illustration of a Pulsar cluster:</p>
-<p><img src="/img/pulsar_system_architecture.png" alt="Architecture Diagram" /></p>
+<!--
-<p>At the broader <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> level, an instance-wide ZooKeeper cluster called <span class="popover-term" tabindex="0" title="What is global ZooKeeper?" data-placement="top" data-content="A ZooKeeper cluster that Pulsar uses for instance-wide, rather than cluster-specifi [...]
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/pulsar-system-architecture.png" width="90%" alt="Pulsar architecture diagram" /></p>
+
+<p>At the broader <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span> level, an instance-wide ZooKeeper cluster called the <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) is a [...]
<h2 id="brokers">Brokers</h2>
@@ -1995,7 +2149,7 @@ enableNonPersistentTopics=true
<ul>
<li>One or more Pulsar <a href="#broker">brokers</a></li>
- <li>A <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> quorum used for cluster-level configuration and coordination</li>
+ <li>A <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> quorum used for cluster-level configuration and coordination</li>
<li>An ensemble of <span class="popover-term" tabindex="0" title="What is a bookie?" data-placement="top" data-content="Bookie is just a nickname for an individual BookKeeper server." data-toggle="popover" data-trigger="focus">bookies</span> used for <a href="#persistent-storage">persistent storage</a> of messages</li>
</ul>
@@ -2029,47 +2183,15 @@ enableNonPersistentTopics=true
</div>
</div>
-<h3 id="global-cluster">Global cluster</h3>
-
-<p>In any Pulsar <span class="popover-term" tabindex="0" title="What is a Pulsar instance?" data-placement="top" data-content="A group of Pulsar clusters that act together as a single unit." data-toggle="popover" data-trigger="focus">instance</span>, there is an instance-wide cluster called <code class="highlighter-rouge">global</code> that you can use to mange non-cluster-specific namespaces and topics. The <code class="highlighter-rouge">global</code> cluster is created for you automat [...]
-
-<p>Global topic names have this basic structure (note the <code class="highlighter-rouge">global</code> cluster):</p>
-
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-<section class="topic">
- persistent://<span class="property">my-property</span>/<span class="cluster">global</span>/<span class="namespace">my-namespace</span>/<span class="t">my-topic</span>
-</section>
-
<h2 id="metadata-store">Metadata store</h2>
<p>Pulsar uses <a href="https://zookeeper.apache.org/">Apache Zookeeper</a> for metadata storage, cluster configuration, and coordination. In a Pulsar instance:</p>
<ul>
- <li>A <span class="popover-term" tabindex="0" title="What is global ZooKeeper?" data-placement="top" data-content="A ZooKeeper cluster that Pulsar uses for instance-wide, rather than cluster-specific, tasks." data-toggle="popover" data-trigger="focus">global ZooKeeper</span> quorum stores configuration for <span class="popover-term" tabindex="0" title="What is a property?" data-placement="top" data-content="A Pulsar tenant." data-toggle="popover" data-trigger="focus">properties</span>, [...]
+ <li>A <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) is a ZooKeeper quorum that is used for configuration-specific tasks. A multi-cluster Pulsar installation requires just one configuration store across all clusters." data-toggle="popover" data-trigger="focus">configuration store</span> quorum stores configuration for <span class="popover-term" tabind [...]
<li>Each cluster has its own local ZooKeeper ensemble that stores <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span>-specific configuration and coordination such as ownership metadata, brok [...]
</ul>
-<p>When creating a <a href="../../admin/ClustersBrokers#initialize-cluster-metadata">new cluster</a></p>
-
<h2 id="persistent-storage">Persistent storage</h2>
<p>Pulsar provides guaranteed message delivery for applications. If a message successfully reaches a Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" dat [...]
@@ -2114,7 +2236,7 @@ enableNonPersistentTopics=true
-->
<section class="topic">
- persistent://<span class="property">my-property</span>/<span class="cluster">global</span>/<span class="namespace">my-namespace</span>/<span class="t">my-topic</span>
+ persistent://<span class="property">my-property</span>/<span class="namespace">my-namespace</span>/<span class="t">my-topic</span>
</section>
<!--
@@ -2147,7 +2269,27 @@ enableNonPersistentTopics=true
<p>You can see an illustration of how <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">brokers</span> and <span class="popover-term" tabind [...]
-<p><img src="/img/broker-bookie.png" alt="Brokers and bookies" /></p>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/broker-bookie.png" width="80%" alt="Brokers and bookies" /></p>
<h3 id="ledgers">Ledgers</h3>
@@ -2228,7 +2370,27 @@ enableNonPersistentTopics=true
<p>The diagram below illustrates both concepts:</p>
-<p><img src="/img/retention-expiry.png" width="80%" /></p>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/retention-expiry.png" width="80%" alt="Message retention and expiry" /></p>
<p>With message retention, shown at the top, a <span style="color: #89b557;">retention policy</span> applied to all topics in a <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespace</span> dicates that some messages are durably stored in Pulsar even though they’ve already been acknowledged. Acknowledged messages that are not covered by the reten [...]
@@ -2248,7 +2410,27 @@ enableNonPersistentTopics=true
<p>The following diagram illustrates what happens when message deduplication is disabled vs. enabled:</p>
-<p><img src="/img/message-deduplication.png" width="75%" /></p>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/message-deduplication.png" width="75%" alt="Pulsar message deduplication" /></p>
<p>Message deduplication is disabled in the scenario shown at the top. Here, a producer publishes message 1 on a topic; the message reaches a Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of mul [...]
@@ -2321,7 +2503,7 @@ enableNonPersistentTopics=true
<h2 id="multi-tenancy">Multi-tenancy</h2>
-<p>Pulsar was created from the ground up as a <span class="popover-term" tabindex="0" title="What is multi-tenancy?" data-placement="top" data-content="The ability to isolate namespaces, specify quotas, and configure authentication and authorization on a per-property basis." data-toggle="popover" data-trigger="focus">multi-tenant</span> system. To support multi-tenancy, Pulsar has a concept of <span class="popover-term" tabindex="0" title="What is a property?" data-placement="top" data-c [...]
+<p>Pulsar was created from the ground up as a <span class="popover-term" tabindex="0" title="What is multi-tenancy?" data-placement="top" data-content="The ability to isolate namespaces, specify quotas, and configure authentication and authorization on a per-property basis." data-toggle="popover" data-trigger="focus">multi-tenant</span> system. To support multi-tenancy, Pulsar has a concept of <span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-con [...]
<p>The multi-tenant nature of Pulsar is reflected mostly visibly in topic URLs, which have this structure:</p>
@@ -2346,12 +2528,12 @@ enableNonPersistentTopics=true
-->
<section class="topic">
- persistent://<span class="property">property</span>/<span class="cluster">cluster</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
+ persistent://<span class="property">tenant</span>/<span class="namespace">namespace</span>/<span class="t">topic</span>
</section>
-<p>As you can see, the property is the most basic unit of categorization for topics (and even more fundamental than the <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">cluster</span>).</p>
+<p>As you can see, the tenant is the most basic unit of categorization for topics (more fundamental than the <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespace</span> and topic name).</p>
-<h3 id="properties-and-namespaces">Properties and namespaces</h3>
+<h3 id="tenants-and-namespaces">Tenants and namespaces</h3>
<!--
@@ -2374,24 +2556,24 @@ enableNonPersistentTopics=true
-->
-<p>Pulsar was designed from the ground up to be a <span class="popover-term" tabindex="0" title="What is multi-tenancy?" data-placement="top" data-content="The ability to isolate namespaces, specify quotas, and configure authentication and authorization on a per-property basis." data-toggle="popover" data-trigger="focus">multi-tenant</span> system. In Pulsar, <span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-content="An administrative unit for al [...]
+<p>Pulsar was designed from the ground up to be a <span class="popover-term" tabindex="0" title="What is multi-tenancy?" data-placement="top" data-content="The ability to isolate namespaces, specify quotas, and configure authentication and authorization on a per-property basis." data-toggle="popover" data-trigger="focus">multi-tenant</span> system. In Pulsar, <span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-content="An administrative unit for al [...]
-<h3 id="properties">Properties</h3>
+<h3 id="tenants">Tenants</h3>
<p>To each property in a Pulsar instance you can assign:</p>
<ul>
<li>An <a href="../../admin/Authz#authorization">authorization</a> scheme</li>
- <li>The set of <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">clusters</span> to which the property applies</li>
+ <li>The set of <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper servers (aka bookies). Clusters can reside in different geographical regions and replicate messages to one another in a process called geo-replication." data-toggle="popover" data-trigger="focus">clusters</span> to which the tenant’s configuration applies</li>
</ul>
-<h3 id="namespaces">Namespaces</h3>
+<h3 id="namespaces-1">Namespaces</h3>
-<p><span class="popover-term" tabindex="0" title="What is a property?" data-placement="top" data-content="A Pulsar tenant." data-toggle="popover" data-trigger="focus">Properties</span> and <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespaces</span> are two key concepts of Pulsar to support <span class="popover-term" tabindex="0" title="What is [...]
+<p><span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-content="An administrative unit for allocating capacity and enforcing an authentication/authorization scheme. Tenants in Pulsar are managed at the property level." data-toggle="popover" data-trigger="focus">Tenants</span> and <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" dat [...]
<ul>
- <li>A <strong>property</strong> identifies a <span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-content="An administrative unit for allocating capacity and enforcing an authentication/authorization scheme. Tenants in Pulsar are managed at the property level." data-toggle="popover" data-trigger="focus">tenant</span>. Pulsar is provisioned for a specified property with appropriate capacity allocated to the property.</li>
- <li>A <strong>namespace</strong> is the administrative unit nomenclature within a property. The configuration policies set on a namespace apply to all the topics created in such namespace. A property may create multiple namespaces via self-administration using REST API and CLI tools. For instance, a property with different applications can create a separate namespace for each application.</li>
+ <li>Pulsar is provisioned for specified <span class="popover-term" tabindex="0" title="What is a tenant?" data-placement="top" data-content="An administrative unit for allocating capacity and enforcing an authentication/authorization scheme. Tenants in Pulsar are managed at the property level." data-toggle="popover" data-trigger="focus">tenants</span> with appropriate capacity allocated to the tenant.</li>
+ <li>A <span class="popover-term" tabindex="0" title="What is a namespace?" data-placement="top" data-content="A grouping mechanism for related topics." data-toggle="popover" data-trigger="focus">namespace</span> is the administrative unit nomenclature within a tenant. The configuration policies set on a namespace apply to all the topics created in that namespace. A tenant may create multiple namespaces via self-administration using the REST API and the <a href="../../reference/CliTools [...]
</ul>
<p>Names for topics in the same namespace will look like this:</p>
@@ -2417,7 +2599,7 @@ enableNonPersistentTopics=true
-->
<section class="topic">
- persistent://<span class="property">my-property</span>/<span class="cluster">us-w</span>/<span class="namespace">my-app1</span>/<span class="t">my-topic-1</span>
+ persistent://<span class="property">my-tenant</span>/<span class="namespace">my-app1</span>/<span class="t">my-topic-1</span>
</section>
<!--
@@ -2441,7 +2623,7 @@ enableNonPersistentTopics=true
-->
<section class="topic">
- persistent://<span class="property">my-property</span>/<span class="cluster">us-w</span>/<span class="namespace">my-app1</span>/<span class="t">my-topic-2</span>
+ persistent://<span class="property">my-tenant</span>/<span class="namespace">my-app1</span>/<span class="t">my-topic-2</span>
</section>
<!--
@@ -2465,12 +2647,12 @@ enableNonPersistentTopics=true
-->
<section class="topic">
- persistent://<span class="property">my-property</span>/<span class="cluster">us-w</span>/<span class="namespace">my-app1</span>/<span class="t">my-topic-3</span>
+ persistent://<span class="property">my-tenant</span>/<span class="namespace">my-app1</span>/<span class="t">my-topic-3</span>
</section>
<h2 id="authentication-and-authorization">Authentication and Authorization</h2>
-<p>Pulsar supports a pluggable <a href="../../admin/Authz">authentication</a> mechanism which can be configured at broker and it also supports authorization to identify client and its access rights on topics and properties.</p>
+<p>Pulsar supports a pluggable <a href="../../admin/Authz">authentication</a> mechanism which can be configured at broker and it also supports authorization to identify client and its access rights on topics and tenants.</p>
<h2 id="client-interface">Client interface</h2>
@@ -2553,11 +2735,11 @@ enableNonPersistentTopics=true
</div>
</div>
-<p>Architecturally, the Pulsar proxy gets all the information it requires from ZooKeeper. When starting the proxy on a machine, you only need to provide ZooKeeper connection strings for the cluster-specific and <span class="popover-term" tabindex="0" title="What is global ZooKeeper?" data-placement="top" data-content="A ZooKeeper cluster that Pulsar uses for instance-wide, rather than cluster-specific, tasks." data-toggle="popover" data-trigger="focus">global ZooKeeper</span> clusters. H [...]
+<p>Architecturally, the Pulsar proxy gets all the information it requires from ZooKeeper. When starting the proxy on a machine, you only need to provide ZooKeeper connection strings for the cluster-specific and instance-wide <span class="popover-term" tabindex="0" title="What is the configuration store?" data-placement="top" data-content="Pulsar's configuration store (previously known as global ZooKeeper) is a ZooKeeper quorum that is used for configuration-specific tasks. A multi-cluste [...]
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar proxy <span class="se">\</span>
<span class="nt">--zookeeper-servers</span> zk-0,zk-1,zk-2 <span class="se">\</span>
- <span class="nt">--global-zookeeper-servers</span> zk-0,zk-1,zk-2
+ <span class="nt">--configuration-store-servers</span> zk-0,zk-1,zk-2
</code></pre></div></div>
<!--
@@ -2603,6 +2785,37 @@ enableNonPersistentTopics=true
<p>You can use your own service discovery system if you’d like. If you use your own system, there is just one requirement: when a client performs an HTTP request to an endpoint, such as <code class="highlighter-rouge">http://pulsar.us-west.example.com:8080</code>, the client needs to be redirected to <em>some</em> active broker in the desired <span class="popover-term" tabindex="0" title="What is a cluster?" data-placement="top" data-content="A set of Pulsar brokers and BookKeeper server [...]
+<p>The diagram below illustrates Pulsar service discovery:</p>
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/pulsar-service-discovery.png" width="50%" alt="" /></p>
+
+<p>In this diagram, the Pulsar cluster is addressable via a single DNS name: <code class="highlighter-rouge">pulsar-cluster.acme.com</code>. A <a href="../../clients/Python">Python client</a>, for example, could access this Pulsar cluster like this:</p>
+
+<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">from</span> <span class="nn">pulsar</span> <span class="kn">import</span> <span class="n">Client</span>
+
+<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s">'pulsar://pulsar-cluster.acme.com:6650'</span><span class="p">)</span>
+</code></pre></div></div>
+
<h2 id="reader-interface">Reader interface</h2>
<p>In Pulsar, the “standard” <a href="#consumers">consumer interface</a> involves using <span class="popover-term" tabindex="0" title="What is a consumer?" data-placement="top" data-content="A process that establishes a subscription to a Pulsar topic and processes messages published to that topic by producers." data-toggle="popover" data-trigger="focus">consumers</span> to listen on <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A name [...]
@@ -2617,7 +2830,27 @@ enableNonPersistentTopics=true
<p>The reader interface is helpful for use cases like using Pulsar to provide <a href="https://blog.streaml.io/exactly-once/">effectively-once</a> processing semantics for a stream processing system. For this use case, it’s essential that the stream processing system be able to “rewind” topics to a specific message and begin reading there. The reader interface provides Pulsar clients with the low-level abstraction necessary to “manually position” themselves within a topic.</p>
-<p><img src="/img/pulsar-reader-consumer-interfaces.png" alt="The Pulsar consumer and reader interfaces" width="80%" /></p>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+<p><img src="/img/pulsar-reader-consumer-interfaces.png" width="80%" alt="The Pulsar consumer and reader interfaces" /></p>
<!--
diff --git a/content/docs/latest/getting-started/LocalCluster/index.html b/content/docs/latest/getting-started/LocalCluster/index.html
index 8096b2f..2f950b6 100644
--- a/content/docs/latest/getting-started/LocalCluster/index.html
+++ b/content/docs/latest/getting-started/LocalCluster/index.html
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -915,6 +931,10 @@
+
+
+
+
<li><a href="/docs/latest/getting-started/LocalCluster/">Setting up a local standalone cluster</a></li>
@@ -1034,6 +1054,8 @@
+
+
</ul>
</div>
</div>
@@ -1131,6 +1153,10 @@
+
+
+
+
<li><a href="/docs/latest/getting-started/LocalCluster/">Setting up a local standalone cluster</a></li>
@@ -1250,6 +1276,8 @@
+
+
</ul>
</div>
</div>
@@ -1301,17 +1329,17 @@
-->
<div class="admonition">
- <div class="danger">
- <span class="admonition-title"><p>Version 2.0</p>
+ <div class="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
</span>
-<p>The documentation that you’re reading is for the upcoming 2.0 release of Apache Pulsar. If you’re looking for the documentation for version 1.22.0-incubating, click <a href="/docs/v1.22.0-incubating/getting-started/LocalCluster">here</a>.</p>
+<p>The documentation that you’re reading is for the 2.0 release of Apache Pulsar. For more information on Pulsar 2.0, see <a href="../../getting-started/Pulsar-2.0">this guide</a>.</p>
</div>
</div>
- <!-- <hr class="hr"> -->
+ <hr class="hr">
</section>
<section class="content">
@@ -1336,9 +1364,7 @@
-->
-<p>For the purposes of local development and testing, you can run Pulsar in <span class="popover-term" tabindex="0" title="What is a standalone Pulsar broker?" data-placement="top" data-content="A lightweight Pulsar broker in which all components run in a single Java Virtual Machine (JVM) process. Standalone clusters can be run on a single machine and are useful for development purposes." data-toggle="popover" data-trigger="focus">standalone</span> mode on your own machine.</p>
-
-<p>Standalone mode includes a Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-content="A stateless component of Pulsar clusters that runs two other components: an HTTP server exposing a REST interface for administration and topic lookup and a dispatcher that handles all message transers. Pulsar clusters typically consist of multiple brokers." data-toggle="popover" data-trigger="focus">broker</span> as well as the necessary <span class="p [...]
+<p>For the purposes of local development and testing, you can run Pulsar in <span class="popover-term" tabindex="0" title="What is a standalone Pulsar broker?" data-placement="top" data-content="A lightweight Pulsar broker in which all components run in a single Java Virtual Machine (JVM) process. Standalone clusters can be run on a single machine and are useful for development purposes." data-toggle="popover" data-trigger="focus">standalone</span> mode on your own machine. Standalone mo [...]
<!--
@@ -1444,6 +1470,10 @@
<td style="text-align: left">Configuration files for Pulsar, including for <a href="../../reference/Configuration#broker">broker configuration</a>, <a href="../../reference/Configuration#zookeeper">ZooKeeper configuration</a>, and more</td>
</tr>
<tr>
+ <td style="text-align: left"><code class="highlighter-rouge">examples</code></td>
+ <td style="text-align: left">A Java JAR file containing example <a href="../../functions/overview">Pulsar Functions</a></td>
+ </tr>
+ <tr>
<td style="text-align: left"><code class="highlighter-rouge">lib</code></td>
<td style="text-align: left">The <a href="https://en.wikipedia.org/wiki/JAR_(file_format)">JAR</a> files used by Pulsar</td>
</tr>
@@ -1466,7 +1496,11 @@
<tbody>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">data</code></td>
- <td style="text-align: left">The data storage directory used by <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a global ZooKeeper for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> and <span class="popover-term" tabinde [...]
+ <td style="text-align: left">The data storage directory used by <span class="popover-term" tabindex="0" title="What is ZooKeeper?" data-placement="top" data-content="ZooKeeper is a service that Pulsar uses for coordination-related tasks.<br /><br />A Pulsar instance relies on both a local ZooKeeper for cluster-specific tasks and a ZooKeeper configuration store for instance-wide tasks." data-toggle="popover" data-trigger="focus">ZooKeeper</span> and <span class="popover- [...]
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">instances</code></td>
+ <td style="text-align: left">Artifacts created for <a href="../../functions/overview">Pulsar Functions</a></td>
</tr>
<tr>
<td style="text-align: left"><code class="highlighter-rouge">logs</code></td>
@@ -1523,14 +1557,13 @@
<p>Pulsar provides a CLI tool called <a href="../../reference/CliTools#pulsar-client"><code class="highlighter-rouge">pulsar-client</code></a> that enables you to do things like send messages to a Pulsar <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topic</span> in a running cluster. This co [...]
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-client produce <span class="se">\</span>
- persistent://sample/standalone/ns1/my-topic <span class="se">\</span>
- <span class="nt">-m</span> <span class="s1">'hello-pulsar'</span>
+<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bin/pulsar-client produce my-topic <span class="se">\</span>
+ <span class="nt">--messages</span> <span class="s2">"hello-pulsar"</span>
</code></pre></div></div>
<p>If the message has been successfully published to the topic, you should see a confirmation like this in the <code class="highlighter-rouge">pulsar-client</code> logs:</p>
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>2017-06-01 18:18:57,094 - INFO - [main:CmdProduce@189] - 1 messages successfully produced
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>13:09:39.356 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 1 messages successfully produced
</code></pre></div></div>
<!--
@@ -1574,28 +1607,24 @@
<p>Here’s an example producer for a Pulsar <span class="popover-term" tabindex="0" title="What is a topic?" data-placement="top" data-content="A named channel used to pass messages published by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topic</span> using the <a href="../../clients/Java">Java</a> client:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">String</span> <span class="n">localClusterUrl</span> <span class="o">=</span> <span class="s">"pulsar://localhost:6650"</span><span class="o">;</span>
-<span class="n">String</span> <span class="n">namespace</span> <span class="o">=</span> <span class="s">"sample/standalone/ns1"</span><span class="o">;</span> <span class="c1">// This namespace is created automatically</span>
-<span class="n">String</span> <span class="n">topic</span> <span class="o">=</span> <span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"persistent://%s/my-topic"</span><span class="o">,</span> <span class="n">namespace</span><span class="o">);</span>
<span class="n">PulsarClient</span> <span class="n">client</span> <span class="o">=</span> <span class="n">PulsarClient</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">localClusterUrl</span><span class="o">);</span>
-<span class="n">Producer</span> <span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">createProducer</span><span class="o">(</span><span class="n">topic</span><span class="o">);</span>
+<span class="n">Producer</span> <span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">createProducer</span><span class="o">(</span><span class="s">"my-topic"</span><span class="o">);</span>
</code></pre></div></div>
<p>Here’s an example <a href="../../clients/Python">Python</a> producer:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">pulsar</span>
-<span class="n">TOPIC</span> <span class="o">=</span> <span class="s">'persistent://sample/standalone/ns/my-topic'</span>
-
<span class="n">client</span> <span class="o">=</span> <span class="n">pulsar</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="s">'pulsar://localhost:6650'</span><span class="p">)</span>
-<span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_producer</span><span class="p">(</span><span class="n">TOPIC</span><span class="p">)</span>
+<span class="n">producer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">create_producer</span><span class="p">(</span><span class="s">'my-topic'</span><span class="p">)</span>
</code></pre></div></div>
<p>Finally, here’s an example <a href="../../clients/Cpp">C++</a> producer:</p>
<div class="language-cpp highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">Client</span> <span class="n">client</span><span class="p">(</span><span class="s">"pulsar://localhost:6650"</span><span class="p">);</span>
<span class="n">Producer</span> <span class="n">producer</span><span class="p">;</span>
-<span class="n">Result</span> <span class="n">result</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">createProducer</span><span class="p">(</span><span class="s">"persistent://sample/standalone/ns1/my-topic"</span><span class="p">,</span> <span class="n">producer</span><span class="p">);</span>
+<span class="n">Result</span> <span class="n">result</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">createProducer</span><span class="p">(</span><span class="s">"my-topic"</span><span class="p">,</span> <span class="n">producer</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">result</span> <span class="o">!=</span> <span class="n">ResultOk</span><span class="p">)</span> <span class="p">{</span>
<span class="n">LOG_ERROR</span><span class="p">(</span><span class="s">"Error creating producer: "</span> <span class="o"><<</span> <span class="n">result</span><span class="p">);</span>
<span class="k">return</span> <span class="o">-</span><span class="mi">1</span><span class="p">;</span>
diff --git a/content/docs/latest/adaptors/PulsarSpark/index.html b/content/docs/latest/getting-started/Pulsar-2.0/index.html
similarity index 81%
copy from content/docs/latest/adaptors/PulsarSpark/index.html
copy to content/docs/latest/getting-started/Pulsar-2.0/index.html
index 7077078..6f0fd52 100644
--- a/content/docs/latest/adaptors/PulsarSpark/index.html
+++ b/content/docs/latest/getting-started/Pulsar-2.0/index.html
@@ -43,7 +43,7 @@
under the License.
-->
-<title>Spark Streaming Pulsar receiver</title>
+<title>Pulsar 2.0</title>
<meta charset="utf-8">
@@ -116,6 +116,8 @@
<h3 class="dropdown-header">Other releases</h3>
+ <a class="dropdown-item" href="/docs/v1.22.0-incubating/getting-started/LocalCluster">1.22.0-incubating</a>
+
<a class="dropdown-item" href="/docs/v1.21.0-incubating/getting-started/LocalCluster">1.21.0-incubating</a>
<a class="dropdown-item" href="/docs/v1.20.0-incubating/getting-started/LocalCluster">1.20.0-incubating</a>
@@ -283,6 +285,13 @@
<li>
+ <a href="../../getting-started/pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
<a href="../../getting-started/LocalCluster">
Run Pulsar locally
</a>
@@ -495,8 +504,8 @@
<li>
- <a href="../../admin/ModularLoadManager">
- Modular load manager
+ <a href="../../admin/LoadDistribution">
+ Load distribution
</a>
</li>
@@ -585,8 +594,8 @@
<li>
- <a href="../../admin-api/properties">
- Properties
+ <a href="../../admin-api/tenants">
+ Tenants
</a>
</li>
@@ -767,6 +776,13 @@
</a>
</li>
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
</ul>
</div>
</div>
@@ -818,15 +834,15 @@
<article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
<section class="docs-header">
<h1 class="docs-title">
- Spark Streaming Pulsar receiver
-
+ Pulsar 2.0
+ <span class="badge badge-warning">New</span>
</h1>
<section class="tags">
- <!-- <span class="badge badge-pill badge-primary">spark</span> -->
- <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-spark">spark</button>
+ <!-- <span class="badge badge-pill badge-primary">2.0</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-2.0">2.0</button>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -847,11 +863,11 @@
under the License.
-->
-<div class="modal fade" id="modal-spark">
+<div class="modal fade" id="modal-2.0">
<div class="modal-dialog" role="document">
<div class="modal-content">
<div class="modal-header">
- <h5 class="modal-title">Pages with the <strong>spark</strong> tag</h5>
+ <h5 class="modal-title">Pages with the <strong>2.0</strong> tag</h5>
</div>
<div class="modal-body">
<ul>
@@ -935,7 +951,13 @@
- <li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
+
+
+ <li><a href="/docs/latest/getting-started/Pulsar-2.0/">Pulsar 2.0</a></li>
+
+
+
+
@@ -1039,8 +1061,8 @@
</div>
- <!-- <span class="badge badge-pill badge-primary">streaming</span> -->
- <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-streaming">streaming</button>
+ <!-- <span class="badge badge-pill badge-primary">tenants</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-tenants">tenants</button>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -1061,11 +1083,11 @@
under the License.
... 38855 lines suppressed ...
--
To stop receiving notification emails like this one, please contact
mmerli@apache.org.