/opensearch-k8s-operator

OpenSearch k8s Operator

Primary LanguageGoApache License 2.0Apache-2.0

build test release

OpenSearch-k8s-operator

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

Getting started

The operator can be installed easily using helm on any CNCF-certified kubernetes cluster. Please refer to the User Guide for installation instructions.

Roadmap

The full roadmap is available in the Development plan

Currently planned features:

  • 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.
  • Auto scaler based on usage, load, and resources.
  • Operator Monitoring, with Prometheus and Grafana.
  • Control shard balancing and allocation: AZ/Rack awareness, Hot/Warm.

Development

Running the Operator locally

  • Clone the repo and go to the opensearch-operator folder.
  • Run make build manifests to build the controller binary and the manifests
  • Start a kubernetes cluster (e.g. with k3d or minikube) and make sure your ~/.kube/config points to it
  • Run make install to create the CRD in the kubernetes cluster
  • Start the operator by running make run

Now you can deploy an opensearch cluster.

Go to opensearch-operator and use opensearch-cluster.yaml as a starting point to define your cluster. Then run:

kubectl apply -f opensearch-cluster.yaml

In order to delete the cluster, you just delete your OpenSearch cluster resource. This will delete the cluster and all its resources.

kubectl delete -f opensearch-cluster.yaml

Contributions

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