Skip to content

Commit 1420fa9

Browse files
authored
Update naming stuff
to reflect changes from the repo itself
1 parent 3fb1362 commit 1420fa9

36 files changed

+143
-142
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
description: About Kafka-UI
2+
description: About Kafbat-UI
33
---
44

55
# About
66

7-
**UI for Apache Kafka** is a versatile, fast, and lightweight web UI for managing Apache Kafka® clusters. Built by developers, for developers.
7+
**Kafbat UI** is a versatile, fast, and lightweight web UI for managing Apache Kafka® clusters. Built by developers, for developers.
88

99

1010

1111
The app is a free, open-source web UI to monitor and manage Apache Kafka clusters.
1212

13-
UI for Apache Kafka is a simple tool that makes your data flows observable, helps find and troubleshoot issues faster and delivers optimal performance. Its lightweight dashboard makes it easy to track key metrics of your Kafka clusters - Brokers, Topics, Partitions, Production, and Consumption.
13+
Kafbat UI is a simple tool that makes your data flows observable, helps find and troubleshoot issues faster and delivers optimal performance. Its lightweight dashboard makes it easy to track key metrics of your Kafka clusters - Brokers, Topics, Partitions, Production, and Consumption.

configuration/audit-log.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Audit log
22

3-
Kafka-UI allows you to log all operations to your kafka clusters done within kafka-ui itself.
3+
Kafbat-UI allows you to log all operations to your kafka clusters done within kafbat-ui itself.
44

55
Logging can be done to either kafka topic and/or console.
66

configuration/authentication/aws-iam.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: How to configure AWS IAM Authentication
44

55
# AWS IAM
66

