diff --git a/docs/modules/hive/pages/reference/commandline-parameters.adoc b/docs/modules/hive/pages/reference/commandline-parameters.adoc index 62ee7145..a9d6c47b 100644 --- a/docs/modules/hive/pages/reference/commandline-parameters.adoc +++ b/docs/modules/hive/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command line parameters +:description: Command-line parameters the Stackable operator for Apache Hive accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/hive/pages/reference/crds.adoc b/docs/modules/hive/pages/reference/crds.adoc index 3109a3c2..17580e51 100644 --- a/docs/modules/hive/pages/reference/crds.adoc +++ b/docs/modules/hive/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache Hive on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache Hive at: {crd-ref}{crd-ref-release}&operator=hive-operator. diff --git a/docs/modules/hive/pages/reference/discovery.adoc b/docs/modules/hive/pages/reference/discovery.adoc index c8b1d8ea..bb91d356 100644 --- a/docs/modules/hive/pages/reference/discovery.adoc +++ b/docs/modules/hive/pages/reference/discovery.adoc @@ -5,6 +5,7 @@ :page-aliases: discovery.adoc = Discovery +:description: Reference for the discovery ConfigMap the Stackable operator for Apache Hive publishes, with the Thrift connection string for the Hive metastore. The Stackable Operator for Apache Hive publishes a discovery https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#configmap-v1-core[ConfigMap], which exposes a client configuration bundle that allows access to the Apache Hive cluster. diff --git a/docs/modules/hive/pages/reference/environment-variables.adoc b/docs/modules/hive/pages/reference/environment-variables.adoc index 61cee5e9..c375486f 100644 --- a/docs/modules/hive/pages/reference/environment-variables.adoc +++ b/docs/modules/hive/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache Hive accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/hive/pages/reference/index.adoc b/docs/modules/hive/pages/reference/index.adoc index eeb572f1..5940750d 100644 --- a/docs/modules/hive/pages/reference/index.adoc +++ b/docs/modules/hive/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache Hive, 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/hive/pages/troubleshooting/index.adoc b/docs/modules/hive/pages/troubleshooting/index.adoc index 444b0506..8a55ef73 100644 --- a/docs/modules/hive/pages/troubleshooting/index.adoc +++ b/docs/modules/hive/pages/troubleshooting/index.adoc @@ -1,4 +1,5 @@ = Troubleshooting +:description: Troubleshooting the Apache Hive metastore on Kubernetes, covering Thrift errors from health checks under Kerberos and failing Iceberg schema changes. == Probe error 'Thrift Error' while using Kerberos authentication diff --git a/docs/modules/hive/pages/usage-guide/index.adoc b/docs/modules/hive/pages/usage-guide/index.adoc index d0ca8ca0..1ebabd79 100644 --- a/docs/modules/hive/pages/usage-guide/index.adoc +++ b/docs/modules/hive/pages/usage-guide/index.adoc @@ -1,4 +1,5 @@ = Usage guide +:description: Guides for Apache Hive metastores on Kubernetes, covering database drivers, data storage, security, resources, logging, monitoring and overrides. :page-aliases: usage.adoc This Section helps you to use and configure the Stackable operator for Apache Hive in various ways. diff --git a/docs/modules/hive/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/hive/pages/usage-guide/operations/cluster-operations.adoc index 67b0f099..d71b4497 100644 --- a/docs/modules/hive/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/hive/pages/usage-guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster operation +:description: Cluster operations for Apache Hive, covering how to pause reconciliation of a metastore cluster or stop it entirely through its custom resource. Hive 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/hive/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/hive/pages/usage-guide/operations/graceful-shutdown.adoc index 2fe54de3..24f76dad 100644 --- a/docs/modules/hive/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/hive/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache Hive metastores, covering the configurable shutdown timeout and how the metastore process stops. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/hive/pages/usage-guide/operations/index.adoc b/docs/modules/hive/pages/usage-guide/operations/index.adoc index b6a1309b..879cc97c 100644 --- a/docs/modules/hive/pages/usage-guide/operations/index.adoc +++ b/docs/modules/hive/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache Hive 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/hive/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/hive/pages/usage-guide/operations/pod-disruptions.adoc index 0de0024b..54bb198a 100644 --- a/docs/modules/hive/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/hive/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: The PodDisruptionBudget the Stackable operator writes for Apache Hive metastores, and how to disable it. You can configure the permitted Pod disruptions for Hive nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/hive/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/hive/pages/usage-guide/operations/pod-placement.adoc index b72e4c28..8d96f63b 100644 --- a/docs/modules/hive/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/hive/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache Hive metastores, covering the default anti-affinity and placement next to OPA when OPA authorization is used. You can configure Pod placement for Hive metastores as described in xref:concepts:operations/pod_placement.adoc[]. diff --git a/docs/modules/hive/pages/usage-guide/resources.adoc b/docs/modules/hive/pages/usage-guide/resources.adoc index 8a59a923..5507827b 100644 --- a/docs/modules/hive/pages/usage-guide/resources.adoc +++ b/docs/modules/hive/pages/usage-guide/resources.adoc @@ -1,7 +1,7 @@ = Resource requests :description: Set CPU and memory requests for Hive metastore in Kubernetes. Default values and customization options are provided for optimal resource management. -include::home:concepts:stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 Hive metastore instances has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: