|
@@ -1,15 +1,15 @@
|
|
|
- Kafka UI – Free Web UI for Kafka
|
|
|
+ UI for Apache Kafka – Free Web UI for Apache Kafka
|
|
|
------------------
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-<em>Kafka UI is a free open-source web UI for monitoring and management of Apache Kafka clusters. </em>
|
|
|
+<em>UI for Apache Kafka is a free open-source web UI for monitoring and management of Apache Kafka clusters. </em>
|
|
|
|
|
|
-Kafka UI 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.
|
|
|
+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 Kafka UI 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
|
|
@@ -25,10 +25,10 @@ Set up Kafka UI with just a couple of easy commands to visualize your Kafka data
|
|
|
|
|
|
# Getting Started
|
|
|
|
|
|
-To run Kafka UI, 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.
|
|
|
|
|
|
## Running From Docker Image
|
|
|
-The official Docker image for Kafka UI is hosted here: [hub.docker.com/r/provectuslabs/kafka-ui](https://hub.docker.com/r/provectuslabs/kafka-ui).
|
|
|
+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).
|
|
|
|
|
|
Launch Docker container in the background:
|
|
|
```sh
|
|
@@ -49,13 +49,13 @@ If you prefer to use `docker-compose` please refer to the [documentation](docker
|
|
|
|
|
|
## Building With Docker
|
|
|
|
|
|
-Steps to build Kafka UI locally with Docker:
|
|
|
+Steps to build UI for Apache Kafka locally with Docker:
|
|
|
|
|
|
1. Install prerequisites: Java and Docker
|
|
|
2. Clone this repository and open a terminal in the directory of the project
|
|
|
-3. Build a Docker container with Kafka UI
|
|
|
-4. Start Kafka UI with your Kafka clusters
|
|
|
-5. Navigate to Kafka UI
|
|
|
+3. Build a Docker container with UI for Apache Kafka
|
|
|
+4. Start UI for Apache Kafka with your Kafka clusters
|
|
|
+5. Navigate to UI for Apache Kafka
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
@@ -76,21 +76,21 @@ Steps to build Kafka UI locally with Docker:
|
|
|
|
|
|
Once you installed the prerequisites and cloned the repository, run the following commands in your project directory:
|
|
|
|
|
|
-Build a Docker container with Kafka UI:
|
|
|
+Build a Docker container with UI for Apache Kafka:
|
|
|
```sh
|
|
|
./mvnw clean install -Pprod
|
|
|
```
|
|
|
-Start Kafka UI with your Kafka clusters:
|
|
|
+Start UI for Apache Kafka with your Kafka clusters:
|
|
|
```sh
|
|
|
docker-compose -f ./docker/kafka-ui.yaml up
|
|
|
```
|
|
|
-To see Kafka UI, navigate to http://localhost:8080.
|
|
|
+To see UI for Apache Kafka, navigate to http://localhost:8080.
|
|
|
|
|
|
If you want to start only kafka-clusters:
|
|
|
```sh
|
|
|
docker-compose -f ./docker/kafka-clusters-only.yaml up
|
|
|
```
|
|
|
-Then start Kafka UI with a **local** profile.
|
|
|
+Then start UI for Apache Kafka with a **local** profile.
|
|
|
|
|
|
## Running Locally Without Docker
|
|
|
|
|
@@ -112,7 +112,7 @@ To be done
|
|
|
|
|
|
## Connecting to a Secure Broker
|
|
|
|
|
|
-Kafka UI supports TLS (SSL) and SASL connections for [encryption and authentication](http://kafka.apache.org/090/documentation.html#security). This can be configured by providing a combination of the following files (placed into the Kafka root directory):
|
|
|
+UI for Apache Kafka supports TLS (SSL) and SASL connections for [encryption and authentication](http://kafka.apache.org/090/documentation.html#security). This can be configured by providing a combination of the following files (placed into the Kafka root directory):
|
|
|
|
|
|
To be continued
|
|
|
|