Skip to content

Commit bcc96fc

Browse files
amuraruamuraru
committed
Update docs
1 parent 9b2e54b commit bcc96fc

File tree

10 files changed

+44
-74
lines changed

10 files changed

+44
-74
lines changed

‎.github/workflows/publish-docs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
cancel-in-progress: false
6161

6262
environment:
63-
name: github-pages-deploy
63+
name: github-pages
6464
url: ${{ steps.deployment.outputs.page_url }}
6565

6666
steps:

‎config/_default/config.toml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Koperator"
33

44
#theme = ["docsy"]
55

6-
baseurl = "/"
6+
baseurl = "https://opensource.adobe.com/koperator/"
77

88
languageCode = "en-us"
99

@@ -55,7 +55,7 @@ weight = 1
5555
project_name = "Koperator"
5656
product_name = "Koperator"
5757

58-
latest_version = "0.25.1" # Used in some installation commands
58+
latest_version = "0.28.0-adobe-20250921" # Used in some installation commands
5959

6060
###############################################################################
6161
# Docsy-theme specific config customizations
@@ -69,12 +69,12 @@ weight = 1
6969
# The version number for the version of the docs represented in this doc set.
7070
# Used in the "version-banner" partial to display a version number for the
7171
# current doc set.
72-
version = "0.25.1"
72+
version = "0.28.0-adobe-20250921"
7373
version_menu_canonicallinks = true
7474

7575
# A link to latest version of the docs. Used in the "version-banner" partial to
7676
# point people to the main doc site.
77-
url_latest_version = "/"
77+
url_latest_version = "https://opensource.adobe.com/koperator/"
7878

7979
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
8080
github_repo = "https://github.com/adobe/koperator/tree/gh-pages"

