Google Git
Sign in
apache / pulsar-manager / aba7c8c9b39783a49358b36d628f07beac701c98
commitaba7c8c9b39783a49358b36d628f07beac701c98[log] [tgz]
authortuteng <eguangning@gmail.com>Sun Aug 18 15:58:53 2019 +0800
committerSijie Guo <sijie@apache.org>Sun Aug 18 15:58:53 2019 +0800
tree21a99c30cdc18e5286afe07c63285dcd6c2a615e
parent07dbb8c51492750c26bdfe2067d93803dfb0ccb8 [diff]
Update readme for backend and front end (#127)

### Motivation
Update README

### Modifications
* Update readme for backend and front end
15 files changed
tree: 21a99c30cdc18e5286afe07c63285dcd6c2a615e
  1. .github/
  2. docker/
  3. docs/
  4. front-end/
  5. gradle/
  6. src/
  7. .gitignore
  8. build.gradle
  9. gradle.properties
  10. gradlew
  11. gradlew.bat
  12. Jenkinsfile
  13. LICENSE
  14. README.md
  15. VERSION
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

  1. 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

  2. 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.

      docker pull streamnative/pulsar-manager
docker run -it  -p 9527:9527 -e REDIRECT_HOST=front-end-ip -e REDIRECT_PORT=front-end-port streamnative/pulsar-manager

    • 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

  3. Access Pulsar manager website.

    Use the account and the password to log in to the Pulsar manager website as below.

Back end

For more information about the back end, see pulsar-manager-backend.

Front end

For more information about the front end, see pulsar-manager-frontend.