From 2a54d2fc80aaa8f993ce6e94f1cf5ab6da58ea96 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:41 +0100 Subject: [PATCH 1/3] docs: Add page descriptions --- docs/modules/opensearch/pages/getting_started/first_steps.adoc | 1 + docs/modules/opensearch/pages/getting_started/index.adoc | 1 + docs/modules/opensearch/pages/getting_started/installation.adoc | 1 + .../opensearch/pages/reference/commandline-parameters.adoc | 1 + docs/modules/opensearch/pages/reference/crds.adoc | 1 + docs/modules/opensearch/pages/reference/discovery.adoc | 1 + .../opensearch/pages/reference/environment-variables.adoc | 1 + docs/modules/opensearch/pages/reference/index.adoc | 1 + docs/modules/opensearch/pages/troubleshooting/index.adoc | 1 + .../pages/usage-guide/configuration-environment-overrides.adoc | 1 + .../pages/usage-guide/operations/cluster-operations.adoc | 1 + .../pages/usage-guide/operations/graceful-shutdown.adoc | 1 + docs/modules/opensearch/pages/usage-guide/operations/index.adoc | 1 + .../opensearch/pages/usage-guide/operations/pod-disruptions.adoc | 1 + .../opensearch/pages/usage-guide/operations/pod-placement.adoc | 1 + 15 files changed, 15 insertions(+) diff --git a/docs/modules/opensearch/pages/getting_started/first_steps.adoc b/docs/modules/opensearch/pages/getting_started/first_steps.adoc index 6e72ccff..ef2a2237 100644 --- a/docs/modules/opensearch/pages/getting_started/first_steps.adoc +++ b/docs/modules/opensearch/pages/getting_started/first_steps.adoc @@ -1,4 +1,5 @@ = First steps +:description: First steps with OpenSearch, covering a first cluster with users and roles, the REST API and OpenSearch Dashboards for indexing and searching data. Once you have followed the steps in xref:getting_started/installation.adoc[] for the operator and its dependencies, you will now go through the steps to set up and connect to an OpenSearch instance. diff --git a/docs/modules/opensearch/pages/getting_started/index.adoc b/docs/modules/opensearch/pages/getting_started/index.adoc index f52430c5..299b5e80 100644 --- a/docs/modules/opensearch/pages/getting_started/index.adoc +++ b/docs/modules/opensearch/pages/getting_started/index.adoc @@ -1,4 +1,5 @@ = Getting started +:description: Getting started with OpenSearch on Kubernetes, covering the Stackable operator and its dependencies, a first cluster and ingesting and searching data. This guide helps you get started with OpenSearch using the Stackable Operator. It covers the installation of the operator and its dependencies, setting up your first OpenSearch instance, connecting to it, and ingesting and searching for data. diff --git a/docs/modules/opensearch/pages/getting_started/installation.adoc b/docs/modules/opensearch/pages/getting_started/installation.adoc index 16e2d0aa..3e47796f 100644 --- a/docs/modules/opensearch/pages/getting_started/installation.adoc +++ b/docs/modules/opensearch/pages/getting_started/installation.adoc @@ -1,4 +1,5 @@ = Installation +:description: Installation of the Stackable operator for OpenSearch and the commons, secret and listener operators it depends on, with stackablectl or Helm. On this page you will install the Stackable OpenSearch Operator as well as the commons, secret and listener operators which are required by all Stackable Operators. diff --git a/docs/modules/opensearch/pages/reference/commandline-parameters.adoc b/docs/modules/opensearch/pages/reference/commandline-parameters.adoc index 465caa71..d5fadad1 100644 --- a/docs/modules/opensearch/pages/reference/commandline-parameters.adoc +++ b/docs/modules/opensearch/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command Line Parameters +:description: Command-line parameters the Stackable operator for OpenSearch accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/opensearch/pages/reference/crds.adoc b/docs/modules/opensearch/pages/reference/crds.adoc index fcdfbed0..94b2f2e4 100644 --- a/docs/modules/opensearch/pages/reference/crds.adoc +++ b/docs/modules/opensearch/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for OpenSearch on the Stackable Hub, covering every field, default and API version. Find all CRD references for the Stackable Operator for OpenSearch at: {crd-ref}{crd-ref-release}&operator=opensearch-operator diff --git a/docs/modules/opensearch/pages/reference/discovery.adoc b/docs/modules/opensearch/pages/reference/discovery.adoc index cde3685a..98dbf7ca 100644 --- a/docs/modules/opensearch/pages/reference/discovery.adoc +++ b/docs/modules/opensearch/pages/reference/discovery.adoc @@ -6,6 +6,7 @@ :exampleOpensearchPort: 31315 = Discovery +:description: Reference for the discovery ConfigMap the Stackable operator for OpenSearch publishes, with the connection parameters for reaching the cluster. :page-aliases: discovery.adoc The Stackable Operator for OpenSearch publishes a xref:concepts:service_discovery.adoc[service discovery ConfigMap] which exposes a client configuration bundle that allows access to the OpenSearch cluster. diff --git a/docs/modules/opensearch/pages/reference/environment-variables.adoc b/docs/modules/opensearch/pages/reference/environment-variables.adoc index 60bca302..45af1712 100644 --- a/docs/modules/opensearch/pages/reference/environment-variables.adoc +++ b/docs/modules/opensearch/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for OpenSearch accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/opensearch/pages/reference/index.adoc b/docs/modules/opensearch/pages/reference/index.adoc index 8484d994..b8199d69 100644 --- a/docs/modules/opensearch/pages/reference/index.adoc +++ b/docs/modules/opensearch/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for OpenSearch, 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/opensearch/pages/troubleshooting/index.adoc b/docs/modules/opensearch/pages/troubleshooting/index.adoc index e1bfe9b1..5168669b 100644 --- a/docs/modules/opensearch/pages/troubleshooting/index.adoc +++ b/docs/modules/opensearch/pages/troubleshooting/index.adoc @@ -1,4 +1,5 @@ = Troubleshooting +:description: Troubleshooting OpenSearch on Kubernetes, covering the SSLHandshakeException warnings about AEAD cipher fragments that appear with TLS connections. == Errors and warnings in the OpenSearch logs diff --git a/docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc b/docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc index 316e8c20..5a737a0f 100644 --- a/docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc +++ b/docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc @@ -1,4 +1,5 @@ = Configuration & Environment Overrides +:description: Overrides for OpenSearch, covering configuration properties, environment variables, CLI parameters and Pod specs per role or role group. The cluster definition also supports overriding configuration properties, environment variables and CLI parameters, either per role or per role group, where the more specific override (role group) has precedence over diff --git a/docs/modules/opensearch/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/opensearch/pages/usage-guide/operations/cluster-operations.adoc index 29482a39..c9c700ff 100644 --- a/docs/modules/opensearch/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/opensearch/pages/usage-guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster Operation +:description: Cluster operations for OpenSearch, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. OpenSearch 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/opensearch/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/opensearch/pages/usage-guide/operations/graceful-shutdown.adoc index 48ecd8a0..185195ff 100644 --- a/docs/modules/opensearch/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/opensearch/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of OpenSearch nodes, covering the configurable shutdown timeout and how the node process stops. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/opensearch/pages/usage-guide/operations/index.adoc b/docs/modules/opensearch/pages/usage-guide/operations/index.adoc index 21d170f9..e9a946f7 100644 --- a/docs/modules/opensearch/pages/usage-guide/operations/index.adoc +++ b/docs/modules/opensearch/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating OpenSearch 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/opensearch/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/opensearch/pages/usage-guide/operations/pod-disruptions.adoc index 82c059f9..ef01ec06 100644 --- a/docs/modules/opensearch/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/opensearch/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: The PodDisruptionBudget the Stackable operator writes for OpenSearch nodes, and how to disable it. You can configure the permitted Pod disruptions for OpenSearch nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/opensearch/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/opensearch/pages/usage-guide/operations/pod-placement.adoc index d697db5a..57618006 100644 --- a/docs/modules/opensearch/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/opensearch/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod Placement +:description: Pod placement for OpenSearch on Kubernetes, covering the default affinity that spreads the nodes of a cluster across Kubernetes nodes. You can configure the Pod placement of the OpenSearch pods as described in xref:concepts:operations/pod_placement.adoc[]. From 5e5883dd7fc028405af397e7e650a629b0334923 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:41 +0100 Subject: [PATCH 2/3] docs: Include the resource requests partial --- .../pages/usage-guide/storage-resource-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc b/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc index 890cc963..728c0844 100644 --- a/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc +++ b/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc @@ -25,7 +25,7 @@ On role groups with only the `cluster_manager` node role, you probably want to d == Resource Requests -include::home:concepts:stackable_resource_requests.adoc[] +include::home:concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 3 nodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements{external-link-icon}^]: From bbdf61f7a04a50806f2e6a7a43700c6930dcb669 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 16:57:02 +0100 Subject: [PATCH 3/3] docs: Fix the resource requests include --- .../pages/usage-guide/storage-resource-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc b/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc index 728c0844..69a39f82 100644 --- a/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc +++ b/docs/modules/opensearch/pages/usage-guide/storage-resource-configuration.adoc @@ -25,7 +25,7 @@ On role groups with only the `cluster_manager` node role, you probably want to d == Resource Requests -include::home:concepts:partial$stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 3 nodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements{external-link-icon}^]: