diff --git a/docs/modules/hbase/pages/getting_started/index.adoc b/docs/modules/hbase/pages/getting_started/index.adoc index bab5bc4b..5d318a34 100644 --- a/docs/modules/hbase/pages/getting_started/index.adoc +++ b/docs/modules/hbase/pages/getting_started/index.adoc @@ -1,4 +1,5 @@ = Getting started +:description: Getting started with Apache HBase on Kubernetes, covering installation of the Stackable operator and its dependencies and a first HBase cluster. This guide gets you started with HBase using the Stackable operator. It guides you through the installation of the operator and its dependencies, setting up your first HBase cluster and verifying its operation. diff --git a/docs/modules/hbase/pages/reference/commandline-parameters.adoc b/docs/modules/hbase/pages/reference/commandline-parameters.adoc index 7f15684e..a6ff8ce7 100644 --- a/docs/modules/hbase/pages/reference/commandline-parameters.adoc +++ b/docs/modules/hbase/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command Line Parameters +:description: Command-line parameters the Stackable operator for Apache HBase accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/hbase/pages/reference/crds.adoc b/docs/modules/hbase/pages/reference/crds.adoc index 76000a70..406e3623 100644 --- a/docs/modules/hbase/pages/reference/crds.adoc +++ b/docs/modules/hbase/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache HBase on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache HBase at: {crd-ref}{crd-ref-release}&operator=hbase-operator. diff --git a/docs/modules/hbase/pages/reference/discovery.adoc b/docs/modules/hbase/pages/reference/discovery.adoc index da2d7b98..6c919db8 100644 --- a/docs/modules/hbase/pages/reference/discovery.adoc +++ b/docs/modules/hbase/pages/reference/discovery.adoc @@ -5,6 +5,7 @@ :page-aliases: discovery.adoc = Discovery +:description: Reference for the discovery ConfigMap the Stackable operator for Apache HBase publishes, with the client configuration for connecting to the cluster. The Stackable Operator for Apache HBase publishes a discovery https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmap-v1-core[ConfigMap], which exposes a client configuration bundle that allows access to the Apache HBase cluster. diff --git a/docs/modules/hbase/pages/reference/environment-variables.adoc b/docs/modules/hbase/pages/reference/environment-variables.adoc index ab123938..1a1fcb72 100644 --- a/docs/modules/hbase/pages/reference/environment-variables.adoc +++ b/docs/modules/hbase/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache HBase accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/hbase/pages/reference/index.adoc b/docs/modules/hbase/pages/reference/index.adoc index eeb572f1..532687c9 100644 --- a/docs/modules/hbase/pages/reference/index.adoc +++ b/docs/modules/hbase/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache HBase, 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/hbase/pages/troubleshooting/index.adoc b/docs/modules/hbase/pages/troubleshooting/index.adoc index 7d79ad88..92ba9185 100644 --- a/docs/modules/hbase/pages/troubleshooting/index.adoc +++ b/docs/modules/hbase/pages/troubleshooting/index.adoc @@ -1,4 +1,5 @@ = Troubleshooting +:description: Troubleshooting Apache HBase on the Stackable Data Platform, covering clients connecting with Kerberos while ZooKeeper only uses mutual TLS. == HBase access with Kerberos authentication diff --git a/docs/modules/hbase/pages/usage-guide/index.adoc b/docs/modules/hbase/pages/usage-guide/index.adoc index 71a6dce1..a0b03e55 100644 --- a/docs/modules/hbase/pages/usage-guide/index.adoc +++ b/docs/modules/hbase/pages/usage-guide/index.adoc @@ -1,4 +1,5 @@ = Usage guide +:description: Guides for Apache HBase on Kubernetes, covering cluster operations, Pod placement, resource requests, logging, monitoring and Apache Phoenix. Learn about xref:usage-guide/operations/cluster-operations.adoc[starting, stopping and pausing] your cluster. diff --git a/docs/modules/hbase/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/hbase/pages/usage-guide/operations/cluster-operations.adoc index 4e674ea8..2446d551 100644 --- a/docs/modules/hbase/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/hbase/pages/usage-guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster operation +:description: Cluster operations for Apache HBase, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. HBase 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/hbase/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/hbase/pages/usage-guide/operations/graceful-shutdown.adoc index f58191f2..f4523f37 100644 --- a/docs/modules/hbase/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/hbase/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache HBase masters, RegionServers and RestServers, covering the configurable shutdown timeout per role. You can configure the graceful shutdown grace period as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/hbase/pages/usage-guide/operations/index.adoc b/docs/modules/hbase/pages/usage-guide/operations/index.adoc index 3d51bd21..344e51d9 100644 --- a/docs/modules/hbase/pages/usage-guide/operations/index.adoc +++ b/docs/modules/hbase/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache HBase 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/hbase/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/hbase/pages/usage-guide/operations/pod-disruptions.adoc index 26e90df3..ac6d6b02 100644 --- a/docs/modules/hbase/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/hbase/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: PodDisruptionBudgets the Stackable operator writes for Apache HBase masters, RegionServers and RestServers, and how to disable them. You can configure the permitted Pod disruptions for HBase nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/hbase/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/hbase/pages/usage-guide/operations/pod-placement.adoc index 1ac105b2..76f989ea 100644 --- a/docs/modules/hbase/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/hbase/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache HBase, covering default affinities that place RegionServers next to HDFS DataNodes and custom placement settings. :page-aliases: pod_placement.adoc You can configure Pod placement for HBase nodes as described in xref:concepts:operations/pod_placement.adoc[]. diff --git a/docs/modules/hbase/pages/usage-guide/resource-requests.adoc b/docs/modules/hbase/pages/usage-guide/resource-requests.adoc index f3909ee3..84a40ca1 100644 --- a/docs/modules/hbase/pages/usage-guide/resource-requests.adoc +++ b/docs/modules/hbase/pages/usage-guide/resource-requests.adoc @@ -1,7 +1,7 @@ = Resource requests :description: Stackable managed HBase defaults to minimal resource requests. Adjust CPU and memory limits for production clusters to ensure proper performance. -include::home:concepts:stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] If no resources are configured explicitly, the HBase operator uses following defaults: