Forráskód Böngészése

Helm Chart Quick Start (#2176)

* add quickstart readme for helm chart

* add link to root README.md

* fix configurationfile example stored in configmap

* change order of possible deployment configuration

Co-authored-by: Azat Safin <azsafin@provectus.com>
azatsafin 3 éve
szülő
commit
101ebc55ef
3 módosított fájl, 70 hozzáadás és 1 törlés
  1. 4 0
      README.md
  2. 1 1
      charts/kafka-ui/templates/configmap_fromValues.yaml
  3. 65 0
      helm_chart.md

+ 4 - 0
README.md

@@ -124,6 +124,10 @@ Further configuration with environment variables - [see environment variables](#
 
 If you prefer to use `docker-compose` please refer to the [documentation](docker-compose.md).
 
+### Helm chart
+Helm chart could be found under [charts/kafka-ui](https://github.com/provectus/kafka-ui/tree/master/charts/kafka-ui) directory
+
+Quick-start instruction [here](helm_chart.md)
 
 ## Building With Docker
 

+ 1 - 1
charts/kafka-ui/templates/configmap_fromValues.yaml

@@ -6,6 +6,6 @@ metadata:
   labels:
     {{- include "kafka-ui.labels" . | nindent 4 }}
 data:
-  config.yml: 
+  config.yml: |-
     {{- toYaml .Values.yamlApplicationConfig | nindent 4}}
 {{ end }}

+ 65 - 0
helm_chart.md

@@ -0,0 +1,65 @@
+# Quick Start with Helm Chart
+
+### 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 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 command
+> helm install helm-release-name charts/kafka-ui --set existingConfigMap="kafka-ui-helm-values"