README v.1 - new structure (#70)

* README v.1 - new structure, add images, logo

* Update README.md

README.md

@@ -1,49 +1,156 @@
-# Kafka-UI
+![Kafka UI logo](images/kafka-ui-logo.png) Kafka UI – Free Web UI for Kafka   
+------------------
 
-UI for Apache Kafka management
+![Kafka UI Price Free](images/free-open-source.svg)
 
-## Prerequisites
+<em>Kafka UI 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. 
+
+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. 
+
+![Kafka UI interface dashboard screenshot](images/kafka-ui-interface-dashboard.png)
+
+
+# Features
+* **Multi-Cluster Management** — monitor and manage all your clusters in one place
+* **Performance Monitoring with Metrics Dashboard** —  track key Kafka metrics with a lightweight dashboard
+* **View Kafka Brokers** — view topic and partition assignments, controller status
+* **View Kafka Topics** — view partition count, replication status, and custom configuration
+* **View Consumer Groups** — view per-partition parked offsets, combined and per-partition lag
+* **Browse Messages** — browse messages with JSON, plain text and Avro encoding
+* **Dynamic Topic Configuration** — create and configure new topics with dynamic configuration
+* **Configurable Authentification** — secure your installation with optional Github/Gitlab/Google OAuth 2.0
+ 
+
+# Getting Started
+
+To run Kafka UI, 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/provectus/kafka-ui](https://hub.docker.com/r/provectus/kafka-ui).
+
+Launch Docker container in the background:
+```sh
+
+docker run -d {}/kafka-ui-api:latest 
+	-e KAFKA_CLUSTERS_0_NAME=local 
+	-e KAFKA_CLUSTERS_0__BOOTSTRAPSERVERS=kafka0:29092
 
-Install Homebrew Cask
 ```
+Then access the web UI at [http://localhost:9000](http://localhost:9000).
+ 
+
+## Building With Docker
+
+Steps to build Kafka UI 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 
+
+### Prerequisites
+
+* Java 13 or newer
+* Docker 
+
+### Installing Prerequisites on Mac
+1. Install Homebrew Cask:
+```sh
 > brew update
 > brew cask
 ``` 
-
+2. Install JAVA 13 with Homebrew Cask:
-Install JAVA 13 with Homebrew Cask
+```sh
-```
 > brew tap homebrew/cask-versions
 > brew cask install java (or java13 if 13th version is not the latest one)
 ``` 
+### Building
 
+Once you installed the prerequisites and cloned the repository, run the following commands in your project directory: 
 
-## Getting started
+Build a Docker container with Kafka UI: 
-
+```sh
-Build application and docker container
-
-```
 ./mvnw clean install -Pprod
 ``` 
-
+Start Kafka UI with your Kafka clusters: 
-Start application with kafka clusters
+```sh
-
-```
 docker-compose -f ./docker/kafka-ui.yaml up
 ``` 
+To see Kafka UI, navigate to http://localhost:8080.
 
-Application should be available at http://localhost:8080.
+If you want to start only kafka-clusters: 
-
+```sh
-To start only kafka-clusters:
-
-```
 docker-compose -f ./docker/kafka-clusters-only.yaml up
 ``` 
+Then start Kafka UI with a **local** profile. 
 
-Kafka-ui then should be started with **local** profile
+## Running Locally Without Docker
 
-### Run application without docker:
+```sh
-
-```
-cd kafka-ui-api
 ./mvnw spring-boot:run -Pprod
 ``` 
+
+
+## Running in Kubernetes
+To be done
+
+# Guides
+
+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):
+
+To be continued
+
+
+# Configuration
+
+## 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
+#     schemaNameTemplate: "%s-value"
+      jmxPort: 9997
+    -
+```    
+
+* `name`: cluster name
+* `bootstrapServers`: where to connect
+* `zookeeper`: zookeeper service address
+* `schemaRegistry`: schemaRegistry's address
+* `schemaNameTemplate`: how keys are saved to schemaRegistry
+* `jmxPort`: open jmxPosrts of a broker
+
+Configure as many clusters as you need by adding their configs below separated with `-`.
+
+## Environment Variables
+
+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`
+
+|Name               	|Description
+|-----------------------|-------------------------------
+|`KAFKA_CLUSTERS_2_NAME` | Cluster name
+|`KAFKA_CLUSTERS_2_BOOTSTRAPSERVERS` 	|Address where to connect 
+|`KAFKA_CLUSTERS_2_ZOOKEEPER` 	| Zookeper service address 
+|`KAFKA_CLUSTERS_2_SCHEMAREGISTRY`   	|SchemaRegistry's address
+|`KAFKA_CLUSTERS_2_SCHEMANAMETEMPLATE`  |How keys are saved to schemaRegistry
+|`KAFKA_CLUSTERS_2_JMXPORT`        	|Open jmxPosrts of a broker
+
+ 
+
+ 
+

images/free-open-source.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="74" height="20"><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="74" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="37" height="20" fill="#0098f7"/><rect width="74" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">price</text><text x="195" y="140" transform="scale(.1)" textLength="270">price</text><text x="545" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">FREE</text><text x="545" y="140" transform="scale(.1)" textLength="270">FREE</text></g></svg>