From 92341d03cd49013915f6645f80fdc41dc64b27c6 Mon Sep 17 00:00:00 2001 From: Benedikt Labrenz Date: Thu, 9 Oct 2025 20:23:33 +0200 Subject: [PATCH 1/4] add documentation on using the OpenSearch Dashboards --- .../usage-guide/opensearch-dashboards.adoc | 19 +++++++++++++++++++ docs/modules/opensearch/partials/nav.adoc | 1 + 2 files changed, 20 insertions(+) create mode 100644 docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc diff --git a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc new file mode 100644 index 0000000..7546d6b --- /dev/null +++ b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc @@ -0,0 +1,19 @@ += OpenSearch Dashboards +:description: OpenSearch Dashboards +:official-helm-chart: https://docs.opensearch.org/latest/install-and-configure/install-dashboards/helm/ + +OpenSearch Dashboards is currently not managed by the operator but the Stackable Data Platform provides a supported OCI image. + +One way to deploy OpenSearch Dashboards is by using the {official-helm-chart}[official Helm chart{external-link-icon}^]. + +A basic `values.yaml` file to deploy OpenSearch Dashboards with this chart might look like this: + +[source,yaml] +---- +opensearchHosts: https://opensearch-nodes-cluster-manager:9200 # <1> +image: + repository: oci.stackable.tech/sdp/opensearch-dashboards # <2> + tag: 3.1.0-stackable0.0.0-dev +---- +<1> Address of the OpenSearch cluster manager service deployed by the operator +<2> Use the OCI image provided by the Stackable Data Platform diff --git a/docs/modules/opensearch/partials/nav.adoc b/docs/modules/opensearch/partials/nav.adoc index 42649b5..6eab681 100644 --- a/docs/modules/opensearch/partials/nav.adoc +++ b/docs/modules/opensearch/partials/nav.adoc @@ -7,6 +7,7 @@ ** xref:opensearch:usage-guide/storage-resource-configuration.adoc[] ** xref:opensearch:usage-guide/configuration-environment-overrides.adoc[] ** xref:opensearch:usage-guide/monitoring.adoc[] +** xref:opensearch:usage-guide/opensearch-dashboards.adoc[] ** xref:opensearch:usage-guide/operations/index.adoc[] *** xref:opensearch:usage-guide/operations/cluster-operations.adoc[] *** xref:opensearch:usage-guide/operations/pod-placement.adoc[] From 29eeeed8e27214b9795582053c167587085f5004 Mon Sep 17 00:00:00 2001 From: Benedikt Labrenz Date: Tue, 14 Oct 2025 10:06:14 +0200 Subject: [PATCH 2/4] address feedback on PR --- .../usage-guide/opensearch-dashboards.adoc | 8 +++++-- .../usage-guide/opensearch-dashboards.adoc.j2 | 23 +++++++++++++++++++ 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 diff --git a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc index 7546d6b..a6a5548 100644 --- a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc +++ b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc @@ -10,10 +10,14 @@ A basic `values.yaml` file to deploy OpenSearch Dashboards with this chart might [source,yaml] ---- -opensearchHosts: https://opensearch-nodes-cluster-manager:9200 # <1> +opensearchHosts: https://opensearch..svc.cluster.local:9200 # <1> image: repository: oci.stackable.tech/sdp/opensearch-dashboards # <2> tag: 3.1.0-stackable0.0.0-dev +serviceAccount: # <3> + create: false + name: opensearch-serviceaccount ---- -<1> Address of the OpenSearch cluster manager service deployed by the operator +<1> Address of the OpenSearch Service deployed by the operator <2> Use the OCI image provided by the Stackable Data Platform +<3> If running on OpenShift use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift. diff --git a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 new file mode 100644 index 0000000..182fd11 --- /dev/null +++ b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 @@ -0,0 +1,23 @@ += OpenSearch Dashboards +:description: OpenSearch Dashboards +:official-helm-chart: https://docs.opensearch.org/latest/install-and-configure/install-dashboards/helm/ + +OpenSearch Dashboards is currently not managed by the operator but the Stackable Data Platform provides a supported OCI image. + +One way to deploy OpenSearch Dashboards is by using the {official-helm-chart}[official Helm chart{external-link-icon}^]. + +A basic `values.yaml` file to deploy OpenSearch Dashboards with this chart might look like this: + +[source,yaml] +---- +opensearchHosts: https://opensearch..svc.cluster.local:9200 # <1> +image: + repository: oci.stackable.tech/sdp/opensearch-dashboards # <2> + tag: 3.1.0-stackable{{ versions.opensearch }} +serviceAccount: # <3> + create: false + name: opensearch-serviceaccount +---- +<1> Address of the OpenSearch Service deployed by the operator +<2> Use the OCI image provided by the Stackable Data Platform +<3> If running on OpenShift use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift. From 423c71ffa818b3d655019cabc30f9bfc37fc7d03 Mon Sep 17 00:00:00 2001 From: Benedikt Labrenz Date: Tue, 14 Oct 2025 13:54:19 +0200 Subject: [PATCH 3/4] fix syntax error in docs --- .../opensearch/pages/usage-guide/opensearch-dashboards.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc index a6a5548..632fe64 100644 --- a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc +++ b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc @@ -20,4 +20,4 @@ serviceAccount: # <3> ---- <1> Address of the OpenSearch Service deployed by the operator <2> Use the OCI image provided by the Stackable Data Platform -<3> If running on OpenShift use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift. +<3> If running on OpenShift, use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift. From 9df9aec43b4f4d708af674303a96128df66ce154 Mon Sep 17 00:00:00 2001 From: Benedikt Labrenz Date: Tue, 14 Oct 2025 14:45:39 +0200 Subject: [PATCH 4/4] fix syntax error in docs --- .../opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 index 182fd11..16f8b7d 100644 --- a/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 +++ b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2 @@ -20,4 +20,4 @@ serviceAccount: # <3> ---- <1> Address of the OpenSearch Service deployed by the operator <2> Use the OCI image provided by the Stackable Data Platform -<3> If running on OpenShift use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift. +<3> If running on OpenShift, use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift.