Skip to content

Commit b7a599f

Browse files
authored
Merge pull request #3 from gnuhpc/0.10.x
Update README
2 parents 91c3355 + 2df9b07 commit b7a599f

File tree

2 files changed

+11
-132
lines changed

2 files changed

+11
-132
lines changed

README.adoc

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
= Kafka REST API
22

3-
43
[[_overview]]
54
== Overview
6-
Kafka/ZK REST API to perform some administration/metric monitor task in daily work.
7-
8-
// tag::base-t[]
9-
=== http://gnuhpc.vicp.io:8121/api[Demo URL for 0.10.x]
5+
Kafka/ZK REST API is to provide the production-ready endpoints to perform some administration/metric task for Kafka and Zookeeper.
106

117
// tag::base-t[]
128
.Following features are provided:
139
* Broker List
1410
* Topic create/delete/describe
1511
* Topic config create/update/delete/list
1612
* Topic partition add and reassign
17-
* Consumer group(old zk based/new kafka based) list/describe
13+
* Consumer group(old zookeeper based/new kafka based) list/describe
1814
* Offset check/reset
1915
* Consumer Group Lag check
2016
// end::base-t[]
@@ -39,21 +35,18 @@ Change the following settings of application-home.yml in src/main/resources to v
3935
kafka.brokers
4036
zookeeper.uris
4137

42-
#mvn clean package +
38+
#mvn clean package -Dmaven.test.skip=true+
4339

4440
You will find zip/tar under directory: Kafka-zk-restapi/target
4541

4642
You can get it running by unzip/untaring the distribution package and run bin/start.sh
4743

48-
49-
50-
5144
=== Support Kafka Version Information
52-
Currently, this rest api supports both kafka 0.11.x and 0.10.x brokers.
45+
Currently, this rest api (master branch) supports Kafka 0.10.x brokers. The master branch is the most active branch.
5346

54-
*For 0.10.x, please checkout the branch 0.10.x by calling the command:*
47+
*For 0.11.x, please checkout the branch 0.11.x by calling the command:*
5548

56-
git clone -b 0.10.x https://github.com/gnuhpc/Kafka-zk-restapi.git
49+
git clone -b 0.11.x https://github.com/gnuhpc/Kafka-zk-restapi.git
5750

5851
=== URI scheme
5952
[%hardbreaks]
@@ -63,17 +56,17 @@ __BasePath__ : /
6356
You can access Swagger-UI by accessing http://127.0.0.1:8121/api
6457

6558

66-
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/master/docs/paths.adoc[API LIST for 0.11]
67-
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/0.10.x/docs/paths.adoc[API LIST for 0.10.x]
59+
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/master/docs/paths.adoc[API LIST for 0.10]
60+
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/0.11.x/docs/paths.adoc[API LIST for 0.11.x]
6861

69-
image::https://raw.githubusercontent.com/gnuhpc/Kafka-zk-restapi/0.10.x/pics/ShowApi.png[API]
62+
image::https://raw.githubusercontent.com/gnuhpc/Kafka-zk-restapi/master/pics/ShowApi.png[API]
7063

7164
* kafka-controller : Kafka Api
7265
* zookeeper-controller : Zookeeper Api
7366

7467

75-
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/0.10.x/docs/definitions.adoc[Data Model Definitions for 0.10.x]
76-
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/master/docs/definitions.adoc[Data Model Definitions for 0.11]
68+
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/master/docs/definitions.adoc[Data Model Definitions for 0.10]
69+
=== https://github.com/gnuhpc/Kafka-zk-restapi/blob/0.11.x/docs/definitions.adoc[Data Model Definitions for 0.11.x]
7770

7871

7972
=== Version information

kafka-rest-springboot.iml

Lines changed: 0 additions & 114 deletions
This file was deleted.

0 commit comments

Comments
 (0)