From 1ad7084acdfe8131e73230b80fbc3b63926037d1 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:31 +0100 Subject: [PATCH 1/2] docs: Add page descriptions --- docs/modules/airflow/pages/reference/commandline-parameters.adoc | 1 + docs/modules/airflow/pages/reference/crds.adoc | 1 + docs/modules/airflow/pages/reference/environment-variables.adoc | 1 + docs/modules/airflow/pages/reference/index.adoc | 1 + docs/modules/airflow/pages/troubleshooting/index.adoc | 1 + .../airflow/pages/usage-guide/operations/cluster-operations.adoc | 1 + .../airflow/pages/usage-guide/operations/graceful-shutdown.adoc | 1 + docs/modules/airflow/pages/usage-guide/operations/index.adoc | 1 + .../airflow/pages/usage-guide/operations/pod-disruptions.adoc | 1 + .../airflow/pages/usage-guide/operations/pod-placement.adoc | 1 + 10 files changed, 10 insertions(+) diff --git a/docs/modules/airflow/pages/reference/commandline-parameters.adoc b/docs/modules/airflow/pages/reference/commandline-parameters.adoc index b41a07bfe..56c6931a4 100644 --- a/docs/modules/airflow/pages/reference/commandline-parameters.adoc +++ b/docs/modules/airflow/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command Line Parameters +:description: Command-line parameters the Stackable operator for Apache Airflow accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/airflow/pages/reference/crds.adoc b/docs/modules/airflow/pages/reference/crds.adoc index 1dd4c9324..b1f0ed380 100644 --- a/docs/modules/airflow/pages/reference/crds.adoc +++ b/docs/modules/airflow/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache Airflow on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache Airflow at: {crd-ref}{crd-ref-release}&operator=airflow-operator. diff --git a/docs/modules/airflow/pages/reference/environment-variables.adoc b/docs/modules/airflow/pages/reference/environment-variables.adoc index ea718826d..2d1672adc 100644 --- a/docs/modules/airflow/pages/reference/environment-variables.adoc +++ b/docs/modules/airflow/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache Airflow accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/airflow/pages/reference/index.adoc b/docs/modules/airflow/pages/reference/index.adoc index 3cfa02891..e7c658c81 100644 --- a/docs/modules/airflow/pages/reference/index.adoc +++ b/docs/modules/airflow/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache Airflow, covering CRD fields, command-line parameters and environment variables. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/airflow/pages/troubleshooting/index.adoc b/docs/modules/airflow/pages/troubleshooting/index.adoc index 9d48bfaf2..7b9c230af 100644 --- a/docs/modules/airflow/pages/troubleshooting/index.adoc +++ b/docs/modules/airflow/pages/troubleshooting/index.adoc @@ -1,4 +1,5 @@ = Troubleshooting +:description: Common Apache Airflow problems on Kubernetes, covering task logs in Azure or S3, API workers, DAG syntax checks and LDAP logins after a major upgrade. == Azure Blob Storage Logging diff --git a/docs/modules/airflow/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/airflow/pages/usage-guide/operations/cluster-operations.adoc index ab4054111..789edfc2c 100644 --- a/docs/modules/airflow/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/airflow/pages/usage-guide/operations/cluster-operations.adoc @@ -1,3 +1,4 @@ = Cluster Operation +:description: Cluster operations for Apache Airflow, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. Airflow 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/airflow/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc index 29fee9fd2..246887f8e 100644 --- a/docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache Airflow schedulers, webservers and Celery executors, 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/airflow/pages/usage-guide/operations/index.adoc b/docs/modules/airflow/pages/usage-guide/operations/index.adoc index a18af9002..32da6ed20 100644 --- a/docs/modules/airflow/pages/usage-guide/operations/index.adoc +++ b/docs/modules/airflow/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache Airflow 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/airflow/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/airflow/pages/usage-guide/operations/pod-disruptions.adoc index 19571f1b6..daf709334 100644 --- a/docs/modules/airflow/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/airflow/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: PodDisruptionBudgets the Stackable operator writes for Apache Airflow schedulers, webservers and executors, and how to disable them. You can configure the permitted Pod disruptions for Airflow nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/airflow/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/airflow/pages/usage-guide/operations/pod-placement.adoc index a0fa39e72..5459a4090 100644 --- a/docs/modules/airflow/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/airflow/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod placement +:description: Pod placement for Apache Airflow on Kubernetes, covering the default affinities and how Pods started by the Kubernetes executor are placed. You can configure the Pod placement of the Airflow pods as described in xref:concepts:operations/pod_placement.adoc[]. From 237476f24ab0a95e90d3f15e2f55eb3776e20a71 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:31 +0100 Subject: [PATCH 2/2] docs: Include the resource requests partial --- docs/modules/airflow/pages/usage-guide/storage-resources.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/airflow/pages/usage-guide/storage-resources.adoc b/docs/modules/airflow/pages/usage-guide/storage-resources.adoc index 69b7772cb..e1107057e 100644 --- a/docs/modules/airflow/pages/usage-guide/storage-resources.adoc +++ b/docs/modules/airflow/pages/usage-guide/storage-resources.adoc @@ -1,7 +1,7 @@ = Resource Requests :description: Find out about minimal HA Airflow requirements for CPU and memory, with defaults for schedulers, Celery executors, webservers, dagProcessors and triggerers using Kubernetes resource limits. -include::home:concepts:stackable_resource_requests.adoc[] +include::home:concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 schedulers, 2 workers, 2 webservers, 2 dag-processors and 1 triggerer has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: