Google Git
Sign in
apache / pulsar-site / aee2d9089b6b8e327f04261353077211f4abd636 / . / content / docs / en / 2.8.3 / administration-pulsar-manager.html
blob: 6979c8469871e9ca8a7eb4df6327f97e32686258 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Pulsar Manager · Apache Pulsar</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Pulsar Manager is a web-based GUI management and monitoring tool that helps administrators and users manage and monitor tenants, namespaces, topics, subscriptions, brokers, clusters, and so on, and supports dynamic configuration of multiple environments."/><meta name="docsearch:version" content="2.8.3"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Pulsar Manager · Apache Pulsar"/><meta property="og:type" content="website"/><meta property="og:url" content="https://pulsar.apache.org/"/><meta property="og:description" content="Pulsar Manager is a web-based GUI management and monitoring tool that helps administrators and users manage and monitor tenants, namespaces, topics, subscriptions, brokers, clusters, and so on, and supports dynamic configuration of multiple environments."/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://pulsar.apache.org/img/pulsar.svg"/><link rel="shortcut icon" href="/img/pulsar.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://pulsar.apache.org/blog/atom.xml" title="Apache Pulsar Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://pulsar.apache.org/blog/feed.xml" title="Apache Pulsar Blog RSS Feed"/><link rel="stylesheet" href="/css/code-blocks-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/custom.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/pulsar.svg" alt="Apache Pulsar"/></a><a href="/en/versions"><h3>2.8.3</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/en/2.8.3/getting-started-standalone" target="_self">Docs</a></li><li class=""><a href="/en/download" target="_self">Download</a></li><li class="siteNavGroupActive"><a href="/docs/en/2.8.3/client-libraries" target="_self">Clients</a></li><li class=""><a href="#restapis" target="_self">REST APIs</a></li><li class=""><a href="#cli" target="_self">Cli</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="#community" target="_self">Community</a></li><li class=""><a href="#apache" target="_self">Apache</a></li><li class=""><a href="https://pulsar-next.staged.apache.org/" target="_self">New Website (Beta)</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/ja/2.8.3/administration-pulsar-manager">日本語</a></li><li><a href="/docs/fr/2.8.3/administration-pulsar-manager">Français</a></li><li><a href="/docs/ko/2.8.3/administration-pulsar-manager">한국어</a></li><li><a href="/docs/zh-CN/2.8.3/administration-pulsar-manager">中文</a></li><li><a href="/docs/zh-TW/2.8.3/administration-pulsar-manager">繁體中文</a></li><li><a href="https://crowdin.com/project/apache-pulsar" target="_blank" rel="noreferrer noopener">Help Translate</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(event) {
event.preventDefault();
if (languagesDropDown.className == "hide") {
languagesDropDown.className = "visible";
} else {
languagesDropDown.className = "hide";
}
});
</script></span></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Administration</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Get Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/getting-started-standalone">Run Pulsar locally</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/getting-started-docker">Run Pulsar in Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/getting-started-helm">Run Pulsar in Kubernetes</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Concepts and Architecture</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-messaging">Messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-architecture-overview">Architecture</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-clients">Clients</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-replication">Geo Replication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-multi-tenancy">Multi Tenancy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-authentication">Authentication and Authorization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-topic-compaction">Topic Compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-proxy-sni-routing">Proxy support with SNI routing</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/concepts-multiple-advertised-listeners">Multiple advertised listeners</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Schema</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/schema-get-started">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/schema-understand">Understand schema</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/schema-evolution-compatibility">Schema evolution and compatibility</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/schema-manage">Manage schema</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Functions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-runtime">Setup: Configure Functions runtime</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-worker">Setup: Pulsar Functions Worker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-develop">How-to: Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-package">How-to: Package</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-debug">How-to: Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-deploy">How-to: Deploy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/functions-cli">Reference: CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/window-functions-context">Window Functions: Context</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar IO</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-quickstart">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-use">Use</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-debug">Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-connectors">Built-in connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-cdc">CDC connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-develop">Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/io-cli">CLI</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar SQL</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/sql-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/sql-getting-started">Query data</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/sql-deployment-configurations">Configuration and deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/sql-rest-api">REST APIs</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Tiered Storage</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/tiered-storage-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/tiered-storage-aws">AWS S3 offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/tiered-storage-gcs">GCS offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/tiered-storage-filesystem">Filesystem offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/tiered-storage-azure">Azure BlobStore offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/tiered-storage-aliyun">Aliyun OSS offloader</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Transactions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/txn-why">Why transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/txn-what">What are transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/txn-how">How transactions work?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/txn-use">How to use transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/txn-monitor">How to monitor transactions?</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Kubernetes (Helm)</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/helm-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/helm-prepare">Prepare</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/helm-install">Install</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/helm-deploy">Deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/helm-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/helm-tools">Required Tools</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Deployment</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/deploy-aws">Amazon Web Services</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/deploy-kubernetes">Kubernetes</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/deploy-bare-metal">Bare metal</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/deploy-bare-metal-multi-cluster">Bare metal multi-cluster</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/deploy-docker">Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/deploy-monitoring">Monitor</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Administration</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/administration-zk-bk">ZooKeeper and BookKeeper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/administration-geo">Geo-replication</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/2.8.3/administration-pulsar-manager">Pulsar Manager</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/administration-stats">Pulsar statistics</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/administration-load-balance">Load balance</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/administration-proxy">Pulsar proxy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/administration-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/administration-isolation">Pulsar isolation</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Security</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-tls-transport">Transport Encryption using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-tls-authentication">Authentication using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-tls-keystore">Using TLS with KeyStore configure</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-jwt">Authentication using JWT</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-athenz">Authentication using Athenz</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-kerberos">Authentication using Kerberos</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-oauth2">Authentication using OAuth 2.0 access tokens</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-authorization">Authorization and ACLs</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-encryption">End-to-End Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-extending">Extending</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/security-bouncy-castle">Bouncy Castle Providers</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Performance</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/performance-pulsar-perf">Pulsar Perf</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Client Libraries</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries-java">Java</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries-go">Go</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries-python">Python</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries-cpp">C++</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries-node">Node.js</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries-websocket">WebSocket</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/client-libraries-dotnet">C#</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Admin API</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-clusters">Clusters</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-tenants">Tenants</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-brokers">Brokers</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-namespaces">Namespaces</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-permissions">Permissions</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-topics">Topics</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-functions">Functions</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/admin-api-packages">Packages</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Adaptors</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/adaptors-kafka">Kafka client wrapper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/adaptors-spark">Apache Spark</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/adaptors-storm">Apache Storm</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Cookbooks</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/cookbooks-compaction">Topic compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/cookbooks-deduplication">Message deduplication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/cookbooks-non-persistent">Non-persistent messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/cookbooks-retention-expiry">Message retention and expiry</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/cookbooks-encryption">Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/cookbooks-message-queue">Message queue</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/cookbooks-bookkeepermetadata">BookKeeper Ledger Metadata</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Development</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/develop-tools">Simulation tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/developing-binary-protocol">Binary protocol</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/develop-schema">Custom schema storage</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/develop-load-manager">Modular load manager</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Reference</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/reference-terminology">Terminology</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/reference-cli-tools">Pulsar CLI tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/reference-configuration">Pulsar configuration</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.3/reference-metrics">Pulsar Metrics</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/apache/pulsar/edit/master/site2/docs/administration-pulsar-manager.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Pulsar Manager</h1></header><article><div><span><p>Pulsar Manager is a web-based GUI management and monitoring tool that helps administrators and users manage and monitor tenants, namespaces, topics, subscriptions, brokers, clusters, and so on, and supports dynamic configuration of multiple environments.</p>
<blockquote>
<p><strong>Note</strong> <br>
If you monitor your current stats with Pulsar dashboard, you can try to use Pulsar Manager instead. Pulsar dashboard is deprecated.</p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="install"></a><a href="#install" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Install</h2>
<p>The easiest way to use the Pulsar Manager is to run it inside a <a href="https://www.docker.com/products/docker">Docker</a> container.</p>
<pre><code class="hljs css language-shell">docker pull apachepulsar/pulsar-manager:v0.2.0
docker run -it \
-p 9527:9527 -p 7750:7750 \
-e SPRING_CONFIGURATION_FILE=/pulsar-manager/pulsar-manager/application.properties \
apachepulsar/pulsar-manager:v0.2.0
</code></pre>
<ul>
<li><code>SPRING_CONFIGURATION_FILE</code>: Default configuration file for spring.</li>
</ul>
<h3><a class="anchor" aria-hidden="true" id="set-administrator-account-and-password"></a><a href="#set-administrator-account-and-password" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Set administrator account and password</h3>
<pre><code class="hljs css language-shell">CSRF_TOKEN=$(curl http://localhost:7750/pulsar-manager/csrf-token)
curl \
-H 'X-XSRF-TOKEN: $CSRF_TOKEN' \
-H 'Cookie: XSRF-TOKEN=$CSRF_TOKEN;' \
-H "Content-Type: application/json" \
-X PUT http://localhost:7750/pulsar-manager/users/superuser \
-d '{"name": "admin", "password": "apachepulsar", "description": "test", "email": "username@test.org"}'
</code></pre>
<p>You can find the docker image in the <a href="https://github.com/apache/pulsar-manager/tree/master/docker">Docker Hub</a> directory and build an image from the source code as well:</p>
<pre><code class="hljs">git clone https:<span class="hljs-string">//github.com/apache/pulsar-manager</span>
<span class="hljs-keyword">cd</span> pulsar-manager/front-end
npm install <span class="hljs-params">--save</span>
npm run build<span class="hljs-function">:prod</span>
<span class="hljs-keyword">cd</span> <span class="hljs-string">..</span>
<span class="hljs-string">./gradlew</span> build -x test
<span class="hljs-keyword">cd</span> <span class="hljs-string">..</span>
docker build -f docker/Dockerfile <span class="hljs-params">--build-arg</span> BUILD_DATE=`date -u +<span class="hljs-string">"%Y-%m-%dT%H:%M:%SZ"</span>` <span class="hljs-params">--build-arg</span> VCS_REF=`latest` <span class="hljs-params">--build-arg</span> VERSION=`latest` -t apachepulsar/pulsar-manager .
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="use-custom-databases"></a><a href="#use-custom-databases" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Use custom databases</h3>
<p>If you have a large amount of data, you can use a custom database. The following is an example of PostgreSQL.</p>
<ol>
<li><p>Initialize database and table structures using the <a href="https://github.com/apache/pulsar-manager/tree/master/src/main/resources/META-INF/sql/postgresql-schema.sql">file</a>.</p></li>
<li><p>Modify the <a href="https://github.com/apache/pulsar-manager/blob/master/src/main/resources/application.properties">configuration file</a> and add PostgreSQL configuration.</p></li>
</ol>
<pre><code class="hljs"><span class="hljs-attr">spring.datasource.driver-class-name</span>=org.postgresql.Driver
<span class="hljs-attr">spring.datasource.url</span>=jdbc:postgresql://<span class="hljs-number">127.0</span>.<span class="hljs-number">0.1</span>:<span class="hljs-number">5432</span>/pulsar_manager
<span class="hljs-attr">spring.datasource.username</span>=postgres
<span class="hljs-attr">spring.datasource.password</span>=postgres
</code></pre>
<ol start="3">
<li>Compile to generate a new executable jar package.</li>
</ol>
<pre><code class="hljs">./gradlew <span class="hljs-keyword">build </span>-x test
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="enable-jwt-authentication"></a><a href="#enable-jwt-authentication" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enable JWT authentication</h3>
<p>If you want to turn on JWT authentication, configure the following parameters:</p>
<ul>
<li><code>backend.jwt.token</code>: token for the superuser. You need to configure this parameter during cluster initialization.</li>
<li><code>jwt.broker.token.mode</code>: multiple modes of generating token, including PUBLIC, PRIVATE, and SECRET.</li>
<li><code>jwt.broker.public.key</code>: configure this option if you use the PUBLIC mode.</li>
<li><code>jwt.broker.private.key</code>: configure this option if you use the PRIVATE mode.</li>
<li><code>jwt.broker.secret.key</code>: configure this option if you use the SECRET mode.</li>
</ul>
<p>For more information, see <a href="http://pulsar.apache.org/docs/en/security-token-admin/">Token Authentication Admin of Pulsar</a>.</p>
<p>If you want to enable JWT authentication, use one of the following methods.</p>
<ul>
<li>Method 1: use command-line tool</li>
</ul>
<pre><code class="hljs">wget https:<span class="hljs-string">//dist.apache.org/repos/dist/release/pulsar/pulsar-manager/pulsar-manager-0.2.0/apache-pulsar-manager-0.2.0-bin.tar.gz</span>
tar -zxvf apache-pulsar-manager-0.2.0-bin.tar.gz
<span class="hljs-keyword">cd</span> pulsar-manager
tar -zxvf pulsar-manager.tar
<span class="hljs-keyword">cd</span> pulsar-manager
cp -r <span class="hljs-string">../dist</span> ui
<span class="hljs-string">./bin/pulsar-manager</span> <span class="hljs-params">--redirect</span>.host=http:<span class="hljs-string">//localhost</span> <span class="hljs-params">--redirect</span>.port=9527 insert.stats.interval=600000 <span class="hljs-params">--backend</span>.jwt.token=token <span class="hljs-params">--jwt</span>.broker.token.mode=PRIVATE <span class="hljs-params">--jwt</span>.broker.private.key=file:<span class="hljs-string">///path/broker-private.key</span> <span class="hljs-params">--jwt</span>.broker.public.key=file:<span class="hljs-string">///path/broker-public.key</span>
</code></pre>
<p>Firstly, <a href="#set-administrator-account-and-password">set the administrator account and password</a></p>
<p>Secondly, log in to Pulsar manager through <a href="http://localhost:7750/ui/index.html">http://localhost:7750/ui/index.html</a>.</p>
<ul>
<li>Method 2: configure the application.properties file</li>
</ul>
<pre><code class="hljs">backend<span class="hljs-selector-class">.jwt</span>.token=token
jwt<span class="hljs-selector-class">.broker</span><span class="hljs-selector-class">.token</span>.mode=PRIVATE
jwt<span class="hljs-selector-class">.broker</span><span class="hljs-selector-class">.public</span>.key=file:<span class="hljs-comment">///path/broker-public.key</span>
jwt<span class="hljs-selector-class">.broker</span><span class="hljs-selector-class">.private</span>.key=file:<span class="hljs-comment">///path/broker-private.key</span>
or
jwt<span class="hljs-selector-class">.broker</span><span class="hljs-selector-class">.token</span>.mode=SECRET
jwt<span class="hljs-selector-class">.broker</span><span class="hljs-selector-class">.secret</span>.key=file:<span class="hljs-comment">///path/broker-secret.key</span>
</code></pre>
<ul>
<li>Method 3: use Docker and enable token authentication.</li>
</ul>
<pre><code class="hljs"><span class="hljs-builtin-name">export</span> <span class="hljs-attribute">JWT_TOKEN</span>=<span class="hljs-string">"your-token"</span>
docker <span class="hljs-builtin-name">run</span> -it -p 9527:9527 -p 7750:7750 -e <span class="hljs-attribute">REDIRECT_HOST</span>=http://localhost -e <span class="hljs-attribute">REDIRECT_PORT</span>=9527 -e <span class="hljs-attribute">DRIVER_CLASS_NAME</span>=org.postgresql.Driver -e <span class="hljs-attribute">URL</span>=<span class="hljs-string">'jdbc:postgresql://127.0.0.1:5432/pulsar_manager'</span> -e <span class="hljs-attribute">USERNAME</span>=pulsar -e <span class="hljs-attribute">PASSWORD</span>=pulsar -e <span class="hljs-attribute">LOG_LEVEL</span>=DEBUG -e <span class="hljs-attribute">JWT_TOKEN</span>=<span class="hljs-variable">$JWT_TOKEN</span> -v <span class="hljs-variable">$PWD</span>:/data apachepulsar/pulsar-manager:v0.2.0 /bin/sh
</code></pre>
<ul>
<li><p><code>JWT_TOKEN</code>: the token of superuser configured for the broker. It is generated by the <code>bin/pulsar tokens create --secret-key</code> or <code>bin/pulsar tokens create --private-key</code> command.</p></li>
<li><p><code>REDIRECT_HOST</code>: the IP address of the front-end server.</p></li>
<li><p><code>REDIRECT_PORT</code>: the port of the front-end server.</p></li>
<li><p><code>DRIVER_CLASS_NAME</code>: the driver class name of the PostgreSQL database.</p></li>
<li><p><code>URL</code>: the JDBC URL of your PostgreSQL database, such as jdbc:<a href="postgresql://127.0.0.1:5432/pulsar_manager">postgresql://127.0.0.1:5432/pulsar_manager</a>. The docker image automatically start a local instance of the PostgreSQL database.</p></li>
<li><p><code>USERNAME</code>: the username of PostgreSQL.</p></li>
<li><p><code>PASSWORD</code>: the password of PostgreSQL.</p></li>
<li><p><code>LOG_LEVEL</code>: the level of log.</p></li>
<li><p>Method 4: use Docker and turn on <strong>token authentication</strong> and <strong>token management</strong> by private key and public key.</p></li>
</ul>
<pre><code class="hljs"><span class="hljs-builtin-name">export</span> <span class="hljs-attribute">JWT_TOKEN</span>=<span class="hljs-string">"your-token"</span>
<span class="hljs-builtin-name">export</span> <span class="hljs-attribute">PRIVATE_KEY</span>=<span class="hljs-string">"file:///pulsar-manager/secret/my-private.key"</span>
<span class="hljs-builtin-name">export</span> <span class="hljs-attribute">PUBLIC_KEY</span>=<span class="hljs-string">"file:///pulsar-manager/secret/my-public.key"</span>
docker <span class="hljs-builtin-name">run</span> -it -p 9527:9527 -p 7750:7750 -e <span class="hljs-attribute">REDIRECT_HOST</span>=http://localhost -e <span class="hljs-attribute">REDIRECT_PORT</span>=9527 -e <span class="hljs-attribute">DRIVER_CLASS_NAME</span>=org.postgresql.Driver -e <span class="hljs-attribute">URL</span>=<span class="hljs-string">'jdbc:postgresql://127.0.0.1:5432/pulsar_manager'</span> -e <span class="hljs-attribute">USERNAME</span>=pulsar -e <span class="hljs-attribute">PASSWORD</span>=pulsar -e <span class="hljs-attribute">LOG_LEVEL</span>=DEBUG -e <span class="hljs-attribute">JWT_TOKEN</span>=<span class="hljs-variable">$JWT_TOKEN</span> -e <span class="hljs-attribute">PRIVATE_KEY</span>=<span class="hljs-variable">$PRIVATE_KEY</span> -e <span class="hljs-attribute">PUBLIC_KEY</span>=<span class="hljs-variable">$PUBLIC_KEY</span> -v <span class="hljs-variable">$PWD</span>:/data -v <span class="hljs-variable">$PWD</span>/secret:/pulsar-manager<span class="hljs-built_in">/secret </span>apachepulsar/pulsar-manager:v0.2.0 /bin/sh
</code></pre>
<ul>
<li><p><code>JWT_TOKEN</code>: the token of superuser configured for the broker. It is generated by the <code>bin/pulsar tokens create --private-key</code> command.</p></li>
<li><p><code>PRIVATE_KEY</code>: private key path mounted in container, generated by <code>bin/pulsar tokens create-key-pair</code> command.</p></li>
<li><p><code>PUBLIC_KEY</code>: public key path mounted in container, generated by <code>bin/pulsar tokens create-key-pair</code> command.</p></li>
<li><p><code>$PWD/secret</code>: the folder where the private key and public key generated by the <code>bin/pulsar tokens create-key-pair</code> command are placed locally</p></li>
<li><p><code>REDIRECT_HOST</code>: the IP address of the front-end server.</p></li>
<li><p><code>REDIRECT_PORT</code>: the port of the front-end server.</p></li>
<li><p><code>DRIVER_CLASS_NAME</code>: the driver class name of the PostgreSQL database.</p></li>
<li><p><code>URL</code>: the JDBC URL of your PostgreSQL database, such as jdbc:<a href="postgresql://127.0.0.1:5432/pulsar_manager">postgresql://127.0.0.1:5432/pulsar_manager</a>. The docker image automatically start a local instance of the PostgreSQL database.</p></li>
<li><p><code>USERNAME</code>: the username of PostgreSQL.</p></li>
<li><p><code>PASSWORD</code>: the password of PostgreSQL.</p></li>
<li><p><code>LOG_LEVEL</code>: the level of log.</p></li>
<li><p>Method 5: use Docker and turn on <strong>token authentication</strong> and <strong>token management</strong> by secret key.</p></li>
</ul>
<pre><code class="hljs"><span class="hljs-builtin-name">export</span> <span class="hljs-attribute">JWT_TOKEN</span>=<span class="hljs-string">"your-token"</span>
<span class="hljs-builtin-name">export</span> <span class="hljs-attribute">SECRET_KEY</span>=<span class="hljs-string">"file:///pulsar-manager/secret/my-secret.key"</span>
docker <span class="hljs-builtin-name">run</span> -it -p 9527:9527 -p 7750:7750 -e <span class="hljs-attribute">REDIRECT_HOST</span>=http://localhost -e <span class="hljs-attribute">REDIRECT_PORT</span>=9527 -e <span class="hljs-attribute">DRIVER_CLASS_NAME</span>=org.postgresql.Driver -e <span class="hljs-attribute">URL</span>=<span class="hljs-string">'jdbc:postgresql://127.0.0.1:5432/pulsar_manager'</span> -e <span class="hljs-attribute">USERNAME</span>=pulsar -e <span class="hljs-attribute">PASSWORD</span>=pulsar -e <span class="hljs-attribute">LOG_LEVEL</span>=DEBUG -e <span class="hljs-attribute">JWT_TOKEN</span>=<span class="hljs-variable">$JWT_TOKEN</span> -e <span class="hljs-attribute">SECRET_KEY</span>=<span class="hljs-variable">$SECRET_KEY</span> -v <span class="hljs-variable">$PWD</span>:/data -v <span class="hljs-variable">$PWD</span>/secret:/pulsar-manager<span class="hljs-built_in">/secret </span>apachepulsar/pulsar-manager:v0.2.0 /bin/sh
</code></pre>
<ul>
<li><p><code>JWT_TOKEN</code>: the token of superuser configured for the broker. It is generated by the <code>bin/pulsar tokens create --secret-key</code> command.</p></li>
<li><p><code>SECRET_KEY</code>: secret key path mounted in container, generated by <code>bin/pulsar tokens create-secret-key</code> command.</p></li>
<li><p><code>$PWD/secret</code>: the folder where the secret key generated by the <code>bin/pulsar tokens create-secret-key</code> command are placed locally</p></li>
<li><p><code>REDIRECT_HOST</code>: the IP address of the front-end server.</p></li>
<li><p><code>REDIRECT_PORT</code>: the port of the front-end server.</p></li>
<li><p><code>DRIVER_CLASS_NAME</code>: the driver class name of the PostgreSQL database.</p></li>
<li><p><code>URL</code>: the JDBC URL of your PostgreSQL database, such as jdbc:<a href="postgresql://127.0.0.1:5432/pulsar_manager">postgresql://127.0.0.1:5432/pulsar_manager</a>. The docker image automatically start a local instance of the PostgreSQL database.</p></li>
<li><p><code>USERNAME</code>: the username of PostgreSQL.</p></li>
<li><p><code>PASSWORD</code>: the password of PostgreSQL.</p></li>
<li><p><code>LOG_LEVEL</code>: the level of log.</p></li>
<li><p>For more information about backend configurations, see <a href="https://github.com/apache/pulsar-manager/blob/master/src/README.md">here</a>.</p></li>
<li><p>For more information about frontend configurations, see <a href="https://github.com/apache/pulsar-manager/tree/master/front-end">here</a>.</p></li>
</ul>
<h2><a class="anchor" aria-hidden="true" id="log-in"></a><a href="#log-in" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Log in</h2>
<p><a href="#set-administrator-account-and-password">Set the administrator account and password</a>.</p>
<p>Visit <a href="http://localhost:9527">http://localhost:9527</a> to log in.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/2.8.3/administration-geo"><span class="arrow-prev">← </span><span>Geo-replication</span></a><a class="docs-next button" href="/docs/en/2.8.3/administration-stats"><span>Pulsar statistics</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#install">Install</a><ul class="toc-headings"><li><a href="#set-administrator-account-and-password">Set administrator account and password</a></li><li><a href="#use-custom-databases">Use custom databases</a></li><li><a href="#enable-jwt-authentication">Enable JWT authentication</a></li></ul></li><li><a href="#log-in">Log in</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2022 The Apache Software Foundation. All Rights Reserved. Apache, Apache Pulsar and the Apache feather logo are trademarks of The Apache Software Foundation.</section><span><script>
const community = document.querySelector("a[href='#community']").parentNode;
const communityMenu =
'<li>' +
'<a id="community-menu" href="#">Community <span style="font-size: 0.75em">&nbsp;▼</span></a>' +
'<div id="community-dropdown" class="hide">' +
'<ul id="community-dropdown-items">' +
'<li><a href="/en/contact">Contact</a></li>' +
'<li><a href="/en/contributing">Contributing</a></li>' +
'<li><a href="/en/coding-guide">Coding guide</a></li>' +
'<li><a href="/en/events">Events</a></li>' +
'<li><a href="https://twitter.com/Apache_Pulsar" target="_blank">Twitter &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/wiki" target="_blank">Wiki &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/issues" target="_blank">Issue tracking &#x2750</a></li>' +
'<li><a href="https://pulsar-summit.org/" target="_blank">Pulsar Summit &#x2750</a></li>' +
'<li>&nbsp;</li>' +
'<li><a href="/en/resources">Resources</a></li>' +
'<li><a href="/en/team">Team</a></li>' +
'<li><a href="/en/powered-by">Powered By</a></li>' +
'</ul>' +
'</div>' +
'</li>';
community.innerHTML = communityMenu;
const communityMenuItem = document.getElementById("community-menu");
const communityDropDown = document.getElementById("community-dropdown");
communityMenuItem.addEventListener("click", function(event) {
event.preventDefault();
if (communityDropDown.className == 'hide') {
communityDropDown.className = 'visible';
} else {
communityDropDown.className = 'hide';
}
});
</script></span></footer></div><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script></body></html>