diff --git a/docs/modules/kafka/pages/getting_started/first_steps.adoc b/docs/modules/kafka/pages/getting_started/first_steps.adoc index df303a48..2e5aad00 100644 --- a/docs/modules/kafka/pages/getting_started/first_steps.adoc +++ b/docs/modules/kafka/pages/getting_started/first_steps.adoc @@ -1,4 +1,5 @@ = First steps +:description: Deploy and verify a Kafka cluster on Kubernetes with Stackable Operators, including ZooKeeper setup and data testing using kcat. After going through the xref:getting_started/installation.adoc[] section and having installed all the operators, you will now deploy a Kafka cluster and the required dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>> by producing test data into a topic and consuming it. diff --git a/docs/modules/kafka/pages/getting_started/index.adoc b/docs/modules/kafka/pages/getting_started/index.adoc index 0f11b88a..65243048 100644 --- a/docs/modules/kafka/pages/getting_started/index.adoc +++ b/docs/modules/kafka/pages/getting_started/index.adoc @@ -1,6 +1,8 @@ = Getting started +:description: Start with Apache Kafka using Stackable Operator: Install, set up Kafka, and manage topics in a Kubernetes cluster. -This guide will get you started with Apache Kafka using the Stackable Operator. It will guide 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. +This guide will get you started with Apache Kafka using the Stackable Operator. +It will guide 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. == Prerequisites diff --git a/docs/modules/kafka/pages/getting_started/installation.adoc b/docs/modules/kafka/pages/getting_started/installation.adoc index d69dd8ea..08acc868 100644 --- a/docs/modules/kafka/pages/getting_started/installation.adoc +++ b/docs/modules/kafka/pages/getting_started/installation.adoc @@ -1,4 +1,5 @@ = Installation +:description: Install Stackable Operator for Apache Kafka using stackablectl or Helm, including dependencies like ZooKeeper and required operators for Kubernetes. On this page you will 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. diff --git a/docs/modules/kafka/pages/index.adoc b/docs/modules/kafka/pages/index.adoc index f0bb7bf4..cd6459c2 100644 --- a/docs/modules/kafka/pages/index.adoc +++ b/docs/modules/kafka/pages/index.adoc @@ -1,5 +1,5 @@ = Stackable Operator for Apache Kafka -:description: The Stackable operator for Apache Superset is a Kubernetes operator that can manage Apache Kafka clusters. Learn about its features, resources, dependencies and demos, and see the list of supported Kafka versions. +:description: Deploy and manage Apache Kafka clusters on Kubernetes using Stackable Operator. :keywords: Stackable operator, Apache Kafka, Kubernetes, operator, SQL, engineer, broker, big data, CRD, StatefulSet, ConfigMap, Service, Druid, ZooKeeper, NiFi, S3, demo, version :kafka: https://kafka.apache.org/ :github: https://github.com/stackabletech/kafka-operator/ diff --git a/docs/modules/kafka/pages/usage-guide/configuration-environment-overrides.adoc b/docs/modules/kafka/pages/usage-guide/configuration-environment-overrides.adoc index b5dead7c..3bd46fcb 100644 --- a/docs/modules/kafka/pages/usage-guide/configuration-environment-overrides.adoc +++ b/docs/modules/kafka/pages/usage-guide/configuration-environment-overrides.adoc @@ -86,3 +86,8 @@ servers: default: replicas: 1 ---- + +== Pod overrides + +The Kafka operator also supports Pod overrides, allowing you to override any property that you can set on a Kubernetes Pod. +Read the xref:concepts:overrides.adoc#pod-overrides[Pod overrides documentation] to learn more about this feature. diff --git a/docs/modules/kafka/pages/usage-guide/logging.adoc b/docs/modules/kafka/pages/usage-guide/logging.adoc index 9d0dee2e..34787b54 100644 --- a/docs/modules/kafka/pages/usage-guide/logging.adoc +++ b/docs/modules/kafka/pages/usage-guide/logging.adoc @@ -1,7 +1,7 @@ = Log aggregation +:description: The logs can be forwarded to a Vector log aggregator by providing a discovery ConfigMap for the aggregator and by enabling the log agent -The logs can be forwarded to a Vector log aggregator by providing a discovery -ConfigMap for the aggregator and by enabling the log agent: +The logs can be forwarded to a Vector log aggregator by providing a discovery ConfigMap for the aggregator and by enabling the log agent: [source,yaml] ---- @@ -14,5 +14,4 @@ spec: enableVectorAgent: true ---- -Further information on how to configure logging, can be found in -xref:concepts:logging.adoc[]. +Further information on how to configure logging, can be found in xref:concepts:logging.adoc[]. diff --git a/docs/modules/kafka/pages/usage-guide/monitoring.adoc b/docs/modules/kafka/pages/usage-guide/monitoring.adoc index efcc5c76..421129ae 100644 --- a/docs/modules/kafka/pages/usage-guide/monitoring.adoc +++ b/docs/modules/kafka/pages/usage-guide/monitoring.adoc @@ -1,4 +1,5 @@ = Monitoring +:description: The managed Kafka instances are automatically configured to export Prometheus metrics. -The managed Kafka instances are automatically configured to export Prometheus metrics. See -xref:operators:monitoring.adoc[] for more details. +The managed Kafka instances are automatically configured to export Prometheus metrics. +See xref:operators:monitoring.adoc[] for more details. diff --git a/docs/modules/kafka/pages/usage-guide/security.adoc b/docs/modules/kafka/pages/usage-guide/security.adoc index 94ed5b1c..1752d1f6 100644 --- a/docs/modules/kafka/pages/usage-guide/security.adoc +++ b/docs/modules/kafka/pages/usage-guide/security.adoc @@ -1,9 +1,10 @@ = Security +:description: Configure TLS encryption, authentication, and Open Policy Agent (OPA) authorization for Kafka with the Stackable Operator. == Encryption -The internal and client communication can be encrypted TLS. This requires the xref:secret-operator:index.adoc[Secret -Operator] to be present in order to provide certificates. The utilized certificates can be changed in a top-level config. +The internal and client communication can be encrypted TLS. This requires the xref:secret-operator:index.adoc[Secret Operator] to be present in order to provide certificates. +The utilized certificates can be changed in a top-level config. [source,yaml] ---- @@ -47,14 +48,12 @@ spec: autoGenerate: true ---- -You can create your own secrets and reference them e.g. in the `spec.clusterConfig.tls.serverSecretClass` or -`spec.clusterConfig.tls.internalSecretClass` to use different certificates. +You can create your own secrets and reference them e.g. in the `spec.clusterConfig.tls.serverSecretClass` or `spec.clusterConfig.tls.internalSecretClass` to use different certificates. == Authentication -The internal or broker-to-broker communication is authenticated via TLS. In order to enforce TLS authentication for -client-to-server communication, you can set an `AuthenticationClass` reference in the custom resource provided by the -xref:commons-operator:index.adoc[Commons Operator]. +The internal or broker-to-broker communication is authenticated via TLS. +In order to enforce TLS authentication for client-to-server communication, you can set an `AuthenticationClass` reference in the custom resource provided by the xref:commons-operator:index.adoc[Commons Operator]. [source,yaml] ---- @@ -105,9 +104,8 @@ spec: == [[authorization]]Authorization -If you wish to include integration with xref:opa:index.adoc[Open Policy Agent] and already have an OPA cluster, then you -can include an `opa` field pointing to the OPA cluster discovery `ConfigMap` and the required package. The package is -optional and will default to the `metadata.name` field: +If you wish to include integration with xref:opa:index.adoc[Open Policy Agent] and already have an OPA cluster, then you can include an `opa` field pointing to the OPA cluster discovery `ConfigMap` and the required package. +The package is optional and will default to the `metadata.name` field: [source,yaml] ---- diff --git a/docs/modules/kafka/pages/usage-guide/storage-resources.adoc b/docs/modules/kafka/pages/usage-guide/storage-resources.adoc index 0b9519ea..f423833f 100644 --- a/docs/modules/kafka/pages/usage-guide/storage-resources.adoc +++ b/docs/modules/kafka/pages/usage-guide/storage-resources.adoc @@ -1,4 +1,5 @@ = Storage and resource configuration +:description: Configure storage and resource allocation for Kafka brokers using Stackable Operator, including PersistentVolumeClaims, CPU, memory, and storage defaults. == Storage for data volumes