From 5d7cf344de7efd25326fd8678954efc9484c3536 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:32 +0100 Subject: [PATCH 1/3] docs: Add page descriptions --- docs/modules/druid/pages/reference/commandline-parameters.adoc | 1 + docs/modules/druid/pages/reference/crds.adoc | 1 + docs/modules/druid/pages/reference/environment-variables.adoc | 1 + docs/modules/druid/pages/reference/index.adoc | 1 + docs/modules/druid/pages/usage-guide/index.adoc | 1 + .../druid/pages/usage-guide/operations/cluster-operations.adoc | 1 + .../druid/pages/usage-guide/operations/graceful-shutdown.adoc | 1 + docs/modules/druid/pages/usage-guide/operations/index.adoc | 1 + .../druid/pages/usage-guide/operations/pod-disruptions.adoc | 1 + .../druid/pages/usage-guide/operations/pod-placement.adoc | 1 + 10 files changed, 10 insertions(+) diff --git a/docs/modules/druid/pages/reference/commandline-parameters.adoc b/docs/modules/druid/pages/reference/commandline-parameters.adoc index 3278c897e..c29c10ff8 100644 --- a/docs/modules/druid/pages/reference/commandline-parameters.adoc +++ b/docs/modules/druid/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command Line parameters +:description: Command-line parameters the Stackable operator for Apache Druid accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/druid/pages/reference/crds.adoc b/docs/modules/druid/pages/reference/crds.adoc index 93c593e9e..8c4e0ffc0 100644 --- a/docs/modules/druid/pages/reference/crds.adoc +++ b/docs/modules/druid/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache Druid on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable operator for Apache Druid at: {crd-ref}{crd-ref-release}&operator=druid-operator. diff --git a/docs/modules/druid/pages/reference/environment-variables.adoc b/docs/modules/druid/pages/reference/environment-variables.adoc index 1f603488f..0b93b5320 100644 --- a/docs/modules/druid/pages/reference/environment-variables.adoc +++ b/docs/modules/druid/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache Druid accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/druid/pages/reference/index.adoc b/docs/modules/druid/pages/reference/index.adoc index eeb572f14..36bec0f5e 100644 --- a/docs/modules/druid/pages/reference/index.adoc +++ b/docs/modules/druid/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache Druid, 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/druid/pages/usage-guide/index.adoc b/docs/modules/druid/pages/usage-guide/index.adoc index fbdd29ba0..bc05620f1 100644 --- a/docs/modules/druid/pages/usage-guide/index.adoc +++ b/docs/modules/druid/pages/usage-guide/index.adoc @@ -1,4 +1,5 @@ = Usage guide +:description: Guides for Apache Druid on Kubernetes, covering deep storage, ingestion, resources, security with TLS, LDAP and OPA, logging and monitoring. :page-aliases: usage.doc The usage guide covers various aspects of configuring Druid and interconnection with other tools. diff --git a/docs/modules/druid/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/druid/pages/usage-guide/operations/cluster-operations.adoc index a7e368692..6500b7c1d 100644 --- a/docs/modules/druid/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/druid/pages/usage-guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster operation +:description: Cluster operations for Apache Druid, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. Druid installations 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/druid/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/druid/pages/usage-guide/operations/graceful-shutdown.adoc index d979c41e9..ecaff3288 100644 --- a/docs/modules/druid/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/druid/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache Druid brokers, coordinators, historicals, middle managers and routers, covering the configurable timeout per role. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/druid/pages/usage-guide/operations/index.adoc b/docs/modules/druid/pages/usage-guide/operations/index.adoc index 21d170f9e..070c34af0 100644 --- a/docs/modules/druid/pages/usage-guide/operations/index.adoc +++ b/docs/modules/druid/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache Druid 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/druid/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/druid/pages/usage-guide/operations/pod-disruptions.adoc index 482dc3918..b3d701f5b 100644 --- a/docs/modules/druid/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/druid/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: PodDisruptionBudgets the Stackable operator writes for each Apache Druid role, from brokers to routers, and how to disable them. You can configure the permitted Pod disruptions for Druid nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/druid/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/druid/pages/usage-guide/operations/pod-placement.adoc index 5a3e2ddb1..480ca2ef3 100644 --- a/docs/modules/druid/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/druid/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache Druid, covering default affinities that keep communicating roles close together and near HDFS when used as deep storage. You can configure the Pod placement of the Druid pods as described in xref:concepts:operations/pod_placement.adoc[]. From 4f200d1aae01184dbcba544056be4fe9235f3fce Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:32 +0100 Subject: [PATCH 2/3] docs: Include the resource requests partial --- docs/modules/druid/pages/usage-guide/resources-and-storage.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc b/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc index 4ceda14bb..f1d6b1ef6 100644 --- a/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc +++ b/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc @@ -7,7 +7,7 @@ Druid uses S3 or HDFS for deep storage, so no extra https://kubernetes.io/docs/c == Resource Requests -include::home:concepts:stackable_resource_requests.adoc[] +include::home:concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 Pods of each role has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: From 6881245f64a5834fa80db5d9a825063336f3f4af Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 16:56:59 +0100 Subject: [PATCH 3/3] docs: Fix the resource requests include --- docs/modules/druid/pages/usage-guide/resources-and-storage.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc b/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc index f1d6b1ef6..c3fd89101 100644 --- a/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc +++ b/docs/modules/druid/pages/usage-guide/resources-and-storage.adoc @@ -7,7 +7,7 @@ Druid uses S3 or HDFS for deep storage, so no extra https://kubernetes.io/docs/c == Resource Requests -include::home:concepts:partial$stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 Pods of each role has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: