ricardoch/franz-manager-api repository overview

⁠Franz-manager-api

This api should work with the front-end franz-manager --> here⁠

⁠Environment variables

⁠Mandatory environment variables

⁠Deprecated (before commit cd17843b82611864f7cd24693f399ce47f78a64b

The api needs 2 environment variables to work :

• KAFKA_BROKERS (ie -> '127.0.0.2:2181,127.0.0.3:2181,127.0.0.4:2181')

• KAFKA_BROKERS_JMX (ie -> '127.0.0.2:9997,127.0.0.3:9997,127.0.0.4:9997')

⁠/!\ Breaking change (commit cd17843b82611864f7cd24693f399ce47f78a64b)

Franz-manager now supports multiple clusters, the 2 previous environment variables are not used anymore. You need to set this one:

• KAFKA_CONF =

[
     {
         "name": "cluster 1",
         "brokersConnectString": "127.0.0.2:2181,127.0.0.3:2181,127.0.0.4:2181",
         "jmxConnectString": "127.0.0.2:9997,127.0.0.3:9997,127.0.0.4:9997"
     },
     {
         "name": "cluster 2",
         "brokersConnectString": "127.0.0.5:2181,127.0.0.6:2181,127.0.0.7:2181",
         "jmxConnectString": "127.0.0.5:9997,127.0.0.6:9997,127.0.0.7:9997"
     }
]

⁠Not mandatory

You might also be interested in defining the following configuration :

• JVM_HEAP_SIZE (ie -> 512)

• LOG_LEVEL (ie -> warn)

⁠Development

First, install the dependencies by running mvn clean package.

Then, run the class FranzManagerApi.java.

Api should be available at localhost:1337

Apidoc can be found here --> localhost:1337/franz-manager-api/apidoc/⁠

⁠Docker

Install dependencies like previous step.

Build your docker : docker build -t franz-manager-api .

Then run it : docker run -e JVM_HEAP_SIZE=512 -e KAFKA_BROKERS="YOUR_KAFKA_BROKERS_STRING" -e KAFKA_BROKERS_JMX="YOUR_KAFKA_BROKERS_JMX" -p 1337:1337 franz-manager-api

Api should be available at localhost:1337

Apidoc can be found here --> localhost:1337/franz-manager-api/apidoc/⁠