Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion configuration/audit-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Logging can be done to either kafka topic and/or console.

See all the available configuration properties:

```
```yaml
kafka:
clusters:
- name: local
Expand Down
2 changes: 1 addition & 1 deletion configuration/authentication/aws-iam.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Please replace

#### Running From Docker Image

```
```bash
docker run -p 8080:8080 \
-e KAFKA_CLUSTERS_0_NAME=local \
-e KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=<KAFKA_URL> \
Expand Down
6 changes: 3 additions & 3 deletions configuration/authentication/basic-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ description: Basic username+password authentication

In order to enable basic username+passworda authentication add these properties:

```
```properties
AUTH_TYPE: "LOGIN_FORM"
SPRING_SECURITY_USER_NAME: admin
SPRING_SECURITY_USER_PASSWORD: pass
```

YAML config counterpart:

```
auth.
```yaml
auth:
type: LOGIN_FORM

spring:
Expand Down
2 changes: 1 addition & 1 deletion configuration/authentication/ldap-active-directory.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# LDAP / Active Directory

```
```yaml
auth:
type: LDAP
spring:
Expand Down
2 changes: 1 addition & 1 deletion configuration/authentication/sasl_scram.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Please replace

#### Running From Docker Image

```
```bash
docker run -p 8080:8080 \
-e KAFKA_CLUSTERS_0_NAME=<KAFKA_NAME> \
-e KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=<KAFKA_URL> \
Expand Down
12 changes: 10 additions & 2 deletions configuration/configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,19 @@ Rather than writing your config from a scratch, it would be more convenient to u

#### Providing a config path for the app instance:

**Docker**: `docker run -it -p 8080:8080 -e spring.config.additional-location=/tmp/config.yml -v /tmp/kui/config.yml:/tmp/config.yml ghcr.io/kafbat/kafka-ui`
**Docker**:

```bash
docker run -it \
-p 8080:8080 \
-e spring.config.additional-location=/tmp/config.yml \
-v /tmp/kui/config.yml:/tmp/config.yml \
ghcr.io/kafbat/kafka-ui
```

**Docker compose**:&#x20;

```
```yaml
services:
kafbat-ui:
container_name: kafbat-ui
Expand Down
5 changes: 2 additions & 3 deletions configuration/configuration-wizard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Since version 0.6 we added an ability to change cluster configs in runtime. This

Sample docker compose configuration:

```
```yaml
services:
kafbat-ui:
container_name: kafbat-ui
Expand All @@ -23,8 +23,7 @@ services:
DYNAMIC_CONFIG_ENABLED: 'true'
KAFKA_CLUSTERS_0_NAME: wizard_test
KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS: kafka0:29092

...
# ...
```

You can even omit all vars other than `DYNAMIC_CONFIG_ENABLED` to start the application with empty configs and setup it up after startup.
Expand Down
2 changes: 1 addition & 1 deletion configuration/data-masking.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ kafka:

Same configuration in env-vars fashion:

```
```properties
...
KAFKA_CLUSTERS_0_MASKING_0_TYPE: REMOVE
KAFKA_CLUSTERS_0_MASKING_0_FIELDS_0: "id"
Expand Down
12 changes: 6 additions & 6 deletions configuration/helm-charts/configuration/ssl-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ To implement SSL for kafbat-ui you need to provide JKS files into the pod. Here
To create configmap use following command.\


```
```bash
kubectl create configmap ssl-files --from-file=kafka.truststore.jks --from-file=kafka.keystore.jks
```

If you have specified namespace use command.\


```
```bash
kubectl create configmap ssl-files --from-file=kafka.truststore.jks --from-file=kafka.keystore.jks -n {{namespace}
```

Expand All @@ -26,7 +26,7 @@ kubectl create configmap ssl-files --from-file=kafka.truststore.jks --from-file=

