Documentation/yaml description (#1374)
* 2 gifs * Update README.md * Update README.md Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com> Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com>
This commit is contained in:
parent
5d5d0c70be
commit
0326cf7c46
3 changed files with 12 additions and 1 deletions
13
README.md
13
README.md
|
@ -23,16 +23,27 @@ Set up UI for Apache Kafka with just a couple of easy commands to visualize your
|
||||||
* **Dynamic Topic Configuration** — create and configure new topics with dynamic configuration
|
* **Dynamic Topic Configuration** — create and configure new topics with dynamic configuration
|
||||||
* **Configurable Authentification** — secure your installation with optional Github/Gitlab/Google OAuth 2.0
|
* **Configurable Authentification** — secure your installation with optional Github/Gitlab/Google OAuth 2.0
|
||||||
|
|
||||||
# The Interface
|
# 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,
|
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.
|
pasting your own parameters, and viewing topics in the list.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
### 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.
|
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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
To run UI for Apache Kafka, you can use a pre-built Docker image or build it locally.
|
To run UI for Apache Kafka, you can use a pre-built Docker image or build it locally.
|
||||||
|
|
BIN
images/Create_schema.gif
Normal file
BIN
images/Create_schema.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2 MiB |
BIN
images/Interface.gif
Normal file
BIN
images/Interface.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 3.3 MiB |
Loading…
Add table
Reference in a new issue