Skip to content

Commit c801705

Browse files
authored
docs: Add documentation on using the OpenSearch Dashboards image (#41)
* add documentation on using the OpenSearch Dashboards * address feedback on PR * fix syntax error in docs * fix syntax error in docs
1 parent 76969bb commit c801705

3 files changed

Lines changed: 47 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= OpenSearch Dashboards
2+
:description: OpenSearch Dashboards
3+
:official-helm-chart: https://docs.opensearch.org/latest/install-and-configure/install-dashboards/helm/
4+
5+
OpenSearch Dashboards is currently not managed by the operator but the Stackable Data Platform provides a supported OCI image.
6+
7+
One way to deploy OpenSearch Dashboards is by using the {official-helm-chart}[official Helm chart{external-link-icon}^].
8+
9+
A basic `values.yaml` file to deploy OpenSearch Dashboards with this chart might look like this:
10+
11+
[source,yaml]
12+
----
13+
opensearchHosts: https://opensearch.<opensearch-namespace>.svc.cluster.local:9200 # <1>
14+
image:
15+
repository: oci.stackable.tech/sdp/opensearch-dashboards # <2>
16+
tag: 3.1.0-stackable0.0.0-dev
17+
serviceAccount: # <3>
18+
create: false
19+
name: opensearch-serviceaccount
20+
----
21+
<1> Address of the OpenSearch Service deployed by the operator
22+
<2> Use the OCI image provided by the Stackable Data Platform
23+
<3> If running on OpenShift, use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= OpenSearch Dashboards
2+
:description: OpenSearch Dashboards
3+
:official-helm-chart: https://docs.opensearch.org/latest/install-and-configure/install-dashboards/helm/
4+
5+
OpenSearch Dashboards is currently not managed by the operator but the Stackable Data Platform provides a supported OCI image.
6+
7+
One way to deploy OpenSearch Dashboards is by using the {official-helm-chart}[official Helm chart{external-link-icon}^].
8+
9+
A basic `values.yaml` file to deploy OpenSearch Dashboards with this chart might look like this:
10+
11+
[source,yaml]
12+
----
13+
opensearchHosts: https://opensearch.<opensearch-namespace>.svc.cluster.local:9200 # <1>
14+
image:
15+
repository: oci.stackable.tech/sdp/opensearch-dashboards # <2>
16+
tag: 3.1.0-stackable{{ versions.opensearch }}
17+
serviceAccount: # <3>
18+
create: false
19+
name: opensearch-serviceaccount
20+
----
21+
<1> Address of the OpenSearch Service deployed by the operator
22+
<2> Use the OCI image provided by the Stackable Data Platform
23+
<3> If running on OpenShift, use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift.

docs/modules/opensearch/partials/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
** xref:opensearch:usage-guide/configuration-environment-overrides.adoc[]
99
** xref:opensearch:usage-guide/monitoring.adoc[]
1010
** xref:opensearch:usage-guide/logging.adoc[]
11+
** xref:opensearch:usage-guide/opensearch-dashboards.adoc[]
1112
** xref:opensearch:usage-guide/operations/index.adoc[]
1213
*** xref:opensearch:usage-guide/operations/cluster-operations.adoc[]
1314
*** xref:opensearch:usage-guide/operations/pod-placement.adoc[]

0 commit comments

Comments
 (0)