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..632fe64 --- /dev/null +++ b/docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc @@ -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-stackable0.0.0-dev +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. 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..16f8b7d --- /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. diff --git a/docs/modules/opensearch/partials/nav.adoc b/docs/modules/opensearch/partials/nav.adoc index 159b56d..71890c0 100644 --- a/docs/modules/opensearch/partials/nav.adoc +++ b/docs/modules/opensearch/partials/nav.adoc @@ -8,6 +8,7 @@ ** xref:opensearch:usage-guide/configuration-environment-overrides.adoc[] ** xref:opensearch:usage-guide/monitoring.adoc[] ** xref:opensearch:usage-guide/logging.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[]