diff --git a/docs/modules/hdfs/pages/reference/commandline-parameters.adoc b/docs/modules/hdfs/pages/reference/commandline-parameters.adoc index 7e0831f7..dbaa68cb 100644 --- a/docs/modules/hdfs/pages/reference/commandline-parameters.adoc +++ b/docs/modules/hdfs/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command line parameters +:description: Command-line parameters the Stackable operator for Apache Hadoop HDFS accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/hdfs/pages/reference/crds.adoc b/docs/modules/hdfs/pages/reference/crds.adoc index 69a19b70..f9dba9c9 100644 --- a/docs/modules/hdfs/pages/reference/crds.adoc +++ b/docs/modules/hdfs/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache Hadoop HDFS on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache HDFS at: {crd-ref}{crd-ref-release}&operator=hdfs-operator. diff --git a/docs/modules/hdfs/pages/reference/discovery.adoc b/docs/modules/hdfs/pages/reference/discovery.adoc index 86660ea8..f4fe380a 100644 --- a/docs/modules/hdfs/pages/reference/discovery.adoc +++ b/docs/modules/hdfs/pages/reference/discovery.adoc @@ -3,6 +3,7 @@ :page-aliases: discovery.adoc = Discovery +:description: Reference for the discovery ConfigMap the Stackable operator for Apache Hadoop HDFS publishes, with the client configuration for accessing the cluster. The Stackable Operator for Apache HDFS 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 HDFS cluster. diff --git a/docs/modules/hdfs/pages/reference/environment-variables.adoc b/docs/modules/hdfs/pages/reference/environment-variables.adoc index 09564694..436fbf4a 100644 --- a/docs/modules/hdfs/pages/reference/environment-variables.adoc +++ b/docs/modules/hdfs/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache Hadoop HDFS accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/hdfs/pages/reference/index.adoc b/docs/modules/hdfs/pages/reference/index.adoc index eeb572f1..07634d55 100644 --- a/docs/modules/hdfs/pages/reference/index.adoc +++ b/docs/modules/hdfs/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache Hadoop HDFS, covering CRD fields, discovery ConfigMap properties, CLI parameters and environment variables. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/hdfs/pages/reference/troubleshooting.adoc b/docs/modules/hdfs/pages/reference/troubleshooting.adoc index 38a783a3..c550307c 100644 --- a/docs/modules/hdfs/pages/reference/troubleshooting.adoc +++ b/docs/modules/hdfs/pages/reference/troubleshooting.adoc @@ -1,4 +1,5 @@ = Troubleshooting +:description: Recovery of an Apache Hadoop HDFS cluster whose NameNode formatting was interrupted and whose format-namenodes init container keeps failing. [#init-container-format-namenode-fails] == Init container format-namenodes fails diff --git a/docs/modules/hdfs/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/hdfs/pages/usage-guide/operations/cluster-operations.adoc index 192e6984..5ae6c7fa 100644 --- a/docs/modules/hdfs/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/hdfs/pages/usage-guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster Operation +:description: Cluster operations for Apache Hadoop HDFS, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. HDFS 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/hdfs/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/hdfs/pages/usage-guide/operations/graceful-shutdown.adoc index 0fcce4ba..bb8526de 100644 --- a/docs/modules/hdfs/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/hdfs/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache Hadoop HDFS JournalNodes, NameNodes and DataNodes, covering the configurable shutdown timeout per role. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/hdfs/pages/usage-guide/operations/index.adoc b/docs/modules/hdfs/pages/usage-guide/operations/index.adoc index 21d170f9..d927ee5d 100644 --- a/docs/modules/hdfs/pages/usage-guide/operations/index.adoc +++ b/docs/modules/hdfs/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache Hadoop HDFS with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement, rack awareness 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/hdfs/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/hdfs/pages/usage-guide/operations/pod-disruptions.adoc index 5cf41742..9445e640 100644 --- a/docs/modules/hdfs/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/hdfs/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,5 +1,6 @@ = Allowed Pod disruptions +:description: PodDisruptionBudgets for Apache Hadoop HDFS JournalNodes, NameNodes and DataNodes, and how to shorten rolling redeployments of large clusters. You can configure the permitted Pod disruptions for HDFS nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/hdfs/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/hdfs/pages/usage-guide/operations/pod-placement.adoc index 32c1d718..50ab74d6 100644 --- a/docs/modules/hdfs/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/hdfs/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache Hadoop HDFS NameNodes, DataNodes and JournalNodes, covering the default affinities and placement next to OPA. You can configure Pod placement for HDFS nodes as described in xref:concepts:operations/pod_placement.adoc[]. diff --git a/docs/modules/hdfs/pages/usage-guide/operations/rack-awareness.adoc b/docs/modules/hdfs/pages/usage-guide/operations/rack-awareness.adoc index f9ae4fce..cd6d6226 100644 --- a/docs/modules/hdfs/pages/usage-guide/operations/rack-awareness.adoc +++ b/docs/modules/hdfs/pages/usage-guide/operations/rack-awareness.adoc @@ -1,4 +1,5 @@ = HDFS Rack Awareness +:description: Rack awareness for Apache Hadoop HDFS on Kubernetes, covering how block replicas are spread across racks or zones for better fault tolerance. :rack-awareness-docs: https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/RackAwareness.html :hdfs-topology-provider: https://github.com/stackabletech/hdfs-utils/blob/v0.5.0/src/main/java/tech/stackable/hadoop/StackableTopologyProvider.java diff --git a/docs/modules/hdfs/pages/usage-guide/resources.adoc b/docs/modules/hdfs/pages/usage-guide/resources.adoc index b2d451f9..a858335e 100644 --- a/docs/modules/hdfs/pages/usage-guide/resources.adoc +++ b/docs/modules/hdfs/pages/usage-guide/resources.adoc @@ -86,7 +86,7 @@ The hdfs-operator recreates the StatefulSet automatically. == Resource Requests -include::home:concepts:stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 3 journalnodes, 2 namenodes and 2 datanodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: