Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bbonnin/pulsar-express
Simple Web Interface for Apache Pulsar
https://github.com/bbonnin/pulsar-express
apache hacktoberfest pulsar ui web
Last synced: 3 months ago
JSON representation
Simple Web Interface for Apache Pulsar
- Host: GitHub
- URL: https://github.com/bbonnin/pulsar-express
- Owner: bbonnin
- License: apache-2.0
- Created: 2019-05-08T13:56:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T08:31:37.000Z (9 months ago)
- Last Synced: 2024-07-13T04:46:42.166Z (4 months ago)
- Topics: apache, hacktoberfest, pulsar, ui, web
- Language: Vue
- Homepage:
- Size: 2.49 MB
- Stars: 106
- Watchers: 5
- Forks: 19
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pulsar - Pulsar Express
README
[](https://github.com/bbonnin/pulsar-express/blob/master/LICENSE)
[](https://github.com/bbonnin/pulsar-express/releases)
# pulsar-express
> Simple Web Interface for Apache Pulsar
## Install
There are several ways to use `pulsar-express`:
* By cloning the projet and running it locally (see `Development` section)
* By running a docker image: `docker run -it -p 3000:3000 bbonnin/pulsar-express`
* You can set a connection url in the command: `docker run -it -p 3000:3000 -e PE_CONNECTION_URL=http://host.docker.internal:8080 bbonnin/pulsar-express`
* Important: the calls to the Pulsar API are done on server side (i.e. from the container), so your Pulsar must be reachable from the container (do not use localhost :)). A solution: you can add `--network=host` to the command line (but, it's only working on Linux...)
* By installing it using `npm`
```bash
# Install it globally
$ npm install pulsar-express -g
# Start it
$ pulsar-express
╭────────────────╮
│ PULSAR EXPRESS │
╰────────────────╯
=> Open http://localhost:3000
# Start it on a specific port
$ PORT=8000 pulsar-express
╭────────────────╮
│ PULSAR EXPRESS │
╰────────────────╯
=> Open http://localhost:8000
```
If you want to configure connections (to be available to all users), you can:
* Create a json file with the connections:
```json
[
{ "name": "test cluster",
"url": "http://test-cluster-host:8080" },
{ "name": "integration cluster",
"url": "http://int-cluster-host:8080",
"token": "" },
{ "name": "prod cluster",
"url": "http://prod-cluster-host:8080",
"fctWorkerUrl": "http://prod-fct-worker-cluster-host:6750",
"token": "" },
]
```
* and set the env variable `PE_CONFIG_FILE`
```bash
export PE_CONFIG_FILE=/path/to/my/config.json
```
* Or you can also set a connection URL
```bash
export PE_CONNECTION_URL=http://pulsar-host:8080
# Without a name, the url will be used (hostname:port),
# Or you can set a name:
export PE_CONNECTION_NAME=my-pulsar
# A token if needed:
export PE_CONNECTION_TOKEN=
```
From there, you can connect with your browser to the url above !
## Quick start
> If you haven't defined a connection, the first step is to go the `Connections` page and add a new connection. These connections are stored on client side (localstorage of your browser)
### Overview
In this page, you can see some basic informations about your clusters.
### Clusters
### Tenants
### Namespaces
### Topics
### Functions
## Security
To enable security in Pulsar, please read [https://pulsar.apache.org/docs/en/security-overview/](the docs).
For example, with token authentication with a secret key (more details, [https://pulsar.apache.org/docs/en/security-token-admin/](here)),
* Create a secret key:
```bash
pulsar tokens create-secret-key --output my-secret.key --base64
```
* Create a token for pulsar-express
```bash
pulsar tokens create --secret-key file:///path/to/my-secret.key \
--subject pulsar-express
```
* Configure your broker (`conf/broker.conf` or `conf/standalone.conf`)
```bash
authenticationEnabled=true
authorizationEnabled=true
authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderToken
superUserRoles=pulsar-express
tokenSecretKey=file:///path/to/my-secret.key
```
* Configure your workers (`conf/functions_worker.yml`)
```bash
clientAuthenticationPlugin: "org.apache.pulsar.client.impl.auth.AuthenticationToken"
clientAuthenticationParameters: "token:"
authenticationEnabled: true
authorizationEnabled: true
authenticationProviders:
- org.apache.pulsar.broker.authentication.AuthenticationProviderToken
properties:
tokenSecretKey: "file:///path/to/my-secret.key"
superUserRoles:
- pulsar-express
```
* Test a call to the API (you should get a 401 response without the token):
```bash
curl localhost:8080/admin/v2/clusters -H "Authorization: Bearer "
["standalone"]
```
## Development
This app has been developed with [Nuxt.js](https://nuxtjs.org).
``` bash
# install dependencies
$ npm install
# serve with hot reload at localhost:3000
$ npm run dev
# build for production and launch server
$ npm run build
$ npm start
```
For detailed explanation on how things work, checkout [Nuxt.js docs](https://nuxtjs.org).
For Docker:
* Build: `npm run docker-build`
* Test locally: `npm run docker-run`
* Tag: `docker tag pulsar-express USER/pulsar-express:VERSION`
* Publish: `docker push USER/pulsar-express:VERSION`
## How-to
* Change the base URL (work in progress, it's a quick fix):
* Set the base URL you want to use: `export PE_BASE_URL=pulsar-express`
* Rebuild the docker image: `npm run docker-build` (or `docker build --build-arg BASE_URL=${PE_BASE_URL} -t pulsar-express .`)
* Run the image, for example: `docker run -it -p 3000:3000 -e PE_CONNECTION_URL=http://host.docker.internal:8080 -e PE_BASE_URL=${PE_BASE_URL} pulsar-express`
> When running the image, do not forget to set PE_BASE_URL !
## To do
> A lot of things of course :), but the main step is to change the architecture and add a backend instead of making the queries from the browser. This backend could provide api, cache, better management of configuration, ...
* General:
* [ ] test with the latest version (2020/06/08 => v2.5.2)
* Clusters
* [x] connections to clusters (configured on server and client side)
* [x] list clusters
* [ ] get config of a cluster
* [ ] manage clusters
* Tenants
* [x] list the tenants
* [x] create a tenant (simple way)
* [x] delete a tenant
* [ ] get config of a tenant
* [ ] update config of a tenant
* Namespaces
* [x] list the namespace
* [ ] create a namespace
* [ ] delete a namespace
* [x] get config of a namespace
* [ ] update config of a namespace
* [ ] any other features (persistence policies, messages ttl, backlog quotas...)
* Topics
* [x] list the topics
* [x] create a topic
* [ ] create a partitioned topic
* [x] delete a topic
* [x] get stats about a topic
* [x] get subscriptions of a topic
* [ ] manage subscriptions
* [ ] manage partitioned topics
* [ ] any other features (reset cursor, expire messages, ...)
* [x] peek messages
* Functions
* [x] list the functions
* [ ] get config of a function
* [x] start/stop instances
* [ ] manage functions (deploy ? delete ? create ? simple python function for test purpose ?)
* Connections
* [x] update a connection
* [ ] Manage base URL (with env var)
* Images (assets vs static)
* Pages (Config router) -> dynamic ? seems to be NO !
* API (config Axios)
## Misc
Icons: https://icones8.fr/
## Credit
Pulsar Express is a single only tool which is using daily to manage and maintain a Pulsar cluster of over ten nodes in production environment at https://doopage.com.