{"id":15096930,"url":"https://github.com/apache/pulsar-manager","last_synced_at":"2025-05-15T02:10:29.028Z","repository":{"id":37405722,"uuid":"155603142","full_name":"apache/pulsar-manager","owner":"apache","description":"Apache Pulsar Manager","archived":false,"fork":false,"pushed_at":"2025-01-12T14:40:43.000Z","size":12878,"stargazers_count":532,"open_issues_count":153,"forks_count":248,"subscribers_count":50,"default_branch":"master","last_synced_at":"2025-05-10T17:16:40.992Z","etag":null,"topics":["admin-dashboard","apache-pulsar","event-streaming","messaging","pubsub","pulsar","pulsar-ui","queuing","streaming","vuejs"],"latest_commit_sha":null,"homepage":"https://pulsar.apache.org/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-31T18:09:47.000Z","updated_at":"2025-05-06T04:31:49.000Z","dependencies_parsed_at":"2024-02-16T23:33:53.442Z","dependency_job_id":"a734e6cb-3d1a-4852-8251-8fe1f9e00ff8","html_url":"https://github.com/apache/pulsar-manager","commit_stats":{"total_commits":259,"total_committers":67,"mean_commits":"3.8656716417910446","dds":0.6949806949806949,"last_synced_commit":"f302f456b7200ce854d7497ae2872734bc28860a"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpulsar-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpulsar-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpulsar-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fpulsar-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/pulsar-manager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254259387,"owners_count":22040821,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["admin-dashboard","apache-pulsar","event-streaming","messaging","pubsub","pulsar","pulsar-ui","queuing","streaming","vuejs"],"created_at":"2024-09-25T16:02:34.422Z","updated_at":"2025-05-15T02:10:28.954Z","avatar_url":"https://github.com/apache.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Apache Pulsar manager\n\nApache Pulsar manager is a web-based GUI management tool for managing and monitoring Pulsar.\n\nA Pulsar Manager is capable of managing multiple Pulsar clusters. A Pulsar instance or a group\nof Pulsar clusters is defined as an `Environment` in Pulsar Manager. You can create as many environments\nas you can. The following diagram illustrates the overall architecture of a Pulsar Manager.\n\n![pulsar-manager-arch](docs/img/pulsar-manager-arch.png)\n\nA running Pulsar Manager instance is comprised of two components: one is the `frontend` which provides\nthe GUI to manage and monitor Pulsar clusters, the other one is the `backend` which interacts with Pulsar\nclusters for collecting metrics, forwarding admin requests to the requested Pulsar cluster or brokers.\n\nSince Pulsar Manager directly interacts with Pulsar brokers and bookies for management, it is required\nto deploy the Pulsar Manager into the same network as your Pulsar clusters. So the Pulsar Manager backend\nis able to talk to the brokers and bookies in your Pulsar cluster.\n\n## Install\n\n### Use Docker\n\n1. Start Pulsar standalone.\n\n    ```\n    docker pull apachepulsar/pulsar:latest\n    docker run -d -it \\\n        -p 6650:6650 \\\n        -p 8080:8080 \\\n        -v pulsardata:/pulsar/data \\\n        -v pulsarconf:/pulsar/conf \\\n        --name pulsar-standalone \\\n        apachepulsar/pulsar:latest \\\n        bin/pulsar standalone\n    ```\n\n2. Start Pulsar Manager in a separate container.\n\n    \u003e NOTE: the command links the pulsar-manager container with the pulsar standalone container so they are in the same network.\n\n    ```\n    docker pull apachepulsar/pulsar-manager:v0.2.0\n    docker run -it \\\n        -p 9527:9527 -p 7750:7750 \\\n        -e SPRING_CONFIGURATION_FILE=/pulsar-manager/pulsar-manager/application.properties \\\n        --link pulsar-standalone \\\n        apachepulsar/pulsar-manager:v0.2.0\n    ```\n\n    \u003e NOTE: Enable bookkeeper visual manager(Optional), update the field `bkvm.enabled` to `true` for the file [bkvm.conf](https://github.com/apache/pulsar-manager/blob/master/src/main/resources/bkvm.conf).\n\n    ```\n    docker pull apachepulsar/pulsar-manager:v0.2.0\n    docker run -it \\\n        -p 9527:9527 -p 7750:7750 \\\n        -e SPRING_CONFIGURATION_FILE=/pulsar-manager/pulsar-manager/application.properties \\\n        -v $PWD/bkvm.conf:/pulsar-manager/pulsar-manager/bkvm.conf \\\n        --link pulsar-standalone \\\n        apachepulsar/pulsar-manager:v0.2.0\n    ```\n\n    * `SPRING_CONFIGURATION_FILE`: Default configuration file for spring.\n\n### Use Docker Compose\n\nAlternatively, you can start a standalone and Pulsar Manager using the docker compose file provided in this repository.\n\n1. Clone this git repoistory.\n\n    ```bash\n    https://github.com/apache/pulsar-manager\n    ```\n\n2. Go to the docker directory.\n\n    ```bash\n    cd docker\n    ```\n\n3. Start the docker composed cluster.\n\n    ```bash\n    docker-compose up\n    ```\n\n### Deploy Pulsar Manager to Kubernetes\n\nThe Pulsar Manager can be deployed as part of [Pulsar Helm Chart](https://github.com/apache/pulsar-helm-chart).\n\n1. Install the Pulsar cluster with Pulsar Manager\n\n    ```bash\n    helm repo add apache https://pulsar.apache.org/charts\n    helm repo update\n    helm install \u003crelease-name\u003e apache/pulsar\n    ```\n\n2. Access the Pulsar Manager.\n\n    The default values will create a `ClusterIP` for the Pulsar Manager you can use to interact with cluster.\n    To find the IP address of the Pulsar Manager, use the following command:\n    ```bash\n    kubectl get service -n \u003ck8s-namespace\u003e\n    ```\n    After find the ip address of the Pulsar Manager, you can access the Pulsar Manager at `http://${pulsar-manager-cluster-ip}/#/environments`.\n\n### Deploy from bin package\n\n```\nwget https://dist.apache.org/repos/dist/release/pulsar/pulsar-manager/pulsar-manager-0.2.0/apache-pulsar-manager-0.2.0-bin.tar.gz\ntar -zxvf apache-pulsar-manager-0.2.0-bin.tar.gz\ncd pulsar-manager\ntar -xvf pulsar-manager.tar\ncd pulsar-manager\ncp -r ../dist ui\n./bin/pulsar-manager\n```\n\nNow, you can access it at the following address: frontend =\u003e http://localhost:7750/ui/index.html.\n\nFor details, see [Set the administrator account and password](#access-pulsar-manager).\n\n#### Enable BookKeeper visual manager(optional)\n\nUpdate the configuration file `pulsar-manager/bkvm.conf`, and set `bkvm.enabled` to `true`.\n\nbkvm address =\u003e http://localhost:7750/bkvm\n\n### Build from source code\n\n#### Prerequisites\n\n* Java JDK 1.8\n* Node.js 16 or later\n* npm 8 later\n* Pulsar 2.4.0 or later\n\n#### Build instructions\n\n1. Clone the source code.\n\n    ``` bash\n    git clone https://github.com/apache/pulsar-manager\n    ```\n\n2. Build and start the backend.\n\n    ```\n    cd pulsar-manager\n    ./gradlew build -x test\n    cd build/distributions\n    unzip pulsar-manager.zip or tar -zxvf pulsar-manager.tar\n    ./pulsar-manager/bin/pulsar-manager\n    ```\n\n3. Open a new terminal, build and start the front end.\n\n    ```\n    cd pulsar-manager/front-end\n    npm install --save\n    npm run dev\n    ```\n\nAfter running these steps, the Pulsar Manager is running locally at http://127.0.0.1:9527/#/environments.\n\n## Access Pulsar Manager\n\n1. Access Pulsar manager UI at `http://${frontend-end-ip}/#/environments`.\n\n    If you started Pulsar Manager using docker or docker-compose, the Pulsar Manager is running at port 9527. You can access the Pulsar Manager UI at http://127.0.0.1:9527/#/environments.\n\n    If you are deploying Pulsar Manager 0.1.0 using the released container, you can log in the Pulsar Manager UI using the following credentials.\n\n    * Account: `pulsar`\n    * Password: `pulsar`\n\n    If you are deploying Pulsar Manager using the latest code, you can create a super-user using the following command. Then you can use the super user credentials to log in the Pulsar Manager UI.\n\n    ```\n    CSRF_TOKEN=$(curl http://backend-service:7750/pulsar-manager/csrf-token)\n    curl \\\n        -H \"X-XSRF-TOKEN: $CSRF_TOKEN\" \\\n        -H \"Cookie: XSRF-TOKEN=$CSRF_TOKEN;\" \\\n        -H 'Content-Type: application/json' \\\n        -X PUT http://backend-service:7750/pulsar-manager/users/superuser \\\n        -d '{\"name\": \"admin\", \"password\": \"apachepulsar\", \"description\": \"test\", \"email\": \"username@test.org\"}'\n    ```\n\n    * `backend-service`: The IP address or domain name of the backend service.\n    * `password`: The password should be more than or equal to 6 digits.\n\n2. Create an environment.\n\n    An environment represents a Pulsar instance or a group of clusters you want to manage. A Pulsar Manager is capable of managing multiple environments.\n\n    - Click \"New Environment\" button to add an environment.\n    - Input the \"Environment Name\". The environment name is used for identifying an environment.\n    - Input the \"Service URL\". The Service URL is the admin service url of your Pulsar cluster.\n        - You need to make sure the service url that Pulsar Manager is able to access. In this example, both pulsar container and pulsar-manager container are linked. So you can use pulsar container name as the domain name of the pulsar standalone cluster. Thus you can type `http://pulsar-standalone:8080`.\n    - Input the \"Bookie URL\". In this example, you can type `http://pulsar-standalone:6650`\n\n## Configure Pulsar Manager\n\n### Back end\n\nFor more information about the back end, see [pulsar-manager-backend](https://github.com/apache/pulsar-manager/blob/master/src/README.md).\n\n### Front end\n\nFor more information about the front end, see [pulsar-manager-frontend](https://github.com/apache/pulsar-manager/blob/master/front-end/README.md).\n\n## Features\n\n* Tenants Management\n* Namespaces Management\n* Topics Management\n* Subscriptions Management\n* Brokers Management\n* Clusters Management\n* Dynamic environments with multiple changes\n* Support JWT Auth\n\n### Log in\n\nUse the default account (`pulsar`) and the default password (`pulsar`) to log in.\n\n![pulsar-manager-login](docs/img/pulsar-manager-login.gif)\n\n### Configure environment\n\nThe pulsar-manager supports multiple environment configurations and can manage multiple environments conveniently.\n\nHere, the service URL represents the service IP address of the broker. If you run Pulsar manager in the standalone mode, it should be set to \"http://127.0.0.1:8080\".\nYou can easily find it in the client.conf file of your pulsar-manager.\n\nAnd the bookie URL represents the service IP address of the bookkeeper. If you run Pulsar manager in the standalone mode, it should be set to \"http://127.0.0.1:6650\".\n\n![pulsar-manager-environments](docs/img/pulsar-manager-environments.gif)\n\n### Manage tenants\n\n![pulsar-manager-tenants](docs/img/pulsar-manager-tenants.gif)\n\n### Manage namespaces\n\n![pulsar-manager-namespaces](docs/img/pulsar-manager-namespaces.gif)\n\n### Manage topics\n\n![pulsar-manager-topics](docs/img/pulsar-manager-topics.gif)\n\n\n### Manage subscriptions\n\n![pulsar-manager-subscriptions](docs/img/pulsar-manager-subscriptions.gif)\n\n### Manage clusters\n\n![pulsar-manager-clusters](docs/img/pulsar-manager-clusters.gif)\n\n### Manage brokers\n\n![pulsar-manager-brokers](docs/img/pulsar-manager-brokers.gif)\n\n\n### Topics monitoring\n\nThe pulsar-manager can monitor topics and subscriptions.\n\n![pulsar-manager-topics-monitors](docs/img/pulsar-manager-topics-monitors.gif)\n\n### Manage token\n\n![pulsar-manager-token](docs/img/pulsar-manager-token.gif)\n\n## Casdoor\n\n\n### Casdoor Installation\n\nYou can use casdoor to realize sso.\n\nCasdoor can connect to Pulsar-manager simply.\n\nBecause the code for connecting the casdoor has been added in Pulsar-manager, we need to configure the casdoor in the back-end and front-end.\n\n#### Step1. Deploy Casdoor\n\nFirstly, the Casdoor should be deployed.\n\nYou can refer to the Casdoor official documentation for the [Casdoor](https://casdoor.org/docs/overview)\n\nAfter a successful deployment, you need to ensure:\n\n- The Casdoor server is successfully running on **http://localhost:8000**.\n- Open your favorite browser and visit **http://localhost:7001**, you will see the login page of Casdoor.\n- Input `admin` and `123` to test login functionality is working fine.\n\nThen you can quickly implement a casdoor based login page in your app with the following steps.\n\n#### step2. Configure Casdoor\n\nConfigure casdoor can refer to [casdoor](https://door.casdoor.com/login)(Configure casdoor's browser better not use one browser with your develop browser).\n\nYou also should configure the organization, and application, you also can refer to [casdoor](https://door.casdoor.com/login).\n\n##### step2.1 you should create an organization\n\n![organization](/docs/img/Pulsar-manager_editOrganization.svg)\n\n##### step2.2 you should create an application\n\n![application](/docs/img/Pulsar-manager_editApplication.svg)\n\n#### Step3. Configure back-end code\n\nYou should configure casdoor's Configuration in the Line 154 of pulsar-manager/src/main/resources/application.properties\n\n```ini\ncasdoor.endpoint=http://localhost:8000\ncasdoor.clientId=\u003cclient id in previous step\u003e\ncasdoor.clientSecret=\u003cclient Secret in previous step\u003e\ncasdoor.certificate=\u003cclient certificate in previous step\u003e\ncasdoor.organizationName=pulsar\ncasdoor.applicationName=app-pulsar\n```\n\n#### Step4. Configure front-end code\n\nYou also need configure casdoor's Configuration in the Line 50 of pulsar-manager/front-end/src/main.js\n\n```\nconst config = {\n  serverUrl: \"http://localhost:7001\",\n  clientId: \"6ba06c1e1a30929fdda7\",\n  organizationName: \"pulsar\",\n  appName: \"app-plusar\",\n  redirectPath: \"/#callback\",\n};\n```\n\nNow you can use Casdoor.\n\n## Development\n\n### Default Test database HerdDB\n\n#### Introduction\n\nPulsar Manager bundles JDBC Drivers for [HerdDB](https://github.com/diennea/herddb).\nThe default configuration starts and embedded in-memory only HerdDB database.\n\nHerdDB can be used in production, you just have to use the  correct JDBC URL.\nFollow the instructions in [application.properties](https://github.com/apache/pulsar-manager/blob/master/src/main/resources/application.properties) to switch the connection to a standalone HerdDB service or cluster.\n\nThe JDBC URL will look like this:\njdbc:herddb:server:localhost:7000\n\nIn 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.\n\nThe JDBC URL will look like this:\njdbc:herddb:zookeeper:localhost:2181/herddb\n\nIn order to start and setup an HerdDB database follow the instructions on the [HerdDB documentation](https://github.com/diennea/herddb/wiki).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fpulsar-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fpulsar-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fpulsar-manager/lists"}