From 92837274d8c0c0be4fab7e4e208b536687149309 Mon Sep 17 00:00:00 2001 From: Razvan-Daniel Mihai <84674+razvan@users.noreply.github.com> Date: Fri, 20 Nov 2026 15:48:51 +0100 Subject: [PATCH 1/2] feat: The getting started guide now showcases KRaft and KafkaTopic --- CHANGELOG.md | 5 + .../getting_started/getting_started.sh | 81 ++++++------- .../getting_started/getting_started.sh.j2 | 81 ++++++------- .../getting_started/install_output.txt | 1 - .../getting_started/install_output.txt.j2 | 1 - .../examples/getting_started/kafka-topic.yaml | 10 ++ .../examples/getting_started/kafka-znode.yaml | 8 -- .../kafka/examples/getting_started/kafka.yaml | 15 ++- .../examples/getting_started/zookeeper.yaml | 12 -- .../pages/getting_started/first_steps.adoc | 109 ++++++++++-------- .../kafka/pages/getting_started/index.adoc | 4 +- .../pages/getting_started/installation.adoc | 5 +- docs/modules/kafka/pages/index.adoc | 2 +- docs/templating_vars.yaml | 1 - 14 files changed, 163 insertions(+), 172 deletions(-) create mode 100644 docs/modules/kafka/examples/getting_started/kafka-topic.yaml delete mode 100644 docs/modules/kafka/examples/getting_started/kafka-znode.yaml delete mode 100644 docs/modules/kafka/examples/getting_started/zookeeper.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index 30783dfda..6b91b2b70 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file. ## [Unreleased] +### Changed + +- Getting started guide uses a KRaft cluster instead of ZooKeeper and declares its topic with a + KafkaTopic managed by the agent. + ## [26.11.0] - 2026-11-20 ### Fixed diff --git a/docs/modules/kafka/examples/getting_started/getting_started.sh b/docs/modules/kafka/examples/getting_started/getting_started.sh index d131a0197..d707bcdc8 100755 --- a/docs/modules/kafka/examples/getting_started/getting_started.sh +++ b/docs/modules/kafka/examples/getting_started/getting_started.sh @@ -32,7 +32,6 @@ echo "Installing Operators with Helm" helm install --wait commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version 0.0.0-dev helm install --wait secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version 0.0.0-dev helm install --wait listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version 0.0.0-dev -helm install --wait zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version 0.0.0-dev helm install --wait kafka-operator oci://oci.stackable.tech/sdp-charts/kafka-operator --version 0.0.0-dev # end::helm-install-operators[] ;; @@ -43,7 +42,6 @@ stackablectl operator install \ commons=0.0.0-dev \ secret=0.0.0-dev \ listener=0.0.0-dev \ - zookeeper=0.0.0-dev \ kafka=0.0.0-dev # end::stackablectl-install-operators[] ;; @@ -53,23 +51,6 @@ exit 1 ;; esac -echo "Installing ZooKeeper from zookeeper.yaml" -# tag::install-zookeeper[] -kubectl apply -f zookeeper.yaml -# end::install-zookeeper[] - -echo "Installing ZNode from kafka-znode.yaml" -# tag::install-znode[] -kubectl apply -f kafka-znode.yaml -# end::install-znode[] - -sleep 15 - -echo "Awaiting ZooKeeper rollout finish" -# tag::watch-zookeeper-rollout[] -kubectl rollout status --watch --timeout=5m statefulset/simple-zk-server-default -# end::watch-zookeeper-rollout[] - echo "Install KafkaCluster from kafka.yaml" # tag::install-kafka[] kubectl apply --server-side -f kafka.yaml @@ -79,47 +60,53 @@ sleep 15 echo "Awaiting Kafka rollout finish" # tag::watch-kafka-rollout[] +kubectl rollout status --watch --timeout=5m statefulset/simple-kafka-controller-default kubectl rollout status --watch --timeout=5m statefulset/simple-kafka-broker-default # end::watch-kafka-rollout[] -echo "Starting port-forwarding of port 9092" -# shellcheck disable=2069 # we want all output to be blackholed -# tag::port-forwarding[] -kubectl port-forward svc/simple-kafka-broker-default-bootstrap 9092 2>&1 >/dev/null & -# end::port-forwarding[] -PORT_FORWARD_PID=$! -# shellcheck disable=2064 # we want the PID evaluated now, not at the time the trap is -trap "kill $PORT_FORWARD_PID" EXIT - -sleep 15 +echo "Awaiting the Kafka agent" +# tag::watch-agent-rollout[] +kubectl rollout status --watch --timeout=5m deployment/simple-kafka-agent +# end::watch-agent-rollout[] -echo "Creating test topic test-data-topic" +echo "Creating test topic test-data-topic from kafka-topic.yaml" # tag::create-topic[] -kubectl exec -n default simple-kafka-broker-default-0 -c kafka -t -- /stackable/kafka/bin/kafka-topics.sh \ ---create \ ---topic test-data-topic \ ---partitions 1 \ ---bootstrap-server localhost:9092 +kubectl apply -f kafka-topic.yaml # end::create-topic[] +echo "Awaiting the KafkaTopic" +# tag::wait-topic[] +kubectl wait --for=condition=Ready --timeout=5m kafkatopics.kafka.stackable.tech/test-data-topic +# end::wait-topic[] + echo "Publish test data" +# shellcheck disable=SC2016 # the script is expanded in the broker Pod, not here # tag::write-data[] -kubectl exec -n default simple-kafka-broker-default-0 -c kafka -t -- /stackable/kafka/bin/kafka-producer-perf-test.sh \ ---producer-props bootstrap.servers=localhost:9092 \ ---topic test-data-topic \ ---payload-monotonic \ ---throughput 1 \ ---num-records 5 +kubectl exec -n default simple-kafka-broker-default-0 -c kafka -- bash -c ' + bootstrap="$(cat /stackable/listener-broker/default-address/address):$(cat /stackable/listener-broker/default-address/ports/kafka-tls)" + /stackable/kafka/bin/kafka-producer-perf-test.sh \ + --producer-props bootstrap.servers="$bootstrap" \ + --producer.config /stackable/config/client.properties \ + --topic test-data-topic \ + --payload-monotonic \ + --throughput 1 \ + --num-records 5 +' # end::write-data[] echo "Consume test data" +# shellcheck disable=SC2016 # the script is expanded in the broker Pod, not here # tag::read-data[] -kubectl exec -n default simple-kafka-broker-default-0 -c kafka -t -- /stackable/kafka/bin/kafka-console-consumer.sh \ ---bootstrap-server localhost:9092 \ ---topic test-data-topic \ ---offset earliest \ ---partition 0 \ ---timeout-ms 1000 +kubectl exec -n default simple-kafka-broker-default-0 -c kafka -- bash -c ' + bootstrap="$(cat /stackable/listener-broker/default-address/address):$(cat /stackable/listener-broker/default-address/ports/kafka-tls)" + /stackable/kafka/bin/kafka-console-consumer.sh \ + --bootstrap-server "$bootstrap" \ + --consumer.config /stackable/config/client.properties \ + --topic test-data-topic \ + --offset earliest \ + --partition 0 \ + --timeout-ms 1000 +' # end::read-data[] echo "Success!" diff --git a/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 b/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 index 6a13eeb54..477c9fac0 100755 --- a/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 +++ b/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 @@ -32,7 +32,6 @@ echo "Installing Operators with Helm" helm install --wait commons-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/commons-operator --version {{ versions.commons }} helm install --wait secret-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/secret-operator --version {{ versions.secret }} helm install --wait listener-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/listener-operator --version {{ versions.listener }} -helm install --wait zookeeper-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/zookeeper-operator --version {{ versions.zookeeper }} helm install --wait kafka-operator oci://{{ helm.repo_url }}/{{ helm.repo_name }}/kafka-operator --version {{ versions.kafka }} # end::helm-install-operators[] ;; @@ -43,7 +42,6 @@ stackablectl operator install \ commons={{ versions.commons }} \ secret={{ versions.secret }} \ listener={{ versions.listener }} \ - zookeeper={{ versions.zookeeper }} \ kafka={{ versions.kafka }} # end::stackablectl-install-operators[] ;; @@ -53,23 +51,6 @@ exit 1 ;; esac -echo "Installing ZooKeeper from zookeeper.yaml" -# tag::install-zookeeper[] -kubectl apply -f zookeeper.yaml -# end::install-zookeeper[] - -echo "Installing ZNode from kafka-znode.yaml" -# tag::install-znode[] -kubectl apply -f kafka-znode.yaml -# end::install-znode[] - -sleep 15 - -echo "Awaiting ZooKeeper rollout finish" -# tag::watch-zookeeper-rollout[] -kubectl rollout status --watch --timeout=5m statefulset/simple-zk-server-default -# end::watch-zookeeper-rollout[] - echo "Install KafkaCluster from kafka.yaml" # tag::install-kafka[] kubectl apply --server-side -f kafka.yaml @@ -79,47 +60,53 @@ sleep 15 echo "Awaiting Kafka rollout finish" # tag::watch-kafka-rollout[] +kubectl rollout status --watch --timeout=5m statefulset/simple-kafka-controller-default kubectl rollout status --watch --timeout=5m statefulset/simple-kafka-broker-default # end::watch-kafka-rollout[] -echo "Starting port-forwarding of port 9092" -# shellcheck disable=2069 # we want all output to be blackholed -# tag::port-forwarding[] -kubectl port-forward svc/simple-kafka-broker-default-bootstrap 9092 2>&1 >/dev/null & -# end::port-forwarding[] -PORT_FORWARD_PID=$! -# shellcheck disable=2064 # we want the PID evaluated now, not at the time the trap is -trap "kill $PORT_FORWARD_PID" EXIT - -sleep 15 +echo "Awaiting the Kafka agent" +# tag::watch-agent-rollout[] +kubectl rollout status --watch --timeout=5m deployment/simple-kafka-agent +# end::watch-agent-rollout[] -echo "Creating test topic test-data-topic" +echo "Creating test topic test-data-topic from kafka-topic.yaml" # tag::create-topic[] -kubectl exec -n default simple-kafka-broker-default-0 -c kafka -t -- /stackable/kafka/bin/kafka-topics.sh \ ---create \ ---topic test-data-topic \ ---partitions 1 \ ---bootstrap-server localhost:9092 +kubectl apply -f kafka-topic.yaml # end::create-topic[] +echo "Awaiting the KafkaTopic" +# tag::wait-topic[] +kubectl wait --for=condition=Ready --timeout=5m kafkatopics.kafka.stackable.tech/test-data-topic +# end::wait-topic[] + echo "Publish test data" +# shellcheck disable=SC2016 # the script is expanded in the broker Pod, not here # tag::write-data[] -kubectl exec -n default simple-kafka-broker-default-0 -c kafka -t -- /stackable/kafka/bin/kafka-producer-perf-test.sh \ ---producer-props bootstrap.servers=localhost:9092 \ ---topic test-data-topic \ ---payload-monotonic \ ---throughput 1 \ ---num-records 5 +kubectl exec -n default simple-kafka-broker-default-0 -c kafka -- bash -c ' + bootstrap="$(cat /stackable/listener-broker/default-address/address):$(cat /stackable/listener-broker/default-address/ports/kafka-tls)" + /stackable/kafka/bin/kafka-producer-perf-test.sh \ + --producer-props bootstrap.servers="$bootstrap" \ + --producer.config /stackable/config/client.properties \ + --topic test-data-topic \ + --payload-monotonic \ + --throughput 1 \ + --num-records 5 +' # end::write-data[] echo "Consume test data" +# shellcheck disable=SC2016 # the script is expanded in the broker Pod, not here # tag::read-data[] -kubectl exec -n default simple-kafka-broker-default-0 -c kafka -t -- /stackable/kafka/bin/kafka-console-consumer.sh \ ---bootstrap-server localhost:9092 \ ---topic test-data-topic \ ---offset earliest \ ---partition 0 \ ---timeout-ms 1000 +kubectl exec -n default simple-kafka-broker-default-0 -c kafka -- bash -c ' + bootstrap="$(cat /stackable/listener-broker/default-address/address):$(cat /stackable/listener-broker/default-address/ports/kafka-tls)" + /stackable/kafka/bin/kafka-console-consumer.sh \ + --bootstrap-server "$bootstrap" \ + --consumer.config /stackable/config/client.properties \ + --topic test-data-topic \ + --offset earliest \ + --partition 0 \ + --timeout-ms 1000 +' # end::read-data[] echo "Success!" diff --git a/docs/modules/kafka/examples/getting_started/install_output.txt b/docs/modules/kafka/examples/getting_started/install_output.txt index 4622a2cb7..8497bb15d 100644 --- a/docs/modules/kafka/examples/getting_started/install_output.txt +++ b/docs/modules/kafka/examples/getting_started/install_output.txt @@ -1,5 +1,4 @@ Installed commons=0.0.0-dev operator Installed secret=0.0.0-dev operator Installed listener=0.0.0-dev operator -Installed zookeeper=0.0.0-dev operator Installed kafka=0.0.0-dev operator diff --git a/docs/modules/kafka/examples/getting_started/install_output.txt.j2 b/docs/modules/kafka/examples/getting_started/install_output.txt.j2 index d1b356918..e3f28682f 100644 --- a/docs/modules/kafka/examples/getting_started/install_output.txt.j2 +++ b/docs/modules/kafka/examples/getting_started/install_output.txt.j2 @@ -1,5 +1,4 @@ Installed commons={{ versions.commons }} operator Installed secret={{ versions.secret }} operator Installed listener={{ versions.listener }} operator -Installed zookeeper={{ versions.zookeeper }} operator Installed kafka={{ versions.kafka }} operator diff --git a/docs/modules/kafka/examples/getting_started/kafka-topic.yaml b/docs/modules/kafka/examples/getting_started/kafka-topic.yaml new file mode 100644 index 000000000..03deec8a9 --- /dev/null +++ b/docs/modules/kafka/examples/getting_started/kafka-topic.yaml @@ -0,0 +1,10 @@ +--- +apiVersion: kafka.stackable.tech/v1alpha1 +kind: KafkaTopic +metadata: + name: test-data-topic +spec: + clusterRef: + name: simple-kafka + partitions: 1 + replicationFactor: 3 diff --git a/docs/modules/kafka/examples/getting_started/kafka-znode.yaml b/docs/modules/kafka/examples/getting_started/kafka-znode.yaml deleted file mode 100644 index 5fdc3f59f..000000000 --- a/docs/modules/kafka/examples/getting_started/kafka-znode.yaml +++ /dev/null @@ -1,8 +0,0 @@ ---- -apiVersion: zookeeper.stackable.tech/v1alpha1 -kind: ZookeeperZnode -metadata: - name: simple-kafka-znode -spec: - clusterRef: - name: simple-zk diff --git a/docs/modules/kafka/examples/getting_started/kafka.yaml b/docs/modules/kafka/examples/getting_started/kafka.yaml index 33bd0c3b4..5a2605768 100644 --- a/docs/modules/kafka/examples/getting_started/kafka.yaml +++ b/docs/modules/kafka/examples/getting_started/kafka.yaml @@ -5,11 +5,18 @@ metadata: name: simple-kafka spec: image: - productVersion: 3.9.2 + productVersion: 4.3.1 clusterConfig: - tls: - serverSecretClass: null - zookeeperConfigMapName: simple-kafka-znode + metadataManager: KRaft + managementAccess: # Deploys the agent, which creates and updates KafkaTopics in this cluster + enabled: true + authentication: + userProvided: + anonymous: {} + controllers: + roleGroups: + default: + replicas: 1 brokers: config: bootstrapListenerClass: external-unstable # This exposes your Stacklet outside of Kubernetes. Remove this property if this is not desired diff --git a/docs/modules/kafka/examples/getting_started/zookeeper.yaml b/docs/modules/kafka/examples/getting_started/zookeeper.yaml deleted file mode 100644 index 6e6277309..000000000 --- a/docs/modules/kafka/examples/getting_started/zookeeper.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- -apiVersion: zookeeper.stackable.tech/v1alpha1 -kind: ZookeeperCluster -metadata: - name: simple-zk -spec: - image: - productVersion: 3.9.6 - servers: - roleGroups: - default: - replicas: 1 diff --git a/docs/modules/kafka/pages/getting_started/first_steps.adoc b/docs/modules/kafka/pages/getting_started/first_steps.adoc index 922106797..a3160b4a0 100644 --- a/docs/modules/kafka/pages/getting_started/first_steps.adoc +++ b/docs/modules/kafka/pages/getting_started/first_steps.adoc @@ -1,70 +1,98 @@ = First steps -:description: Deploy and verify a Kafka cluster on Kubernetes with Stackable Operators, including ZooKeeper setup and data testing. +:description: Deploy a Kafka cluster in KRaft mode on Kubernetes with Stackable Operators, declare a topic with a KafkaTopic, and verify it by producing and consuming data. -After going through the xref:getting_started/installation.adoc[] section and having installed all the operators, you now deploy a Kafka cluster and the required dependencies. -Afterward you can <<_verify_that_it_works, verify that it works>> by producing test data into a topic and consuming it. +After going through the xref:getting_started/installation.adoc[] section and having installed all the operators, you now deploy a Kafka cluster in xref:usage-guide/kraft-controller.adoc[KRaft mode] and declare a topic. +Afterward you can <<_verify_that_it_works, verify that it works>> by producing test data into the topic and consuming it. == Setup -Two things need to be installed to create a Kafka cluster: +Kafka in KRaft mode manages its metadata itself, so no ZooKeeper is needed. +The cluster consists of two roles: -* A ZooKeeper instance for internal use by Kafka -* The Kafka cluster itself +* The `controllers` store the cluster metadata and take part in the metadata quorum. +* The `brokers` serve the clients. -Create them in this order by applying the corresponding manifest files. -The operators you just installed then create the resources according to the manifest. - -=== ZooKeeper +=== Kafka -Create a file named `zookeeper.yaml` with the following content: +Create a file named `kafka.yaml` with the following contents: [source,yaml] - ---- -include::example$getting_started/zookeeper.yaml[] +include::example$getting_started/kafka.yaml[] ---- and apply it: [source,bash] ---- -include::example$getting_started/getting_started.sh[tag=install-zookeeper] +include::example$getting_started/getting_started.sh[tag=install-kafka] ---- -Create a file `kafka-znode.yaml` with the following content: +This creates the actual Kafka instance. +The cluster has a single controller to keep the resource requirements low. +For production, use three or more (odd number of) controllers. + +The `managementAccess` section makes the operator deploy an _agent_ next to the cluster. +The agent manages resources inside Kafka, such as topics, so that you can declare them in Kubernetes. +Here, the agent connects without a client certificate, which is possible because the cluster does not require client authentication. +Learn more in xref:usage-guide/management-access.adoc[]. + +Wait until the controllers, the brokers and the agent are ready: + +[source,bash] +---- +include::example$getting_started/getting_started.sh[tag=watch-kafka-rollout] +include::example$getting_started/getting_started.sh[tag=watch-agent-rollout] +---- + +=== Topic + +Instead of running the Kafka command line tools, you declare the topic as a `KafkaTopic` resource. +The agent creates the topic in Kafka and keeps it in the declared state. + +Create a file named `kafka-topic.yaml` with the following contents: [source,yaml] ---- -include::example$getting_started/kafka-znode.yaml[] +include::example$getting_started/kafka-topic.yaml[] ---- and apply it: [source,bash] ---- -include::example$getting_started/getting_started.sh[tag=install-znode] +include::example$getting_started/getting_started.sh[tag=create-topic] ---- -=== Kafka +The topic is named after the resource, `test-data-topic`, and refers to the Kafka cluster with `clusterRef`. +Wait until the agent reports the topic as ready: -Create a file named `kafka.yaml` with the following contents: +[source,bash] +---- +include::example$getting_started/getting_started.sh[tag=wait-topic] +---- -[source,yaml] +NOTE: Other operators, such as Strimzi, also provide a resource of the kind `KafkaTopic`, so the commands use the full resource name. + +Show the topic as the agent sees it: + +[source,bash] ---- -include::example$getting_started/kafka.yaml[] +kubectl get kafkatopics.kafka.stackable.tech test-data-topic ---- -and apply it: +The output should look somewhat like this: ---- -include::example$getting_started/getting_started.sh[tag=install-kafka] +NAME TOPIC CLUSTER PARTITIONS REPLICATION FACTOR READY SYNCED REASON AGE +test-data-topic test-data-topic simple-kafka 1 3 True True Synced 30s ---- -This creates the actual Kafka instance. +Learn more about topics in xref:usage-guide/topics.adoc[]. == Verify that it works -Next, use the Kafka client scripts to create a topic and publish and consume data. +Next, use the Kafka client scripts to publish and consume data on the topic created by the agent. The Kafka operator has created a service called `simple-kafka-broker-default-bootstrap`. This service represents the endpoint clients should initially connect to in order to publish and consume data. @@ -85,7 +113,7 @@ Labels: app.kubernetes.io/component=broker app.kubernetes.io/managed-by=listeners.stackable.tech_listener app.kubernetes.io/name=listener app.kubernetes.io/role-group=default - app.kubernetes.io/version=3.9.2-stackable0.0.0-dev + app.kubernetes.io/version=4.3.1-stackable0.0.0-dev stackable.tech/vendor=Stackable Annotations: Selector: listener.stackable.tech/mnt.9555cbb6f38d4b0ca1771e6d83d28e27=simple-kafka-broker-default-bootstrap @@ -94,10 +122,10 @@ IP Family Policy: SingleStack IP Families: IPv4 IP: 10.105.88.52 IPs: 10.105.88.52 -Port: kafka 9092/TCP -TargetPort: 9092/TCP -NodePort: kafka 32608/TCP -Endpoints: 10.244.4.22:9092,10.244.4.24:9092,10.244.4.23:9092 +Port: kafka-tls 9093/TCP +TargetPort: 9093/TCP +NodePort: kafka-tls 32608/TCP +Endpoints: 10.244.4.22:9093,10.244.4.24:9093,10.244.4.23:9093 Session Affinity: None External Traffic Policy: Local Internal Traffic Policy: Cluster @@ -107,20 +135,10 @@ Events: The output shows that there are three endpoints serviced here. They correspond to the three broker pods belonging to the Kafka cluster. -Then, create a port-forward on this service: - ----- -include::example$getting_started/getting_started.sh[tag=port-forwarding] ----- - -Now, create a new topic called `test-data-topic`: - ----- -include::example$getting_started/getting_started.sh[tag=create-topic] ----- - -Use the Kafka performance producer script to send a couple of messages to the topic previously created: +Use the Kafka performance producer script to send a couple of messages to the topic previously created. +The brokers use TLS, so the command uses the client configuration that the operator provides in the broker Pod and connects to the address of the broker listener: +[source,bash] ---- include::example$getting_started/getting_started.sh[tag=write-data] ---- @@ -136,6 +154,7 @@ We are not interested in any performance indicators but appreciate the fact that Now let's consume the messages from above: +[source,bash] ---- include::example$getting_started/getting_started.sh[tag=read-data] ---- @@ -150,8 +169,8 @@ The consumer should print the messages in between logging statements 4 ---- -You successfully created a Kafka cluster and produced and consumed data. +You successfully created a Kafka cluster in KRaft mode, declared a topic with a KafkaTopic, and produced and consumed data. == What's next -Have a look at the xref:usage.adoc[] page to find out more about the features of the Kafka Operator. +Have a look at the xref:usage.adoc[] page to find out more about the features of the Kafka Operator, for example xref:usage-guide/topics.adoc[declarative topics] and xref:usage-guide/security.adoc[security]. diff --git a/docs/modules/kafka/pages/getting_started/index.adoc b/docs/modules/kafka/pages/getting_started/index.adoc index 87386ecdb..253cf1076 100644 --- a/docs/modules/kafka/pages/getting_started/index.adoc +++ b/docs/modules/kafka/pages/getting_started/index.adoc @@ -1,8 +1,8 @@ = Getting started -:description: Start with Apache Kafka using Stackable Operator: Install, set up Kafka, and manage topics in a Kubernetes cluster. +:description: Start with Apache Kafka in KRaft mode using Stackable Operator: Install, set up Kafka, and manage topics declaratively in a Kubernetes cluster. This guide gets you started with Apache Kafka using the Stackable Operator. -It guides you through the installation of the Operator and its dependencies, setting up your first Kafka instance and create, write to and read from a topic. +It guides you through the installation of the Operator, setting up your first Kafka instance in xref:usage-guide/kraft-controller.adoc[KRaft mode], declaring a topic with a xref:usage-guide/topics.adoc[KafkaTopic] resource, and writing to and reading from that topic. == Prerequisites diff --git a/docs/modules/kafka/pages/getting_started/installation.adoc b/docs/modules/kafka/pages/getting_started/installation.adoc index 224d1d073..5601e0c58 100644 --- a/docs/modules/kafka/pages/getting_started/installation.adoc +++ b/docs/modules/kafka/pages/getting_started/installation.adoc @@ -1,8 +1,7 @@ = Installation -:description: Install Stackable Operator for Apache Kafka using stackablectl or Helm, including dependencies like ZooKeeper and required operators for Kubernetes. +:description: Install Stackable Operator for Apache Kafka using stackablectl or Helm, including the required commons, secret and listener operators for Kubernetes. -Install the Stackable Operator for Apache Kafka and operators for its dependencies -- ZooKeeper -- -as well as the commons, secret and listener operator which are required by all Stackable Operators. +Install the Stackable Operator for Apache Kafka together with the commons, secret and listener operators, which are required by all Stackable Operators. There are multiple ways to install the Stackable Operator for Apache Kafka. xref:management:stackablectl:index.adoc[] is the preferred way, but Helm is also supported. diff --git a/docs/modules/kafka/pages/index.adoc b/docs/modules/kafka/pages/index.adoc index 5b0c25a5c..ff57eb867 100644 --- a/docs/modules/kafka/pages/index.adoc +++ b/docs/modules/kafka/pages/index.adoc @@ -22,7 +22,7 @@ It is commonly used for real-time data processing, data ingestion, event streami == Getting started -Follow the xref:kafka:getting_started/index.adoc[] which guides you through installing The Stackable Kafka and ZooKeeper operators, setting up ZooKeeper and Kafka and testing your Kafka installation. +Follow the xref:kafka:getting_started/index.adoc[] which guides you through installing the Stackable Kafka operator, setting up Kafka in KRaft mode, creating a topic with a KafkaTopic and testing your Kafka installation. == Resources diff --git a/docs/templating_vars.yaml b/docs/templating_vars.yaml index 36c236b5f..28827f400 100644 --- a/docs/templating_vars.yaml +++ b/docs/templating_vars.yaml @@ -6,5 +6,4 @@ versions: commons: 0.0.0-dev secret: 0.0.0-dev listener: 0.0.0-dev - zookeeper: 0.0.0-dev kafka: 0.0.0-dev From 24eca56251135bc24fb6584baa9ac5a07bb8f530 Mon Sep 17 00:00:00 2001 From: Razvan-Daniel Mihai <84674+razvan@users.noreply.github.com> Date: Fri, 20 Nov 2026 16:13:33 +0100 Subject: [PATCH 2/2] update changelog --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b91b2b70..e64266bb8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,9 @@ All notable changes to this project will be documented in this file. ### Changed - Getting started guide uses a KRaft cluster instead of ZooKeeper and declares its topic with a - KafkaTopic managed by the agent. + KafkaTopic managed by the agent ([#1079]). + +[#1079]: https://github.com/stackabletech/kafka-operator/pull/1079 ## [26.11.0] - 2026-11-20