Skip to content

Commit 13608b5

Browse files
Haaroleangitbook-bot
authored andcommitted
GITBOOK-29: Update QS & Add helm pages
1 parent ccf2fd8 commit 13608b5

File tree

4 files changed

+62
-0
lines changed

4 files changed

+62
-0
lines changed

Diff for: SUMMARY.md

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
* [Configuration wizard](configuration/configuration-wizard.md)
2828
* [Configuration file](configuration/configuration-file.md)
2929
* [Compose examples](configuration/compose-examples.md)
30+
* [Helm charts](configuration/helm-charts/README.md)
31+
* [Configuration](configuration/helm-charts/configuration.md)
3032
* [Misc configuration properties](configuration/misc-configuration-properties.md)
3133
* [Permissions](configuration/permissions/README.md)
3234
* [Required Kafka ACLs](configuration/configuration/required-acls.md)

Diff for: configuration/helm-charts/README.md

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

Diff for: configuration/helm-charts/configuration.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Configuration
2+
3+
Most of the Helm charts parameters are common, follow table describes unique parameters related to application configuration.
4+
5+
#### Kafka-UI parameters
6+
7+
| Parameter | Description | Default |
8+
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
9+
| `existingConfigMap` | Name of the existing ConfigMap with Kafka-UI environment variables | `nil` |
10+
| `existingSecret` | Name of the existing Secret with Kafka-UI environment variables | `nil` |
11+
| `envs.secret` | Set of the sensitive environment variables to pass to Kafka-UI | `{}` |
12+
| `envs.config` | Set of the environment variables to pass to Kafka-UI | `{}` |
13+
| `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 | `{}` |
14+
| `yamlApplicationConfig` | Kafka-UI config in Yaml format | `{}` |
15+
| `networkPolicy.enabled` | Enable network policies | `false` |
16+
| `networkPolicy.egressRules.customRules` | Custom network egress policy rules | `[]` |
17+
| `networkPolicy.ingressRules.customRules` | Custom network ingress policy rules | `[]` |
18+
| `podLabels` | Extra labels for Kafka-UI pod | `{}` |
19+
20+
### Example
21+
22+
To install Kafka-UI need to execute follow:
23+
24+
```bash
25+
helm repo add kafka-ui https://provectus.github.io/kafka-ui
26+
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
27+
```
28+
29+
To connect to Kafka-UI web application need to execute:
30+
31+
```bash
32+
kubectl port-forward svc/kafka-ui 8080:80
33+
```
34+
35+
Open the `http://127.0.0.1:8080` on the browser to access Kafka-UI.

Diff for: configuration/quick-start.md

+22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Quick Start
22

3+
## Quick start (demo run)
4+
35
1. Ensure you have docker installed
46
2. Ensure your kafka cluster is available from the machine you're planning to run the app on
57
3. Run the following:
@@ -11,3 +13,23 @@ docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true provectuslabs/kafka-u
1113
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.
1214

1315
When you're done with testing, you can refer to the next articles to persist your config & deploy the app wherever you need to.
16+
17+
## Persistent start
18+
19+
Please ensure the target volume (`~/kui/config.yml`) of your config file does exist.
20+
21+
```
22+
services:
23+
kafka-ui:
24+
container_name: kafka-ui
25+
image: provectuslabs/kafka-ui:latest
26+
ports:
27+
- 8080:8080
28+
environment:
29+
DYNAMIC_CONFIG_ENABLED: true
30+
volumes:
31+
- ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml
32+
```
33+
34+
```
35+
```

0 commit comments

Comments
 (0)