‎content/docs/benchmarks/_index.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,10 @@ How to setup the environment for the Kafka Performance Test.
5656
1. Create a ZooKeeper cluster with 3 replicas using Pravega's Zookeeper Operator.
5757
5858
```bash
59-
helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com/
60-
helm install zookeeper-operator --namespace=zookeeper --create-namespace pravega/zookeeper-operator
59+
helm install zookeeper-operator \
60+
--repo https://charts.pravega.io zookeeper-operator \
61+
--namespace=zookeeper \
62+
--create-namespace
6163
kubectl create -f - <<EOF
6264
apiVersion: zookeeper.pravega.io/v1beta1
6365
kind: ZookeeperCluster
@@ -76,10 +78,13 @@ How to setup the environment for the Kafka Performance Test.
7678
```
7779
7880
```bash
79-
helm install kafka-operator --namespace=kafka --create-namespace banzaicloud-stable/kafka-operator
81+
helm install kafka-operator \
82+
oci://ghcr.io/adobe/koperator/kafka-operator \
83+
--namespace=kafka \
84+
--create-namespace
8085
```
8186
82-
1. Create a 3-broker Kafka Cluster using [this YAML file](https://raw.githubusercontent.com/banzaicloud/koperator/master/docs/benchmarks/infrastructure/kafka.yaml).
87+
1. Create a 3-broker Kafka Cluster using [this YAML file](https://raw.githubusercontent.com/adobe/koperator/master/docs/benchmarks/infrastructure/kafka.yaml).
8388
8489
This will install 3 brokers with fast SSD. If you would like the brokers in different zones, modify the following configurations to match your environment and use them in the broker configurations:
8590
@@ -148,7 +153,7 @@ Monitoring environment is automatically installed. To monitor the infrastructure
148153
149154
## Run the tests
150155
151-
1. Run performance test against the cluster, by building [this Docker image](https://raw.githubusercontent.com/banzaicloud/koperator/master/docs/benchmarks/loadgens/Dockerfile).
156+
1. Run performance test against the cluster, by building [this Docker image](https://raw.githubusercontent.com/adobe/koperator/master/docs/benchmarks/loadgens/Dockerfile).
152157
153158
```bash
154159
docker build -t <yourname>/perfload:0.1.0 /loadgens

‎content/docs/compatibility-matrix.md‎

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -6,68 +6,32 @@ weight: 770
66

77
This page shows you the list of supported Koperator versions, and the versions of other components they are compatible with.
88

9-
## Compatibility matrix
10-
11-
|Operator Version|Apache Kafka Version|JMX Exporter Version|Cruise Control Version|Istio Operator Version|Example cluster CR|Maintained|
12-
|-------|------|----------------|-------|----|---|-|
13-
|v0.18.3|2.6.2+|0.15.0|2.5.37|1.10|[link](https://github.com/adobe/koperator/blob/v0.18.3/config/samples/simplekafkacluster.yaml)|-|
14-
|v0.19.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/adobe/koperator/blob/v0.19.0/config/samples/simplekafkacluster.yaml)|-|
15-
|v0.20.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/adobe/koperator/blob/v0.20.0/config/samples/simplekafkacluster.yaml)|-|
16-
|v0.20.2|2.6.2+|0.16.1|2.5.80|1.10|[link](https://github.com/adobe/koperator/blob/v0.20.2/config/samples/simplekafkacluster.yaml)|-|
17-
|v0.21.0|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.0/config/samples/simplekafkacluster.yaml)|-|
18-
|v0.21.1|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.1/config/samples/simplekafkacluster.yaml)|-|
19-
|v0.21.2|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.2/config/samples/simplekafkacluster.yaml)|-|
20-
|v0.22.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.22.0/config/samples/simplekafkacluster.yaml)|+|
21-
|v0.23.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.23.0/config/samples/simplekafkacluster.yaml)|+|
22-
|v0.24.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.24.0/config/samples/simplekafkacluster.yaml)|+|
239

2410
## Available Koperator images
2511

12+
> **Note**: Starting from version 0.25.0, Koperator images are published to `ghcr.io/adobe/koperator` instead of `ghcr.io/banzaicloud/kafka-operator`.
13+
2614
|Image|Go version|
2715
|-|-|
28-
|ghcr.io/banzaicloud/kafka-operator:v0.17.0|1.16|
29-
|ghcr.io/banzaicloud/kafka-operator:v0.18.3|1.16|
30-
|ghcr.io/banzaicloud/kafka-operator:v0.19.0|1.16|
31-
|ghcr.io/banzaicloud/kafka-operator:v0.20.2|1.17|
32-
|ghcr.io/banzaicloud/kafka-operator:v0.21.0|1.17|
33-
|ghcr.io/banzaicloud/kafka-operator:v0.21.1|1.17|
34-
|ghcr.io/banzaicloud/kafka-operator:v0.21.2|1.17|
35-
|ghcr.io/banzaicloud/kafka-operator:v0.22.0|1.19|
36-
|ghcr.io/banzaicloud/kafka-operator:v0.23.0|1.19|
37-
|ghcr.io/banzaicloud/kafka-operator:v0.23.1|1.19|
38-
|ghcr.io/banzaicloud/kafka-operator:v0.24.0|1.19|
39-
|ghcr.io/banzaicloud/kafka-operator:v0.24.1|1.19|
16+
|ghcr.io/adobe/koperator/kafka-operator:0.28.0-adobe-20250921|1.25|
4017

4118
## Available Apache Kafka images
4219

20+
> **Note**: Starting from version 0.25.0, Kafka images are published to `ghcr.io/adobe/kafka` instead of `ghcr.io/banzaicloud/kafka`.
21+
4322
|Image|Java version|
4423
|-|-|
45-
|ghcr.io/banzaicloud/kafka:2.13-2.6.2-bzc.1|11|
46-
|ghcr.io/banzaicloud/kafka:2.13-2.7.0-bzc.1|11|
47-
|ghcr.io/banzaicloud/kafka:2.13-2.7.0-bzc.2|11|
48-
|ghcr.io/banzaicloud/kafka:2.13-2.8.0|11|
49-
|ghcr.io/banzaicloud/kafka:2.13-2.8.1|11|
50-
|ghcr.io/banzaicloud/kafka:2.13-3.1.0|17|
24+
|ghcr.io/adobe/kafka:2.13-3.9.1|21|
5125

5226
## Available JMX Exporter images
5327

5428
|Image|Java version|
5529
|-|-|
56-
|ghcr.io/banzaicloud/jmx-javaagent:0.14.0|11|
57-
|ghcr.io/banzaicloud/jmx-javaagent:0.15.0|11|
58-
|ghcr.io/banzaicloud/jmx-javaagent:0.16.1|11|
30+
31+
|ghcr.io/amuraru/jmx-javaagent:0.19.1|21|
5932

6033
## Available Cruise Control images
6134

6235
|Image|Java version|
6336
|-|-|
64-
|ghcr.io/banzaicloud/cruise-control:2.5.23|11|
65-
|ghcr.io/banzaicloud/cruise-control:2.5.28|11|
66-
|ghcr.io/banzaicloud/cruise-control:2.5.34|11|
67-
|ghcr.io/banzaicloud/cruise-control:2.5.37|11|
68-
|ghcr.io/banzaicloud/cruise-control:2.5.43|11|
69-
|ghcr.io/banzaicloud/cruise-control:2.5.53|11|
70-
|ghcr.io/banzaicloud/cruise-control:2.5.68|11|
71-
|ghcr.io/banzaicloud/cruise-control:2.5.80|11|
72-
|ghcr.io/banzaicloud/cruise-control:2.5.86|11|
73-
|ghcr.io/banzaicloud/cruise-control:2.5.101|11|
37+
|adobe/cruise-control:3.0.3-adbe-20250804|21|

‎content/docs/delete-kafka-operator.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In case you want to delete the Koperator from your cluster, note that because of
1616
```
1717
kubectl delete \
1818
-n kafka \
19-
-f https://raw.githubusercontent.com/banzaicloud/koperator/{{< param "latest_version" >}}/config/samples/kafkacluster-prometheus.yaml
19+
-f https://raw.githubusercontent.com/adobe/koperator/{{< param "latest_version" >}}/config/samples/kafkacluster-prometheus.yaml
2020
```
2121
2222
Expected output:

‎content/docs/install-kafka-operator.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ shorttitle: Install
44
weight: 10
55
---
66

7-
The operator installs version 3.1.0 of Apache Kafka, and can run on:
7+
The operator installs version 3.9.1 of Apache Kafka, and can run on:
88

99
- Minikube v0.33.1+,
10-
- Kubernetes 1.21-1.24, and
10+
- Kubernetes 1.21+, and
1111
- Red Hat OpenShift 4.10-4.11.
1212

13-
> The operator supports Kafka 2.6.2-3.1.x.
13+
> The operator supports Kafka 2.6.2-3.9.x.
1414
1515
{{< include-headless "warning-ebs-csi-driver.md" >}}
1616

@@ -542,7 +542,7 @@ Koperator can be deployed using its [Helm chart](https://github.com/adobe/kopera
542542
```bash
543543
helm install \
544544
kafka-operator \
545-
--repo https://kubernetes-charts.banzaicloud.com kafka-operator \
545+
oci://ghcr.io/adobe/koperator/kafka-operator \
546546
--version {{< param "latest_version" >}} \
547547
--namespace=kafka \
548548
--create-namespace \
@@ -591,15 +591,15 @@ Koperator can be deployed using its [Helm chart](https://github.com/adobe/kopera
591591
```bash
592592
kubectl create \
593593
-n kafka \
594-
-f https://raw.githubusercontent.com/banzaicloud/koperator/v{{< param "latest_version" >}}/config/samples/simplekafkacluster.yaml
594+
-f https://raw.githubusercontent.com/adobe/koperator/v{{< param "latest_version" >}}/config/samples/simplekafkacluster.yaml
595595
```
596596
597597
- To create a sample Kafka cluster that allows TLS-encrypted client connections, run the following command. For details on the configuration parameters related to SSL, see {{% xref "/docs/ssl.md#enable-ssl" %}}.
598598
599599
```bash
600600
kubectl create \
601601
-n kafka \
602-
-f https://raw.githubusercontent.com/banzaicloud/koperator/v{{< param "latest_version" >}}/config/samples/simplekafkacluster_ssl.yaml
602+
-f https://raw.githubusercontent.com/adobe/koperator/v{{< param "latest_version" >}}/config/samples/simplekafkacluster_ssl.yaml
603603
```
604604
605605
Expected output:
@@ -660,7 +660,7 @@ Koperator can be deployed using its [Helm chart](https://github.com/adobe/kopera
660660
```bash
661661
kubectl create \
662662
-n kafka \
663-
-f https://raw.githubusercontent.com/banzaicloud/koperator/v{{< param "latest_version" >}}/config/samples/kafkacluster-prometheus.yaml
663+
-f https://raw.githubusercontent.com/adobe/koperator/v{{< param "latest_version" >}}/config/samples/kafkacluster-prometheus.yaml
664664
```
665665
666666
Expected output:

‎content/docs/monitoring.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ To change this behavior, modify the following lines at the end of the CR.
6565
```yaml
6666
monitoringConfig:
6767
jmxImage describes the used prometheus jmx exporter agent container
68-
jmxImage: "banzaicloud/jmx-javaagent:0.15.0"
68+
jmxImage: "ghcr.io/amuraru/jmx-javaagent:0.19.1"
6969
pathToJar describes the path to the jar file in the given image
70-
pathToJar: "/opt/jmx_exporter/jmx_prometheus_javaagent-0.15.0.jar"
70+
pathToJar: "/opt/jmx_exporter/jmx_prometheus_javaagent-0.19.1.jar"
7171
kafkaJMXExporterConfig describes jmx exporter config for Kafka
7272
kafkaJMXExporterConfig: |
7373
lowercaseOutputName: true

‎content/docs/test.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ Topic creation by default is enabled in Apache Kafka, but if it is configured ot
2525
For internal listeners exposed by a headless service (`KafkaCluster.spec.headlessServiceEnabled `set to `true`):
2626

2727
```bash
28-
kubectl -n kafka run kafka-topics -it --image=ghcr.io/banzaicloud/kafka:2.13-3.1.0 --rm=true --restart=Never -- /opt/kafka/bin/kafka-topics.sh --bootstrap-server kafka-headless.kafka:29092 --topic my-topic --create --partitions 1 --replication-factor 1
28+
kubectl -n kafka run kafka-topics -it --image=ghcr.io/adobe/kafka:2.13-3.9.1 --rm=true --restart=Never -- /opt/kafka/bin/kafka-topics.sh --bootstrap-server kafka-headless.kafka:29092 --topic my-topic --create --partitions 1 --replication-factor 1
2929
```
3030

3131
For internal listeners exposed by a regular service (`KafkaCluster.spec.headlessServiceEnabled` set to `false`):
3232

3333
```bash
34-
kubectl -n kafka run kafka-topics -it --image=ghcr.io/banzaicloud/kafka:2.13-3.1.0 --rm=true --restart=Never -- /opt/kafka/bin/kafka-topics.sh --bootstrap-server kafka-all-broker.kafka:29092 --topic my-topic --create --partitions 1 --replication-factor 1
34+
kubectl -n kafka run kafka-topics -it --image=ghcr.io/adobe/kafka:2.13-3.9.1 --rm=true --restart=Never -- /opt/kafka/bin/kafka-topics.sh --bootstrap-server kafka-all-broker.kafka:29092 --topic my-topic --create --partitions 1 --replication-factor 1
3535
```
3636

3737
After you have created a topic, produce and consume some messages:
@@ -52,7 +52,7 @@ You can use the following commands to send and receive messages within a Kuberne
5252
-n kafka \
5353
kafka-producer \
5454
-it \
55-
--image=ghcr.io/banzaicloud/kafka:2.13-3.1.0 \
55+
--image=ghcr.io/adobe/kafka:2.13-3.9.1 \
5656
--rm=true \
5757
--restart=Never \
5858
-- \
@@ -103,7 +103,7 @@ You can use the following commands to send and receive messages within a Kuberne
103103
-n kafka \
104104
kafka-consumer \
105105
-it \
106-
--image=ghcr.io/banzaicloud/kafka:2.13-3.1.0 \
106+
--image=ghcr.io/adobe/kafka:2.13-3.9.1 \
107107
--rm=true \
108108
--restart=Never \
109109
-- \

‎content/docs/troubleshooting/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ spec:
8787
id: 0
8888
- brokerConfigGroup: default
8989
id: 1
90-
clusterImage: ghcr.io/banzaicloud/kafka:2.13-3.1.0
90+
clusterImage: ghcr.io/adobe/kafka:2.13-3.9.1
9191
cruiseControlConfig:
9292
clusterConfig: |
9393
{
@@ -141,7 +141,7 @@ status:
141141
cruiseControlOperationReference:
142142
name: kafka-rebalance-bhs7n
143143
cruiseControlVolumeState: GracefulDiskRebalanceSucceeded
144-
image: ghcr.io/banzaicloud/kafka:2.13-3.1.0
144+
image: ghcr.io/adobe/kafka:2.13-3.9.1
145145
perBrokerConfigurationState: PerBrokerConfigInSync
146146
rackAwarenessState: ""
147147
version: 3.1.0
@@ -155,7 +155,7 @@ status:
155155
cruiseControlOperationReference:
156156
name: kafka-rebalance-bhs7n
157157
cruiseControlVolumeState: GracefulDiskRebalanceSucceeded
158-
image: ghcr.io/banzaicloud/kafka:2.13-3.1.0
158+
image: ghcr.io/adobe/kafka:2.13-3.9.1
159159
perBrokerConfigurationState: PerBrokerConfigInSync
160160
rackAwarenessState: ""
161161
version: 3.1.0

‎content/docs/upgrade-kafka-operator.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ When upgrading your Koperator deployment to a new version, complete the followin
1919
1. Update your Koperator deployment by running:
2020

2121
```bash
22-
helm repo update
23-
helm upgrade kafka-operator --namespace=kafka banzaicloud-stable/kafka-operator
22+
helm upgrade kafka-operator \
23+
oci://ghcr.io/adobe/koperator/kafka-operator \
24+
--namespace=kafka
2425
```

0 commit comments

Comments
 (0)