diff --git a/docs/modules/druid/pages/reference/commandline-parameters.adoc b/docs/modules/druid/pages/reference/commandline-parameters.adoc index 3278c897..c29c10ff 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 93c593e9..8c4e0ffc 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 1f603488..0b93b532 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 eeb572f1..36bec0f5 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 fbdd29ba..bc05620f 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 a7e36869..6500b7c1 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 d979c41e..ecaff328 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 21d170f9..070c34af 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 482dc391..b3d701f5 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 5a3e2ddb..480ca2ef 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[]. 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 4ceda14b..c3fd8910 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::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]: