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/27 05:52:41 UTC
[incubator-pulsar] branch asf-site updated: Copying generated
documentation for v2.0.0-rc1-incubating
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 c63cb69 Copying generated documentation for v2.0.0-rc1-incubating
c63cb69 is described below
commit c63cb69ebd0716d25080eab8b735933fc920d493
Author: Matteo Merli <mm...@apache.org>
AuthorDate: Sat May 26 22:52:28 2018 -0700
Copying generated documentation for v2.0.0-rc1-incubating
---
.../adaptors/KafkaWrapper/index.html | 2397 +++
.../adaptors/PulsarSpark/index.html | 1753 ++
.../adaptors/PulsarStorm/index.html | 1571 ++
.../admin-api/brokers/index.html | 1192 ++
.../admin-api/clusters/index.html | 1277 ++
.../admin-api/namespaces/index.html | 1607 ++
.../admin-api/non-persistent-topics/index.html | 1291 ++
.../admin-api/overview/index.html | 2125 +++
.../admin-api/partitioned-topics/index.html | 1733 ++
.../admin-api/permissions/index.html | 1150 ++
.../admin-api/persistent-topics/index.html | 1680 ++
.../admin-api/properties/index.html | 1071 ++
.../admin-api/tenants/index.html | 1097 ++
.../v2.0.0-rc1-incubating/admin/Authz/index.html | 3187 ++++
.../admin/Dashboard/index.html | 1052 ++
.../admin/GeoReplication/index.html | 1161 ++
.../admin/LoadDistribution/index.html | 1222 ++
.../admin/ModularLoadManager/index.html | 1215 ++
.../v2.0.0-rc1-incubating/admin/Proxy/index.html | 1075 ++
.../v2.0.0-rc1-incubating/admin/Stats/index.html | 1374 ++
.../admin/ZooKeeperBookKeeper/index.html | 1615 ++
.../advanced/Encryption/index.html | 1776 ++
.../advanced/PartitionedTopics/index.html | 2782 ++++
.../advanced/RetentionExpiry/index.html | 2169 +++
.../v2.0.0-rc1-incubating/clients/Cpp/index.html | 1683 ++
.../v2.0.0-rc1-incubating/clients/Java/index.html | 2521 +++
.../clients/Python/index.html | 1573 ++
.../clients/WebSocket/index.html | 2433 +++
.../cookbooks/Encryption/index.html | 2099 +++
.../cookbooks/PartitionedTopics/index.html | 3121 ++++
.../cookbooks/RetentionExpiry/index.html | 2504 +++
.../cookbooks/message-deduplication/index.html | 1858 +++
.../cookbooks/message-queue/index.html | 2275 +++
.../cookbooks/non-persistent-messaging/index.html | 1218 ++
.../deployment/InstanceSetup/index.html | 1891 +++
.../deployment/Kubernetes/index.html | 1812 ++
.../deployment/Monitoring/index.html | 1112 ++
.../deployment/aws-cluster/index.html | 2369 +++
.../deployment/bare-metal/cluster/index.html | 1960 +++
.../deployment/bare-metal/instance/index.html | 2312 +++
.../deployment/cluster/index.html | 2289 +++
.../deployment/dcos/index.html | 1202 ++
.../deployment/instance/index.html | 2564 +++
.../v2.0.0-rc1-incubating/functions/api/index.html | 2066 +++
.../functions/deployment/index.html | 1338 ++
.../functions/guarantees/index.html | 1079 ++
.../functions/metrics-and-stats/index.html | 874 +
.../functions/metrics/index.html | 1062 ++
.../functions/overview/index.html | 1532 ++
.../functions/quickstart/index.html | 1350 ++
.../getting-started/Clients/index.html | 1068 ++
.../ConceptsAndArchitecture/index.html | 3219 ++++
.../getting-started/LocalCluster/index.html | 1736 ++
.../getting-started/Pulsar-2.0/index.html | 1818 ++
.../getting-started/docker/index.html | 1865 +++
.../project/BinaryProtocol/index.html | 6537 ++++++++
.../project/Codebase/index.html | 1236 ++
.../project/ModularLoadManager/index.html | 1241 ++
.../project/SimulationTools/index.html | 1368 ++
.../project/schema-storage/index.html | 1556 ++
.../reference/CliTools/index.html | 10233 ++++++++++++
.../reference/Configuration/index.html | 3642 ++++
.../reference/RestApi/index.html | 16604 +++++++++++++++++++
63 files changed, 138792 insertions(+)
diff --git a/content/docs/v2.0.0-rc1-incubating/adaptors/KafkaWrapper/index.html b/content/docs/v2.0.0-rc1-incubating/adaptors/KafkaWrapper/index.html
new file mode 100644
index 0000000..ddeb1f7
--- /dev/null
+++ b/content/docs/v2.0.0-rc1-incubating/adaptors/KafkaWrapper/index.html
@@ -0,0 +1,2397 @@
+<!DOCTYPE html>
+
+<!--
+
+ 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.
+
+-->
+
+<html>
+ <head>
+ <!--
+
+ 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.
+
+-->
+<title>Pulsar adaptor for Apache Kafka</title>
+
+<meta charset="utf-8">
+
+<link rel="stylesheet" href="/css/style.css">
+<link rel="shortcut icon" href="/img/favicon.ico">
+
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
+<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"></script>
+<script src="/js/jquery.tocify.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
+
+<script src="/js/jquery.scrollTo.min.js"></script>
+<script async src="/js/main.js"></script>
+
+ </head>
+ <body class="body">
+ <main class="main">
+ <!--
+
+ 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.
+
+-->
+
+<nav class="navbar navbar-toggleable-md navbar-light sticky-top">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+
+ <a class="navbar-brand" href="/">
+ <img class="main-logo" src="/img/pulsar-logo.png" alt="Pulsar logo">
+ </a>
+
+
+ <a class="navbar-nav"></a>
+
+ <div class="collapse navbar-collapse justify-content-end" id="navbarNavDropdown">
+ <ul class="navbar-nav">
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
+
+ <div class="dropdown-menu" aria-labelledby="documentationDropdown">
+ <a class="dropdown-item" href="/docs/latest/getting-started/LocalCluster">Latest</a>
+
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Stable release</h3>
+ <a class="dropdown-item" href="/docs/v2.0.0-incubating/getting-started/LocalCluster">2.0.0-incubating</a>
+
+
+ <div class="dropdown-divider"></div>
+ <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>
+
+ <a class="dropdown-item" href="/docs/v1.19.0-incubating/getting-started/LocalCluster">1.19.0-incubating</a>
+
+
+ </div>
+ </li>
+
+ <li class="nav-item">
+ <a class="nav-link" href="/download">Download</a>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Client libraries
+ </a>
+ <div class="dropdown-menu" aria-labelledby="clientLibsDropdown">
+ <a class="dropdown-item" href="/docs/latest/clients/Java">
+ Java
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Python">
+ Python
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Cpp">
+ C++
+ </a>
+ <div class="dropdown-divider"></div>
+ <a class="dropdown-item" href="/api/client">
+ Java client Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/admin">
+ Java admin Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/pulsar-functions">
+ Pulsar Functions Java SDK
+ </a>
+ <a class="dropdown-item" href="/api/python">
+ Python API docs
+ </a>
+ <a class="dropdown-item" href="/api/cpp">
+ C++ API docs
+ </a>
+ </div>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="versionsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Community
+ </a>
+ <div class="dropdown-menu dropdown-left" aria-labelledby="versionsDropdown">
+ <h3 class="dropdown-header">Get in touch</h3>
+ <a class="dropdown-item" href="/contact">Contact</a>
+ <a class="dropdown-item" href="/events/current-event">Events</a>
+ <a class="dropdown-item" href="https://twitter.com/Apache_Pulsar">Twitter</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/wiki">Wiki</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/issues">Issue tracking</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Resources</h3>
+ <a class="dropdown-item" href="/resources">Resources</a>
+ <a class="dropdown-item" href="/team">Team</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Apache</h3>
+ <a class="dropdown-item" href="https://www.apache.org/">The Apache Software Foundation</a>
+ <a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="dropdown-item" href="https://www.apache.org/security">Security</a>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <a class="hidden-md-down" href="http://www.apache.org/">
+ <img class="asf-logo" title="Apache Software Foundation" src="/img/feather.png" />
+ </a>
+</nav>
+
+<!--
+<nav class="navbar navbar-toggleable-md navbar-light" style="border: 1px solid red;">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <a class="navbar-brand" href="/">
+ <img src="/img/pulsar-logo.png" class="d-inline-block align-top" alt="Pulsar logo" height="40" width="60">
+ </a>
+
+ <div class="collapse navbar-collapse" id="navbarSupportedContent">
+ <ul class="navbar-nav mr-auto">
+ <li class="nav-item active">
+ <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="#">Link</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link disabled" href="#">Disabled</a>
+ </li>
+ </ul>
+ </div>
+</nav>-->
+
+
+ <main>
+ <!--
+
+ 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="docs-container container-fluid">
+ <div class="row">
+ <nav class="sidebar-nav hidden-md-down col-lg-3">
+ <!--
+
+ 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.
+
+-->
+
+
+<aside class="sidebar-nav">
+ <div id="sidebar-accordion" role="tablist" aria-multiselectable="true">
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-getting-started">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-getting-started" aria-controls="collapse-getting-started">
+ Getting started
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-getting-started" role="tabpanel" aria-labelledby="heading-getting-started">
+ <ul>
+
+
+ <li>
+ <a href="../../getting-started/Pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/LocalCluster">
+ Run Pulsar locally
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/docker">
+ Pulsar in Docker
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/Clients">
+ Client libraries
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/ConceptsAndArchitecture">
+ Concepts and architecture
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-functions">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-functions" aria-controls="collapse-pulsar-functions">
+ Pulsar Functions
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-functions" role="tabpanel" aria-labelledby="heading-pulsar-functions">
+ <ul>
+
+
+ <li>
+ <a href="../../functions/overview">
+ Pulsar Functions overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/quickstart">
+ Getting started with Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/api">
+ The Pulsar Functions API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/deployment">
+ Deploying Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/guarantees">
+ Processing guarantees
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/metrics">
+ Metrics for Pulsar Functions
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-deployment">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-deployment" aria-controls="collapse-deployment">
+ Deployment
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-deployment" role="tabpanel" aria-labelledby="heading-deployment">
+ <ul>
+
+
+ <li>
+ <a href="../../deployment/aws-cluster">
+ Deploy on Amazon Web Services
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/cluster">
+ Single cluster on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/instance">
+ Multi-cluster instance on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes">
+ Pulsar on Kubernetes
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-google-kubernetes-engine">
+ Pulsar on Google Kubernetes Engine
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-amazon-web-services">
+ Pulsar on AWS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/dcos">
+ Pulsar on DC/OS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Monitoring">
+ Monitoring
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-administration">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-administration" aria-controls="collapse-pulsar-administration">
+ Pulsar administration
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-administration" role="tabpanel" aria-labelledby="heading-pulsar-administration">
+ <ul>
+
+
+ <li>
+ <a href="../../admin/ZooKeeperBookKeeper">
+ ZooKeeper and BookKeeper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/GeoReplication">
+ Geo-replication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Authz">
+ Authentication and authorization
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Dashboard">
+ Dashboard
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Stats">
+ Pulsar statistics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/LoadDistribution">
+ Load distribution
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Proxy">
+ Pulsar proxy
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-client-libraries">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-client-libraries" aria-controls="collapse-client-libraries">
+ Client libraries
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-client-libraries" role="tabpanel" aria-labelledby="heading-client-libraries">
+ <ul>
+
+
+ <li>
+ <a href="../../clients/Java">
+ Java client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Cpp">
+ C++ client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Python">
+ Python client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/WebSocket">
+ WebSocket API
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-admin-api">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-admin-api" aria-controls="collapse-admin-api">
+ Admin API
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-admin-api" role="tabpanel" aria-labelledby="heading-admin-api">
+ <ul>
+
+
+ <li>
+ <a href="../../admin-api/overview">
+ Overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/clusters">
+ Clusters
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/tenants">
+ Tenants
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/brokers">
+ Brokers
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/namespaces">
+ Namespaces
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/permissions">
+ Permissions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/persistent-topics">
+ Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/non-persistent-topics">
+ Non-Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/partitioned-topics">
+ Partitioned topics
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-adaptors">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-adaptors" aria-controls="collapse-adaptors">
+ Adaptors
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-adaptors" role="tabpanel" aria-labelledby="heading-adaptors">
+ <ul>
+
+
+ <li>
+ <a href="../../adaptors/KafkaWrapper">
+ Apache Kafka client wrapper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarSpark">
+ Spark Streaming
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarStorm">
+ Apache Storm
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-cookbooks">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-cookbooks" aria-controls="collapse-cookbooks">
+ Cookbooks
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-cookbooks" role="tabpanel" aria-labelledby="heading-cookbooks">
+ <ul>
+
+
+ <li>
+ <a href="../../cookbooks/message-deduplication">
+ Message deduplication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/non-persistent-messaging">
+ Non-persistent messaging
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/PartitionedTopics">
+ Partitioned topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/RetentionExpiry">
+ Retention and expiry
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/Encryption">
+ Encryption
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/message-queue">
+ Using Pulsar as a message queue
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-developing-pulsar">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-developing-pulsar" aria-controls="collapse-developing-pulsar">
+ Developing Pulsar
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-developing-pulsar" role="tabpanel" aria-labelledby="heading-developing-pulsar">
+ <ul>
+
+
+ <li>
+ <a href="../../project/SimulationTools">
+ Simulation tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/BinaryProtocol">
+ Pulsar binary protocol
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/Codebase">
+ Codebase
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/schema-storage">
+ Custom schema storage
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-reference">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-reference" aria-controls="collapse-reference">
+ Reference
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-reference" role="tabpanel" aria-labelledby="heading-reference">
+ <ul>
+
+
+ <li>
+ <a href="../../reference/RestApi">
+ Pulsar REST API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/CliTools">
+ Command-line tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/Configuration">
+ Pulsar configuration
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+ </div>
+</aside>
+
+
+ </nav>
+
+ <article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
+ <section class="docs-header">
+ <h1 class="docs-title">
+ Pulsar adaptor for Apache Kafka
+
+
+ </h1>
+
+ <section class="tags">
+
+ <!-- <span class="badge badge-pill badge-primary">apache</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-apache">apache</button>
+ <!--
+
+ 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="modal fade" id="modal-apache">
+ <div class="modal-dialog" role="document">
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title">Pages with the <strong>apache</strong> tag</h5>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/KafkaWrapper/">Pulsar adaptor for Apache Kafka</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ <!-- <span class="badge badge-pill badge-primary">kafka</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-kafka">kafka</button>
+ <!--
+
+ 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="modal fade" id="modal-kafka">
+ <div class="modal-dialog" role="document">
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title">Pages with the <strong>kafka</strong> tag</h5>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/KafkaWrapper/">Pulsar adaptor for Apache Kafka</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ <!-- <span class="badge badge-pill badge-primary">wrapper</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-wrapper">wrapper</button>
+ <!--
+
+ 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="modal fade" id="modal-wrapper">
+ <div class="modal-dialog" role="document">
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title">Pages with the <strong>wrapper</strong> tag</h5>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/KafkaWrapper/">Pulsar adaptor for Apache Kafka</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </section>
+
+ <!--
+
+ 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.
+
+-->
+
+<!--
+
+ 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="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
+</span>
+
+<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">
+ </section>
+
+ <section class="content">
+ <!--
+
+ 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>Pulsar provides an easy option for applications that are currently written using the
+<a href="http://kafka.apache.org">Apache Kafka</a> Java client API.</p>
+
+<h2 id="using-the-pulsar-kafka-compatibility-wrapper">Using the Pulsar Kafka compatibility wrapper</h2>
+
+<p>In an existing application, change the regular Kafka client dependency and replace it with
+the Pulsar Kafka wrapper:</p>
+
+<p>Remove:</p>
+
+<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.kafka<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>kakfa-clients<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>0.10.2.1<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+</code></pre></div></div>
+
+<p>Include dependency for Pulsar Kafka wrapper:</p>
+
+<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.pulsar<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>pulsar-client-kafka<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>2.0.0-incubating<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+</code></pre></div></div>
+
+<p>With the new dependency, the existing code should work without any changes. The only
+thing that needs to be adjusted is the configuration, to make sure to point the
+producers and consumers to Pulsar service rather than Kafka and to use a particular
+Pulsar topic.</p>
+
+<h2 id="using-the-pulsar-kafka-compatibility-wrapper-together-with-existing-kafka-client">Using the Pulsar Kafka compatibility wrapper together with existing kafka client.</h2>
+
+<p>When migrating from Kafka to Pulsar, the application might have to use the original kafka client
+and the pulsar kafka wrapper together during migration. Then you should consider using the
+unshaded pulsar kafka client wrapper.</p>
+
+<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.pulsar<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>pulsar-client-kafka-original<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>2.0.0-incubating<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+</code></pre></div></div>
+
+<p>When using this dependency, you need to construct producer using <code class="highlighter-rouge">org.apache.kafka.clients.producer.PulsarKafkaProducer</code>
+instead of <code class="highlighter-rouge">org.apache.kafka.clients.producer.KafkaProducer</code> and <code class="highlighter-rouge">org.apache.kafka.clients.producer.PulsarKafkaConsumer</code> for consumers.</p>
+
+<h2 id="producer-example">Producer example</h2>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">// Topic needs to be a regular Pulsar topic</span>
+<span class="n">String</span> <span class="n">topic</span> <span class="o">=</span> <span class="s">"persistent://sample/standalone/ns/my-topic"</span><span class="o">;</span>
+
+<span class="n">Properties</span> <span class="n">props</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Properties</span><span class="o">();</span>
+<span class="c1">// Point to a Pulsar service</span>
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"bootstrap.servers"</span><span class="o">,</span> <span class="s">"pulsar://localhost:6650"</span><span class="o">);</span>
+
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"key.serializer"</span><span class="o">,</span> <span class="n">IntegerSerializer</span><span class="o">.</span><span class="na">class</span><span class="o">.</span><span class="na">getName</span><span class="o">());</span>
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"value.serializer"</span><span class="o">,</span> <span class="n">StringSerializer</span><span class="o">.</span><span class="na">class</span><span class="o">.</span><span class="na">getName</span><span class="o">());</span>
+
+<span class="n">Producer</span><span class="o"><</span><span class="n">Integer</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">producer</span> <span class="o">=</span> <span class="k">new</span> <span class="n">KafkaProducer</span><span class="o"><>(</span><span class="n">props</span><span class="o">);</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">producer</span><span class="o">.</span><span class="na">send</span><span class="o">(</span><span class="k">new</span> <span class="n">ProducerRecord</span><span class="o"><</span><span class="n">Integer</span><span class="o">,</span> <span class="n">String</span><span class="o">>(</span><span class="n">topic</span><span class="o">,</span> <span class="n">i</span><span class="o">,</span> <span class="s">"hello-"</span> <span class="o">+</span> <span class="n">i</ [...]
+ <span class="n">log</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"Message {} sent successfully"</span><span class="o">,</span> <span class="n">i</span><span class="o">);</span>
+<span class="o">}</span>
+
+<span class="n">producer</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
+</code></pre></div></div>
+
+<h2 id="consumer-example">Consumer example</h2>
+
+<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/ns/my-topic"</span><span class="o">;</span>
+
+<span class="n">Properties</span> <span class="n">props</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Properties</span><span class="o">();</span>
+<span class="c1">// Point to a Pulsar service</span>
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"bootstrap.servers"</span><span class="o">,</span> <span class="s">"pulsar://localhost:6650"</span><span class="o">);</span>
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"group.id"</span><span class="o">,</span> <span class="s">"my-subscription-name"</span><span class="o">);</span>
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"enable.auto.commit"</span><span class="o">,</span> <span class="s">"false"</span><span class="o">);</span>
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"key.deserializer"</span><span class="o">,</span> <span class="n">IntegerDeserializer</span><span class="o">.</span><span class="na">class</span><span class="o">.</span><span class="na">getName</span><span class="o">());</span>
+<span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"value.deserializer"</span><span class="o">,</span> <span class="n">StringDeserializer</span><span class="o">.</span><span class="na">class</span><span class="o">.</span><span class="na">getName</span><span class="o">());</span>
+
+<span class="n">Consumer</span><span class="o"><</span><span class="n">Integer</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">consumer</span> <span class="o">=</span> <span class="k">new</span> <span class="n">KafkaConsumer</span><span class="o"><>(</span><span class="n">props</span><span class="o">);</span>
+<span class="n">consumer</span><span class="o">.</span><span class="na">subscribe</span><span class="o">(</span><span class="n">Arrays</span><span class="o">.</span><span class="na">asList</span><span class="o">(</span><span class="n">topic</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>
+ <span class="n">ConsumerRecords</span><span class="o"><</span><span class="n">Integer</span><span class="o">,</span> <span class="n">String</span><span class="o">></span> <span class="n">records</span> <span class="o">=</span> <span class="n">consumer</span><span class="o">.</span><span class="na">poll</span><span class="o">(</span><span class="mi">100</span><span class="o">);</span>
+ <span class="n">records</span><span class="o">.</span><span class="na">forEach</span><span class="o">(</span><span class="n">record</span> <span class="o">-></span> <span class="o">{</span>
+ <span class="n">log</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"Received record: {}"</span><span class="o">,</span> <span class="n">record</span><span class="o">);</span>
+ <span class="o">});</span>
+
+ <span class="c1">// Commit last offset</span>
+ <span class="n">consumer</span><span class="o">.</span><span class="na">commitSync</span><span class="o">();</span>
+<span class="o">}</span>
+</code></pre></div></div>
+
+<h2 id="complete-examples">Complete Examples</h2>
+
+<p>You can find the complete producer and consumer examples
+<a href="https://github.com/apache/incubator-pulsar/tree/master/pulsar-client-kafka-compat/pulsar-client-kafka-tests/src/test/java/org/apache/pulsar/client/kafka/compat/examples">here</a>.</p>
+
+<h2 id="compatibility-matrix">Compatibility matrix</h2>
+
+<p>Currently the Pulsar Kafka wrapper supports most of the operations offered by the Kafka API.</p>
+
+<h4 id="producer">Producer</h4>
+
+<p>APIs:</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">Producer Method</th>
+ <th style="text-align: left">Supported</th>
+ <th style="text-align: left">Notes</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Future<RecordMetadata> send(ProducerRecord<K, V> record)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left">Currently no support for explicitly set the partition id when publishing</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Future<RecordMetadata> send(ProducerRecord<K, V> record, Callback callback)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void flush()</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">List<PartitionInfo> partitionsFor(String topic)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Map<MetricName, ? extends Metric> metrics()</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void close()</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void close(long timeout, TimeUnit unit)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ </tbody>
+</table>
+
+<p>Properties:</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">Config property</th>
+ <th style="text-align: left">Supported</th>
+ <th style="text-align: left">Notes</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">acks</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left">Durability and quorum writes are configured at the namespace level</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">batch.size</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">block.on.buffer.full</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left">If true it will block producer, otherwise give error</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">bootstrap.servers</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left">Needs to point to a single Pulsar service URL</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">buffer.memory</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">client.id</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">compression.type</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left">Allows <code class="highlighter-rouge">gzip</code> and <code class="highlighter-rouge">lz4</code>. No <code class="highlighter-rouge">snappy</code>.</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">connections.max.idle.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">interceptor.classes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">key.serializer</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">linger.ms</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left">Controls the group commit time when batching messages</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">max.block.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">max.in.flight.requests.per.connection</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left">In Pulsar ordering is maintained even with multiple requests in flight</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">max.request.size</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">metric.reporters</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">metrics.num.samples</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">metrics.sample.window.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">partitioner.class</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">receive.buffer.bytes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">reconnect.backoff.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">request.timeout.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">retries</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left">Pulsar client retries with exponential backoff until the send timeout expires</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">send.buffer.bytes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">timeout.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">value.serializer</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h4 id="consumer">Consumer</h4>
+
+<p>APIs:</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">Consumer Method</th>
+ <th style="text-align: left">Supported</th>
+ <th style="text-align: left">Notes</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Set<TopicPartition> assignment()</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Set<String> subscription()</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void subscribe(Collection<String> topics)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void subscribe(Collection<String> topics, ConsumerRebalanceListener callback)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void assign(Collection<TopicPartition> partitions)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void subscribe(Pattern pattern, ConsumerRebalanceListener callback)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void unsubscribe()</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">ConsumerRecords<K, V> poll(long timeoutMillis)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void commitSync()</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void commitSync(Map<TopicPartition, OffsetAndMetadata> offsets)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void commitAsync()</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void commitAsync(OffsetCommitCallback callback)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void commitAsync(Map<TopicPartition, OffsetAndMetadata> offsets, OffsetCommitCallback callback)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void seek(TopicPartition partition, long offset)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void seekToBeginning(Collection<TopicPartition> partitions)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void seekToEnd(Collection<TopicPartition> partitions)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">long position(TopicPartition partition)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">OffsetAndMetadata committed(TopicPartition partition)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Map<MetricName, ? extends Metric> metrics()</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">List<PartitionInfo> partitionsFor(String topic)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Map<String, List<PartitionInfo>> listTopics()</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Set<TopicPartition> paused()</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void pause(Collection<TopicPartition> partitions)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void resume(Collection<TopicPartition> partitions)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Map<TopicPartition, OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition, Long> timestampsToSearch)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Map<TopicPartition, Long> beginningOffsets(Collection<TopicPartition> partitions)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">Map<TopicPartition, Long> endOffsets(Collection<TopicPartition> partitions)</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void close()</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void close(long timeout, TimeUnit unit)</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">void wakeup()</code></td>
+ <td style="text-align: left">No</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ </tbody>
+</table>
+
+<p>Properties:</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">Config property</th>
+ <th style="text-align: left">Supported</th>
+ <th style="text-align: left">Notes</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">group.id</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left">Maps to a Pulsar subscription name</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">max.poll.records</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">max.poll.interval.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left">Messages are “pushed” from broker</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">session.timeout.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">heartbeat.interval.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">bootstrap.servers</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left">Needs to point to a single Pulsar service URL</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">enable.auto.commit</code></td>
+ <td style="text-align: left">Yes</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">auto.commit.interval.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left">With auto-commit, acks are sent immediately to broker</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">partition.assignment.strategy</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">auto.offset.reset</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">fetch.min.bytes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">fetch.max.bytes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">fetch.max.wait.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">metadata.max.age.ms</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">max.partition.fetch.bytes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">send.buffer.bytes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">receive.buffer.bytes</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">client.id</code></td>
+ <td style="text-align: left">Ignored</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2 id="custom-pulsar-configurations">Custom Pulsar configurations</h2>
+
+<p>You can configure Pulsar authentication provider directly from the Kafka properties.</p>
+
+<h3 id="pulsar-client-properties">Pulsar client properties:</h3>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">Config property</th>
+ <th style="text-align: left">Default</th>
+ <th style="text-align: left">Notes</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left"><code class="highlighter-rouge">pulsar.authentication.class</code></td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">Configure to auth provider. Eg. <code class="highlighter-rouge">org.apache.pulsar.client.impl.auth.AuthenticationTls</code></td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setUseTls-boolean-"><code class="highlighter-rouge">pulsar.use.tls</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">false</code></td>
+ <td style="text-align: left">Enable TLS transport encryption</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setTlsTrustCertsFilePath-java.lang.String-"><code class="highlighter-rouge">pulsar.tls.trust.certs.file.path</code></a></td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">Path for the TLS trust certificate store</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setTlsAllowInsecureConnection-boolean-"><code class="highlighter-rouge">pulsar.tls.allow.insecure.connection</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">false</code></td>
+ <td style="text-align: left">Accept self-signed certificates from brokers</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setOperationTimeout-int-java.util.concurrent.TimeUnit-"><code class="highlighter-rouge">pulsar.operation.timeout.ms</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">30000</code></td>
+ <td style="text-align: left">General operations timeout</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setStatsInterval-long-java.util.concurrent.TimeUnit-"><code class="highlighter-rouge">pulsar.stats.interval.seconds</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">60</code></td>
+ <td style="text-align: left">Pulsar client lib stats printing interval</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setIoThreads-int-"><code class="highlighter-rouge">pulsar.num.io.threads</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">1</code></td>
+ <td style="text-align: left">Number of Netty IO threads to use</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setConnectionsPerBroker-int-"><code class="highlighter-rouge">pulsar.connections.per.broker</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">1</code></td>
+ <td style="text-align: left">Max number of connection to open to each broker</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setUseTcpNoDelay-boolean-"><code class="highlighter-rouge">pulsar.use.tcp.nodelay</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">true</code></td>
+ <td style="text-align: left">TCP no-delay</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setConcurrentLookupRequest-int-"><code class="highlighter-rouge">pulsar.concurrent.lookup.requests</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">50000</code></td>
+ <td style="text-align: left">Max number of concurrent topic lookups</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ClientConfiguration.html#setMaxNumberOfRejectedRequestPerConnection-int-"><code class="highlighter-rouge">pulsar.max.number.rejected.request.per.connection</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">50</code></td>
+ <td style="text-align: left">Threshold of errors to forcefully close a connection</td>
+ </tr>
+ </tbody>
+</table>
+
+<h3 id="pulsar-producer-properties">Pulsar producer properties</h3>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">Config property</th>
+ <th style="text-align: left">Default</th>
+ <th style="text-align: left">Notes</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html#setProducerName-java.lang.String-"><code class="highlighter-rouge">pulsar.producer.name</code></a></td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">Specify producer name</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html#setInitialSequenceId-long-"><code class="highlighter-rouge">pulsar.producer.initial.sequence.id</code></a></td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">Specify baseline for sequence id for this producer</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html#setMaxPendingMessages-int-"><code class="highlighter-rouge">pulsar.producer.max.pending.messages</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">1000</code></td>
+ <td style="text-align: left">Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker.</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html#setMaxPendingMessagesAcrossPartitions-int-"><code class="highlighter-rouge">pulsar.producer.max.pending.messages.across.partitions</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">50000</code></td>
+ <td style="text-align: left">Set the number of max pending messages across all the partitions</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html#setBatchingEnabled-boolean-"><code class="highlighter-rouge">pulsar.producer.batching.enabled</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">true</code></td>
+ <td style="text-align: left">Control whether automatic batching of messages is enabled for the producer</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html#setBatchingMaxMessages-int-"><code class="highlighter-rouge">pulsar.producer.batching.max.messages</code></a></td>
+ <td style="text-align: left"><code class="highlighter-rouge">1000</code></td>
+ <td style="text-align: left">The maximum number of messages permitted in a batch</td>
+ </tr>
+ </tbody>
+</table>
+
+<h3 id="pulsar-consumer-properties">Pulsar consumer Properties</h3>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">Config property</th>
+ <th style="text-align: left">Default</th>
+ <th style="text-align: left">Notes</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ConsumerConfiguration.html#setConsumerName-java.lang.String-"><code class="highlighter-rouge">pulsar.consumer.name</code></a></td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">Set the consumer name</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ConsumerConfiguration.html#setReceiverQueueSize-int-"><code class="highlighter-rouge">pulsar.consumer.receiver.queue.size</code></a></td>
+ <td style="text-align: left">1000</td>
+ <td style="text-align: left">Sets the size of the consumer receive queue</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a href="http://pulsar.apache.org/api/client/org/apache/pulsar/client/api/ConsumerConfiguration.html#setMaxTotalReceiverQueueSizeAcrossPartitions-int-"><code class="highlighter-rouge">pulsar.consumer.total.receiver.queue.size.across.partitions</code></a></td>
+ <td style="text-align: left">50000</td>
+ <td style="text-align: left">Set the max total receiver queue size across partitons</td>
+ </tr>
+ </tbody>
+</table>
+
+ </section>
+ </article>
+
+ <nav class="toc-bar hidden-md-down col-lg-2">
+
+ <div id="toc">
+ <h4>Pulsar adaptor for Apache Kafka</h4>
+ </div>
+
+ </nav>
+ </div>
+</div>
+
+ </main>
+ </main>
+
+ <!--
+
+ 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.
+
+-->
+<footer class="footer">
+ <div class="container">
+ <p class="text-center">Copyright 2018 The Apache Software Foundation. All Rights Reserved.</p>
+ <p class="text-center">Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </div>
+</footer>
+
+
+
+
+
+ <!--
+
+ 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.
+
+-->
+
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-102219959-1', 'auto');
+ ga('send', 'pageview');
+</script>
+
+
+
+ <script type="text/javascript">
+ var navbarOffset = -1 * (document.getElementsByClassName("navbar")[0].offsetHeight);
+ var shiftWindow = function() { scrollBy(0, navbarOffset) };
+ window.addEventListener("hashchange", shiftWindow);
+ window.addEventListener("pageshow", shiftWindow);
+ function load() { if (window.location.hash) shiftWindow(); }
+ </script>
+ </body>
+</html>
diff --git a/content/docs/v2.0.0-rc1-incubating/adaptors/PulsarSpark/index.html b/content/docs/v2.0.0-rc1-incubating/adaptors/PulsarSpark/index.html
new file mode 100644
index 0000000..dfdaf27
--- /dev/null
+++ b/content/docs/v2.0.0-rc1-incubating/adaptors/PulsarSpark/index.html
@@ -0,0 +1,1753 @@
+<!DOCTYPE html>
+
+<!--
+
+ 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.
+
+-->
+
+<html>
+ <head>
+ <!--
+
+ 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.
+
+-->
+<title>Spark Streaming Pulsar receiver</title>
+
+<meta charset="utf-8">
+
+<link rel="stylesheet" href="/css/style.css">
+<link rel="shortcut icon" href="/img/favicon.ico">
+
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
+<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"></script>
+<script src="/js/jquery.tocify.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
+
+<script src="/js/jquery.scrollTo.min.js"></script>
+<script async src="/js/main.js"></script>
+
+ </head>
+ <body class="body">
+ <main class="main">
+ <!--
+
+ 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.
+
+-->
+
+<nav class="navbar navbar-toggleable-md navbar-light sticky-top">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+
+ <a class="navbar-brand" href="/">
+ <img class="main-logo" src="/img/pulsar-logo.png" alt="Pulsar logo">
+ </a>
+
+
+ <a class="navbar-nav"></a>
+
+ <div class="collapse navbar-collapse justify-content-end" id="navbarNavDropdown">
+ <ul class="navbar-nav">
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
+
+ <div class="dropdown-menu" aria-labelledby="documentationDropdown">
+ <a class="dropdown-item" href="/docs/latest/getting-started/LocalCluster">Latest</a>
+
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Stable release</h3>
+ <a class="dropdown-item" href="/docs/v2.0.0-incubating/getting-started/LocalCluster">2.0.0-incubating</a>
+
+
+ <div class="dropdown-divider"></div>
+ <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>
+
+ <a class="dropdown-item" href="/docs/v1.19.0-incubating/getting-started/LocalCluster">1.19.0-incubating</a>
+
+
+ </div>
+ </li>
+
+ <li class="nav-item">
+ <a class="nav-link" href="/download">Download</a>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Client libraries
+ </a>
+ <div class="dropdown-menu" aria-labelledby="clientLibsDropdown">
+ <a class="dropdown-item" href="/docs/latest/clients/Java">
+ Java
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Python">
+ Python
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Cpp">
+ C++
+ </a>
+ <div class="dropdown-divider"></div>
+ <a class="dropdown-item" href="/api/client">
+ Java client Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/admin">
+ Java admin Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/pulsar-functions">
+ Pulsar Functions Java SDK
+ </a>
+ <a class="dropdown-item" href="/api/python">
+ Python API docs
+ </a>
+ <a class="dropdown-item" href="/api/cpp">
+ C++ API docs
+ </a>
+ </div>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="versionsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Community
+ </a>
+ <div class="dropdown-menu dropdown-left" aria-labelledby="versionsDropdown">
+ <h3 class="dropdown-header">Get in touch</h3>
+ <a class="dropdown-item" href="/contact">Contact</a>
+ <a class="dropdown-item" href="/events/current-event">Events</a>
+ <a class="dropdown-item" href="https://twitter.com/Apache_Pulsar">Twitter</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/wiki">Wiki</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/issues">Issue tracking</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Resources</h3>
+ <a class="dropdown-item" href="/resources">Resources</a>
+ <a class="dropdown-item" href="/team">Team</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Apache</h3>
+ <a class="dropdown-item" href="https://www.apache.org/">The Apache Software Foundation</a>
+ <a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="dropdown-item" href="https://www.apache.org/security">Security</a>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <a class="hidden-md-down" href="http://www.apache.org/">
+ <img class="asf-logo" title="Apache Software Foundation" src="/img/feather.png" />
+ </a>
+</nav>
+
+<!--
+<nav class="navbar navbar-toggleable-md navbar-light" style="border: 1px solid red;">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <a class="navbar-brand" href="/">
+ <img src="/img/pulsar-logo.png" class="d-inline-block align-top" alt="Pulsar logo" height="40" width="60">
+ </a>
+
+ <div class="collapse navbar-collapse" id="navbarSupportedContent">
+ <ul class="navbar-nav mr-auto">
+ <li class="nav-item active">
+ <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="#">Link</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link disabled" href="#">Disabled</a>
+ </li>
+ </ul>
+ </div>
+</nav>-->
+
+
+ <main>
+ <!--
+
+ 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="docs-container container-fluid">
+ <div class="row">
+ <nav class="sidebar-nav hidden-md-down col-lg-3">
+ <!--
+
+ 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.
+
+-->
+
+
+<aside class="sidebar-nav">
+ <div id="sidebar-accordion" role="tablist" aria-multiselectable="true">
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-getting-started">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-getting-started" aria-controls="collapse-getting-started">
+ Getting started
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-getting-started" role="tabpanel" aria-labelledby="heading-getting-started">
+ <ul>
+
+
+ <li>
+ <a href="../../getting-started/Pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/LocalCluster">
+ Run Pulsar locally
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/docker">
+ Pulsar in Docker
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/Clients">
+ Client libraries
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/ConceptsAndArchitecture">
+ Concepts and architecture
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-functions">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-functions" aria-controls="collapse-pulsar-functions">
+ Pulsar Functions
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-functions" role="tabpanel" aria-labelledby="heading-pulsar-functions">
+ <ul>
+
+
+ <li>
+ <a href="../../functions/overview">
+ Pulsar Functions overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/quickstart">
+ Getting started with Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/api">
+ The Pulsar Functions API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/deployment">
+ Deploying Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/guarantees">
+ Processing guarantees
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/metrics">
+ Metrics for Pulsar Functions
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-deployment">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-deployment" aria-controls="collapse-deployment">
+ Deployment
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-deployment" role="tabpanel" aria-labelledby="heading-deployment">
+ <ul>
+
+
+ <li>
+ <a href="../../deployment/aws-cluster">
+ Deploy on Amazon Web Services
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/cluster">
+ Single cluster on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/instance">
+ Multi-cluster instance on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes">
+ Pulsar on Kubernetes
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-google-kubernetes-engine">
+ Pulsar on Google Kubernetes Engine
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-amazon-web-services">
+ Pulsar on AWS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/dcos">
+ Pulsar on DC/OS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Monitoring">
+ Monitoring
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-administration">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-administration" aria-controls="collapse-pulsar-administration">
+ Pulsar administration
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-administration" role="tabpanel" aria-labelledby="heading-pulsar-administration">
+ <ul>
+
+
+ <li>
+ <a href="../../admin/ZooKeeperBookKeeper">
+ ZooKeeper and BookKeeper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/GeoReplication">
+ Geo-replication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Authz">
+ Authentication and authorization
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Dashboard">
+ Dashboard
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Stats">
+ Pulsar statistics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/LoadDistribution">
+ Load distribution
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Proxy">
+ Pulsar proxy
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-client-libraries">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-client-libraries" aria-controls="collapse-client-libraries">
+ Client libraries
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-client-libraries" role="tabpanel" aria-labelledby="heading-client-libraries">
+ <ul>
+
+
+ <li>
+ <a href="../../clients/Java">
+ Java client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Cpp">
+ C++ client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Python">
+ Python client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/WebSocket">
+ WebSocket API
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-admin-api">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-admin-api" aria-controls="collapse-admin-api">
+ Admin API
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-admin-api" role="tabpanel" aria-labelledby="heading-admin-api">
+ <ul>
+
+
+ <li>
+ <a href="../../admin-api/overview">
+ Overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/clusters">
+ Clusters
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/tenants">
+ Tenants
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/brokers">
+ Brokers
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/namespaces">
+ Namespaces
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/permissions">
+ Permissions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/persistent-topics">
+ Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/non-persistent-topics">
+ Non-Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/partitioned-topics">
+ Partitioned topics
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-adaptors">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-adaptors" aria-controls="collapse-adaptors">
+ Adaptors
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-adaptors" role="tabpanel" aria-labelledby="heading-adaptors">
+ <ul>
+
+
+ <li>
+ <a href="../../adaptors/KafkaWrapper">
+ Apache Kafka client wrapper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarSpark">
+ Spark Streaming
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarStorm">
+ Apache Storm
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-cookbooks">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-cookbooks" aria-controls="collapse-cookbooks">
+ Cookbooks
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-cookbooks" role="tabpanel" aria-labelledby="heading-cookbooks">
+ <ul>
+
+
+ <li>
+ <a href="../../cookbooks/message-deduplication">
+ Message deduplication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/non-persistent-messaging">
+ Non-persistent messaging
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/PartitionedTopics">
+ Partitioned topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/RetentionExpiry">
+ Retention and expiry
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/Encryption">
+ Encryption
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/message-queue">
+ Using Pulsar as a message queue
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-developing-pulsar">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-developing-pulsar" aria-controls="collapse-developing-pulsar">
+ Developing Pulsar
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-developing-pulsar" role="tabpanel" aria-labelledby="heading-developing-pulsar">
+ <ul>
+
+
+ <li>
+ <a href="../../project/SimulationTools">
+ Simulation tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/BinaryProtocol">
+ Pulsar binary protocol
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/Codebase">
+ Codebase
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/schema-storage">
+ Custom schema storage
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-reference">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-reference" aria-controls="collapse-reference">
+ Reference
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-reference" role="tabpanel" aria-labelledby="heading-reference">
+ <ul>
+
+
+ <li>
+ <a href="../../reference/RestApi">
+ Pulsar REST API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/CliTools">
+ Command-line tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/Configuration">
+ Pulsar configuration
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+ </div>
+</aside>
+
+
+ </nav>
+
+ <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
+
+
+ </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>
+ <!--
+
+ 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="modal fade" id="modal-spark">
+ <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>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</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>
+ <!--
+
+ 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="modal fade" id="modal-streaming">
+ <div class="modal-dialog" role="document">
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title">Pages with the <strong>streaming</strong> tag</h5>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ <!-- <span class="badge badge-pill badge-primary">java</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-java">java</button>
+ <!--
+
+ 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="modal fade" id="modal-java">
+ <div class="modal-dialog" role="document">
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title">Pages with the <strong>java</strong> tag</h5>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+ <li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/clients/Java/">The Pulsar Java client</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/PulsarStorm/">Pulsar adaptor for Apache Storm</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </section>
+
+ <!--
+
+ 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.
+
+-->
+
+<!--
+
+ 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="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
+</span>
+
+<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">
+ </section>
+
+ <section class="content">
+ <!--
+
+ 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>The Spark Streaming receiver for Pulsar is a custom receiver that enables Apache <a href="https://spark.apache.org/streaming/">Spark Streaming</a> to receive data from Pulsar.</p>
+
+<p>An application can receive data in <a href="https://spark.apache.org/docs/latest/programming-guide.html#resilient-distributed-datasets-rdds">Resilient Distributed Dataset</a> (RDD) format via the Spark Streaming Pulsar receiver and can process it in a variety of ways.</p>
+
+<h2 id="prerequisites">Prerequisites</h2>
+
+<p>To use the receiver, include a dependency for the <code class="highlighter-rouge">pulsar-spark</code> library in your Java configuration.</p>
+
+<h3 id="maven">Maven</h3>
+
+<p>If you’re using Maven, add this to your <code class="highlighter-rouge">pom.xml</code>:</p>
+
+<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"><!-- in your <properties> block --></span>
+<span class="nt"><pulsar.version></span>2.0.0-incubating<span class="nt"></pulsar.version></span>
+
+<span class="c"><!-- in your <dependencies> block --></span>
+<span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.pulsar<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>pulsar-spark<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>${pulsar.version}<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+</code></pre></div></div>
+
+<h3 id="gradle">Gradle</h3>
+
+<p>If you’re using Gradle, add this to your <code class="highlighter-rouge">build.gradle</code> file:</p>
+
+<div class="language-groovy highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">def</span> <span class="n">pulsarVersion</span> <span class="o">=</span> <span class="s2">"2.0.0-incubating"</span>
+
+<span class="n">dependencies</span> <span class="o">{</span>
+ <span class="n">compile</span> <span class="nl">group:</span> <span class="s1">'org.apache.pulsar'</span><span class="o">,</span> <span class="nl">name:</span> <span class="s1">'pulsar-spark'</span><span class="o">,</span> <span class="nl">version:</span> <span class="n">pulsarVersion</span>
+<span class="o">}</span>
+</code></pre></div></div>
+
+<h2 id="usage">Usage</h2>
+
+<p>Pass an instance of <code class="highlighter-rouge">SparkStreamingPulsarReceiver</code> to the <code class="highlighter-rouge">receiverStream</code> method in <code class="highlighter-rouge">JavaStreamingContext</code>:</p>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">SparkConf</span> <span class="n">conf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">SparkConf</span><span class="o">().</span><span class="na">setMaster</span><span class="o">(</span><span class="s">"local[*]"</span><span class="o">).</span><span class="na">setAppName</span><span class="o">(</span><span class="s">"pulsar-spark"</span><span class="o [...]
+<span class="n">JavaStreamingContext</span> <span class="n">jssc</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JavaStreamingContext</span><span class="o">(</span><span class="n">conf</span><span class="o">,</span> <span class="n">Durations</span><span class="o">.</span><span class="na">seconds</span><span class="o">(</span><span class="mi">5</span><span class="o">));</span>
+
+<span class="n">ClientConfiguration</span> <span class="n">clientConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ClientConfiguration</span><span class="o">();</span>
+<span class="n">ConsumerConfiguration</span> <span class="n">consConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ConsumerConfiguration</span><span class="o">();</span>
+<span class="n">String</span> <span class="n">url</span> <span class="o">=</span> <span class="s">"pulsar://localhost:6650/"</span><span class="o">;</span>
+<span class="n">String</span> <span class="n">topic</span> <span class="o">=</span> <span class="s">"persistent://sample/standalone/ns1/topic1"</span><span class="o">;</span>
+<span class="n">String</span> <span class="n">subs</span> <span class="o">=</span> <span class="s">"sub1"</span><span class="o">;</span>
+
+<span class="n">JavaReceiverInputDStream</span><span class="o"><</span><span class="kt">byte</span><span class="o">[]></span> <span class="n">msgs</span> <span class="o">=</span> <span class="n">jssc</span>
+ <span class="o">.</span><span class="na">receiverStream</span><span class="o">(</span><span class="k">new</span> <span class="n">SparkStreamingPulsarReceiver</span><span class="o">(</span><span class="n">clientConf</span><span class="o">,</span> <span class="n">consConf</span><span class="o">,</span> <span class="n">url</span><span class="o">,</span> <span class="n">topic</span><span class="o">,</span> <span class="n">subs</span><span class="o">));</span>
+</code></pre></div></div>
+
+<h2 id="example">Example</h2>
+
+<p>You can find a complete example <a href="https://github.com/apache/incubator-pulsar/tree/master/pulsar-spark/src/test/java/org/apache/pulsar/spark/example/SparkStreamingPulsarReceiverExample.java">here</a>.
+In this example, the number of messages which contain the string “Pulsar” in received messages is counted.</p>
+
+ </section>
+ </article>
+
+ <nav class="toc-bar hidden-md-down col-lg-2">
+
+ <div id="toc">
+ <h4>Spark Streaming Pulsar receiver</h4>
+ </div>
+
+ </nav>
+ </div>
+</div>
+
+ </main>
+ </main>
+
+ <!--
+
+ 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.
+
+-->
+<footer class="footer">
+ <div class="container">
+ <p class="text-center">Copyright 2018 The Apache Software Foundation. All Rights Reserved.</p>
+ <p class="text-center">Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </div>
+</footer>
+
+
+
+
+
+ <!--
+
+ 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.
+
+-->
+
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-102219959-1', 'auto');
+ ga('send', 'pageview');
+</script>
+
+
+
+ <script type="text/javascript">
+ var navbarOffset = -1 * (document.getElementsByClassName("navbar")[0].offsetHeight);
+ var shiftWindow = function() { scrollBy(0, navbarOffset) };
+ window.addEventListener("hashchange", shiftWindow);
+ window.addEventListener("pageshow", shiftWindow);
+ function load() { if (window.location.hash) shiftWindow(); }
+ </script>
+ </body>
+</html>
diff --git a/content/docs/v2.0.0-rc1-incubating/adaptors/PulsarStorm/index.html b/content/docs/v2.0.0-rc1-incubating/adaptors/PulsarStorm/index.html
new file mode 100644
index 0000000..27f6b43
--- /dev/null
+++ b/content/docs/v2.0.0-rc1-incubating/adaptors/PulsarStorm/index.html
@@ -0,0 +1,1571 @@
+<!DOCTYPE html>
+
+<!--
+
+ 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.
+
+-->
+
+<html>
+ <head>
+ <!--
+
+ 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.
+
+-->
+<title>Pulsar adaptor for Apache Storm</title>
+
+<meta charset="utf-8">
+
+<link rel="stylesheet" href="/css/style.css">
+<link rel="shortcut icon" href="/img/favicon.ico">
+
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
+<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"></script>
+<script src="/js/jquery.tocify.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
+
+<script src="/js/jquery.scrollTo.min.js"></script>
+<script async src="/js/main.js"></script>
+
+ </head>
+ <body class="body">
+ <main class="main">
+ <!--
+
+ 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.
+
+-->
+
+<nav class="navbar navbar-toggleable-md navbar-light sticky-top">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+
+ <a class="navbar-brand" href="/">
+ <img class="main-logo" src="/img/pulsar-logo.png" alt="Pulsar logo">
+ </a>
+
+
+ <a class="navbar-nav"></a>
+
+ <div class="collapse navbar-collapse justify-content-end" id="navbarNavDropdown">
+ <ul class="navbar-nav">
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
+
+ <div class="dropdown-menu" aria-labelledby="documentationDropdown">
+ <a class="dropdown-item" href="/docs/latest/getting-started/LocalCluster">Latest</a>
+
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Stable release</h3>
+ <a class="dropdown-item" href="/docs/v2.0.0-incubating/getting-started/LocalCluster">2.0.0-incubating</a>
+
+
+ <div class="dropdown-divider"></div>
+ <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>
+
+ <a class="dropdown-item" href="/docs/v1.19.0-incubating/getting-started/LocalCluster">1.19.0-incubating</a>
+
+
+ </div>
+ </li>
+
+ <li class="nav-item">
+ <a class="nav-link" href="/download">Download</a>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Client libraries
+ </a>
+ <div class="dropdown-menu" aria-labelledby="clientLibsDropdown">
+ <a class="dropdown-item" href="/docs/latest/clients/Java">
+ Java
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Python">
+ Python
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Cpp">
+ C++
+ </a>
+ <div class="dropdown-divider"></div>
+ <a class="dropdown-item" href="/api/client">
+ Java client Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/admin">
+ Java admin Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/pulsar-functions">
+ Pulsar Functions Java SDK
+ </a>
+ <a class="dropdown-item" href="/api/python">
+ Python API docs
+ </a>
+ <a class="dropdown-item" href="/api/cpp">
+ C++ API docs
+ </a>
+ </div>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="versionsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Community
+ </a>
+ <div class="dropdown-menu dropdown-left" aria-labelledby="versionsDropdown">
+ <h3 class="dropdown-header">Get in touch</h3>
+ <a class="dropdown-item" href="/contact">Contact</a>
+ <a class="dropdown-item" href="/events/current-event">Events</a>
+ <a class="dropdown-item" href="https://twitter.com/Apache_Pulsar">Twitter</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/wiki">Wiki</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/issues">Issue tracking</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Resources</h3>
+ <a class="dropdown-item" href="/resources">Resources</a>
+ <a class="dropdown-item" href="/team">Team</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Apache</h3>
+ <a class="dropdown-item" href="https://www.apache.org/">The Apache Software Foundation</a>
+ <a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="dropdown-item" href="https://www.apache.org/security">Security</a>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <a class="hidden-md-down" href="http://www.apache.org/">
+ <img class="asf-logo" title="Apache Software Foundation" src="/img/feather.png" />
+ </a>
+</nav>
+
+<!--
+<nav class="navbar navbar-toggleable-md navbar-light" style="border: 1px solid red;">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <a class="navbar-brand" href="/">
+ <img src="/img/pulsar-logo.png" class="d-inline-block align-top" alt="Pulsar logo" height="40" width="60">
+ </a>
+
+ <div class="collapse navbar-collapse" id="navbarSupportedContent">
+ <ul class="navbar-nav mr-auto">
+ <li class="nav-item active">
+ <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="#">Link</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link disabled" href="#">Disabled</a>
+ </li>
+ </ul>
+ </div>
+</nav>-->
+
+
+ <main>
+ <!--
+
+ 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="docs-container container-fluid">
+ <div class="row">
+ <nav class="sidebar-nav hidden-md-down col-lg-3">
+ <!--
+
+ 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.
+
+-->
+
+
+<aside class="sidebar-nav">
+ <div id="sidebar-accordion" role="tablist" aria-multiselectable="true">
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-getting-started">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-getting-started" aria-controls="collapse-getting-started">
+ Getting started
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-getting-started" role="tabpanel" aria-labelledby="heading-getting-started">
+ <ul>
+
+
+ <li>
+ <a href="../../getting-started/Pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/LocalCluster">
+ Run Pulsar locally
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/docker">
+ Pulsar in Docker
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/Clients">
+ Client libraries
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/ConceptsAndArchitecture">
+ Concepts and architecture
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-functions">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-functions" aria-controls="collapse-pulsar-functions">
+ Pulsar Functions
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-functions" role="tabpanel" aria-labelledby="heading-pulsar-functions">
+ <ul>
+
+
+ <li>
+ <a href="../../functions/overview">
+ Pulsar Functions overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/quickstart">
+ Getting started with Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/api">
+ The Pulsar Functions API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/deployment">
+ Deploying Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/guarantees">
+ Processing guarantees
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/metrics">
+ Metrics for Pulsar Functions
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-deployment">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-deployment" aria-controls="collapse-deployment">
+ Deployment
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-deployment" role="tabpanel" aria-labelledby="heading-deployment">
+ <ul>
+
+
+ <li>
+ <a href="../../deployment/aws-cluster">
+ Deploy on Amazon Web Services
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/cluster">
+ Single cluster on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/instance">
+ Multi-cluster instance on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes">
+ Pulsar on Kubernetes
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-google-kubernetes-engine">
+ Pulsar on Google Kubernetes Engine
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-amazon-web-services">
+ Pulsar on AWS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/dcos">
+ Pulsar on DC/OS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Monitoring">
+ Monitoring
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-administration">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-administration" aria-controls="collapse-pulsar-administration">
+ Pulsar administration
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-administration" role="tabpanel" aria-labelledby="heading-pulsar-administration">
+ <ul>
+
+
+ <li>
+ <a href="../../admin/ZooKeeperBookKeeper">
+ ZooKeeper and BookKeeper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/GeoReplication">
+ Geo-replication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Authz">
+ Authentication and authorization
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Dashboard">
+ Dashboard
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Stats">
+ Pulsar statistics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/LoadDistribution">
+ Load distribution
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Proxy">
+ Pulsar proxy
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-client-libraries">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-client-libraries" aria-controls="collapse-client-libraries">
+ Client libraries
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-client-libraries" role="tabpanel" aria-labelledby="heading-client-libraries">
+ <ul>
+
+
+ <li>
+ <a href="../../clients/Java">
+ Java client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Cpp">
+ C++ client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Python">
+ Python client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/WebSocket">
+ WebSocket API
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-admin-api">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-admin-api" aria-controls="collapse-admin-api">
+ Admin API
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-admin-api" role="tabpanel" aria-labelledby="heading-admin-api">
+ <ul>
+
+
+ <li>
+ <a href="../../admin-api/overview">
+ Overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/clusters">
+ Clusters
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/tenants">
+ Tenants
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/brokers">
+ Brokers
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/namespaces">
+ Namespaces
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/permissions">
+ Permissions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/persistent-topics">
+ Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/non-persistent-topics">
+ Non-Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/partitioned-topics">
+ Partitioned topics
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-adaptors">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-adaptors" aria-controls="collapse-adaptors">
+ Adaptors
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-adaptors" role="tabpanel" aria-labelledby="heading-adaptors">
+ <ul>
+
+
+ <li>
+ <a href="../../adaptors/KafkaWrapper">
+ Apache Kafka client wrapper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarSpark">
+ Spark Streaming
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarStorm">
+ Apache Storm
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-cookbooks">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-cookbooks" aria-controls="collapse-cookbooks">
+ Cookbooks
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-cookbooks" role="tabpanel" aria-labelledby="heading-cookbooks">
+ <ul>
+
+
+ <li>
+ <a href="../../cookbooks/message-deduplication">
+ Message deduplication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/non-persistent-messaging">
+ Non-persistent messaging
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/PartitionedTopics">
+ Partitioned topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/RetentionExpiry">
+ Retention and expiry
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/Encryption">
+ Encryption
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/message-queue">
+ Using Pulsar as a message queue
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-developing-pulsar">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-developing-pulsar" aria-controls="collapse-developing-pulsar">
+ Developing Pulsar
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-developing-pulsar" role="tabpanel" aria-labelledby="heading-developing-pulsar">
+ <ul>
+
+
+ <li>
+ <a href="../../project/SimulationTools">
+ Simulation tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/BinaryProtocol">
+ Pulsar binary protocol
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/Codebase">
+ Codebase
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/schema-storage">
+ Custom schema storage
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-reference">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-reference" aria-controls="collapse-reference">
+ Reference
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-reference" role="tabpanel" aria-labelledby="heading-reference">
+ <ul>
+
+
+ <li>
+ <a href="../../reference/RestApi">
+ Pulsar REST API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/CliTools">
+ Command-line tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/Configuration">
+ Pulsar configuration
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+ </div>
+</aside>
+
+
+ </nav>
+
+ <article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
+ <section class="docs-header">
+ <h1 class="docs-title">
+ Pulsar adaptor for Apache Storm
+
+
+ </h1>
+
+ <section class="tags">
+
+ <!-- <span class="badge badge-pill badge-primary">storm</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-storm">storm</button>
+ <!--
+
+ 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="modal fade" id="modal-storm">
+ <div class="modal-dialog" role="document">
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title">Pages with the <strong>storm</strong> tag</h5>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/PulsarStorm/">Pulsar adaptor for Apache Storm</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ <!-- <span class="badge badge-pill badge-primary">java</span> -->
+ <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modal-java">java</button>
+ <!--
+
+ 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="modal fade" id="modal-java">
+ <div class="modal-dialog" role="document">
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title">Pages with the <strong>java</strong> tag</h5>
+ </div>
+ <div class="modal-body">
+ <ul>
+
+
+
+
+
+
+ <li><a href="/docs/latest/admin/Authz/">Authentication and authorization in Pulsar</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/clients/Java/">The Pulsar Java client</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/PulsarSpark/">Spark Streaming Pulsar receiver</a></li>
+
+
+
+
+
+ <li><a href="/docs/latest/adaptors/PulsarStorm/">Pulsar adaptor for Apache Storm</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/cookbooks/message-queue/">Using Pulsar as a message queue</a></li>
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/latest/admin-api/overview/">The Pulsar admin interface</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </section>
+
+ <!--
+
+ 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.
+
+-->
+
+<!--
+
+ 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="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
+</span>
+
+<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">
+ </section>
+
+ <section class="content">
+ <!--
+
+ 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>Pulsar Storm is an adaptor for integrating with <a href="http://storm.apache.org/">Apache Storm</a> topologies. It provides core Storm implementations for sending and receiving data.</p>
+
+<p>An application can inject data into a Storm topology via a generic Pulsar spout, as well as consume data from a Storm topology via a generic Pulsar bolt.</p>
+
+<h2 id="using-the-pulsar-storm-adaptor">Using the Pulsar Storm Adaptor</h2>
+
+<p>Include dependency for Pulsar Storm Adaptor:</p>
+
+<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.pulsar<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>pulsar-storm<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>${pulsar.version}<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+</code></pre></div></div>
+
+<h2 id="pulsar-spout">Pulsar Spout</h2>
+
+<p>The Pulsar Spout allows for the data published on 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 by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topic</span> to be consumed by a Storm topology. It emits a Storm tuple based on the message received and the <code class="highlighter-rouge">MessageToValuesMapper</code> provided by the client.</p>
+
+<p>The tuples that fail to be processed by the downstream bolts will be re-injected by the spout with an exponential backoff, within a configurable timeout (the default is 60 seconds) or a configurable number of retries, whichever comes first, after which it is <span class="popover-term" tabindex="0" title="What is an acknowledgement (ack)?" data-placement="top" data-content="A message sent to a Pulsar broker by a consumer that a message has been successfully processed. An acknowledgemen [...]
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">// Configure a Pulsar Client</span>
+<span class="n">ClientConfiguration</span> <span class="n">clientConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ClientConfiguration</span><span class="o">();</span>
+
+<span class="c1">// Configure a Pulsar Consumer</span>
+<span class="n">ConsumerConfiguration</span> <span class="n">consumerConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ConsumerConfiguration</span><span class="o">();</span>
+
+<span class="nd">@SuppressWarnings</span><span class="o">(</span><span class="s">"serial"</span><span class="o">)</span>
+<span class="n">MessageToValuesMapper</span> <span class="n">messageToValuesMapper</span> <span class="o">=</span> <span class="k">new</span> <span class="n">MessageToValuesMapper</span><span class="o">()</span> <span class="o">{</span>
+
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="n">Values</span> <span class="nf">toValues</span><span class="o">(</span><span class="n">Message</span> <span class="n">msg</span><span class="o">)</span> <span class="o">{</span>
+ <span class="k">return</span> <span class="k">new</span> <span class="nf">Values</span><span class="o">(</span><span class="k">new</span> <span class="n">String</span><span class="o">(</span><span class="n">msg</span><span class="o">.</span><span class="na">getData</span><span class="o">()));</span>
+ <span class="o">}</span>
+
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="kt">void</span> <span class="nf">declareOutputFields</span><span class="o">(</span><span class="n">OutputFieldsDeclarer</span> <span class="n">declarer</span><span class="o">)</span> <span class="o">{</span>
+ <span class="c1">// declare the output fields</span>
+ <span class="n">declarer</span><span class="o">.</span><span class="na">declare</span><span class="o">(</span><span class="k">new</span> <span class="n">Fields</span><span class="o">(</span><span class="s">"string"</span><span class="o">));</span>
+ <span class="o">}</span>
+<span class="o">};</span>
+
+<span class="c1">// Configure a Pulsar Spout</span>
+<span class="n">PulsarSpoutConfiguration</span> <span class="n">spoutConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PulsarSpoutConfiguration</span><span class="o">();</span>
+<span class="n">spoutConf</span><span class="o">.</span><span class="na">setServiceUrl</span><span class="o">(</span><span class="s">"pulsar://broker.messaging.usw.example.com:6650"</span><span class="o">);</span>
+<span class="n">spoutConf</span><span class="o">.</span><span class="na">setTopic</span><span class="o">(</span><span class="s">"persistent://my-property/usw/my-ns/my-topic1"</span><span class="o">);</span>
+<span class="n">spoutConf</span><span class="o">.</span><span class="na">setSubscriptionName</span><span class="o">(</span><span class="s">"my-subscriber-name1"</span><span class="o">);</span>
+<span class="n">spoutConf</span><span class="o">.</span><span class="na">setMessageToValuesMapper</span><span class="o">(</span><span class="n">messageToValuesMapper</span><span class="o">);</span>
+
+<span class="c1">// Create a Pulsar Spout</span>
+<span class="n">PulsarSpout</span> <span class="n">spout</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PulsarSpout</span><span class="o">(</span><span class="n">spoutConf</span><span class="o">,</span> <span class="n">clientConf</span><span class="o">,</span> <span class="n">consumerConf</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h2 id="pulsar-bolt">Pulsar Bolt</h2>
+
+<p>The Pulsar bolt allows data in a Storm topology to be published on 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 by producers to consumers who process those messages." data-toggle="popover" data-trigger="focus">topic</span>. It publishes messages based on the Storm tuple received and the <code class="highlighter-rouge">TupleToMessageMapper</code> provided by the client.</p>
+
+<p>A partitioned topic can also be used to publish messages on different topics. In the implementation of the <code class="highlighter-rouge">TupleToMessageMapper</code>, a “key” will need to be provided in the message which will send the messages with the same key to the same topic. Here’s an example bolt:</p>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">// Configure a Pulsar Client</span>
+<span class="n">ClientConfiguration</span> <span class="n">clientConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ClientConfiguration</span><span class="o">();</span>
+
+<span class="c1">// Configure a Pulsar Producer </span>
+<span class="n">ProducerConfiguration</span> <span class="n">producerConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ProducerConfiguration</span><span class="o">();</span>
+
+<span class="nd">@SuppressWarnings</span><span class="o">(</span><span class="s">"serial"</span><span class="o">)</span>
+<span class="n">TupleToMessageMapper</span> <span class="n">tupleToMessageMapper</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TupleToMessageMapper</span><span class="o">()</span> <span class="o">{</span>
+
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="n">Message</span> <span class="nf">toMessage</span><span class="o">(</span><span class="n">Tuple</span> <span class="n">tuple</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">String</span> <span class="n">receivedMessage</span> <span class="o">=</span> <span class="n">tuple</span><span class="o">.</span><span class="na">getString</span><span class="o">(</span><span class="mi">0</span><span class="o">);</span>
+ <span class="c1">// message processing</span>
+ <span class="n">String</span> <span class="n">processedMsg</span> <span class="o">=</span> <span class="n">receivedMessage</span> <span class="o">+</span> <span class="s">"-processed"</span><span class="o">;</span>
+ <span class="k">return</span> <span class="n">MessageBuilder</span><span class="o">.</span><span class="na">create</span><span class="o">().</span><span class="na">setContent</span><span class="o">(</span><span class="n">processedMsg</span><span class="o">.</span><span class="na">getBytes</span><span class="o">()).</span><span class="na">build</span><span class="o">();</span>
+ <span class="o">}</span>
+
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="kt">void</span> <span class="nf">declareOutputFields</span><span class="o">(</span><span class="n">OutputFieldsDeclarer</span> <span class="n">declarer</span><span class="o">)</span> <span class="o">{</span>
+ <span class="c1">// declare the output fields</span>
+ <span class="o">}</span>
+<span class="o">};</span>
+
+<span class="c1">// Configure a Pulsar Bolt</span>
+<span class="n">PulsarBoltConfiguration</span> <span class="n">boltConf</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PulsarBoltConfiguration</span><span class="o">();</span>
+<span class="n">boltConf</span><span class="o">.</span><span class="na">setServiceUrl</span><span class="o">(</span><span class="s">"pulsar://broker.messaging.usw.example.com:6650"</span><span class="o">);</span>
+<span class="n">boltConf</span><span class="o">.</span><span class="na">setTopic</span><span class="o">(</span><span class="s">"persistent://my-property/usw/my-ns/my-topic2"</span><span class="o">);</span>
+<span class="n">boltConf</span><span class="o">.</span><span class="na">setTupleToMessageMapper</span><span class="o">(</span><span class="n">tupleToMessageMapper</span><span class="o">);</span>
+
+<span class="c1">// Create a Pulsar Bolt</span>
+<span class="n">PulsarBolt</span> <span class="n">bolt</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PulsarBolt</span><span class="o">(</span><span class="n">boltConf</span><span class="o">,</span> <span class="n">clientConf</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h2 id="example">Example</h2>
+
+<p>You can find a complete example <a href="https://github.com/apache/incubator-pulsar/tree/master/pulsar-storm/src/test/java/org/apache/pulsar/storm/example/StormExample.java">here</a>.</p>
+
+ </section>
+ </article>
+
+ <nav class="toc-bar hidden-md-down col-lg-2">
+
+ <div id="toc">
+ <h4>Pulsar adaptor for Apache Storm</h4>
+ </div>
+
+ </nav>
+ </div>
+</div>
+
+ </main>
+ </main>
+
+ <!--
+
+ 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.
+
+-->
+<footer class="footer">
+ <div class="container">
+ <p class="text-center">Copyright 2018 The Apache Software Foundation. All Rights Reserved.</p>
+ <p class="text-center">Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </div>
+</footer>
+
+
+
+
+
+ <!--
+
+ 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.
+
+-->
+
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-102219959-1', 'auto');
+ ga('send', 'pageview');
+</script>
+
+
+
+ <script type="text/javascript">
+ var navbarOffset = -1 * (document.getElementsByClassName("navbar")[0].offsetHeight);
+ var shiftWindow = function() { scrollBy(0, navbarOffset) };
+ window.addEventListener("hashchange", shiftWindow);
+ window.addEventListener("pageshow", shiftWindow);
+ function load() { if (window.location.hash) shiftWindow(); }
+ </script>
+ </body>
+</html>
diff --git a/content/docs/v2.0.0-rc1-incubating/admin-api/brokers/index.html b/content/docs/v2.0.0-rc1-incubating/admin-api/brokers/index.html
new file mode 100644
index 0000000..82e21d4
--- /dev/null
+++ b/content/docs/v2.0.0-rc1-incubating/admin-api/brokers/index.html
@@ -0,0 +1,1192 @@
+<!DOCTYPE html>
+
+<!--
+
+ 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.
+
+-->
+
+<html>
+ <head>
+ <!--
+
+ 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.
+
+-->
+<title>Managing brokers</title>
+
+<meta charset="utf-8">
+
+<link rel="stylesheet" href="/css/style.css">
+<link rel="shortcut icon" href="/img/favicon.ico">
+
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
+<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"></script>
+<script src="/js/jquery.tocify.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
+
+<script src="/js/jquery.scrollTo.min.js"></script>
+<script async src="/js/main.js"></script>
+
+ </head>
+ <body class="body">
+ <main class="main">
+ <!--
+
+ 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.
+
+-->
+
+<nav class="navbar navbar-toggleable-md navbar-light sticky-top">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+
+ <a class="navbar-brand" href="/">
+ <img class="main-logo" src="/img/pulsar-logo.png" alt="Pulsar logo">
+ </a>
+
+
+ <a class="navbar-nav"></a>
+
+ <div class="collapse navbar-collapse justify-content-end" id="navbarNavDropdown">
+ <ul class="navbar-nav">
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
+
+ <div class="dropdown-menu" aria-labelledby="documentationDropdown">
+ <a class="dropdown-item" href="/docs/latest/getting-started/LocalCluster">Latest</a>
+
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Stable release</h3>
+ <a class="dropdown-item" href="/docs/v2.0.0-incubating/getting-started/LocalCluster">2.0.0-incubating</a>
+
+
+ <div class="dropdown-divider"></div>
+ <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>
+
+ <a class="dropdown-item" href="/docs/v1.19.0-incubating/getting-started/LocalCluster">1.19.0-incubating</a>
+
+
+ </div>
+ </li>
+
+ <li class="nav-item">
+ <a class="nav-link" href="/download">Download</a>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Client libraries
+ </a>
+ <div class="dropdown-menu" aria-labelledby="clientLibsDropdown">
+ <a class="dropdown-item" href="/docs/latest/clients/Java">
+ Java
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Python">
+ Python
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Cpp">
+ C++
+ </a>
+ <div class="dropdown-divider"></div>
+ <a class="dropdown-item" href="/api/client">
+ Java client Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/admin">
+ Java admin Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/pulsar-functions">
+ Pulsar Functions Java SDK
+ </a>
+ <a class="dropdown-item" href="/api/python">
+ Python API docs
+ </a>
+ <a class="dropdown-item" href="/api/cpp">
+ C++ API docs
+ </a>
+ </div>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="versionsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Community
+ </a>
+ <div class="dropdown-menu dropdown-left" aria-labelledby="versionsDropdown">
+ <h3 class="dropdown-header">Get in touch</h3>
+ <a class="dropdown-item" href="/contact">Contact</a>
+ <a class="dropdown-item" href="/events/current-event">Events</a>
+ <a class="dropdown-item" href="https://twitter.com/Apache_Pulsar">Twitter</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/wiki">Wiki</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/issues">Issue tracking</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Resources</h3>
+ <a class="dropdown-item" href="/resources">Resources</a>
+ <a class="dropdown-item" href="/team">Team</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Apache</h3>
+ <a class="dropdown-item" href="https://www.apache.org/">The Apache Software Foundation</a>
+ <a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="dropdown-item" href="https://www.apache.org/security">Security</a>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <a class="hidden-md-down" href="http://www.apache.org/">
+ <img class="asf-logo" title="Apache Software Foundation" src="/img/feather.png" />
+ </a>
+</nav>
+
+<!--
+<nav class="navbar navbar-toggleable-md navbar-light" style="border: 1px solid red;">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <a class="navbar-brand" href="/">
+ <img src="/img/pulsar-logo.png" class="d-inline-block align-top" alt="Pulsar logo" height="40" width="60">
+ </a>
+
+ <div class="collapse navbar-collapse" id="navbarSupportedContent">
+ <ul class="navbar-nav mr-auto">
+ <li class="nav-item active">
+ <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="#">Link</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link disabled" href="#">Disabled</a>
+ </li>
+ </ul>
+ </div>
+</nav>-->
+
+
+ <main>
+ <!--
+
+ 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="docs-container container-fluid">
+ <div class="row">
+ <nav class="sidebar-nav hidden-md-down col-lg-3">
+ <!--
+
+ 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.
+
+-->
+
+
+<aside class="sidebar-nav">
+ <div id="sidebar-accordion" role="tablist" aria-multiselectable="true">
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-getting-started">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-getting-started" aria-controls="collapse-getting-started">
+ Getting started
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-getting-started" role="tabpanel" aria-labelledby="heading-getting-started">
+ <ul>
+
+
+ <li>
+ <a href="../../getting-started/Pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/LocalCluster">
+ Run Pulsar locally
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/docker">
+ Pulsar in Docker
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/Clients">
+ Client libraries
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/ConceptsAndArchitecture">
+ Concepts and architecture
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-functions">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-functions" aria-controls="collapse-pulsar-functions">
+ Pulsar Functions
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-functions" role="tabpanel" aria-labelledby="heading-pulsar-functions">
+ <ul>
+
+
+ <li>
+ <a href="../../functions/overview">
+ Pulsar Functions overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/quickstart">
+ Getting started with Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/api">
+ The Pulsar Functions API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/deployment">
+ Deploying Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/guarantees">
+ Processing guarantees
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/metrics">
+ Metrics for Pulsar Functions
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-deployment">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-deployment" aria-controls="collapse-deployment">
+ Deployment
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-deployment" role="tabpanel" aria-labelledby="heading-deployment">
+ <ul>
+
+
+ <li>
+ <a href="../../deployment/aws-cluster">
+ Deploy on Amazon Web Services
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/cluster">
+ Single cluster on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/instance">
+ Multi-cluster instance on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes">
+ Pulsar on Kubernetes
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-google-kubernetes-engine">
+ Pulsar on Google Kubernetes Engine
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-amazon-web-services">
+ Pulsar on AWS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/dcos">
+ Pulsar on DC/OS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Monitoring">
+ Monitoring
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-administration">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-administration" aria-controls="collapse-pulsar-administration">
+ Pulsar administration
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-administration" role="tabpanel" aria-labelledby="heading-pulsar-administration">
+ <ul>
+
+
+ <li>
+ <a href="../../admin/ZooKeeperBookKeeper">
+ ZooKeeper and BookKeeper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/GeoReplication">
+ Geo-replication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Authz">
+ Authentication and authorization
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Dashboard">
+ Dashboard
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Stats">
+ Pulsar statistics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/LoadDistribution">
+ Load distribution
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Proxy">
+ Pulsar proxy
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-client-libraries">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-client-libraries" aria-controls="collapse-client-libraries">
+ Client libraries
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-client-libraries" role="tabpanel" aria-labelledby="heading-client-libraries">
+ <ul>
+
+
+ <li>
+ <a href="../../clients/Java">
+ Java client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Cpp">
+ C++ client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Python">
+ Python client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/WebSocket">
+ WebSocket API
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-admin-api">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-admin-api" aria-controls="collapse-admin-api">
+ Admin API
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-admin-api" role="tabpanel" aria-labelledby="heading-admin-api">
+ <ul>
+
+
+ <li>
+ <a href="../../admin-api/overview">
+ Overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/clusters">
+ Clusters
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/tenants">
+ Tenants
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/brokers">
+ Brokers
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/namespaces">
+ Namespaces
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/permissions">
+ Permissions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/persistent-topics">
+ Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/non-persistent-topics">
+ Non-Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/partitioned-topics">
+ Partitioned topics
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-adaptors">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-adaptors" aria-controls="collapse-adaptors">
+ Adaptors
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-adaptors" role="tabpanel" aria-labelledby="heading-adaptors">
+ <ul>
+
+
+ <li>
+ <a href="../../adaptors/KafkaWrapper">
+ Apache Kafka client wrapper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarSpark">
+ Spark Streaming
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarStorm">
+ Apache Storm
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-cookbooks">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-cookbooks" aria-controls="collapse-cookbooks">
+ Cookbooks
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-cookbooks" role="tabpanel" aria-labelledby="heading-cookbooks">
+ <ul>
+
+
+ <li>
+ <a href="../../cookbooks/message-deduplication">
+ Message deduplication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/non-persistent-messaging">
+ Non-persistent messaging
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/PartitionedTopics">
+ Partitioned topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/RetentionExpiry">
+ Retention and expiry
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/Encryption">
+ Encryption
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/message-queue">
+ Using Pulsar as a message queue
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-developing-pulsar">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-developing-pulsar" aria-controls="collapse-developing-pulsar">
+ Developing Pulsar
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-developing-pulsar" role="tabpanel" aria-labelledby="heading-developing-pulsar">
+ <ul>
+
+
+ <li>
+ <a href="../../project/SimulationTools">
+ Simulation tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/BinaryProtocol">
+ Pulsar binary protocol
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/Codebase">
+ Codebase
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/schema-storage">
+ Custom schema storage
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-reference">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-reference" aria-controls="collapse-reference">
+ Reference
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-reference" role="tabpanel" aria-labelledby="heading-reference">
+ <ul>
+
+
+ <li>
+ <a href="../../reference/RestApi">
+ Pulsar REST API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/CliTools">
+ Command-line tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/Configuration">
+ Pulsar configuration
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+ </div>
+</aside>
+
+
+ </nav>
+
+ <article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
+ <section class="docs-header">
+ <h1 class="docs-title">
+ Managing brokers
+
+
+ </h1>
+
+ <section class="tags">
+
+ </section>
+
+ <!--
+
+ 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.
+
+-->
+
+<!--
+
+ 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="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
+</span>
+
+<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">
+ </section>
+
+ <section class="content">
+ <!--
+
+ 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>Pulsar brokers consist of two components:</p>
+
+<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><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>
+
+<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>
+
+<p>In addition to being configurable when you start them up, brokers can also be <a href="#dynamic-broker-configuration">dynamically configured</a>.</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>See the <a href="../../reference/Configuration#broker">Configuration</a> page for a full listing of broker-specific configuration parameters.</p>
+
+ </div>
+</div>
+
+<h2 id="brokers-resources">Brokers resources</h2>
+
+<h3 id="list-active-brokers">List active brokers</h3>
+
+<p>Fetch all available active brokers that are serving traffic.</p>
+
+<h4 id="pulsar-admin">pulsar-admin</h4>
+
+<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>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>broker1.use.org.com:8080
+</code></pre></div></div>
+
+<h6 id="rest">REST</h6>
+
+<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><a href="../../reference/RestApi#/admin/brokers/:cluster">More info</a></p>
+
+<h6 id="java">Java</h6>
+
+<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>
+</code></pre></div></div>
+
+<h4 id="list-of-namespaces-owned-by-a-given-broker">list of namespaces owned by a given broker</h4>
+
+<p>It finds all namespaces which are owned and served by a given broker.</p>
+
+<h6 id="cli">CLI</h6>
+
+<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>
+
+<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>
+
+<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>
+
+<h6 id="java-1">Java</h6>
+
+<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>
+</code></pre></div></div>
+
+<h3 id="dynamic-broker-configuration">Dynamic broker configuration</h3>
+
+<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 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>
+ <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>
+
+<h3 id="update-dynamic-configuration">Update dynamic configuration</h3>
+
+<h4 id="pulsar-admin-1">pulsar-admin</h4>
+
+<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>
+
+<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>
+
+<h4 id="rest-api">REST API</h4>
+
+<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>
+
+<p><a href="../../reference/RestApi#/admin/brokers/configuration/:configName/:configValue">More info</a></p>
+
+<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>
+</code></pre></div></div>
+
+<h3 id="list-updated-values">List updated values</h3>
+
+<p>Fetch a list of all potentially updatable configuration parameters.</p>
+
+<h4 id="pulsar-admin-2">pulsar-admin</h4>
+
+<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>
+
+<h4 id="rest-api-1">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/brokers/configuration</code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/brokers/configuration">More info</a></p>
+
+<h4 id="java-3">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">getDynamicConfigurationNames</span><span class="o">();</span>
+</code></pre></div></div>
+
+<h3 id="list-all">List all</h3>
+
+<p>Fetch a list of all parameters that have been dynamically updated.</p>
+
+<h4 id="pulsar-admin-3">pulsar-admin</h4>
+
+<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
+</code></pre></div></div>
+
+<h4 id="rest-api-2">REST API</h4>
+
+<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><a href="../../reference/RestApi#/admin/brokers/configuration/values">More info</a></p>
+
+<h4 id="java-4">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">getAllDynamicConfigurations</span><span class="o">();</span>
+</code></pre></div></div>
+
+ </section>
+ </article>
+
+ <nav class="toc-bar hidden-md-down col-lg-2">
+
+ <div id="toc">
+ <h4>Managing brokers</h4>
+ </div>
+
+ </nav>
+ </div>
+</div>
+
+ </main>
+ </main>
+
+ <!--
+
+ 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.
+
+-->
+<footer class="footer">
+ <div class="container">
+ <p class="text-center">Copyright 2018 The Apache Software Foundation. All Rights Reserved.</p>
+ <p class="text-center">Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </div>
+</footer>
+
+
+
+
+
+ <!--
+
+ 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.
+
+-->
+
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-102219959-1', 'auto');
+ ga('send', 'pageview');
+</script>
+
+
+
+ <script type="text/javascript">
+ var navbarOffset = -1 * (document.getElementsByClassName("navbar")[0].offsetHeight);
+ var shiftWindow = function() { scrollBy(0, navbarOffset) };
+ window.addEventListener("hashchange", shiftWindow);
+ window.addEventListener("pageshow", shiftWindow);
+ function load() { if (window.location.hash) shiftWindow(); }
+ </script>
+ </body>
+</html>
diff --git a/content/docs/v2.0.0-rc1-incubating/admin-api/clusters/index.html b/content/docs/v2.0.0-rc1-incubating/admin-api/clusters/index.html
new file mode 100644
index 0000000..c65f929
--- /dev/null
+++ b/content/docs/v2.0.0-rc1-incubating/admin-api/clusters/index.html
@@ -0,0 +1,1277 @@
+<!DOCTYPE html>
+
+<!--
+
+ 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.
+
+-->
+
+<html>
+ <head>
+ <!--
+
+ 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.
+
+-->
+<title>Managing Clusters</title>
+
+<meta charset="utf-8">
+
+<link rel="stylesheet" href="/css/style.css">
+<link rel="shortcut icon" href="/img/favicon.ico">
+
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
+<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"></script>
+<script src="/js/jquery.tocify.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
+
+<script src="/js/jquery.scrollTo.min.js"></script>
+<script async src="/js/main.js"></script>
+
+ </head>
+ <body class="body">
+ <main class="main">
+ <!--
+
+ 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.
+
+-->
+
+<nav class="navbar navbar-toggleable-md navbar-light sticky-top">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+
+ <a class="navbar-brand" href="/">
+ <img class="main-logo" src="/img/pulsar-logo.png" alt="Pulsar logo">
+ </a>
+
+
+ <a class="navbar-nav"></a>
+
+ <div class="collapse navbar-collapse justify-content-end" id="navbarNavDropdown">
+ <ul class="navbar-nav">
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
+
+ <div class="dropdown-menu" aria-labelledby="documentationDropdown">
+ <a class="dropdown-item" href="/docs/latest/getting-started/LocalCluster">Latest</a>
+
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Stable release</h3>
+ <a class="dropdown-item" href="/docs/v2.0.0-incubating/getting-started/LocalCluster">2.0.0-incubating</a>
+
+
+ <div class="dropdown-divider"></div>
+ <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>
+
+ <a class="dropdown-item" href="/docs/v1.19.0-incubating/getting-started/LocalCluster">1.19.0-incubating</a>
+
+
+ </div>
+ </li>
+
+ <li class="nav-item">
+ <a class="nav-link" href="/download">Download</a>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Client libraries
+ </a>
+ <div class="dropdown-menu" aria-labelledby="clientLibsDropdown">
+ <a class="dropdown-item" href="/docs/latest/clients/Java">
+ Java
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Python">
+ Python
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Cpp">
+ C++
+ </a>
+ <div class="dropdown-divider"></div>
+ <a class="dropdown-item" href="/api/client">
+ Java client Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/admin">
+ Java admin Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/pulsar-functions">
+ Pulsar Functions Java SDK
+ </a>
+ <a class="dropdown-item" href="/api/python">
+ Python API docs
+ </a>
+ <a class="dropdown-item" href="/api/cpp">
+ C++ API docs
+ </a>
+ </div>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="versionsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Community
+ </a>
+ <div class="dropdown-menu dropdown-left" aria-labelledby="versionsDropdown">
+ <h3 class="dropdown-header">Get in touch</h3>
+ <a class="dropdown-item" href="/contact">Contact</a>
+ <a class="dropdown-item" href="/events/current-event">Events</a>
+ <a class="dropdown-item" href="https://twitter.com/Apache_Pulsar">Twitter</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/wiki">Wiki</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/issues">Issue tracking</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Resources</h3>
+ <a class="dropdown-item" href="/resources">Resources</a>
+ <a class="dropdown-item" href="/team">Team</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Apache</h3>
+ <a class="dropdown-item" href="https://www.apache.org/">The Apache Software Foundation</a>
+ <a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="dropdown-item" href="https://www.apache.org/security">Security</a>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <a class="hidden-md-down" href="http://www.apache.org/">
+ <img class="asf-logo" title="Apache Software Foundation" src="/img/feather.png" />
+ </a>
+</nav>
+
+<!--
+<nav class="navbar navbar-toggleable-md navbar-light" style="border: 1px solid red;">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <a class="navbar-brand" href="/">
+ <img src="/img/pulsar-logo.png" class="d-inline-block align-top" alt="Pulsar logo" height="40" width="60">
+ </a>
+
+ <div class="collapse navbar-collapse" id="navbarSupportedContent">
+ <ul class="navbar-nav mr-auto">
+ <li class="nav-item active">
+ <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="#">Link</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link disabled" href="#">Disabled</a>
+ </li>
+ </ul>
+ </div>
+</nav>-->
+
+
+ <main>
+ <!--
+
+ 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="docs-container container-fluid">
+ <div class="row">
+ <nav class="sidebar-nav hidden-md-down col-lg-3">
+ <!--
+
+ 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.
+
+-->
+
+
+<aside class="sidebar-nav">
+ <div id="sidebar-accordion" role="tablist" aria-multiselectable="true">
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-getting-started">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-getting-started" aria-controls="collapse-getting-started">
+ Getting started
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-getting-started" role="tabpanel" aria-labelledby="heading-getting-started">
+ <ul>
+
+
+ <li>
+ <a href="../../getting-started/Pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/LocalCluster">
+ Run Pulsar locally
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/docker">
+ Pulsar in Docker
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/Clients">
+ Client libraries
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/ConceptsAndArchitecture">
+ Concepts and architecture
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-functions">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-functions" aria-controls="collapse-pulsar-functions">
+ Pulsar Functions
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-functions" role="tabpanel" aria-labelledby="heading-pulsar-functions">
+ <ul>
+
+
+ <li>
+ <a href="../../functions/overview">
+ Pulsar Functions overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/quickstart">
+ Getting started with Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/api">
+ The Pulsar Functions API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/deployment">
+ Deploying Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/guarantees">
+ Processing guarantees
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/metrics">
+ Metrics for Pulsar Functions
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-deployment">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-deployment" aria-controls="collapse-deployment">
+ Deployment
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-deployment" role="tabpanel" aria-labelledby="heading-deployment">
+ <ul>
+
+
+ <li>
+ <a href="../../deployment/aws-cluster">
+ Deploy on Amazon Web Services
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/cluster">
+ Single cluster on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/instance">
+ Multi-cluster instance on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes">
+ Pulsar on Kubernetes
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-google-kubernetes-engine">
+ Pulsar on Google Kubernetes Engine
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-amazon-web-services">
+ Pulsar on AWS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/dcos">
+ Pulsar on DC/OS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Monitoring">
+ Monitoring
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-administration">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-administration" aria-controls="collapse-pulsar-administration">
+ Pulsar administration
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-administration" role="tabpanel" aria-labelledby="heading-pulsar-administration">
+ <ul>
+
+
+ <li>
+ <a href="../../admin/ZooKeeperBookKeeper">
+ ZooKeeper and BookKeeper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/GeoReplication">
+ Geo-replication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Authz">
+ Authentication and authorization
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Dashboard">
+ Dashboard
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Stats">
+ Pulsar statistics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/LoadDistribution">
+ Load distribution
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Proxy">
+ Pulsar proxy
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-client-libraries">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-client-libraries" aria-controls="collapse-client-libraries">
+ Client libraries
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-client-libraries" role="tabpanel" aria-labelledby="heading-client-libraries">
+ <ul>
+
+
+ <li>
+ <a href="../../clients/Java">
+ Java client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Cpp">
+ C++ client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Python">
+ Python client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/WebSocket">
+ WebSocket API
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-admin-api">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-admin-api" aria-controls="collapse-admin-api">
+ Admin API
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-admin-api" role="tabpanel" aria-labelledby="heading-admin-api">
+ <ul>
+
+
+ <li>
+ <a href="../../admin-api/overview">
+ Overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/clusters">
+ Clusters
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/tenants">
+ Tenants
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/brokers">
+ Brokers
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/namespaces">
+ Namespaces
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/permissions">
+ Permissions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/persistent-topics">
+ Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/non-persistent-topics">
+ Non-Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/partitioned-topics">
+ Partitioned topics
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-adaptors">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-adaptors" aria-controls="collapse-adaptors">
+ Adaptors
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-adaptors" role="tabpanel" aria-labelledby="heading-adaptors">
+ <ul>
+
+
+ <li>
+ <a href="../../adaptors/KafkaWrapper">
+ Apache Kafka client wrapper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarSpark">
+ Spark Streaming
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarStorm">
+ Apache Storm
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-cookbooks">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-cookbooks" aria-controls="collapse-cookbooks">
+ Cookbooks
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-cookbooks" role="tabpanel" aria-labelledby="heading-cookbooks">
+ <ul>
+
+
+ <li>
+ <a href="../../cookbooks/message-deduplication">
+ Message deduplication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/non-persistent-messaging">
+ Non-persistent messaging
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/PartitionedTopics">
+ Partitioned topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/RetentionExpiry">
+ Retention and expiry
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/Encryption">
+ Encryption
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/message-queue">
+ Using Pulsar as a message queue
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-developing-pulsar">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-developing-pulsar" aria-controls="collapse-developing-pulsar">
+ Developing Pulsar
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-developing-pulsar" role="tabpanel" aria-labelledby="heading-developing-pulsar">
+ <ul>
+
+
+ <li>
+ <a href="../../project/SimulationTools">
+ Simulation tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/BinaryProtocol">
+ Pulsar binary protocol
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/Codebase">
+ Codebase
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/schema-storage">
+ Custom schema storage
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-reference">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-reference" aria-controls="collapse-reference">
+ Reference
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-reference" role="tabpanel" aria-labelledby="heading-reference">
+ <ul>
+
+
+ <li>
+ <a href="../../reference/RestApi">
+ Pulsar REST API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/CliTools">
+ Command-line tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/Configuration">
+ Pulsar configuration
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+ </div>
+</aside>
+
+
+ </nav>
+
+ <article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
+ <section class="docs-header">
+ <h1 class="docs-title">
+ Managing Clusters
+
+
+ </h1>
+
+ <section class="tags">
+
+ </section>
+
+ <!--
+
+ 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.
+
+-->
+
+<!--
+
+ 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="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
+</span>
+
+<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">
+ </section>
+
+ <section class="content">
+ <!--
+
+ 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>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>
+
+<ul>
+ <li>The <a href="../../reference/CliTools#pulsar-admin-clusters"><code class="highlighter-rouge">clusters</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/clusters</code> endpoint of the admin <a href="../../reference/RestApi">REST API</a></li>
+ <li>The <code class="highlighter-rouge">clusters</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="clusters-resources">Clusters resources</h2>
+
+<h3 id="provision">Provision</h3>
+
+<p>New clusters can be provisioned using the admin interface.</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="warning">
+
+ <p>Please note that this operation requires <a href="../../admin/Authz#superusers">superuser</a> privileges.</p>
+
+ </div>
+</div>
+
+<h4 id="pulsar-admin">pulsar-admin</h4>
+
+<p>You can provision a new cluster using the <a href="../../reference/CliTools#pulsar-admin-clusters-create"><code class="highlighter-rouge">create</code></a> subcommand. Here’s an example:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin clusters create cluster-1 <span class="se">\</span>
+ <span class="nt">--url</span> http://my-cluster.org.com:8080 <span class="se">\</span>
+ <span class="nt">--broker-url</span> pulsar://my-cluster.org.com:6650
+</code></pre></div></div>
+
+<h4 id="rest-api">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method put">PUT</code><code class="url">/admin/clusters/<span class="endpoint">:cluster</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/clusters/:cluster">More info</a></p>
+
+<h4 id="java">Java</h4>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">ClusterData</span> <span class="n">clusterData</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ClusterData</span><span class="o">(</span>
+ <span class="n">serviceUrl</span><span class="o">,</span>
+ <span class="n">serviceUrlTls</span><span class="o">,</span>
+ <span class="n">brokerServiceUrl</span><span class="o">,</span>
+ <span class="n">brokerServiceUrlTls</span>
+<span class="o">);</span>
+<span class="n">admin</span><span class="o">.</span><span class="na">clusters</span><span class="o">().</span><span class="na">createCluster</span><span class="o">(</span><span class="n">clusterName</span><span class="o">,</span> <span class="n">clusterData</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="initialize-cluster-metadata">Initialize cluster metadata</h3>
+
+<p>When provision a new cluster, you need to initialize that cluster’s <a href="../../getting-started/ConceptsAndArchitecture#metadata-store">metadata</a>. When initializing cluster metadata, you need to specify all of the following:</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 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>
+
+<p>You must initialize cluster metadata <em>before</em> starting up any <a href="../brokers">brokers</a> that will belong to 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
+
+ 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="warning">
+ <span class="admonition-title"><p>No cluster metadata initialization through the REST API or the Java admin API</p>
+</span>
+
+<p>Unlike most other admin functions in Pulsar, cluster metadata initialization cannot be performed via the admin REST API or the admin Java client, as metadata initialization involves communicating with ZooKeeper directly. Instead, you can use the <a href="../../reference/CliTools#pulsar"><code class="highlighter-rouge">pulsar</code></a> CLI tool, in particular the <a href="../../reference/CliTools#pulsar-initialize-cluster-metadata"><code class="highlighter-rouge">initialize-cluster-me [...]
+
+ </div>
+</div>
+
+<p>Here’s an example cluster metadata initialization command:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>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">--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>
+ <span class="nt">--broker-service-url-tls</span> pulsar+ssl://pulsar.us-west.example.com:6651/
+</code></pre></div></div>
+
+<p>You’ll need to use <code class="highlighter-rouge">--*-tls</code> flags only if you’re using <a href="../../admin/Authz#tls-client-auth">TLS authentication</a> in your instance.</p>
+
+<h3 id="get-configuration">Get configuration</h3>
+
+<p>You can fetch the <a href="../../reference/Configuration">configuration</a> for an existing cluster at any time.</p>
+
+<h4 id="pulsar-admin-1">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-clusters-get"><code class="highlighter-rouge">get</code></a> subcommand and specify the name of the cluster. Here’s an example:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin clusters get cluster-1
+<span class="o">{</span>
+ <span class="s2">"serviceUrl"</span>: <span class="s2">"http://my-cluster.org.com:8080/"</span>,
+ <span class="s2">"serviceUrlTls"</span>: null,
+ <span class="s2">"brokerServiceUrl"</span>: <span class="s2">"pulsar://my-cluster.org.com:6650/"</span>,
+ <span class="s2">"brokerServiceUrlTls"</span>: null
+ <span class="s2">"peerClusterNames"</span>: null
+<span class="o">}</span>
+</code></pre></div></div>
+
+<h4 id="rest-api-1">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/clusters/<span class="endpoint">:cluster</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/clusters/:cluster">More info</a></p>
+
+<h4 id="java-1">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">clusters</span><span class="o">().</span><span class="na">getCluster</span><span class="o">(</span><span class="n">clusterName</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="update">Update</h3>
+
+<p>You can update the configuration for an existing cluster at any time.</p>
+
+<h4 id="pulsar-admin-2">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-clusters-update"><code class="highlighter-rouge">update</code></a> subcommand and specify new configuration values using flags.</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin clusters update cluster-1 <span class="se">\</span>
+ <span class="nt">--url</span> http://my-cluster.org.com:4081 <span class="se">\</span>
+ <span class="nt">--broker-url</span> pulsar://my-cluster.org.com:3350
+</code></pre></div></div>
+
+<h4 id="rest">REST</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method post">POST</code><code class="url">/admin/clusters/<span class="endpoint">:cluster</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/clusters/:cluster">More info</a></p>
+
+<h4 id="java-2">Java</h4>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">ClusterData</span> <span class="n">clusterData</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ClusterData</span><span class="o">(</span>
+ <span class="n">serviceUrl</span><span class="o">,</span>
+ <span class="n">serviceUrlTls</span><span class="o">,</span>
+ <span class="n">brokerServiceUrl</span><span class="o">,</span>
+ <span class="n">brokerServiceUrlTls</span>
+<span class="o">);</span>
+<span class="n">admin</span><span class="o">.</span><span class="na">clusters</span><span class="o">().</span><span class="na">updateCluster</span><span class="o">(</span><span class="n">clusterName</span><span class="o">,</span> <span class="n">clusterData</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="delete">Delete</h3>
+
+<p>Clusters can be deleted from a 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>.</p>
+
+<h4 id="pulsar-admin-3">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-clusters-delete"><code class="highlighter-rouge">delete</code></a> subcommand and specify the name of the cluster.</p>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin clusters delete cluster-1
+</code></pre></div></div>
+
+<h4 id="rest-api-2">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method delete">DELETE</code><code class="url">/admin/clusters/<span class="endpoint">:cluster</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/clusters/:cluster">More info</a></p>
+
+<h4 id="java-3">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">clusters</span><span class="o">().</span><span class="na">deleteCluster</span><span class="o">(</span><span class="n">clusterName</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="list">List</h3>
+
+<p>You can fetch a list of all clusters in a 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>.</p>
+
+<h4 id="pulsar-admin-4">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-clusters-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>pulsar-admin clusters list
+cluster-1
+cluster-2
+</code></pre></div></div>
+
+<h4 id="rest-api-3">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/clusters</code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/clusters">More info</a></p>
+
+<h6 id="java-4">Java</h6>
+
+<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">clusters</span><span class="o">().</span><span class="na">getClusters</span><span class="o">();</span>
+</code></pre></div></div>
+
+<h3 id="update-peer-cluster-data">Update peer-cluster data</h3>
+
+<p>Peer clusters can be configured for a given cluster in a 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>.</p>
+
+<h4 id="pulsar-admin-5">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-clusters-update-peer-clusters"><code class="highlighter-rouge">update-peer-clusters</code></a> subcommand and specify the list of peer-cluster names.</p>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin update-peer-clusters cluster-1 --peer-clusters cluster-2
+</code></pre></div></div>
+
+<h4 id="rest-api-4">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method post">POST</code><code class="url">/admin/clusters/<span class="endpoint">:cluster</span>/peers</code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/clusters/:cluster/peers">More info</a></p>
+
+<h4 id="java-5">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">clusters</span><span class="o">().</span><span class="na">updatePeerClusterNames</span><span class="o">(</span><span class="n">clusterName</span><span class="o">,</span> <span class="n">peerClusterList</span><span class="o">);</span>
+</code></pre></div></div>
+
+ </section>
+ </article>
+
+ <nav class="toc-bar hidden-md-down col-lg-2">
+
+ <div id="toc">
+ <h4>Managing Clusters</h4>
+ </div>
+
+ </nav>
+ </div>
+</div>
+
+ </main>
+ </main>
+
+ <!--
+
+ 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.
+
+-->
+<footer class="footer">
+ <div class="container">
+ <p class="text-center">Copyright 2018 The Apache Software Foundation. All Rights Reserved.</p>
+ <p class="text-center">Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </div>
+</footer>
+
+
+
+
+
+ <!--
+
+ 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.
+
+-->
+
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-102219959-1', 'auto');
+ ga('send', 'pageview');
+</script>
+
+
+
+ <script type="text/javascript">
+ var navbarOffset = -1 * (document.getElementsByClassName("navbar")[0].offsetHeight);
+ var shiftWindow = function() { scrollBy(0, navbarOffset) };
+ window.addEventListener("hashchange", shiftWindow);
+ window.addEventListener("pageshow", shiftWindow);
+ function load() { if (window.location.hash) shiftWindow(); }
+ </script>
+ </body>
+</html>
diff --git a/content/docs/v2.0.0-rc1-incubating/admin-api/namespaces/index.html b/content/docs/v2.0.0-rc1-incubating/admin-api/namespaces/index.html
new file mode 100644
index 0000000..bd58c76
--- /dev/null
+++ b/content/docs/v2.0.0-rc1-incubating/admin-api/namespaces/index.html
@@ -0,0 +1,1607 @@
+<!DOCTYPE html>
+
+<!--
+
+ 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.
+
+-->
+
+<html>
+ <head>
+ <!--
+
+ 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.
+
+-->
+<title>Managing namespaces</title>
+
+<meta charset="utf-8">
+
+<link rel="stylesheet" href="/css/style.css">
+<link rel="shortcut icon" href="/img/favicon.ico">
+
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
+<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"></script>
+<script src="/js/jquery.tocify.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
+
+<script src="/js/jquery.scrollTo.min.js"></script>
+<script async src="/js/main.js"></script>
+
+ </head>
+ <body class="body">
+ <main class="main">
+ <!--
+
+ 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.
+
+-->
+
+<nav class="navbar navbar-toggleable-md navbar-light sticky-top">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+
+ <a class="navbar-brand" href="/">
+ <img class="main-logo" src="/img/pulsar-logo.png" alt="Pulsar logo">
+ </a>
+
+
+ <a class="navbar-nav"></a>
+
+ <div class="collapse navbar-collapse justify-content-end" id="navbarNavDropdown">
+ <ul class="navbar-nav">
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
+
+ <div class="dropdown-menu" aria-labelledby="documentationDropdown">
+ <a class="dropdown-item" href="/docs/latest/getting-started/LocalCluster">Latest</a>
+
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Stable release</h3>
+ <a class="dropdown-item" href="/docs/v2.0.0-incubating/getting-started/LocalCluster">2.0.0-incubating</a>
+
+
+ <div class="dropdown-divider"></div>
+ <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>
+
+ <a class="dropdown-item" href="/docs/v1.19.0-incubating/getting-started/LocalCluster">1.19.0-incubating</a>
+
+
+ </div>
+ </li>
+
+ <li class="nav-item">
+ <a class="nav-link" href="/download">Download</a>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="clientLibsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Client libraries
+ </a>
+ <div class="dropdown-menu" aria-labelledby="clientLibsDropdown">
+ <a class="dropdown-item" href="/docs/latest/clients/Java">
+ Java
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Python">
+ Python
+ </a>
+ <a class="dropdown-item" href="/docs/latest/clients/Cpp">
+ C++
+ </a>
+ <div class="dropdown-divider"></div>
+ <a class="dropdown-item" href="/api/client">
+ Java client Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/admin">
+ Java admin Javadoc
+ </a>
+ <a class="dropdown-item" href="/api/pulsar-functions">
+ Pulsar Functions Java SDK
+ </a>
+ <a class="dropdown-item" href="/api/python">
+ Python API docs
+ </a>
+ <a class="dropdown-item" href="/api/cpp">
+ C++ API docs
+ </a>
+ </div>
+ </li>
+
+ <li class="nav-item dropdown">
+ <a class="nav-link dropdown-toggle" href="#" id="versionsDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ Community
+ </a>
+ <div class="dropdown-menu dropdown-left" aria-labelledby="versionsDropdown">
+ <h3 class="dropdown-header">Get in touch</h3>
+ <a class="dropdown-item" href="/contact">Contact</a>
+ <a class="dropdown-item" href="/events/current-event">Events</a>
+ <a class="dropdown-item" href="https://twitter.com/Apache_Pulsar">Twitter</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/wiki">Wiki</a>
+ <a class="dropdown-item" href="https://github.com/apache/incubator-pulsar/issues">Issue tracking</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Resources</h3>
+ <a class="dropdown-item" href="/resources">Resources</a>
+ <a class="dropdown-item" href="/team">Team</a>
+ <div class="dropdown-divider"></div>
+ <h3 class="dropdown-header">Apache</h3>
+ <a class="dropdown-item" href="https://www.apache.org/">The Apache Software Foundation</a>
+ <a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="dropdown-item" href="https://www.apache.org/security">Security</a>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <a class="hidden-md-down" href="http://www.apache.org/">
+ <img class="asf-logo" title="Apache Software Foundation" src="/img/feather.png" />
+ </a>
+</nav>
+
+<!--
+<nav class="navbar navbar-toggleable-md navbar-light" style="border: 1px solid red;">
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <a class="navbar-brand" href="/">
+ <img src="/img/pulsar-logo.png" class="d-inline-block align-top" alt="Pulsar logo" height="40" width="60">
+ </a>
+
+ <div class="collapse navbar-collapse" id="navbarSupportedContent">
+ <ul class="navbar-nav mr-auto">
+ <li class="nav-item active">
+ <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="#">Link</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link disabled" href="#">Disabled</a>
+ </li>
+ </ul>
+ </div>
+</nav>-->
+
+
+ <main>
+ <!--
+
+ 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="docs-container container-fluid">
+ <div class="row">
+ <nav class="sidebar-nav hidden-md-down col-lg-3">
+ <!--
+
+ 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.
+
+-->
+
+
+<aside class="sidebar-nav">
+ <div id="sidebar-accordion" role="tablist" aria-multiselectable="true">
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-getting-started">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-getting-started" aria-controls="collapse-getting-started">
+ Getting started
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-getting-started" role="tabpanel" aria-labelledby="heading-getting-started">
+ <ul>
+
+
+ <li>
+ <a href="../../getting-started/Pulsar-2.0">
+ Pulsar 2.0
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/LocalCluster">
+ Run Pulsar locally
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/docker">
+ Pulsar in Docker
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/Clients">
+ Client libraries
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../getting-started/ConceptsAndArchitecture">
+ Concepts and architecture
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-functions">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-functions" aria-controls="collapse-pulsar-functions">
+ Pulsar Functions
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-functions" role="tabpanel" aria-labelledby="heading-pulsar-functions">
+ <ul>
+
+
+ <li>
+ <a href="../../functions/overview">
+ Pulsar Functions overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/quickstart">
+ Getting started with Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/api">
+ The Pulsar Functions API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/deployment">
+ Deploying Pulsar Functions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/guarantees">
+ Processing guarantees
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../functions/metrics">
+ Metrics for Pulsar Functions
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-deployment">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-deployment" aria-controls="collapse-deployment">
+ Deployment
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-deployment" role="tabpanel" aria-labelledby="heading-deployment">
+ <ul>
+
+
+ <li>
+ <a href="../../deployment/aws-cluster">
+ Deploy on Amazon Web Services
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/cluster">
+ Single cluster on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/instance">
+ Multi-cluster instance on bare metal
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes">
+ Pulsar on Kubernetes
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-google-kubernetes-engine">
+ Pulsar on Google Kubernetes Engine
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Kubernetes/#pulsar-on-amazon-web-services">
+ Pulsar on AWS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/dcos">
+ Pulsar on DC/OS
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../deployment/Monitoring">
+ Monitoring
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-pulsar-administration">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-pulsar-administration" aria-controls="collapse-pulsar-administration">
+ Pulsar administration
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-pulsar-administration" role="tabpanel" aria-labelledby="heading-pulsar-administration">
+ <ul>
+
+
+ <li>
+ <a href="../../admin/ZooKeeperBookKeeper">
+ ZooKeeper and BookKeeper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/GeoReplication">
+ Geo-replication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Authz">
+ Authentication and authorization
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Dashboard">
+ Dashboard
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Stats">
+ Pulsar statistics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/LoadDistribution">
+ Load distribution
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin/Proxy">
+ Pulsar proxy
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-client-libraries">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-client-libraries" aria-controls="collapse-client-libraries">
+ Client libraries
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-client-libraries" role="tabpanel" aria-labelledby="heading-client-libraries">
+ <ul>
+
+
+ <li>
+ <a href="../../clients/Java">
+ Java client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Cpp">
+ C++ client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/Python">
+ Python client
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../clients/WebSocket">
+ WebSocket API
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-admin-api">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-admin-api" aria-controls="collapse-admin-api">
+ Admin API
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-admin-api" role="tabpanel" aria-labelledby="heading-admin-api">
+ <ul>
+
+
+ <li>
+ <a href="../../admin-api/overview">
+ Overview
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/clusters">
+ Clusters
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/tenants">
+ Tenants
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/brokers">
+ Brokers
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/namespaces">
+ Namespaces
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/permissions">
+ Permissions
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/persistent-topics">
+ Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/non-persistent-topics">
+ Non-Persistent topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../admin-api/partitioned-topics">
+ Partitioned topics
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-adaptors">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-adaptors" aria-controls="collapse-adaptors">
+ Adaptors
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-adaptors" role="tabpanel" aria-labelledby="heading-adaptors">
+ <ul>
+
+
+ <li>
+ <a href="../../adaptors/KafkaWrapper">
+ Apache Kafka client wrapper
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarSpark">
+ Spark Streaming
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../adaptors/PulsarStorm">
+ Apache Storm
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-cookbooks">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-cookbooks" aria-controls="collapse-cookbooks">
+ Cookbooks
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-cookbooks" role="tabpanel" aria-labelledby="heading-cookbooks">
+ <ul>
+
+
+ <li>
+ <a href="../../cookbooks/message-deduplication">
+ Message deduplication
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/non-persistent-messaging">
+ Non-persistent messaging
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/PartitionedTopics">
+ Partitioned topics
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/RetentionExpiry">
+ Retention and expiry
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/Encryption">
+ Encryption
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../cookbooks/message-queue">
+ Using Pulsar as a message queue
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-developing-pulsar">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-developing-pulsar" aria-controls="collapse-developing-pulsar">
+ Developing Pulsar
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-developing-pulsar" role="tabpanel" aria-labelledby="heading-developing-pulsar">
+ <ul>
+
+
+ <li>
+ <a href="../../project/SimulationTools">
+ Simulation tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/BinaryProtocol">
+ Pulsar binary protocol
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/Codebase">
+ Codebase
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/schema-storage">
+ Custom schema storage
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../project/ModularLoadManager">
+ Modular load manager
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ <div class="card">
+ <div class="card-header" role="tab" id="heading-reference">
+ <h5>
+ <a data-toggle="collapse" data-parent="#sidebar-accordion" href="#collapse-reference" aria-controls="collapse-reference">
+ Reference
+ </a>
+ </h5>
+ </div>
+
+ <div class="sidebar-group collapse" id="collapse-reference" role="tabpanel" aria-labelledby="heading-reference">
+ <ul>
+
+
+ <li>
+ <a href="../../reference/RestApi">
+ Pulsar REST API
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/CliTools">
+ Command-line tools
+ </a>
+ </li>
+
+
+ <li>
+ <a href="../../reference/Configuration">
+ Pulsar configuration
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+ </div>
+</aside>
+
+
+ </nav>
+
+ <article class="col-xs-12 col-sm-12 col-md-12 col-lg-7">
+ <section class="docs-header">
+ <h1 class="docs-title">
+ Managing namespaces
+
+
+ </h1>
+
+ <section class="tags">
+
+ </section>
+
+ <!--
+
+ 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.
+
+-->
+
+<!--
+
+ 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="success">
+ <span class="admonition-title"><p>Pulsar version 2.0</p>
+</span>
+
+<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">
+ </section>
+
+ <section class="content">
+ <!--
+
+ 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>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> are logical groupings of <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">topi [...]
+
+<p>Namespaces can be managed via:</p>
+
+<ul>
+ <li>The <a href="../../reference/CliTools#pulsar-admin-clusters"><code class="highlighter-rouge">namespaces</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/namespaces</code> endpoint of the admin <a href="../../reference/RestApi">REST API</a></li>
+ <li>The <code class="highlighter-rouge">namespaces</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="../../applications/JavaClient">Java API</a></li>
+</ul>
+
+<h2 id="namespaces-resources">Namespaces resources</h2>
+
+<h3 id="create">Create</h3>
+
+<p>You can create new namespaces under a given <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> and within a 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 o [...]
+
+<h4 id="pulsar-admin">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-namespaces-create"><code class="highlighter-rouge">create</code></a> subcommand and specify the namespace by name:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin namespaces create test-property/cl1/ns1
+</code></pre></div></div>
+
+<h4 id="rest-api">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method put">PUT</code><code class="url">/admin/namespaces/<span class="endpoint">:property</span>/<span class="endpoint">:cluster</span>/<span class="endpoint">:namespace</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace">More info</a></p>
+
+<h4 id="java">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">namespaces</span><span class="o">().</span><span class="na">createNamespace</span><span class="o">(</span><span class="n">namespace</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="get-policies">Get policies</h3>
+
+<p>You can fetch the current policies associated with a namespace at any time.</p>
+
+<h4 id="pulsar-admin-1">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-namespaces-policies"><code class="highlighter-rouge">policies</code></a> subcommand and specify the namespace:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin namespaces policies test-property/cl1/ns1
+<span class="o">{</span>
+ <span class="s2">"auth_policies"</span>: <span class="o">{</span>
+ <span class="s2">"namespace_auth"</span>: <span class="o">{}</span>,
+ <span class="s2">"destination_auth"</span>: <span class="o">{}</span>
+ <span class="o">}</span>,
+ <span class="s2">"replication_clusters"</span>: <span class="o">[]</span>,
+ <span class="s2">"bundles_activated"</span>: <span class="nb">true</span>,
+ <span class="s2">"bundles"</span>: <span class="o">{</span>
+ <span class="s2">"boundaries"</span>: <span class="o">[</span>
+ <span class="s2">"0x00000000"</span>,
+ <span class="s2">"0xffffffff"</span>
+ <span class="o">]</span>,
+ <span class="s2">"numBundles"</span>: 1
+ <span class="o">}</span>,
+ <span class="s2">"backlog_quota_map"</span>: <span class="o">{}</span>,
+ <span class="s2">"persistence"</span>: null,
+ <span class="s2">"latency_stats_sample_rate"</span>: <span class="o">{}</span>,
+ <span class="s2">"message_ttl_in_seconds"</span>: 0,
+ <span class="s2">"retention_policies"</span>: null,
+ <span class="s2">"deleted"</span>: <span class="nb">false</span>
+<span class="o">}</span>
+</code></pre></div></div>
+
+<h4 id="rest-api-1">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/namespaces/<span class="endpoint">:property</span>/<span class="endpoint">:cluster</span>/<span class="endpoint">:namespace</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace">More info</a></p>
+
+<h4 id="java-1">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">namespaces</span><span class="o">().</span><span class="na">getPolicies</span><span class="o">(</span><span class="n">namespace</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="list-namespaces-within-a-property">List namespaces within a property</h3>
+
+<p>You can list all namespaces within a given Pulsar <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>.</p>
+
+<h4 id="pulsar-admin-2">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-namespaces-list"><code class="highlighter-rouge">list</code></a> subcommand and specify the property:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin namespaces list test-property
+test-property/cl1/ns1
+test-property/cl2/ns2
+</code></pre></div></div>
+
+<h4 id="rest-api-2">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/namespaces/<span class="endpoint">:property</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/namespaces/:property">More info</a></p>
+
+<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">namespaces</span><span class="o">().</span><span class="na">getNamespaces</span><span class="o">(</span><span class="n">property</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="list-namespaces-within-a-cluster">List namespaces within a cluster</h3>
+
+<p>You can list all namespaces within a given 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>
+
+<h4 id="pulsar-admin-3">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-namespaces-list-cluster"><code class="highlighter-rouge">list-cluster</code></a> subcommand and specify the cluster:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin namespaces list-cluster test-property/cl1
+test-property/cl1/ns1
+test-property/cl1/ns1
+</code></pre></div></div>
+
+<h4 id="rest-api-3">REST API</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method get">GET</code><code class="url">/admin/namespaces/<span class="endpoint">:property</span>/<span class="endpoint">:cluster</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/namespaces/:property/:cluster">More info</a></p>
+
+<h4 id="java-3">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">namespaces</span><span class="o">().</span><span class="na">getNamespaces</span><span class="o">(</span><span class="n">property</span><span class="o">,</span> <span class="n">cluster</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h3 id="delete">Delete</h3>
+
+<p>You can delete existing namespaces from a property/cluster.</p>
+
+<h4 id="pulsar-admin-4">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-namespaces-delete"><code class="highlighter-rouge">delete</code></a> subcommand and specify the namespace:</p>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin namespaces delete test-property/cl1/ns1
+</code></pre></div></div>
+
+<h4 id="rest">REST</h4>
+
+<div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method delete">DELETE</code><code class="url">/admin/namespaces/<span class="endpoint">:property</span>/<span class="endpoint">:cluster</span>/<span class="endpoint">:namespace</span></code></pre></div>
+
+<p><a href="../../reference/RestApi#/admin/namespaces/:property/:cluster/:namespace">More info</a></p>
+
+<h4 id="java-4">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">namespaces</span><span class="o">().</span><span class="na">deleteNamespace</span><span class="o">(</span><span class="n">namespace</span><span class="o">);</span>
+</code></pre></div></div>
+
+<h4 id="set-replication-cluster">set replication cluster</h4>
+
+<p>It sets replication clusters for a namespace, so Pulsar can internally replicate publish message from one colo to another colo. However, in order to set replication clusters, your namespace has to be global such as: <em>test-property/<strong>global</strong>/ns1.</em> It means cluster-name has to be <em>“global”</em></p>
+
+<h6 id="cli">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces set-clusters test-property/cl1/ns1 \
+ --clusters cl2
+</code></pre></div></div>
+
+<h6 id="rest-1">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code><div class="highlighter-rouge endpoint"><pre class="highlight"><code class="method post">POST</code><code class="url">/admin/namespaces/<span class="endpoint">:property</span>/<span class="endpoint">:cluster</span>/<span class="endpoint">:namespace</span>/replication</code></pre></div>
+</code></pre></div></div>
+
+<h6 id="java-5">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">setNamespaceReplicationClusters</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="n">clusters</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="get-replication-cluster">get replication cluster</h4>
+
+<p>It gives a list of replication clusters for a given namespace.</p>
+
+<h6 id="cli-1">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces get-clusters test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cl2
+</code></pre></div></div>
+
+<h6 id="rest-2">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>GET /admin/namespaces/{property}/{cluster}/{namespace}/replication
+</code></pre></div></div>
+
+<h6 id="java-6">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">getNamespaceReplicationClusters</span><span class="o">(</span><span class="n">namespace</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="set-backlog-quota-policies">set backlog quota policies</h4>
+
+<p>Backlog quota helps broker to restrict bandwidth/storage of a namespace once it reach certain threshold limit . Admin can set this limit and one of the following action after the limit is reached.</p>
+
+<ol>
+ <li>
+ <p>producer_request_hold: broker will hold and not persist produce request payload</p>
+ </li>
+ <li>
+ <p>producer_exception: broker will disconnects with client by giving exception</p>
+ </li>
+ <li>
+ <p>consumer_backlog_eviction: broker will start discarding backlog messages</p>
+ </li>
+</ol>
+
+<p>Backlog quota restriction can be taken care by defining restriction of backlog-quota-type: destination_storage</p>
+
+<h6 id="cli-2">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces set-backlog-quota --limit 10 --policy producer_request_hold test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-3">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>POST /admin/namespaces/{property}/{cluster}/{namespace}/backlogQuota
+</code></pre></div></div>
+
+<h6 id="java-7">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">setBacklogQuota</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="k">new</span> <span class="n">BacklogQuota</span><span class="o">(</span><span class="n">limit</span><span class="o">,</span> <span class="n">policy</ [...]
+</code></pre></div></div>
+
+<h4 id="get-backlog-quota-policies">get backlog quota policies</h4>
+
+<p>It shows a configured backlog quota for a given namespace.</p>
+
+<h6 id="cli-3">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces get-backlog-quotas test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
+ </span><span class="s2">"destination_storage"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+ </span><span class="s2">"limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w">
+ </span><span class="s2">"policy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"producer_request_hold"</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-4">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>GET /admin/namespaces/{property}/{cluster}/{namespace}/backlogQuotaMap
+</code></pre></div></div>
+
+<h6 id="java-8">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">getBacklogQuotaMap</span><span class="o">(</span><span class="n">namespace</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="remove-backlog-quota-policies">remove backlog quota policies</h4>
+
+<p>It removes backlog quota policies for a given namespace</p>
+
+<h6 id="cli-4">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces remove-backlog-quota test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-5">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>DELETE /admin/namespaces/{property}/{cluster}/{namespace}/backlogQuota
+</code></pre></div></div>
+
+<h6 id="java-9">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">removeBacklogQuota</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="n">backlogQuotaType</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="set-persistence-policies">set persistence policies</h4>
+
+<p>Persistence policies allow to configure persistency-level for all topic messages under a given namespace.</p>
+
+<ul>
+ <li>
+ <p>Bookkeeper-ack-quorum: Number of acks (guaranteed copies) to wait for each entry, default: 0</p>
+ </li>
+ <li>
+ <p>Bookkeeper-ensemble: Number of bookies to use for a topic, default: 0</p>
+ </li>
+ <li>
+ <p>Bookkeeper-write-quorum: How many writes to make of each entry, default: 0</p>
+ </li>
+ <li>
+ <p>Ml-mark-delete-max-rate: Throttling rate of mark-delete operation (0 means no throttle), default: 0.0</p>
+ </li>
+</ul>
+
+<h6 id="cli-5">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces set-persistence --bookkeeper-ack-quorum 2 --bookkeeper-ensemble 3 --bookkeeper-write-quorum 2 --ml-mark-delete-max-rate 0 test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-6">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>POST /admin/persistent/{property}/{cluster}/{namespace}/persistence
+</code></pre></div></div>
+
+<h6 id="java-10">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">setPersistence</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span><span class="k">new</span> <span class="n">PersistencePolicies</span><span class="o">(</span><span class="n">bookkeeperEnsemble</span><span class="o">,</span> <span [...]
+</code></pre></div></div>
+
+<h4 id="get-persistence-policies">get persistence policies</h4>
+
+<p>It shows configured persistence policies of a given namespace.</p>
+
+<h6 id="cli-6">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces get-persistence test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
+ </span><span class="s2">"bookkeeperEnsemble"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
+ </span><span class="s2">"bookkeeperWriteQuorum"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
+ </span><span class="s2">"bookkeeperAckQuorum"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
+ </span><span class="s2">"managedLedgerMaxMarkDeleteRate"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
+</span><span class="p">}</span><span class="w">
+</span></code></pre></div></div>
+
+<h6 id="rest-7">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>GET /admin/namespaces/{property}/{cluster}/{namespace}/persistence
+</code></pre></div></div>
+
+<h6 id="java-11">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">getPersistence</span><span class="o">(</span><span class="n">namespace</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="unload-namespace-bundle">unload namespace bundle</h4>
+
+<p>Namespace bundle is a virtual group of topics which belong to same namespace. If broker gets overloaded with number of bundles then this command can help to unload heavy bundle from that broker, so it can be served by some other less loaded broker. Namespace bundle is defined with it’s start and end range such as 0x00000000 and 0xffffffff.</p>
+
+<h6 id="cli-7">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces unload --bundle 0x00000000_0xffffffff test-property/pstg-gq1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-8">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>PUT /admin/namespaces/{property}/{cluster}/{namespace}/unload
+</code></pre></div></div>
+
+<h6 id="java-12">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">unloadNamespaceBundle</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="n">bundle</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="set-message-ttl">set message-ttl</h4>
+
+<p>It configures message’s time to live (in seconds) duration.</p>
+
+<h6 id="cli-8">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces set-message-ttl --messageTTL 100 test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-9">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>POST /admin/namespaces/{property}/{cluster}/{namespace}/messageTTL
+</code></pre></div></div>
+
+<h6 id="java-13">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">setNamespaceMessageTTL</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="n">messageTTL</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="get-message-ttl">get message-ttl</h4>
+
+<p>It gives a message ttl of configured namespace.</p>
+
+<h6 id="cli-9">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces get-message-ttl test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>100
+</code></pre></div></div>
+
+<h6 id="rest-10">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>GET /admin/namespaces/{property}/{cluster}/{namespace}/messageTTL
+</code></pre></div></div>
+
+<h6 id="java-14">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">getNamespaceReplicationClusters</span><span class="o">(</span><span class="n">namespace</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="split-bundle">split bundle</h4>
+
+<p>Each namespace bundle can contain multiple topics and each bundle can be served by only one broker. If bundle gets heavy with multiple live topics in it then it creates load on that broker and in order to resolve this issue, admin can split bundle using this command.</p>
+
+<h6 id="cli-10">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-11">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>PUT /admin/namespaces/{property}/{cluster}/{namespace}/{bundle}/split
+</code></pre></div></div>
+
+<h6 id="java-15">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">splitNamespaceBundle</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="n">bundle</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="clear-backlog">clear backlog</h4>
+
+<p>It clears all message backlog for all the topics those belong to specific namespace. You can also clear backlog for a specific subscription as well.</p>
+
+<h6 id="cli-11">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces clear-backlog --sub my-subscription test-property/pstg-gq1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-12">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>POST /admin/namespaces/{property}/{cluster}/{namespace}/clearBacklog
+</code></pre></div></div>
+
+<h6 id="java-16">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">clearNamespaceBacklogForSubscription</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="n">subscription</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="clear-bundle-backlog">clear bundle backlog</h4>
+
+<p>It clears all message backlog for all the topics those belong to specific NamespaceBundle. You can also clear backlog for a specific subscription as well.</p>
+
+<h6 id="cli-12">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces clear-backlog --bundle 0x00000000_0xffffffff --sub my-subscription test-property/pstg-gq1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-13">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>POST /admin/namespaces/{property}/{cluster}/{namespace}/{bundle}/clearBacklog
+</code></pre></div></div>
+
+<h6 id="java-17">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">clearNamespaceBundleBacklogForSubscription</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="n">bundle</span><span class="o">,</span> <span class="n">subscription</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="set-retention">set retention</h4>
+
+<p>Each namespace contains multiple topics and each topic’s retention size (storage size) should not exceed to a specific threshold or it should be stored till certain time duration. This command helps to configure retention size and time of topics in a given namespace.</p>
+
+<h6 id="cli-13">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin set-retention --size 10 --time 100 test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>N/A
+</code></pre></div></div>
+
+<h6 id="rest-14">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>POST /admin/namespaces/{property}/{cluster}/{namespace}/retention
+</code></pre></div></div>
+
+<h6 id="java-18">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">setRetention</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="k">new</span> <span class="n">RetentionPolicies</span><span class="o">(</span><span class="n">retentionTimeInMin</span><span class="o">,</span> <span cla [...]
+</code></pre></div></div>
+
+<h4 id="get-retention">get retention</h4>
+
+<p>It shows retention information of a given namespace.</p>
+
+<h6 id="cli-14">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces get-retention test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
+ </span><span class="s2">"retentionTimeInMinutes"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w">
+ </span><span class="s2">"retentionSizeInMB"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="w">
+</span><span class="p">}</span><span class="w">
+</span></code></pre></div></div>
+
+<h6 id="rest-15">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>GET /admin/namespaces/{property}/{cluster}/{namespace}/retention
+</code></pre></div></div>
+
+<h6 id="java-19">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">getRetention</span><span class="o">(</span><span class="n">namespace</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="set-dispatch-throttling">set dispatch throttling</h4>
+
+<p>It sets message dispatch rate for all the topics under a given namespace.
+Dispatch rate can be restricted by number of message per X seconds (<code class="highlighter-rouge">msg-dispatch-rate</code>) or by number of message-bytes per X second (<code class="highlighter-rouge">byte-dispatch-rate</code>).
+dispatch rate is in second and it can be configured with <code class="highlighter-rouge">dispatch-rate-period</code>. Default value of <code class="highlighter-rouge">msg-dispatch-rate</code> and <code class="highlighter-rouge">byte-dispatch-rate</code> is -1 which
+disables the throttling.</p>
+
+<h6 id="cli-15">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces set-dispatch-rate test-property/cl1/ns1 --msg-dispatch-rate 1000 --byte-dispatch-rate 1048576 --dispatch-rate-period 1
+</code></pre></div></div>
+
+<h6 id="rest-16">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>POST /admin/namespaces/{property}/{cluster}/{namespace}/dispatchRate
+</code></pre></div></div>
+
+<h6 id="java-20">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">setDispatchRate</span><span class="o">(</span><span class="n">namespace</span><span class="o">,</span> <span class="mi">1000</span><span class="o">,</span> <span class="mi">1048576</span><span class="o">,</span> <span class="mi">1</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h4 id="get-configured-message-rate">get configured message-rate</h4>
+
+<p>It shows configured message-rate for the namespace (topics under this namespace can dispatch this many messages per second)</p>
+
+<h6 id="cli-16">CLI</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ pulsar-admin namespaces get-dispatch-rate test-property/cl1/ns1
+</code></pre></div></div>
+
+<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
+ </span><span class="s2">"dispatchThrottlingRatePerTopicInMsg"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">1000</span><span class="p">,</span><span class="w">
+ </span><span class="s2">"dispatchThrottlingRatePerTopicInByte"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">1048576</span><span class="p">,</span><span class="w">
+ </span><span class="s2">"ratePeriodInSecond"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
+</span><span class="p">}</span><span class="w">
+</span></code></pre></div></div>
+
+<h6 id="rest-17">REST</h6>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>GET /admin/namespaces/{property}/{cluster}/{namespace}/dispatchRate
+</code></pre></div></div>
+
+<h6 id="java-21">Java</h6>
+
+<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">namespaces</span><span class="o">().</span><span class="na">getDispatchRate</span><span class="o">(</span><span class="n">namespace</span><span class="o">)</span>
+</code></pre></div></div>
+
+<h3 id="namespace-isolation">Namespace isolation</h3>
+
+<p>Coming soon.</p>
+
+<h3 id="unloading-from-a-broker">Unloading from a broker</h3>
+
+<p>You can unload a namespace, or a <span class="popover-term" tabindex="0" title="What is a namespace bundle?" data-placement="top" data-content="A virtual group of topics that belong to the same namespace. A namespace bundle is defined as a range between two 32-bit hashes, such as 0x00000000 and 0xffffffff." data-toggle="popover" data-trigger="focus">namespace bundle</span>, from the Pulsar <span class="popover-term" tabindex="0" title="What is a broker?" data-placement="top" data-cont [...]
+
+<h4 id="pulsar-admin-5">pulsar-admin</h4>
+
+<p>Use the <a href="../../reference/CliTools#pulsar-admin-namespaces-unload"><code class="highlighter-rouge">unload</code></a> subcommand of the <a href="../../reference/CliTools#pulsar-admin-namespaces"><code class="highlighter-rouge">namespaces</code></a> command.</p>
+
+<h5 id="example">Example</h5>
+
+<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pulsar-admin namespaces unload my-prop/my-cluster/my-ns
+</code></pre></div></div>
+
+<h4 id="rest-api-4">REST API</h4>
+
+<h4 id="java-22">Java</h4>
+
+ </section>
+ </article>
+
+ <nav class="toc-bar hidden-md-down col-lg-2">
+
+ <div id="toc">
+ <h4>Managing namespaces</h4>
+ </div>
+
+ </nav>
+ </div>
+</div>
+
+ </main>
+ </main>
+
+ <!--
+
+ 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.
+
+-->
+<footer class="footer">
+ <div class="container">
+ <p class="text-center">Copyright 2018 The Apache Software Foundation. All Rights Reserved.</p>
+ <p class="text-center">Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </div>
+</footer>
+
+
+
+
+
+ <!--
+
+ 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.
+
+-->
+
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-102219959-1', 'auto');
+ ga('send', 'pageview');
+</script>
+
+
+
+ <script type="text/javascript">
+ var navbarOffset = -1 * (document.getElementsByClassName("navbar")[0].offsetHeight);
+ var shiftWindow = function() { scrollBy(0, navbarOffset) };
+ window.addEventListener("hashchange", shiftWindow);
+ window.addEventListener("pageshow", shiftWindow);
+ function load() { if (window.location.hash) shiftWindow(); }
+ </script>
+ </body>
+</html>
diff --git a/content/docs/v2.0.0-rc1-incubating/admin-api/non-persistent-topics/index.html b/content/docs/v2.0.0-rc1-incubating/admin-api/non-persistent-topics/index.html
new file mode 100644
index 0000000..5378775
--- /dev/null
+++ b/content/docs/v2.0.0-rc1-incubating/admin-api/non-persistent-topics/index.html
@@ -0,0 +1,1291 @@
+<!DOCTYPE html>
+
+<!--
+
+ 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.
+
+-->
+
+<html>
+ <head>
+ <!--
+
+ 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.
+
+-->
+<title>Managing non-persistent topics</title>
+
+<meta charset="utf-8">
+
+<link rel="stylesheet" href="/css/style.css">
+<link rel="shortcut icon" href="/img/favicon.ico">
+
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
+<script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"></script>
+<script src="/js/jquery.tocify.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>
+
+<script src="/js/jquery.scrollTo.min.js"></script>
+<script async src="/js/main.js"></script>
+
+ </head>
+ <body class="body">
+ <main class="main">
+ <!--
+
+ 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.
+
... 129245 lines suppressed ...
--
To stop receiving notification emails like this one, please contact
mmerli@apache.org.