Skip to content

Commit 962f93d

Browse files
committed
Merge branch 'master' into branch-0.1.0
2 parents 2643a78 + c3fd41f commit 962f93d

File tree

8 files changed

+37
-39
lines changed

8 files changed

+37
-39
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Node 10.15 | https://nodejs.org/en/
1717

1818
### Fork pulsar-manager repository
1919

20-
Fork the [pulsar-manager](https://github.com/streamnative/pulsar-manager) repository to your GitHub repository.
20+
Fork the [pulsar-manager](https://github.com/apache/pulsar-manager) repository to your GitHub repository.
2121

2222
### Install pulsar-manager dependency
2323

@@ -62,14 +62,14 @@ Follow the instructions [here](https://howtodoinjava.com/automation/lombok-eclip
6262
1. Add a remote repository.
6363

6464
```bash
65-
$ git remote add streamnative [email protected]:streamnative/pulsar-manager.git
65+
$ git remote add apache [email protected]:apache/pulsar-manager.git
6666
```
6767

6868
2. Sync you local repository with the remote repository.
6969

7070
```bash
7171
$ git checkout master
72-
$ git pull streamnative master
72+
$ git pull apache master
7373
```
7474

7575
3. Create your PR and commit code changes.

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Apache Pulsar manager
22

3-
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fstreamnative%2Fpulsar-manager.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fstreamnative%2Fpulsar-manager?ref=badge_shield)
4-
53
Apache Pulsar manager is a web-based GUI management tool for managing and monitoring Pulsar.
64

75
## Feature
@@ -67,7 +65,7 @@ The pulsar-manager can monitor topics and subscriptions.
6765

6866

6967
## Prerequisites
70-
* Java 8 or later
68+
* Java JDK 1.8
7169
* Node 10.15.3 or later
7270
* Npm 6.4.1 or later
7371
* Pulsar 2.4.0 or later
@@ -92,17 +90,17 @@ The pulsar-manager can monitor topics and subscriptions.
9290
9391
* `REDIRECT_PORT`: the port of the front-end server.
9492
95-
* `DRIVER_CLASS_NAME`: the driver class name of MySQL.
93+
* `DRIVER_CLASS_NAME`: the driver class name of PostgreSQL.
9694
97-
* `URL`: the url of MySQL jdbc, example: jdbc:mysql://localhost:3306/pulsar_manager?useSSL=false
95+
* `URL`: the url of PostgreSQL jdbc, example: jdbc:postgresql://127.0.0.1:5432/pulsar_manager
9896
99-
* `USERNAME`: the username of MySQL
97+
* `USERNAME`: the username of PostgreSQL
10098
101-
* `PASSWORD`: the password of MySQL
99+
* `PASSWORD`: the password of PostgreSQL
102100
103101
```
104-
docker pull streamnative/pulsar-manager
105-
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
102+
docker pull apache/pulsar-manager
103+
docker run -it -p 9527:9527 -e REDIRECT_HOST=front-end-ip -e REDIRECT_PORT=front-end-port -e DRIVER_CLASS_NAME=org.postgresql.Driver -e URL='jdbc-url' -e USERNAME=root -e PASSWORD=pulsar pulsar-manager /bin/sh
106104
```
107105
108106
This is an example:
@@ -116,14 +114,16 @@ The pulsar-manager can monitor topics and subscriptions.
116114
(1) Download the source code.
117115
118116
```
119-
git clone https://github.com/streamnative/pulsar-manager
117+
git clone https://github.com/apache/pulsar-manager
120118
```
121119
122120
(2) Build and start the backend.
123121
```
124122
cd pulsar-manager
125123
./gradlew build -x test
126-
java -jar ./build/libs/pulsar-manager.jar
124+
cd build/distributions
125+
unzip pulsar-manager.zip or tar -zxvf pulsar-manager.tar
126+
./pulsar-manager/bin/pulsar-manager
127127
```
128128
129129
(3) Build and start the front end.
@@ -150,7 +150,7 @@ Pulsar Manager bundles JDBC Drivers for [HerdDB](https://github.com/diennea/herd
150150
The default confguration starts and embedded in-memory only HerdDB database.
151151
152152
HerdDB can be used in production, you just have to use the correct JDBC URL.
153-
Follow the instructions in [application.properties](https://github.com/streamnative/pulsar-manager/blob/master/src/main/resources/application.properties) to switch the connection to a standalone HerdDB service or cluster.
153+
Follow 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.
154154
155155
The JDBC URL will look like this:
156156
jdbc:herddb:server:localhost:7000
@@ -164,14 +164,10 @@ In order to start and setup an HerdDB database follow the instructions on the [H
164164
165165
## Back end
166166
167-
For more information about the back end, see [pulsar-manager-backend](https://github.com/streamnative/pulsar-manager/blob/master/src/README.md).
167+
For more information about the back end, see [pulsar-manager-backend](https://github.com/apache/pulsar-manager/blob/master/src/README.md).
168168
169169
170170
## Front end
171171
172-
For more information about the front end, see [pulsar-manager-frontend](https://github.com/streamnative/pulsar-manager/blob/master/front-end/README.md).
173-
174-
172+
For more information about the front end, see [pulsar-manager-frontend](https://github.com/apache/pulsar-manager/blob/master/front-end/README.md).
175173
176-
## License
177-
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fstreamnative%2Fpulsar-manager.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fstreamnative%2Fpulsar-manager?ref=badge_large)

docker/Dockerfile

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ ARG VERSION
2424
LABEL org.label-schema.build-date=$BUILD_DATE \
2525
org.label-schema.name="Apache Pulsar Manager" \
2626
org.label-schema.description="An Apache Pulsar Manager for management Pulsar clusters" \
27-
org.label-schema.url="https://github.com/streamnative/pulsar-manager" \
27+
org.label-schema.url="https://github.com/apache/pulsar-manager" \
2828
org.label-schema.vcs-ref=$VCS_REF \
29-
org.label-schema.vcs-url="https://github.com/streamnative/pulsar-manager" \
30-
org.label-schema.vendor="StreamNative Limited" \
29+
org.label-schema.vcs-url="https://github.com/apache/pulsar-manager" \
30+
org.label-schema.vendor="Apache Software Foundation" \
3131
org.label-schema.version=$VERSION \
3232
org.label-schema.schema-version="1.0"
3333

@@ -43,7 +43,9 @@ RUN mkdir -p /run/nginx
4343

4444
WORKDIR /pulsar-manager
4545

46-
COPY build/libs/*.jar pulsar-manager.jar
46+
COPY build/distributions/pulsar-manager.tar .
47+
48+
RUN tar -zxvf pulsar-manager.tar
4749

4850
COPY docker/supervisord.conf /etc/
4951

docker/supervisord.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ minfds=1024
2828
minprocs=200
2929

3030
[program:pulsar-manager-backend]
31-
command = /usr/bin/java -jar /pulsar-manager/pulsar-manager.jar --redirect.host=%(ENV_REDIRECT_HOST)s --redirect.port=%(ENV_REDIRECT_PORT)s --spring.datasource.driver-class-name=%(ENV_DRIVER_CLASS_NAME)s --spring.datasource.url=%(ENV_URL)s --spring.datasource.username=%(ENV_USERNAME)s --spring.datasource.password=%(ENV_PASSWORD)s --spring.datasource.initialization-mode=never
31+
command = /pulsar-manager/pulsar-manager/bin/pulsar-manager --redirect.host=%(ENV_REDIRECT_HOST)s --redirect.port=%(ENV_REDIRECT_PORT)s --spring.datasource.driver-class-name=%(ENV_DRIVER_CLASS_NAME)s --spring.datasource.url=%(ENV_URL)s --spring.datasource.username=%(ENV_USERNAME)s --spring.datasource.password=%(ENV_PASSWORD)s --spring.datasource.initialization-mode=never
3232
user = root

docs/developer-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ The code structure of the backend is shown below.
2020

2121
![backend-code](img/pulsar-manager-backend-code.png)
2222

23-
* The backend configuration file is [here](https://github.com/streamnative/pulsar-manager/blob/master/src/main/resources/application.properties).
24-
* The database schema is defined [here](https://github.com/streamnative/pulsar-manager/blob/master/src/main/resources/META-INF/sql/mysql-schema.sql)
23+
* The backend configuration file is [here](https://github.com/apache/pulsar-manager/blob/master/src/main/resources/application.properties).
24+
* The database schema is defined [here](https://github.com/apache/pulsar-manager/blob/master/src/main/resources/META-INF/sql/mysql-schema.sql)
2525

2626
### Add new RESTful API
2727

@@ -74,7 +74,7 @@ In the following class you can add some description information, error response,
7474
## Frontend
7575

7676
The frontend is developed based on [vue-element-admi](https://panjiachen.github.io/vue-element-admin-site/guide/) and [Element](https://element.eleme.cn/#/en-US).
77-
The development of the frontend is [here](https://github.com/streamnative/pulsar-manager/tree/master/front-end/src/views/management).
77+
The development of the frontend is [here](https://github.com/apache/pulsar-manager/tree/master/front-end/src/views/management).
7878

7979
![frontend-code](img/frontend-code.png)
8080

@@ -95,8 +95,8 @@ The RESTful interface is defined in the `api` folder.
9595

9696
2. Add a new page.
9797

98-
Add a new page [here](https://github.com/streamnative/pulsar-manager/tree/master/front-end/src/views/management).
99-
For example, [this](https://github.com/streamnative/pulsar-manager/blob/master/front-end/src/views/management/tenants/index.vue) is a tenant page. )
98+
Add a new page [here](https://github.com/apache/pulsar-manager/tree/master/front-end/src/views/management).
99+
For example, [this](https://github.com/apache/pulsar-manager/blob/master/front-end/src/views/management/tenants/index.vue) is a tenant page. )
100100

101101
3. Localization
102102

front-end/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
The pulsar-manager is tested with Chrome browser.
88

99
### Set cross domain
10-
Add [proxyTable](https://github.com/streamnative/pulsar-manager/blob/master/front-end/config/index.js).
10+
Add [proxyTable](https://github.com/apache/pulsar-manager/blob/master/front-end/config/index.js).
1111
For localhost debug
1212
```bash
1313
proxyTable: {
@@ -28,7 +28,7 @@ For localhost debug
2828

2929
## Deploy production environment
3030

31-
* Add the following parameters to the Nginx server configuration file [prod.env.js](https://github.com/streamnative/pulsar-manager/blob/master/front-end/config/prod.env.js).
31+
* Add the following parameters to the Nginx server configuration file [prod.env.js](https://github.com/apache/pulsar-manager/blob/master/front-end/config/prod.env.js).
3232
```
3333
module.exports = {
3434
NODE_ENV: '"production"',

front-end/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828
],
2929
"repository": {
3030
"type": "git",
31-
"url": "git+https://github.com/streamnative/pulsar-manager.git"
31+
"url": "git+https://github.com/apache/pulsar-manager.git"
3232
},
3333
"bugs": {
34-
"url": "https://github.com/streamnative/pulsar-manager/issues"
34+
"url": "https://github.com/apache/pulsar-manager/issues"
3535
},
3636
"dependencies": {
3737
"axios": "0.18.1",

src/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ Pulsar manager backend is a supplement and improvement to Pulsar broker.
2121
### How to set parameters when starting back-end services
2222

2323
```
24-
java -jar ./build/libs/pulsar-manager.jar --redirect.host=http://localhost --redirect.port=9527 insert.stats.interval=600000
24+
./build/distributions/pulsar-manager/bin/pulsar-manager --redirect.host=http://localhost --redirect.port=9527 insert.stats.interval=600000
2525
```
2626

2727
### Use custom databases
2828

2929
If you have a large amount of data, you can use a custom database. The following is an example of PostgreSQL.
3030

31-
1. Initialize database and table structures using [file](https://github.com/streamnative/pulsar-manager/tree/master/src/main/resources/META-INF/sql/postgresql-schema.sql).
31+
1. Initialize database and table structures using [file](https://github.com/apache/pulsar-manager/tree/master/src/main/resources/META-INF/sql/postgresql-schema.sql).
3232

33-
2. Modify the [configuration file](https://github.com/streamnative/pulsar-manager/blob/master/src/main/resources/application.properties) and add PostgreSQL configuration
33+
2. Modify the [configuration file](https://github.com/apache/pulsar-manager/blob/master/src/main/resources/application.properties) and add PostgreSQL configuration
3434

3535
```
3636
spring.datasource.driver-class-name=org.postgresql.Driver
@@ -60,7 +60,7 @@ For more information, see [Apache Pulsar](http://pulsar.apache.org/docs/en/secur
6060
* Method 1: Use command-line tool
6161

6262
```
63-
java -jar ./build/libs/pulsar-manager.jar --redirect.host=http://localhost --redirect.port=9527 insert.stats.interval=600000 --backend.jwt.token=token --jwt.broker.token.mode=PRIVATE --jwt.broker.private.key=file:///path/broker-private.key --jwt.broker.public.key=file:///path/broker-public.key
63+
./build/distributions/pulsar-manager/bin/pulsar-manager --redirect.host=http://localhost --redirect.port=9527 insert.stats.interval=600000 --backend.jwt.token=token --jwt.broker.token.mode=PRIVATE --jwt.broker.private.key=file:///path/broker-private.key --jwt.broker.public.key=file:///path/broker-public.key
6464
```
6565

6666
* Method 2. Configure the application.properties file

0 commit comments

Comments
 (0)