diff --git a/docs/modules/kafka/pages/reference/commandline-parameters.adoc b/docs/modules/kafka/pages/reference/commandline-parameters.adoc index 3c66dc419..7bbd26d36 100644 --- a/docs/modules/kafka/pages/reference/commandline-parameters.adoc +++ b/docs/modules/kafka/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command line parameters +:description: Command-line parameters the Stackable operator for Apache Kafka accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/kafka/pages/reference/crds.adoc b/docs/modules/kafka/pages/reference/crds.adoc index 740200236..85a83644c 100644 --- a/docs/modules/kafka/pages/reference/crds.adoc +++ b/docs/modules/kafka/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache Kafka on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache Kafka at: {crd-ref}{crd-ref-release}&operator=kafka-operator. diff --git a/docs/modules/kafka/pages/reference/discovery.adoc b/docs/modules/kafka/pages/reference/discovery.adoc index eb30da5bb..454b2e829 100644 --- a/docs/modules/kafka/pages/reference/discovery.adoc +++ b/docs/modules/kafka/pages/reference/discovery.adoc @@ -3,6 +3,7 @@ :brokerPort: 9092 = Discovery +:description: Reference for the discovery ConfigMap the Stackable operator for Apache Kafka publishes, with the connection string other tools use to reach the brokers. :page-aliases: discovery.adoc The Stackable Operator for Apache Kafka publishes a xref:concepts:service_discovery.adoc[service discovery ConfigMap] which exposes a client configuration bundle that allows access to the Apache Kafka cluster. diff --git a/docs/modules/kafka/pages/reference/environment-variables.adoc b/docs/modules/kafka/pages/reference/environment-variables.adoc index d2271300d..745d88e67 100644 --- a/docs/modules/kafka/pages/reference/environment-variables.adoc +++ b/docs/modules/kafka/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache Kafka accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/kafka/pages/reference/index.adoc b/docs/modules/kafka/pages/reference/index.adoc index eeb572f14..7d0c4dac6 100644 --- a/docs/modules/kafka/pages/reference/index.adoc +++ b/docs/modules/kafka/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache Kafka, covering CRD fields, discovery ConfigMap properties, command-line parameters and environment variables. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/kafka/pages/usage-guide/index.adoc b/docs/modules/kafka/pages/usage-guide/index.adoc index 9e16826fc..158ec1f68 100644 --- a/docs/modules/kafka/pages/usage-guide/index.adoc +++ b/docs/modules/kafka/pages/usage-guide/index.adoc @@ -1,2 +1,3 @@ = Usage guide +:description: Guides for Apache Kafka on Kubernetes, covering KRaft controllers, service exposition, security, storage, logging, monitoring and overrides. :page-aliases: usage.adoc diff --git a/docs/modules/kafka/pages/usage-guide/listenerclass.adoc b/docs/modules/kafka/pages/usage-guide/listenerclass.adoc index b9fbf7412..f3564cfbd 100644 --- a/docs/modules/kafka/pages/usage-guide/listenerclass.adoc +++ b/docs/modules/kafka/pages/usage-guide/listenerclass.adoc @@ -1,4 +1,5 @@ = Service exposition with ListenerClasses +:description: Exposing Apache Kafka brokers with ListenerClasses, covering the bootstrap and per-broker Listeners the operator creates for client connections. The operator deploys a bootstrap xref:listener-operator:listener.adoc[Listener] for each broker rolegroup, as well as a xref:listener-operator:listener.adoc[Listener] for each broker pod. diff --git a/docs/modules/kafka/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/kafka/pages/usage-guide/operations/cluster-operations.adoc index 0a89c476d..eaaf386df 100644 --- a/docs/modules/kafka/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/kafka/pages/usage-guide/operations/cluster-operations.adoc @@ -1,5 +1,6 @@ = Cluster operation +:description: Cluster operations for Apache Kafka, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. The managed Kafka instances can be configured with different cluster operations like pausing reconciliation or stopping the cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details. diff --git a/docs/modules/kafka/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/kafka/pages/usage-guide/operations/graceful-shutdown.adoc index 40acb4720..a5fd4a54f 100644 --- a/docs/modules/kafka/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/kafka/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache Kafka brokers, covering the shutdown timeout and how brokers hand over partition leadership before stopping. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/kafka/pages/usage-guide/operations/index.adoc b/docs/modules/kafka/pages/usage-guide/operations/index.adoc index b6a1309b8..18c49e710 100644 --- a/docs/modules/kafka/pages/usage-guide/operations/index.adoc +++ b/docs/modules/kafka/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache Kafka with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement, cluster IDs and cluster operations. This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation. diff --git a/docs/modules/kafka/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/kafka/pages/usage-guide/operations/pod-disruptions.adoc index 57c9e86cf..1dc9e4023 100644 --- a/docs/modules/kafka/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/kafka/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,5 +1,6 @@ = Allowed Pod disruptions +:description: PodDisruptionBudgets the Stackable operator writes for Apache Kafka brokers and KRaft controllers, and how to disable them. You can configure the permitted Pod disruptions for Kafka nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/kafka/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/kafka/pages/usage-guide/operations/pod-placement.adoc index 2035fb271..c5dd0e408 100644 --- a/docs/modules/kafka/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/kafka/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache Kafka brokers, covering the default anti-affinity and placement next to OPA when OPA authorization is used. You can configure Pod placement for Kafka brokers and controllers as described in xref:concepts:pod_placement.adoc[]. diff --git a/docs/modules/kafka/pages/usage-guide/operations/znode-id.adoc b/docs/modules/kafka/pages/usage-guide/operations/znode-id.adoc index f9edc814d..e8456c511 100644 --- a/docs/modules/kafka/pages/usage-guide/operations/znode-id.adoc +++ b/docs/modules/kafka/pages/usage-guide/operations/znode-id.adoc @@ -1,4 +1,5 @@ = Cluster ID +:description: The Apache Kafka cluster ID stored in ZooKeeper, covering how mismatches arise when restarting a cluster, replacing a ZNode or upgrading SDP. Kafka has an internal check to ensure that a broker cannot join a different cluster to the one in which it was previously registered (this is important to avoid various kinds of metadata inconsistencies in the cluster). The clusterId is stored locally after initial registration and is verified upon cluster startup that it still matches what is in ZooKeeper. diff --git a/docs/modules/kafka/pages/usage-guide/overrides.adoc b/docs/modules/kafka/pages/usage-guide/overrides.adoc index 4c8747432..91f9a457a 100644 --- a/docs/modules/kafka/pages/usage-guide/overrides.adoc +++ b/docs/modules/kafka/pages/usage-guide/overrides.adoc @@ -1,4 +1,5 @@ = Configuration & Environment Overrides +:description: Overrides for Apache Kafka, covering configuration properties, security.properties, environment variables, Pod specs and JVM arguments per role group. The cluster definition also supports overriding configuration properties and environment variables, either per role or per role group, where the more specific override (role group) has precedence over the less specific one (role). diff --git a/docs/modules/kafka/pages/usage-guide/storage-resources.adoc b/docs/modules/kafka/pages/usage-guide/storage-resources.adoc index df08f05f6..185417331 100644 --- a/docs/modules/kafka/pages/usage-guide/storage-resources.adoc +++ b/docs/modules/kafka/pages/usage-guide/storage-resources.adoc @@ -23,7 +23,7 @@ If nothing is configured in the custom resource for a certain role group, then b == Resource Requests -include::home:concepts:stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 Brokers has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: