From fb14b8a262d5c8f95a6d1218dfa37fc1d4f57c22 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:47 +0100 Subject: [PATCH 1/4] docs: Add page descriptions --- docs/modules/zookeeper/pages/getting_started/first_steps.adoc | 1 + docs/modules/zookeeper/pages/getting_started/index.adoc | 1 + .../zookeeper/pages/reference/commandline-parameters.adoc | 1 + docs/modules/zookeeper/pages/reference/crds.adoc | 1 + docs/modules/zookeeper/pages/reference/discovery.adoc | 1 + .../modules/zookeeper/pages/reference/environment-variables.adoc | 1 + docs/modules/zookeeper/pages/reference/index.adoc | 1 + docs/modules/zookeeper/pages/usage_guide/index.adoc | 1 + .../pages/usage_guide/operations/cluster-operations.adoc | 1 + .../pages/usage_guide/operations/graceful-shutdown.adoc | 1 + docs/modules/zookeeper/pages/usage_guide/operations/index.adoc | 1 + .../zookeeper/pages/usage_guide/operations/pod-disruptions.adoc | 1 + .../zookeeper/pages/usage_guide/operations/pod-placement.adoc | 1 + docs/modules/zookeeper/pages/usage_guide/overrides.adoc | 1 + 14 files changed, 14 insertions(+) diff --git a/docs/modules/zookeeper/pages/getting_started/first_steps.adoc b/docs/modules/zookeeper/pages/getting_started/first_steps.adoc index 4253e3505..6f4e53f1a 100644 --- a/docs/modules/zookeeper/pages/getting_started/first_steps.adoc +++ b/docs/modules/zookeeper/pages/getting_started/first_steps.adoc @@ -1,4 +1,5 @@ = First steps +:description: First steps with Apache ZooKeeper, covering a first cluster and ZNode deployed by the Stackable operator and connecting through the discovery ConfigMap. Now that the operator is installed it is time to deploy a ZooKeeper cluster and connect to it. diff --git a/docs/modules/zookeeper/pages/getting_started/index.adoc b/docs/modules/zookeeper/pages/getting_started/index.adoc index 808b0cdf8..72c1504c6 100644 --- a/docs/modules/zookeeper/pages/getting_started/index.adoc +++ b/docs/modules/zookeeper/pages/getting_started/index.adoc @@ -1,4 +1,5 @@ = Getting started +:description: Getting started with Apache ZooKeeper on Kubernetes, covering the Stackable operator, a first ZooKeeper cluster and ZNode and connecting to them. This guide gets you started with Apache ZooKeeper using the Stackable Operator. It guides you through the installation of the Operator and its dependencies, setting up your first ZooKeeper cluster and connecting to it as well as setting up your first xref:znodes.adoc[ZNode]. diff --git a/docs/modules/zookeeper/pages/reference/commandline-parameters.adoc b/docs/modules/zookeeper/pages/reference/commandline-parameters.adoc index 4e27f3283..045311e41 100644 --- a/docs/modules/zookeeper/pages/reference/commandline-parameters.adoc +++ b/docs/modules/zookeeper/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command line parameters +:description: Command-line parameters the Stackable operator for Apache ZooKeeper accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/zookeeper/pages/reference/crds.adoc b/docs/modules/zookeeper/pages/reference/crds.adoc index 6e455f72a..d89eac059 100644 --- a/docs/modules/zookeeper/pages/reference/crds.adoc +++ b/docs/modules/zookeeper/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache ZooKeeper on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache ZooKeeper at: {crd-ref}{crd-ref-release}&operator=zookeeper-operator. diff --git a/docs/modules/zookeeper/pages/reference/discovery.adoc b/docs/modules/zookeeper/pages/reference/discovery.adoc index b66303bb3..d1b21bab9 100644 --- a/docs/modules/zookeeper/pages/reference/discovery.adoc +++ b/docs/modules/zookeeper/pages/reference/discovery.adoc @@ -1,4 +1,5 @@ = Discovery Profiles +:description: Reference for the discovery profiles the Stackable operator for Apache ZooKeeper publishes as ConfigMaps for clusters and ZNodes, with their contents. :page-aliases: discovery.adoc The Stackable Operator for Apache ZooKeeper creates a number of discovery profiles, which are client configuration bundles diff --git a/docs/modules/zookeeper/pages/reference/environment-variables.adoc b/docs/modules/zookeeper/pages/reference/environment-variables.adoc index c36ec4ac8..d10ab23a2 100644 --- a/docs/modules/zookeeper/pages/reference/environment-variables.adoc +++ b/docs/modules/zookeeper/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache ZooKeeper accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/zookeeper/pages/reference/index.adoc b/docs/modules/zookeeper/pages/reference/index.adoc index 9cf74cba7..e096b7281 100644 --- a/docs/modules/zookeeper/pages/reference/index.adoc +++ b/docs/modules/zookeeper/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache ZooKeeper, covering CRDs, discovery properties, command-line parameters, environment variables and zoo.cfg. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/zookeeper/pages/usage_guide/index.adoc b/docs/modules/zookeeper/pages/usage_guide/index.adoc index 6487895c6..732c1d4b4 100644 --- a/docs/modules/zookeeper/pages/usage_guide/index.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/index.adoc @@ -1,3 +1,4 @@ = Usage guide +:description: In-depth guides to the Stackable operator for Apache ZooKeeper, covering ZNodes, authentication, encryption, resources, logging, monitoring and overrides. This section provides more in depth information about specific aspects of using the Stackable Operator for Apache ZooKeeper. diff --git a/docs/modules/zookeeper/pages/usage_guide/operations/cluster-operations.adoc b/docs/modules/zookeeper/pages/usage_guide/operations/cluster-operations.adoc index c73f91cc7..60e9cb5ff 100644 --- a/docs/modules/zookeeper/pages/usage_guide/operations/cluster-operations.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster Operation +:description: Cluster operations for Apache ZooKeeper, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. The managed ZooKeeper 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/zookeeper/pages/usage_guide/operations/graceful-shutdown.adoc b/docs/modules/zookeeper/pages/usage_guide/operations/graceful-shutdown.adoc index 37823fafe..ac476a7ab 100644 --- a/docs/modules/zookeeper/pages/usage_guide/operations/graceful-shutdown.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache ZooKeeper servers, covering the configurable shutdown timeout and how the server process stops. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/zookeeper/pages/usage_guide/operations/index.adoc b/docs/modules/zookeeper/pages/usage_guide/operations/index.adoc index dacf0b793..00eb31b8c 100644 --- a/docs/modules/zookeeper/pages/usage_guide/operations/index.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache ZooKeeper with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement 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/zookeeper/pages/usage_guide/operations/pod-disruptions.adoc b/docs/modules/zookeeper/pages/usage_guide/operations/pod-disruptions.adoc index 016f4689e..e516b6caa 100644 --- a/docs/modules/zookeeper/pages/usage_guide/operations/pod-disruptions.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: The PodDisruptionBudget the Stackable operator writes for Apache ZooKeeper servers, and how to disable it. You can configure the permitted Pod disruptions for Zookeeper nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/zookeeper/pages/usage_guide/operations/pod-placement.adoc b/docs/modules/zookeeper/pages/usage_guide/operations/pod-placement.adoc index b97973391..77ea3091b 100644 --- a/docs/modules/zookeeper/pages/usage_guide/operations/pod-placement.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache ZooKeeper on Kubernetes, covering the default affinity that spreads the servers of an ensemble across nodes. You can configure the Pod placement of the ZooKeeper pods as described in xref:concepts:operations/pod_placement.adoc[]. diff --git a/docs/modules/zookeeper/pages/usage_guide/overrides.adoc b/docs/modules/zookeeper/pages/usage_guide/overrides.adoc index b576ed93a..980c98b1e 100644 --- a/docs/modules/zookeeper/pages/usage_guide/overrides.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/overrides.adoc @@ -1,5 +1,6 @@ = Configuration and environment overrides +:description: Overrides for Apache ZooKeeper, covering zoo.cfg and security.properties settings, 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). From 7b5f9c057e567a3e2388e1cafa6314c6f69881e5 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:47 +0100 Subject: [PATCH 2/4] docs: Include the resource requests partial --- .../zookeeper/pages/usage_guide/resource_configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc b/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc index f40bea6c0..2f3c7c708 100644 --- a/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc @@ -27,7 +27,7 @@ See the xref:data_directory.adoc[data directory docs] for how that data grows an == Resource requests -include::home:concepts:stackable_resource_requests.adoc[] +include::home:concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 3 ZooKeeper instances has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: From 632b80554416ba2f762b20a73caac46035e5efa0 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:47 +0100 Subject: [PATCH 3/4] docs: Remove the duplicate cluster operations page --- .../zookeeper/pages/usage_guide/cluster_operations.adoc | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 docs/modules/zookeeper/pages/usage_guide/cluster_operations.adoc diff --git a/docs/modules/zookeeper/pages/usage_guide/cluster_operations.adoc b/docs/modules/zookeeper/pages/usage_guide/cluster_operations.adoc deleted file mode 100644 index afca75f6e..000000000 --- a/docs/modules/zookeeper/pages/usage_guide/cluster_operations.adoc +++ /dev/null @@ -1,4 +0,0 @@ - -= Cluster Operation - -The managed ZooKeeper instances can be configured with different cluster operations like pausing reconciliation or stopping the cluster. See xref:concepts:cluster_operations.adoc[cluster operations] for more details. From eb85889b184cf377efe9850c06e6efbd4589581f Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 16:57:03 +0100 Subject: [PATCH 4/4] docs: Fix the resource requests include --- .../zookeeper/pages/usage_guide/resource_configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc b/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc index 2f3c7c708..51847f442 100644 --- a/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc +++ b/docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc @@ -27,7 +27,7 @@ See the xref:data_directory.adoc[data directory docs] for how that data grows an == Resource requests -include::home:concepts:partial$stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 3 ZooKeeper instances has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: