Skip to content

docs: Add documentation on using the OpenSearch Dashboards image #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add documentation on using the OpenSearch Dashboards image #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/modules/opensearch/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
Loading