Skip to content

index.adoc

Latest commit

 

History

History
68 lines (48 loc) · 3.59 KB

index.adoc

File metadata and controls

68 lines (48 loc) · 3.59 KB

Stackable Operator for OpenSearch

Warning

This operator is experimental, and subject to change.

The Stackable operator for OpenSearch{external-link-icon} deploys and manages OpenSearch clusters on Kubernetes. OpenSearch is a powerful search and analytics engine built on Apache Lucene. This operator helps you manage your OpenSearch instances on Kubernetes efficiently.

Getting started

Get started using OpenSearch with the Stackable operator by following the getting_started/index.adoc. It guides you through installing the operator, connecting to your OpenSearch instance and using the REST API to ingest and search for data.

Operator model

The operator manages the OpenSearchCluster resource. It creates a number of different Kubernetes resources based on this custom resource{external-link-icon}.

Custom resources

The OpenSearchCluster is the resource for the configuration of the OpenSearch instance. The resource defines only one role, the nodes. The various configuration options are explained in the usage-guide/index.adoc. It helps you tune your cluster to your needs by configuring resource usage and more.

Kubernetes resources

Based on the custom resources you define, the operator creates ConfigMaps, StatefulSets and Services.

A diagram depicting the Kubernetes resources created by the operator

The diagram above depicts all the Kubernetes resources created by the operator, and how they relate to each other.

For every role group you define, the operator creates a StatefulSet with the amount of replicas defined in the role group. For every role group, a Service is created, as well as one for the whole cluster that references the cluster manager nodes.

Additionally, a ConfigMap is created for each role group. These ConfigMaps contain configuration files like opensearch.yml.

Supported versions

The Stackable operator for OpenSearch currently supports the OpenSearch versions listed below. To use a specific OpenSearch version in your OpenSearchCluster, you have to specify an image - this is explained in the concepts:product-image-selection.adoc documentation. The operator also supports running images from a custom registry or running entirely customized images; both of these cases are explained under concepts:product-image-selection.adoc as well.

Useful links