OpenSearch Kubernetes Operator

The Kubernetes OpenSearch Operator is used for automating the deployment, provisioning, management, and orchestration of OpenSearch clusters and OpenSearch dashboards.

API Group Migration Notice: The operator is migrating from opensearch.opster.io to opensearch.org API group. Both are currently supported, but opensearch.opster.io is deprecated. Please see the Migration Guide for details.

Getting started

The Operator can be easily installed using Helm on any CNCF-certified Kubernetes cluster:

1. Add the helm repo: helm repo add opensearch-operator https://opensearch-project.github.io/opensearch-k8s-operator/
2. Install the Operator: helm install opensearch-operator opensearch-operator/opensearch-operator

After installation, you can deploy your first OpenSearch cluster by creating an OpenSearchCluster custom resource. Please refer to the User Guide for detailed instructions and configuration options.

Video Tutorial

Learn how to install and use the operator with the OpenSearch Kubernetes Operator Tutorial Series on YouTube.

Features

• Deploy and manage OpenSearch clusters with multiple node pools
• Deploy and configure OpenSearch Dashboards
• Configure all node roles (cluster_manager, data, ingest, coordinating, etc.)
• Scale cluster resources manually, per node pool
• Rolling version upgrades with quorum-safe restarts
• Online volume expansion for disk scaling
• Certificate management with TLS hot reloading
• Multi-namespace support for managing clusters across organizational boundaries
• Plugin installation during bootstrap phase

Compatibility

The opensearch k8s operator aims to be compatible to all supported opensearch versions. Please check the table below for details:

Operator Version	Min Supported Opensearch Version	Max Supported Opensearch Version	Comment
3.0.0	2.19.2	latest 3.x	Supports the latest OpenSearch 3.x version.
2.8.0	2.19.2	latest 3.x	Supports the latest OpenSearch 3.x version.
2.7.0 2.6.1 2.6.0 2.5.1 2.5.0	1.3.x	2.19.2	Supports the OpenSearch 2.19.2 version.

This table only lists versions that have been explicitly tested with the operator, the operator will not prevent you from using other versions. Newer minor versions (2.x) not listed here generally also work but you should proceed with caution and test it out in a non-production environment first.

Development

If you want to develop the operator, please see the separate developer docs.

Contributions

We welcome contributions! See how you can get involved by reading CONTRIBUTING.md.