瀏覽代碼

GITBOOK-30: Add helm quick start page

Roman Zabaluev 2 年之前
父節點
當前提交
3afe9c65f4
共有 3 個文件被更改,包括 91 次插入2 次删除
  1. 1 0
      SUMMARY.md
  2. 81 0
      configuration/helm-charts/quick-start.md
  3. 9 2
      configuration/quick-start.md

+ 1 - 0
SUMMARY.md

@@ -28,6 +28,7 @@
 * [Configuration file](configuration/configuration-file.md)
 * [Compose examples](configuration/compose-examples.md)
 * [Helm charts](configuration/helm-charts/README.md)
+  * [Quick start](configuration/helm-charts/quick-start.md)
   * [Configuration](configuration/helm-charts/configuration.md)
 * [Misc configuration properties](configuration/misc-configuration-properties.md)
 * [Permissions](configuration/permissions/README.md)

+ 81 - 0
configuration/helm-charts/quick-start.md

@@ -0,0 +1,81 @@
+---
+description: Quick Start with Helm Chart
+---
+
+# Quick start
+
+## General
+
+1. Clone/Copy Chart to your working directory
+2. Execute command `helm install helm-release-name charts/kafka-ui`
+
+#### Passing Kafka-UI configuration as Dict
+
+Create values.yml file
+
+```
+yamlApplicationConfig:
+  kafka:
+    clusters:
+      - name: yaml
+        bootstrapServers:  kafka-cluster-broker-endpoints:9092
+  auth:
+    type: disabled
+  management:
+    health:
+      ldap:
+        enabled: false
+```
+
+Install by executing command
+
+> helm install helm-release-name charts/kafka-ui -f values.yml
+
+#### Passing configuration file as ConfigMap
+
+Create config map
+
+```
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: kafka-ui-existing-configmap-as-a-configfile
+data:
+  config.yml: |-
+    kafka:
+      clusters:
+        - name: yaml
+          bootstrapServers: kafka-cluster-broker-endpoints:9092
+    auth:
+      type: disabled
+    management:
+      health:
+        ldap:
+          enabled: false
+```
+
+This ConfigMap will be mounted to the Pod
+
+Install by executing the command
+
+> helm install helm-release-name charts/kafka-ui --set yamlApplicationConfigConfigMap.name="kafka-ui-config",yamlApplicationConfigConfigMap.keyName="config.yml"
+
+#### Passing environment variables as ConfigMap
+
+Create config map
+
+```
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: kafka-ui-helm-values
+data:
+  KAFKA_CLUSTERS_0_NAME: "kafka-cluster-name"
+  KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS: "kafka-cluster-broker-endpoints:9092"
+  AUTH_TYPE: "DISABLED"
+  MANAGEMENT_HEALTH_LDAP_ENABLED: "FALSE" 
+```
+
+Install by executing the command
+
+> helm install helm-release-name charts/kafka-ui --set existingConfigMap="kafka-ui-helm-values"

+ 9 - 2
configuration/quick-start.md

@@ -31,5 +31,12 @@ services:
       - ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml
 ```
 
-```
-```
+## AWS Marketplace
+
+To start the app quickly on AWS, please refer to **this page.**
+
+The app in AWS Marketplace could be found by [this link](https://aws.amazon.com/marketplace/pp/prodview-ogtt5hfhzkq6a).
+
+## Helm way
+
+To install the app via Helm please refer to [this page](helm-charts/quick-start.md).