7-
UI for Apache Kafka comes with a built-in [aws-msk-iam-auth](https://github.com/aws/aws-msk-iam-auth) library.
7+
Kafbat UI comes with a built-in [aws-msk-iam-auth](https://github.com/aws/aws-msk-iam-auth) library.
88

99
You could pass SASL configs in the properties section for each cluster.
1010

@@ -29,7 +29,7 @@ docker run -p 8080:8080 \
2929
-e KAFKA_CLUSTERS_0_PROPERTIES_SASL_MECHANISM=AWS_MSK_IAM \
3030
-e KAFKA_CLUSTERS_0_PROPERTIES_SASL_CLIENT_CALLBACK_HANDLER_CLASS=software.amazon.msk.auth.iam.IAMClientCallbackHandler \
3131
-e KAFKA_CLUSTERS_0_PROPERTIES_SASL_JAAS_CONFIG=software.amazon.msk.auth.iam.IAMLoginModule required awsProfileName="<PROFILE_NAME>"; \
32-
-d provectuslabs/kafka-ui:latest
32+
-d ghcr.io/kafbat/kafka-ui
3333
```
3434

3535
#### Configuring by application.yaml

configuration/authentication/oauth2.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ auth:
8686
user-name-attribute: email
8787
custom-params:
8888
type: google
89-
allowedDomain: provectus.com # for RBAC
89+
allowedDomain: kafbat.io # for RBAC
9090
```
9191

9292
### Azure
@@ -116,7 +116,7 @@ auth:
116116

117117
Example of callback URL for github OAuth app settings:
118118

119-
`https://www.kafka-ui.provectus.io/login/oauth2/code/github`
119+
`https://kafbat.io/login/oauth2/code/github`
120120

121121
For the self-hosted installation find the properties a little bit below.
122122

configuration/authentication/sasl_scram.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ docker run -p 8080:8080 \
2424
-e KAFKA_CLUSTERS_0_PROPERTIES_SECURITY_PROTOCOL=SASL_SSL \
2525
-e KAFKA_CLUSTERS_0_PROPERTIES_SASL_MECHANISM=SCRAM-SHA-512 \
2626
-e KAFKA_CLUSTERS_0_PROPERTIES_SASL_JAAS_CONFIG=org.apache.kafka.common.security.scram.ScramLoginModule required username="<KAFKA_USERNAME>" password="<KAFKA_PASSWORD>"; \
27-
-d provectuslabs/kafka-ui:latest
27+
-d ghcr.io/kafbat/kafka-ui
2828
```
2929

3030
#### Running From Docker-compose file
@@ -34,9 +34,9 @@ docker run -p 8080:8080 \
3434
version: '3.4'
3535
services:
3636

37-
kafka-ui:
38-
image: provectuslabs/kafka-ui
39-
container_name: kafka-ui
37+
kafbat-ui:
38+
image: ghcr.io/kafbat/kafka-ui
39+
container_name: kafbat-ui
4040
ports:
4141
- "888:8080"
4242
restart: always

configuration/authentication/sso-guide.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This is a main parameters required for enabling SSO
3030

3131
### Step 3
3232

33-
To launch UI for Apache Kafka with enabled TLS and SSO run following:
33+
To launch Kafbat UI with enabled TLS and SSO run following:
3434

3535
```bash
3636
docker run -p 8080:8080 -v `pwd`/cert:/opt/cert -e AUTH_TYPE=LOGIN_FORM \
@@ -46,7 +46,7 @@ docker run -p 8080:8080 -v `pwd`/cert:/opt/cert -e AUTH_TYPE=LOGIN_FORM \
4646
-e SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_AUTH0_SCOPE=openid \
4747
-e TRUST_STORE=/opt/cert/ui-for-apache-kafka.p12 \
4848
-e TRUST_STORE_PASSWORD=123456 \
49-
provectuslabs/kafka-ui:latest
49+
ghcr.io/kafbat/kafka-ui
5050
```
5151

5252
In the case with trusted CA-signed SSL certificate and SSL termination somewhere outside of application we can pass only SSO related environment variables:
@@ -57,12 +57,12 @@ docker run -p 8080:8080 -v `pwd`/cert:/opt/cert -e AUTH_TYPE=OAUTH2 \
5757
-e SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_AUTH0_CLIENTSECRET=YXfRjmodifiedTujnkVr7zuW9ECCAK4TcnCio-i \
5858
-e SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_AUTH0_ISSUER_URI=https://dev-a63ggcut.auth0.com/ \
5959
-e SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_AUTH0_SCOPE=openid \
60-
provectuslabs/kafka-ui:latest
60+
ghcr.io/kafbat/kafka-ui
6161
```
6262

6363
### Step 4 (Load Balancer HTTP) (optional)
6464

65-
If you're using load balancer/proxy and use HTTP between the proxy and the app, you might want to set `server_forward-headers-strategy` to `native` as well (`SERVER_FORWARDHEADERSSTRATEGY=native`), for more info refer to [this issue](https://github.com/provectus/kafka-ui/issues/1017).
65+
If you're using load balancer/proxy and use HTTP between the proxy and the app, you might want to set `server_forward-headers-strategy` to `native` as well (`SERVER_FORWARDHEADERSSTRATEGY=native`), for more info refer to [this issue](https://github.com/kafbat/kafka-ui/issues/1017).
6666

6767
### Step 5 (Azure) (optional)
6868

@@ -82,7 +82,7 @@ docker run -p 8080:8080 \
8282
-e AUTH_OAUTH2_CLIENT_AZURE_PROVIDER="azure" \
8383
-e AUTH_OAUTH2_CLIENT_AZURE_ISSUERURI="https://login.microsoftonline.com/{tenant_id}/v2.0" \
8484
-e AUTH_OAUTH2_CLIENT_AZURE_JWKSETURI="https://login.microsoftonline.com/{tenant_id}/discovery/v2.0/keys" \
85-
-d provectuslabs/kafka-ui:latest"
85+
-d ghcr.io/kafbat/kafka-ui"
8686
```
8787
8888
Note that scope is created by default when Application registration is done in Azure portal. You'll need to update application registration manifest to include `"accessTokenAcceptedVersion": 2`

configuration/compose-examples.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ description: A list of ready-to-go docker compose files for various setup scenar
44

55
# Compose examples
66

7-
[https://github.com/provectus/kafka-ui/blob/master/documentation/compose/DOCKER\_COMPOSE.md](https://github.com/provectus/kafka-ui/blob/master/documentation/compose/DOCKER\_COMPOSE.md)
7+
[https://github.com/kafbat/kafka-ui/blob/main/documentation/compose/DOCKER\_COMPOSE.md](https://github.com/kafbat/kafka-ui/blob/main/documentation/compose/DOCKER\_COMPOSE.md)

configuration/configuration-file.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Rather than writing your config from a scratch, it would be more convenient to u
1616

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

19-
**Docker**: `docker run -it -p 8080:8080 -e spring.config.additional-location=/tmp/config.yml -v /tmp/kui/config.yml:/tmp/config.yml provectuslabs/kafka-ui`
19+
**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`
2020

2121
**Docker compose**:&#x20;
2222

2323
```
2424
services:
25-
kafka-ui:
26-
container_name: kafka-ui
27-
image: provectuslabs/kafka-ui:latest
25+
kafbat-ui:
26+
container_name: kafbat-ui
27+
image: ghcr.io/kafbat/kafka-ui
2828
environment:
2929
KAFKA_CLUSTERS_0_NAME: local
3030
# other properties, omitted

configuration/configuration-wizard.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
![](../.gitbook/assets/image.png)![](<../.gitbook/assets/image (1).png>)
66

7-
By default, kafka-ui does not allow to change of its configuration in runtime. When the application is started it reads configuration from system env, config files (ex. application.yaml), and JVM arguments (set by `-D`). Once the configuration was read it was treated as immutable and won't be refreshed even if the config source (ex. file) was changed.
7+
By default, kafbat-ui does not allow to change of its configuration in runtime. When the application is started it reads configuration from system env, config files (ex. application.yaml), and JVM arguments (set by `-D`). Once the configuration was read it was treated as immutable and won't be refreshed even if the config source (ex. file) was changed.
88

99
Since version 0.6 we added an ability to change cluster configs in runtime. This option is disabled by default and should be implicitly enabled. To enable it, you should set `DYNAMIC_CONFIG_ENABLED` env property to `true` or add `dynamic.config.enabled: true` property to your yaml config file.
1010

1111
Sample docker compose configuration:
1212

1313
```
1414
services:
15-
kafka-ui:
16-
container_name: kafka-ui
17-
image: provectuslabs/kafka-ui:latest
15+
kafbat-ui:
16+
container_name: kafbat-ui
17+
image: ghcr.io/kafbat/kafka-ui
1818
ports:
1919
- 8080:8080
2020
depends_on:
@@ -35,11 +35,11 @@ When the dynamic config feature is enabled you will see additional buttons that
3535

3636
#### Dynamic config files
3737

38-
Kafka-ui is a stateless application by its nature, so, when you edit configuration during runtime, it will store configuration additions on the container's filesystem (in `dynamic_config.yaml` file). Dynamic config file will be overridden on each configuration submission.
38+
Kafbat-UI is a stateless application by its nature, so, when you edit configuration during runtime, it will store configuration additions on the container's filesystem (in `dynamic_config.yaml` file). Dynamic config file will be overridden on each configuration submission.
3939

4040
During the configuration process, you can also upload configuration-related files (like truststore and keystores). They will be stored in `etc/kafkaui/uploads` a folder with a unique timestamp suffix to prevent name collision. In the wizard, you can also use files that were mounted to the container's filesystem, without uploading them directly.
4141

42-
**Note**, that if the container is recreated, your edited (and uploaded) files won't be present and the app will be started with static configuration only. If you want to be able to keep the configuration created by wizard, you have to mount/copy the same files into newly created kafka-ui containers (whole `/etc/kafkaui/` folder, by default).
42+
**Note**, that if the container is recreated, your edited (and uploaded) files won't be present and the app will be started with static configuration only. If you want to be able to keep the configuration created by wizard, you have to mount/copy the same files into newly created kafbat-ui containers (whole `/etc/kafkaui/` folder, by default).
4343

4444
Properties, specified where dynamic config files will be persisted:
4545

@@ -50,4 +50,4 @@ Properties, specified where dynamic config files will be persisted:
5050

5151
#### Implementation notes:
5252

53-
Currently, the new configuration submission leads to a full application restart. So, if your kafka-ui app is starting slow (not a usual case, but may happen when you have a slow connection to kafka clusters) you may notice UI inaccessibility during restart time.
53+
Currently, the new configuration submission leads to a full application restart. So, if your kafbat-ui app is starting slow (not a usual case, but may happen when you have a slow connection to kafka clusters) you may notice UI inaccessibility during restart time.

configuration/configuration/complex-configuration-examples/kraft-mode-+-multiple-brokers.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ description: Kafka in kraft (zk-less) mode with multiple brokers
88
---
99
version: '2'
1010
services:
11-
kafka-ui:
12-
container_name: kafka-ui
13-
image: provectuslabs/kafka-ui:latest
11+
kafbat-ui:
12+
container_name: kafbat-ui
13+
image: ghcr.io/kafbat/kafka-ui
1414
ports:
1515
- 8080:8080
1616
depends_on:

configuration/data-masking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Topics data masking
44

5-
You can configure kafka-ui to mask sensitive data shown in Messages page.
5+
You can configure kafbat-ui to mask sensitive data shown in Messages page.
66

77
Several masking policies supported:
88

configuration/helm-charts/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Helm charts
22

3-
UI for Apache Kafka is also available as a helm chart. See the underlying articles to learn more about it.
3+
Kafbat UI is also available as a helm chart. See the underlying articles to learn more about it.

configuration/helm-charts/configuration/README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,39 @@
22

33
Most of the Helm charts parameters are common, follow table describes unique parameters related to application configuration.
44

5-
#### Kafka-UI parameters
5+
#### Kafbat-UI parameters
66

77
| 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 | `{}` |
8+
| ----------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------| ----------- |
9+
| `existingConfigMap` | Name of the existing ConfigMap with kafbat-ui environment variables | `nil` |
10+
| `existingSecret` | Name of the existing Secret with Kafbat-UI environment variables | `nil` |
11+
| `envs.secret` | Set of the sensitive environment variables to pass to Kafbat-UI | `{}` |
12+
| `envs.config` | Set of the environment variables to pass to Kafbat-UI | `{}` |
13+
| `yamlApplicationConfigConfigMap` | Map with name and keyName keys, name refers to the existing ConfigMap, keyName refers to the ConfigMap key with Kafbat-UI config in Yaml format | `{}` |
14+
| `yamlApplicationConfig` | Kafbat-UI config in Yaml format | `{}` |
1515
| `networkPolicy.enabled` | Enable network policies | `false` |
1616
| `networkPolicy.egressRules.customRules` | Custom network egress policy rules | `[]` |
1717
| `networkPolicy.ingressRules.customRules` | Custom network ingress policy rules | `[]` |
18-
| `podLabels` | Extra labels for Kafka-UI pod | `{}` |
19-
| `route.enabled` | Enable OpenShift route to expose the Kafka-UI service | `false` |
18+
| `podLabels` | Extra labels for Kafbat-UI pod | `{}` |
19+
| `route.enabled` | Enable OpenShift route to expose the Kafbat-UI service | `false` |
2020
| `route.annotations` | Add annotations to the OpenShift route | `{}` |
2121
| `route.tls.enabled` | Enable OpenShift route as a secured endpoint | `false` |
2222
| `route.tls.termination` | Set OpenShift Route TLS termination | `edge` |
2323
| `route.tls.insecureEdgeTerminationPolicy` | Set OpenShift Route Insecure Edge Termination Policy | `Redirect` |
2424

2525
### Example
2626

27-
To install Kafka-UI need to execute follow:
27+
To install Kafbat-UI need to execute follow:
2828

2929
```bash
30-
helm repo add kafka-ui https://provectus.github.io/kafka-ui
30+
helm repo add kafka-ui https://kafbat.github.io/helm-charts
3131
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
3232
```
3333

34-
To connect to Kafka-UI web application need to execute:
34+
To connect to Kafbat-UI web application need to execute:
3535

3636
```bash
37-
kubectl port-forward svc/kafka-ui 8080:80
37+
kubectl port-forward svc/kafbat-ui 8080:80
3838
```
3939

40-
Open the `http://127.0.0.1:8080` on the browser to access Kafka-UI.
40+
Open the `http://127.0.0.1:8080` on the browser to access Kafbat-UI.

configuration/helm-charts/configuration/ssl-example.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# SSL example
22

3-
## Implement ssl for kafka-ui
3+
## Implement ssl for kafbat-ui
44

5-
To implement SSL for kafka-ui you need to provide JKS files into the pod. Here is the instruction on how to do that.
5+
To implement SSL for kafbat-ui you need to provide JKS files into the pod. Here is the instruction on how to do that.
66

77
### Create config map with content from kafka.truststore.jks and kafka.keystore.jks.
88

@@ -65,11 +65,11 @@ volumes:
6565
### Install chart with command
6666

6767
```
68-
helm install kafka-ui kafka-ui/kafka-ui-charts -f ssl-values.yaml
68+
helm install kafbat-ui kafbat-ui/helm-charts -f ssl-values.yaml
6969
```
7070

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

7373
```
74-
helm install kafka-ui kafka-ui/kafka-ui -f ssl-values.yaml -n {namespace}
74+
helm install kafbat-ui kafbat-ui/helm-charts -f ssl-values.yaml -n {namespace}
7575
```

configuration/helm-charts/quick-start.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ description: Quick Start with Helm Chart
1010
2. Execute command
1111

1212
```
13-
helm repo add kafka-ui https://provectus.github.io/kafka-ui-charts
14-
helm install kafka-ui kafka-ui/kafka-ui
13+
helm repo add kafbat-ui https://kafbat.github.io/helm-charts
14+
helm install kafbat-ui kafbat-ui/kafbat-ui
1515
```
1616
17-
#### Passing Kafka-UI configuration as Dict
17+
#### Passing Kafbat-UI configuration as Dict
1818
1919
Create values.yml file
2020
@@ -44,7 +44,7 @@ Create config map
4444
apiVersion: v1
4545
kind: ConfigMap
4646
metadata:
47-
name: kafka-ui-configmap
47+
name: kafbat-ui-configmap
4848
data:
4949
config.yml: |-
5050
kafka:
@@ -73,7 +73,7 @@ Create config map
7373
apiVersion: v1
7474
kind: ConfigMap
7575
metadata:
76-
name: kafka-ui-helm-values
76+
name: kafbat-ui-helm-values
7777
data:
7878
KAFKA_CLUSTERS_0_NAME: "kafka-cluster-name"
7979
KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS: "kafka-cluster-broker-endpoints:9092"
@@ -83,4 +83,4 @@ data:
8383
8484
Install by executing the command
8585
86-
> helm install helm-release-name charts/kafka-ui --set existingConfigMap="kafka-ui-helm-values"
86+
> helm install helm-release-name charts/kafka-ui --set existingConfigMap="kafbat-ui-helm-values"

0 commit comments

Comments
 (0)