New gifs for the readme (#1377)
* new gifs * Update README.md * Update README.md Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com> * Update README.md Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com> * Apply suggestions from code review * Delete apache-kafka-ui-interface-dashboard.png Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com>
This commit is contained in:
agolosen
GitHub
parent
0c60ac5132
commit
611307ef59
4 changed files with 52 additions and 45 deletions
97
README.md
97
README.md
|
|
@ -8,10 +8,10 @@
|
|||
|
||||
UI for Apache Kafka is a simple tool that makes your data flows observable, helps find and troubleshoot issues faster and deliver optimal performance. Its lightweight dashboard makes it easy to track key metrics of your Kafka clusters - Brokers, Topics, Partitions, Production, and Consumption.
|
||||
|
||||
Set up UI for Apache Kafka with just a couple of easy commands to visualize your Kafka data in a comprehensible way. You can run the tool locally or in the cloud.
|
||||
|
||||
|
||||
Set up UI for Apache Kafka with just a couple of easy commands to visualize your Kafka data in a comprehensible way. You can run the tool locally or in
|
||||
the cloud.
|
||||
|
||||
|
||||
|
||||
# Features
|
||||
* **Multi-Cluster Management** — monitor and manage all your clusters in one place
|
||||
|
|
@ -26,28 +26,72 @@ Set up UI for Apache Kafka with just a couple of easy commands to visualize your
|
|||
# The Interface
|
||||
UI for Apache Kafka wraps major functions of Apache Kafka with an intuitive user interface.
|
||||
|
||||
|
||||
|
||||
## Topics
|
||||
UI for Apache Kafka makes it easy for you to create topics in your browser by several clicks,
|
||||
pasting your own parameters, and viewing topics in the list.
|
||||
|
||||
|
||||
|
||||
|
||||
It's possible to jump from connectors view to corresponding topics and from a topic to consumers (back and forth) for more convenient navigation.
|
||||
connectors, overview topic`s settings.
|
||||
|
||||
|
||||
|
||||
### Messages
|
||||
Let's say we want to produce messages for our topic. With the UI for Apache Kafka we can send or write data/messages to the Kafka topics without effort by specifying parameters, and viewing messages in the list.
|
||||
|
||||
|
||||
|
||||
|
||||
## Schema registry
|
||||
There are 3 supported types of schemas: Avro®, JSON Schema, and Protobuf schemas.
|
||||
|
||||
|
||||
|
||||
Before producing avro-encoded messages, you have to add an avro schema for the topic in Schema Registry. Now all these steps are easy to do
|
||||
with a few clicks in a user-friendly interface.
|
||||
|
||||
|
||||
|
||||
# Getting Started
|
||||
|
||||
To run UI for Apache Kafka, you can use a pre-built Docker image or build it locally.
|
||||
|
||||
## Configuration
|
||||
|
||||
We have plenty of [docker-compose files](guides/yaml-description.md) as examples. They're built for various configuration stacks.
|
||||
|
||||
### Configuration File
|
||||
Example of how to configure clusters in the [application-local.yml](https://github.com/provectus/kafka-ui/blob/master/kafka-ui-api/src/main/resources/application-local.yml) configuration file:
|
||||
|
||||
|
||||
```sh
|
||||
kafka:
|
||||
clusters:
|
||||
-
|
||||
name: local
|
||||
bootstrapServers: localhost:29091
|
||||
zookeeper: localhost:2183
|
||||
schemaRegistry: http://localhost:8085
|
||||
schemaRegistryAuth:
|
||||
username: username
|
||||
password: password
|
||||
# schemaNameTemplate: "%s-value"
|
||||
jmxPort: 9997
|
||||
-
|
||||
```
|
||||
|
||||
* `name`: cluster name
|
||||
* `bootstrapServers`: where to connect
|
||||
* `zookeeper`: zookeeper service address
|
||||
* `schemaRegistry`: schemaRegistry's address
|
||||
* `schemaRegistryAuth.username`: schemaRegistry's basic authentication username
|
||||
* `schemaRegistryAuth.password`: schemaRegistry's basic authentication password
|
||||
* `schemaNameTemplate`: how keys are saved to schemaRegistry
|
||||
* `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 `-`.
|
||||
|
||||
## Running From Docker Image
|
||||
The official Docker image for UI for Apache Kafka is hosted here: [hub.docker.com/r/provectuslabs/kafka-ui](https://hub.docker.com/r/provectuslabs/kafka-ui).
|
||||
|
||||
|
|
@ -119,7 +163,6 @@ Then start UI for Apache Kafka with a **local** profile.
|
|||
./mvnw spring-boot:run -Pprod
|
||||
```
|
||||
|
||||
|
||||
## Running in Kubernetes
|
||||
``` bash
|
||||
helm repo add kafka-ui https://provectus.github.io/kafka-ui
|
||||
|
|
@ -131,6 +174,7 @@ To read more please follow to [chart documentation](charts/kafka-ui/README.md)
|
|||
|
||||
- [SSO configuration](guides/SSO.md)
|
||||
- [AWS IAM configuration](guides/AWS_IAM.md)
|
||||
- [Docker-compose files](guides/yaml-description.md)
|
||||
|
||||
## Connecting to a Secure Broker
|
||||
|
||||
|
|
@ -138,43 +182,6 @@ UI for Apache Kafka supports TLS (SSL) and SASL connections for [encryption and
|
|||
|
||||
To be continued
|
||||
|
||||
|
||||
# Configuration
|
||||
|
||||
We have plenty of docker-compose files as examples. Please check them out in ``docker`` directory.
|
||||
|
||||
## Configuration File
|
||||
Example of how to configure clusters in the [application-local.yml](https://github.com/provectus/kafka-ui/blob/master/kafka-ui-api/src/main/resources/application-local.yml) configuration file:
|
||||
|
||||
|
||||
```sh
|
||||
kafka:
|
||||
clusters:
|
||||
-
|
||||
name: local
|
||||
bootstrapServers: localhost:29091
|
||||
zookeeper: localhost:2183
|
||||
schemaRegistry: http://localhost:8085
|
||||
schemaRegistryAuth:
|
||||
username: username
|
||||
password: password
|
||||
# schemaNameTemplate: "%s-value"
|
||||
jmxPort: 9997
|
||||
-
|
||||
```
|
||||
|
||||
* `name`: cluster name
|
||||
* `bootstrapServers`: where to connect
|
||||
* `zookeeper`: zookeeper service address
|
||||
* `schemaRegistry`: schemaRegistry's address
|
||||
* `schemaRegistryAuth.username`: schemaRegistry's basic authentication username
|
||||
* `schemaRegistryAuth.password`: schemaRegistry's basic authentication password
|
||||
* `schemaNameTemplate`: how keys are saved to schemaRegistry
|
||||
* `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 `-`.
|
||||
|
||||
## <a name="env_variables"></a> Environment Variables
|
||||
|
||||
Alternatively, each variable of the .yml file can be set with an environment variable.
|
||||
|
|
|
|||
BIN
images/Connector_Topic_Consumer.gif
Normal file
BIN
images/Connector_Topic_Consumer.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.6 MiB |
BIN
images/Schema_Topic.gif
Normal file
BIN
images/Schema_Topic.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.8 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 87 KiB |
Loading…
Add table
Reference in a new issue