Skip to content

first_steps.adoc

Latest commit

 

History

History
112 lines (76 loc) · 3.33 KB

first_steps.adoc

File metadata and controls

112 lines (76 loc) · 3.33 KB
Raw

First steps

Once you have followed the steps in 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.

Security plugin configuration

The configuration for the OpenSearch security plugin must be provided in a separate resource, e.g. a Secret:

link:example$getting_started/opensearch-security-config.yaml[role=include]

Apply the Secret:

link:example$getting_started/getting_started.sh[role=include]

The passwords in internal_users.yml are hashes using the bcrypt algorithm. Such a hash can be e.g. generated with htpasswd:

$ htpasswd -nbBC 10 admin AJVFsGJBbpT6mChn
admin:$2y$10$xRtHZFJ9QhG9GcYhRpAGpufCZYsk//nxsuel5URh0GWEBgmiI4Q/e

$ htpasswd -nbBC 10 kibanaserver E4kENuEmkqH3jyHC
kibanaserver:$2y$10$vPgQ/6ilKDM5utawBqxoR.7euhVQ0qeGl8mPTeKhmFT475WUDrfQS

Creation of OpenSearch nodes

OpenSearch nodes must be created as a custom resource; Create a file called opensearch.yaml:

link:example$getting_started/opensearch.yaml[role=include]

And apply it:

link:example$getting_started/getting_started.sh[role=include]

metadata.name contains the name of the OpenSearch cluster.

The previously created security plugin configuration must be referenced via podOverrides.

You need to wait for the OpenSearch nodes to finish deploying. You can do so with this command:

link:example$getting_started/getting_started.sh[role=include]

Connecting to the HTTP endpoint

Once the OpenSearch nodes are created, you can use the REST API of OpenSearch.

To forward the HTTP port (9200) to localhost, run:

link:example$getting_started/getting_started.sh[role=include]

Using the REST API

You can use the REST API as follows:

link:example$getting_started/getting_started.sh[role=include]

Great! Now you can create your own indexes, populate them with data and search for it.

Using OpenSearch Dashboards

OpenSearch Dashboards is currently not managed by the operator, but the Stackable Data Platform provides a supported OCI image. First, create the Helm values file opensearch-dashboards-values.yaml:

link:example$getting_started/opensearch-dashboards-values.yaml[role=include]

Then, create the Secret with the credentials for the kibanaserver user and deploy the OpenSearch Dashboards Helm chart:

link:example$getting_started/getting_started.sh[role=include]

Forward the OpenSearch Dashboards port 5601 to localhost, open https://localhost:5601 in your browser and log in with username admin and password AJVFsGJBbpT6mChn:

link:example$getting_started/getting_started.sh[role=include]
Browser showing OpenSearch Dashboards after logging in

What’s next

Check the usage-guide/index.adoc to find out more about configuring your OpenSearch instance or have a look at the OpenSearch documentation to ingest, search or visualize your data with OpenSearch Dashboards{external-link-icon}.