Encode secret with base64(You can use this tool https://www.base64encode.org/). Create secret.yaml file with the following content

```
```yml
apiVersion: v1
kind: Secret
metadata:
Expand All @@ -41,7 +41,7 @@ data:

### Create ssl-values.yaml file with the following content.

```
```yml
existingSecret: "ssl-secret"


Expand All @@ -64,12 +64,12 @@ volumes:

### Install chart with command

```
```bash
helm install kafbat-ui kafbat-ui/helm-charts -f ssl-values.yaml
```

If you have specified namespace for configmap and secret please use this command

```
```bash
helm install kafbat-ui kafbat-ui/helm-charts -f ssl-values.yaml -n {namespace}
```
23 changes: 14 additions & 9 deletions configuration/helm-charts/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ description: Quick Start with Helm Chart
1. Clone/Copy Chart to your working directory
2. Execute command

```
```bash
helm repo add kafbat-ui https://kafbat.github.io/helm-charts
helm install kafbat-ui kafbat-ui/kafka-ui
```
```

#### Passing Kafbat-UI configuration as Dict

Create values.yml file

```
```yaml
yamlApplicationConfig:
kafka:
clusters:
Expand All @@ -34,13 +34,15 @@ yamlApplicationConfig:

Install by executing command

> helm install kafbat-ui kafbat-ui/kafka-ui -f values.yml
```bash
helm install kafbat-ui kafbat-ui/kafka-ui -f values.yml
```

#### Passing configuration file as ConfigMap

Create config map

```
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
Expand All @@ -63,13 +65,15 @@ This ConfigMap will be mounted to the Pod

Install by executing the command

> helm install kafbat-ui kafbat-ui/kafka-ui --set yamlApplicationConfigConfigMap.name="kafka-ui-configmap",yamlApplicationConfigConfigMap.keyName="config.yml"
```bash
helm install kafbat-ui kafbat-ui/kafka-ui --set yamlApplicationConfigConfigMap.name="kafka-ui-configmap",yamlApplicationConfigConfigMap.keyName="config.yml"
```

#### Passing environment variables as ConfigMap

Create config map

```
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
Expand All @@ -80,7 +84,8 @@ data:
AUTH_TYPE: "DISABLED"
MANAGEMENT_HEALTH_LDAP_ENABLED: "FALSE"
```

Install by executing the command

> helm install kafbat-ui kafbat-ui/kafka-ui --set existingConfigMap="kafbat-ui-helm-values"
```bash
helm install kafbat-ui kafbat-ui/kafka-ui --set existingConfigMap="kafbat-ui-helm-values"
```
6 changes: 3 additions & 3 deletions configuration/helm-charts/resource-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ There are two options:

To set or change resource limits for pods you need to create the file `values.yaml` and add the following lines:

```
```yaml
resources:
limits:
cpu: 200m
Expand All @@ -22,14 +22,14 @@ resources:

Specify `values.yaml` file during chart install

```
```bash
helm install kafka-ui kafka-ui/kafka-ui -f values.yaml
```

### Set limits via CLI

To set limits via CLI you need to specify limits with helm install command.

```
```bash
helm install kafka-ui kafka-ui/kafka-ui --set resources.limits.cpu=200m --set resources.limits.memory=512Mi --set resources.requests.memory=256Mi --set resources.requests.cpu=200m
```
2 changes: 1 addition & 1 deletion configuration/helm-charts/sticky-sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The solution for this would be using sticky session/session affinity.

An example:

```
```properties
nginx.ingress.kubernetes.io/affinity: cookie
nginx.ingress.kubernetes.io/affinity-mode: balanced
nginx.ingress.kubernetes.io/session-cookie-expires: "172800"
Expand Down
2 changes: 1 addition & 1 deletion configuration/misc-configuration-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A reminder: any of these properties can be converted into yaml config properties

becomes

```
```yaml
kafka:
clusters:
- bootstrapServers: xxx
Expand Down
16 changes: 8 additions & 8 deletions configuration/rbac-role-based-access-control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ First of all, you have to decide if either:

This is how you include one more file to start with a docker-compose example:

```
```yaml
services:
kafbat-ui:
container_name: kafbat-ui
Expand All @@ -38,7 +38,7 @@ Alternatively, you can append the roles file contents to your main config file.

In the roles file we define roles, duh. Every role has access to defined clusters:

```
```yaml
rbac:
roles:
- name: "memelords"
Expand All @@ -53,7 +53,7 @@ rbac:

A role also has a list of _subjects_ which are the entities we will use to assign roles to. They are provider-dependant, in general, they can be users, groups, or some other entities (github orgs, google domains, LDAP queries, etc.) In this example we define a role `memelords` that will contain all the users within the Google domain `memelord.lol` and, additionally, a GitHub user `Haarolean`. You can combine as many subjects as you want within a role.

```
```yaml
- name: "memelords"
subjects:
- provider: oauth_google
Expand All @@ -68,7 +68,7 @@ The subject value is either a fixed string or a regular expression identifying a
Regular expression works for any combination of `provider` and `type`.
In this example, we define a role `admins` that will contain all the users with an oauth role ending with `-ADMIN`.

```
```yaml
- name: "admins"
subjects:
- provider: oauth
Expand Down Expand Up @@ -100,7 +100,7 @@ The next thing which is present in your roles file is, surprisingly, permissions
2. The resource value is either a fixed string or a regular expression identifying a resource. Value is not applicable to `clusterconfig` and `ksql` resources. Please do not fill it out.
3. Actions It's a list of actions (the possible values depend on the resource, see the lists below) that will be applied to the certain permission. Also, note, there's a special action for any of the resources called "all", it will virtually grant all the actions within the corresponding resource. An example for enabling viewing and creating topics whose name start with "derp":

```
```yaml
permissions:
- resource: topic
value: "derp.*"
Expand All @@ -126,7 +126,7 @@ A list of all the actions for the corresponding resources (please note neither r

**A complete file example:**

```
```yaml
rbac:
roles:
- name: "memelords"
Expand Down Expand Up @@ -222,7 +222,7 @@ rbac:

**A read-only setup:**

```
```yaml
rbac:
roles:
- name: "readonly"
Expand Down Expand Up @@ -260,7 +260,7 @@ rbac:

**An admin-group setup example:**

```
```yaml
rbac:
roles:
- name: "admins"
Expand Down
2 changes: 1 addition & 1 deletion configuration/serialization-serde.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Base64 (RFC4648) binary data representation. Can be useful in case if the actual

Class name: `io.kafbat.ui.serdes.builtin.HexSerde`

```
```yaml
kafka:
clusters:
- name: Cluster1
Expand Down
Loading