Bläddra i källkod

GITBOOK-29: Update QS & Add helm pages

Roman Zabaluev 2 år sedan
förälder
incheckning
13608b59f2

+ 2 - 0
SUMMARY.md

@@ -27,6 +27,8 @@
 * [Configuration wizard](configuration/configuration-wizard.md)
 * [Configuration file](configuration/configuration-file.md)
 * [Compose examples](configuration/compose-examples.md)
+* [Helm charts](configuration/helm-charts/README.md)
+  * [Configuration](configuration/helm-charts/configuration.md)
 * [Misc configuration properties](configuration/misc-configuration-properties.md)
 * [Permissions](configuration/permissions/README.md)
   * [Required Kafka ACLs](configuration/configuration/required-acls.md)

+ 3 - 0
configuration/helm-charts/README.md

@@ -0,0 +1,3 @@
+# Helm charts
+
+UI for Apache Kafka is also available as a helm chart. See the underlying articles to learn more about it.

+ 35 - 0
configuration/helm-charts/configuration.md

@@ -0,0 +1,35 @@
+# Configuration
+
+Most of the Helm charts parameters are common, follow table describes unique parameters related to application configuration.
+
+#### Kafka-UI parameters
+
+| Parameter                                | Description                                                                                                                                    | Default |
+| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `existingConfigMap`                      | Name of the existing ConfigMap with Kafka-UI environment variables                                                                             | `nil`   |
+| `existingSecret`                         | Name of the existing Secret with Kafka-UI environment variables                                                                                | `nil`   |
+| `envs.secret`                            | Set of the sensitive environment variables to pass to Kafka-UI                                                                                 | `{}`    |
+| `envs.config`                            | Set of the environment variables to pass to Kafka-UI                                                                                           | `{}`    |
+| `yamlApplicationConfigConfigMap`         | Map with name and keyName keys, name refers to the existing ConfigMap, keyName refers to the ConfigMap key with Kafka-UI config in Yaml format | `{}`    |
+| `yamlApplicationConfig`                  | Kafka-UI config in Yaml format                                                                                                                 | `{}`    |
+| `networkPolicy.enabled`                  | Enable network policies                                                                                                                        | `false` |
+| `networkPolicy.egressRules.customRules`  | Custom network egress policy rules                                                                                                             | `[]`    |
+| `networkPolicy.ingressRules.customRules` | Custom network ingress policy rules                                                                                                            | `[]`    |
+| `podLabels`                              | Extra labels for Kafka-UI pod                                                                                                                  | `{}`    |
+
+### Example
+
+To install Kafka-UI need to execute follow:
+
+```bash
+helm repo add kafka-ui https://provectus.github.io/kafka-ui
+helm install kafka-ui kafka-ui/kafka-ui --set envs.config.KAFKA_CLUSTERS_0_NAME=local --set envs.config.KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka:9092
+```
+
+To connect to Kafka-UI web application need to execute:
+
+```bash
+kubectl port-forward svc/kafka-ui 8080:80
+```
+
+Open the `http://127.0.0.1:8080` on the browser to access Kafka-UI.

+ 22 - 0
configuration/quick-start.md

@@ -1,5 +1,7 @@
 # Quick Start
 
+## Quick start (demo run)
+
 1. Ensure you have docker installed
 2. Ensure your kafka cluster is available from the machine you're planning to run the app on
 3. Run the following:
@@ -11,3 +13,23 @@ docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true provectuslabs/kafka-u
 4. Go to \`[http://localhost:8080/ui/clusters/create-new-cluster](http://localhost:8080/ui/clusters/create-new-cluster)\` and configure your first cluster by pressing on "Configure new cluster" button.
 
 When you're done with testing, you can refer to the next articles to persist your config & deploy the app wherever you need to.
+
+## Persistent start
+
+Please ensure the target volume (`~/kui/config.yml`) of your config file does exist.
+
+```
+services:
+  kafka-ui:
+    container_name: kafka-ui
+    image: provectuslabs/kafka-ui:latest
+    ports:
+      - 8080:8080
+    environment:
+      DYNAMIC_CONFIG_ENABLED: true
+    volumes:
+      - ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml
+```
+
+```
+```