Pulsar Manager

note

If you are monitoring your current stats with Pulsar dashboard, we recommend you use Pulsar Manager instead. Pulsar dashboard is deprecated.

The easiest way to use the Pulsar Manager is to run it inside a container.

  • Pulsar Manager is divided into front-end and back-end, the front-end service port is and the back-end service port is 7750.
  • SPRING_CONFIGURATION_FILE: Default configuration file for spring.
  • By default, Pulsar Manager uses the herddb database. HerdDB is a SQL distributed database implemented in Java and can be found at herddb.org for more information.

Configure Database or JWT authentication

Configure Database (optional)

If you have a large amount of data, you can use a custom database, otherwise, some display errors may occur, such as the topic information cannot be displayed when the topic exceeds 10000. The following is an example of PostgreSQL.

  1. Initialize database and table structures using the .
  2. Download and modify the configuration file, then add the PostgreSQL configuration.
  2. spring.datasource.driver-class-name=org.postgresql.Driver
  3. spring.datasource.url=jdbc:postgresql://127.0.0.1:5432/pulsar_manager
  4. spring.datasource.username=postgres
  5. spring.datasource.password=postgres
  1. Add a configuration mount and start with a docker image.
  2. docker pull apachepulsar/pulsar-manager:v0.2.0
  3.     -p 9527:9527 -p 7750:7750 \
  4.     -v /your-path/application.properties:/pulsar-manager/pulsar-
  5. manager/application.properties
  6.     -e SPRING_CONFIGURATION_FILE=/pulsar-manager/pulsar-manager/application.properties \
  7.     apachepulsar/pulsar-manager:v0.2.0

Enable JWT authentication (optional)

If you want to turn on JWT authentication, configure the application.properties file.

• backend.jwt.token: token for the superuser. You need to configure this parameter during cluster initialization.
• jwt.broker.token.mode: multiple modes of generating token, including PUBLIC, PRIVATE, and SECRET.
• jwt.broker.public.key: configure this option if you use the PUBLIC mode.
• jwt.broker.private.key: configure this option if you use the PRIVATE mode.
• jwt.broker.secret.key: configure this option if you use the SECRET mode.
For more information, see Token Authentication Admin of Pulsar.

  2. docker pull apachepulsar/pulsar-manager:v0.2.0
  4.     -p 9527:9527 -p 7750:7750 \
  5.     -v /your-path/application.properties:/pulsar-manager/pulsar-
  6. manager/application.properties
  7.     -v /your-path/private.key:/pulsar-manager/private.key
  8.     -e SPRING_CONFIGURATION_FILE=/pulsar-manager/pulsar-manager/application.properties \
  9.     apachepulsar/pulsar-manager:v0.2.0
  2. CSRF_TOKEN=$(curl http://localhost:7750/pulsar-manager/csrf-token)
  3. curl \
  4.    -H 'X-XSRF-TOKEN: $CSRF_TOKEN' \
  5.    -H 'Cookie: XSRF-TOKEN=$CSRF_TOKEN;' \
  6.    -H "Content-Type: application/json" \
  7.    -X PUT http://localhost:7750/pulsar-manager/users/superuser \
  8.    -d '{"name": "admin", "password": "apachepulsar", "description": "test", "email": "username@test.org"}'

The request parameter in curl command:

  • name is the Pulsar Manager login username, currently admin.
  • password is the password of the current user of Pulsar Manager, currently apachepulsar. The password should be more than or equal to 6 digits.

Configure the environment

  1. Login to the system, Visit http://localhost:9527 to login. The current default account is admin/apachepulsar

  2. Input the “Environment Name”. The environment name is used for identifying an environment.

  3. Input the “Service URL”. The Service URL is the admin service url of your Pulsar cluster.

  • Download and unzip the binary package, which is available on the page.

    2.     wget https://dist.apache.org/repos/dist/release/pulsar/pulsar-manager/pulsar-manager-0.2.0/apache-pulsar-manager-0.2.0-bin.tar.gz
    3.     tar -zxvf apache-pulsar-manager-0.2.0-bin.tar.gz

  • Extract the back-end service binary package and place the front-end resources in the back-end service directory.

    2.     cd pulsar-manager
    4.     cd pulsar-manager
    5.     cp -r ../dist ui

  • Modify application.properties configuration on demand.

  • Start Pulsar Manager

Custom docker image installation

  2. git clone https://github.com/apache/pulsar-manager
  3. cd pulsar-manager/front-end
  4. npm install --save
  5. npm run build:prod
  6. cd ..
  7. ./gradlew build -x test
  8. cd ..
  9. docker build -f docker/Dockerfile --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` --build-arg VCS_REF=`latest` --build-arg VERSION=`latest` -t apachepulsar/pulsar-manager .
  • For more information about backend configurations, see .
  • For more information about frontend configurations, see here.