commit	fc0c4225efdde3bd474035e7437d3f829b0650d5	[log] [tgz]
author	Enrico Olivelli <eolivelli@gmail.com>	Tue Oct 15 02:47:10 2019 +0200
committer	tuteng <guangning@apache.org>	Tue Oct 15 08:47:10 2019 +0800
tree	bc3af096f7757777e83224f1d228547fbf1e189d
parent	f2508356422a896f33778e302faa7a6f87c725d5 [diff]

tree: bc3af096f7757777e83224f1d228547fbf1e189d

README.md

Apache Pulsar manager

Apache Pulsar manager is a web-based GUI management tool for managing and monitoring Pulsar.

Feature

Tenants Management
Namespaces Management
Topics Management
Subscriptions Management
Brokers Management
Clusters Management
Dynamic environments with multiple changes

Feature preview

Log in

Use the default account (pulsar) and the default password (pulsar) to log in.

pulsar-manager-login

Configure environment

The puslar-manager supports multiple environment configurations and can manage multiple environments conveniently.

pulsar-manager-environments

Manage tenants

pulsar-manager-tenants

Manage namespaces

pulsar-manager-namespaces

Manage topics

pulsar-manager-topics

Manage subscriptions

pulsar-manager-subscriptions

Manage clusters

pulsar-manager-clusters

Manage brokers

pulsar-manager-brokers

Topics monitoring

The pulsar-manager can monitor topics and subscriptions.

pulsar-manager-topics-monitors

Prerequisites

Java 8 or later
Node 10.15.3 or later
Npm 6.4.1 or later
Pulsar 2.4.0 or later
Docker

Preparation

Start Pulsar standalone.

docker pull apachepulsar/pulsar:2.4.0
docker run -d -it -p 6650:6650 -p 8080:8080 -v $PWD/data:/pulsar/data --name pulsar-manager-standalone apachepulsar/pulsar:2.4.0 bin/pulsar standalone

Build an environment.

You can build an environment with Docker or build a local environment.

Build an environment with Docker

REDIRECT_HOST: the IP address of the front-end server.
REDIRECT_PORT: the port of the front-end server.
DRIVER_CLASS_NAME: the driver class name of MySQL.
URL: the url of MySQL jdbc, example: jdbc:mysql://localhost:3306/pulsar_manager?useSSL=false
USERNAME: the username of MySQL
PASSWORD: the password of MySQL

docker pull streamnative/pulsar-manager
docker run -it -p 9527:9527 -e REDIRECT_HOST=front-end-ip -e REDIRECT_PORT=front-end-port -e DRIVER_CLASS_NAME=com.mysql.jdbc.Driver -e URL='jdbc-url' -e USERNAME=root -e PASSWORD=pulsar pulsar-manager /bin/sh

This is an example:

docker run -it -p 9527:9527 -e REDIRECT_HOST=http://192.168.0.104 -e REDIRECT_PORT=9527 -e DRIVER_CLASS_NAME=org.postgresql.Driver -e URL='jdbc:postgresql://127.0.0.1:5432/pulsar_manager' -e USERNAME=pulsar -e PASSWORD=pulsar -v $PWD:/data pulsar-manager:latest /bin/sh

Build a local environment

(1) Download the source code.

git clone https://github.com/streamnative/pulsar-manager

(2) Build and start the backend.

cd pulsar-manager
./gradlew build -x test
java -jar ./build/libs/pulsar-manager.jar

(3) Build and start the front end.

cd pulsar-manager/front-end
npm install --save
npm run dev

Access Pulsar manager website.
Use the account and the password to log in to the Pulsar manager website as below.
- Account: pulsar
- Password: pulsar
- Pulsar manager website: http://localhost:9527/

Default Test database HerdDB

Introduction

Pulsar Manager bundles JDBC Drivers for HerdDB. The default confguration starts and embedded in-memory only HerdDB database.

HerdDB can be used in production, you just have to use the correct JDBC URL. Follow the instructions in application.properties to switch the connection to a standalone HerdDB service or cluster.

The JDBC URL will look like this: jdbc:herddb:server:localhost:7000

In cluster mode HerdDB uses Apache BookKeeper and Apache ZooKeeper to store data and metadata, you can share your ZooKeeper cluster and the Bookies bundled with Pulsar.

The JDBC URL will look like this: jdbc:herddb:zookeeper:localhost:2181/herddb

In order to start and setup an HerdDB database follow the instructions on the HerdDB documentation.