This is a fork of the opensearch-k8s-operator that was formerly hosted by Opster and is now part of the opensearch-project. Due to confusion and instability in the project, MaibornWolff has decided to (temporarily) provide a fork of the operator with compatible and stable releases. Feel free to open an issue or start a discussion if you have questions.
The Kubernetes OpenSearch Operator is used for automating the deployment, provisioning, management, and orchestration of OpenSearch clusters and OpenSearch dashboards.
The Operator can be easily installed using helm on any CNCF-certified Kubernetes cluster. Please refer to the User Guide for installation instructions.
- Deploy a new OS cluster.
- Ability to deploy multiple clusters.
- Spin up OS dashboards.
- Configuration of all node roles (master, data, coordinating..).
- Scale the cluster resources (manually), per nodes' role group.
- Drain strategy for scale down.
- Version updates.
- Change nodes' memory allocation and limits.
- Secured installation features.
- Certificate management.
- Rolling restarts - through API.
- Scaling nodes' disks - increase disk size.
- Cluster configurations and nodes' settings updates.
- Operator Monitoring, with Prometheus and Grafana.
The Operator can be easily installed using Helm:
- Add the helm repo:
helm repo add opensearch-operator https://maibornwolff.github.io/opensearch-operator/ - Install the Operator:
helm install opensearch-operator opensearch-operator/opensearch-operator
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 |
|---|---|---|---|
| 2.5 | 1.0 | 2.11 | |
| 2.4 | 1.0 | 2.8 | |
| 2.3 | 1.0 | 2.8 | |
| 2.2 | 1.0 | 2.5 | |
| 2.1 | 1.0 | 2.3 | |
| 2.0 | 1.0 | 2.3 | |
| 1.x | 1.0 | 1.x | |
| 0.x | 1.0 | 1.x | Beta |
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.
If you want to develop the operator, please see the separate developer docs.
We welcome contributions! See how you can get involved by reading CONTRIBUTING.md.