0ct0pu5/kafka-ui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updating documentation for read only mode (#247)

Browse source 
Co-authored-by: andormarkus <andormarkus@marc-o-polo.com>
This commit is contained in:
Andor Markus 2021-03-12 09:54:28 +01:00 • committed by GitHub
parent 6355bf3d69
commit c91d6aad9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -39,7 +39,8 @@ docker run -p 8080:8080 \
-d provectuslabs/kafka-ui:latest -d provectuslabs/kafka-ui:latest
``` ```
Then access the web UI at [http://localhost:8080](http://localhost:8080). Then access the web UI at [http://localhost:8080](http://localhost:8080).
Further configuration with environment variables - [see environment variables](#env_variables)
### Docker Compose ### Docker Compose
@ -138,10 +139,11 @@ kafka:
* `schemaRegistry`: schemaRegistry's address * `schemaRegistry`: schemaRegistry's address
* `schemaNameTemplate`: how keys are saved to schemaRegistry * `schemaNameTemplate`: how keys are saved to schemaRegistry
* `jmxPort`: open jmxPosrts of a broker * `jmxPort`: open jmxPosrts of a broker
* `readOnly`: enable read only mode
Configure as many clusters as you need by adding their configs below separated with `-`. Configure as many clusters as you need by adding their configs below separated with `-`.
## Environment Variables ## <a name="env_variables"></a> Environment Variables
Alternatively, each variable of of the .yml file can be set with an environment variable. Alternatively, each variable of of the .yml file can be set with an environment variable.
For example, if you want to use an environment variable to set the `name` parameter, you can write it like this: `KAFKA_CLUSTERS_2_NAME` For example, if you want to use an environment variable to set the `name` parameter, you can write it like this: `KAFKA_CLUSTERS_2_NAME`
@ -154,6 +156,7 @@ For example, if you want to use an environment variable to set the `name` parame
|`KAFKA_CLUSTERS_0_SCHEMAREGISTRY` |SchemaRegistry's address |`KAFKA_CLUSTERS_0_SCHEMAREGISTRY` |SchemaRegistry's address
|`KAFKA_CLUSTERS_0_SCHEMANAMETEMPLATE` |How keys are saved to schemaRegistry |`KAFKA_CLUSTERS_0_SCHEMANAMETEMPLATE` |How keys are saved to schemaRegistry
|`KAFKA_CLUSTERS_0_JMXPORT` |Open jmxPosrts of a broker |`KAFKA_CLUSTERS_0_JMXPORT` |Open jmxPosrts of a broker
|`KAFKA_CLUSTERS_0_READONLY` |Enable read only mode. Default: false

27
docker-compose.md
View file

@ -1,5 +1,7 @@
# Quick Start with docker-compose # Quick Start with docker-compose
Envinronment variables documentation - [see usage](README.md#env_variables)
* Add a new service in docker-compose.yml * Add a new service in docker-compose.yml
```yaml ```yaml
@ -9,14 +11,31 @@ services:
image: provectuslabs/kafka-ui image: provectuslabs/kafka-ui
container_name: kafka-ui container_name: kafka-ui
ports: ports:
- "9000:8080" - "8080:8080"
restart: always restart: always
environment: environment:
-e KAFKA_CLUSTERS_0_NAME=local - KAFKA_CLUSTERS_0_NAME=local
-e KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka:9092 - KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka:9092
-e KAFKA_CLUSTERS_0_ZOOKEEPER=localhost:2181 - KAFKA_CLUSTERS_0_ZOOKEEPER=localhost:2181
``` ```
* If you prefer Kafka UI in read only mode
```yaml
version: '2'
services:
kafka-ui:
image: provectuslabs/kafka-ui
container_name: kafka-ui
ports:
- "8080:8080"
restart: always
environment:
- KAFKA_CLUSTERS_0_NAME=local
- KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka:9092
- KAFKA_CLUSTERS_0_ZOOKEEPER=localhost:2181
- KAFKA_CLUSTERS_0_READONLY=true
```
* Start Kafka UI process * Start Kafka UI process