https://github.com/scylladb/scylla-operator
The Kubernetes Operator for ScyllaDB
https://github.com/scylladb/scylla-operator
kubernetes kubernetes-operator operator scylla-operator
Last synced: 11 days ago
JSON representation
The Kubernetes Operator for ScyllaDB
- Host: GitHub
- URL: https://github.com/scylladb/scylla-operator
- Owner: scylladb
- License: apache-2.0
- Created: 2018-12-11T02:24:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-11T09:16:34.000Z (12 days ago)
- Last Synced: 2025-04-11T10:55:36.010Z (12 days ago)
- Topics: kubernetes, kubernetes-operator, operator, scylla-operator
- Language: Go
- Homepage: https://operator.docs.scylladb.com/
- Size: 59.1 MB
- Stars: 370
- Watchers: 29
- Forks: 181
- Open Issues: 205
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - scylladb/scylla-operator - The Kubernetes Operator for ScyllaDB (Go)
README
# Scylla Operator
[](https://github.com/scylladb/scylla-operator/releases)
[](https://github.com/scylladb/scylla-operator/actions/workflows/go.yaml?query=branch%3Amaster)
[](https://goreportcard.com/report/github.com/scylladb/scylla-operator)
[](https://golang.org/)
[](https://github.com/scylladb/scylla-operator/blob/master/LICENSE)
[Scylla Operator](https://github.com/scylladb/scylla-operator) is a Kubernetes Operator for managing and automating tasks related to managing ScyllaDB clusters.
[ScyllaDB](https://www.scylladb.com) is a close-to-the-hardware rewrite of Cassandra in C++. It features a shared nothing architecture that enables true linear scaling and major hardware optimizations that achieve ultra-low latencies and extreme throughput. It is a drop-in replacement for Cassandra and uses the same interfaces.
## Deploying the Operator
For version requirements see the [support matrix](https://operator.docs.scylladb.com/stable/support/releases.html).
### GitOps
Kubernetes manifests are located in the `deploy/` folder. To deploy the operator manually using Kubernetes manifests or to integrate it into your GitOps flow please follow [these instructions](./deploy/README.md).
### Helm Charts
You can also use Helm charts to deploy both Scylla Operator and Scylla clusters:
#### Stable
```bash
helm repo add scylla-operator https://storage.googleapis.com/scylla-operator-charts/stable
```
#### Latest
```bash
helm repo add scylla-operator https://storage.googleapis.com/scylla-operator-charts/latest
```
## Quickstarts and Training
To quickly deploy a ScyllaCluster, you can choose one of the following options:
* [GKE](https://operator.docs.scylladb.com/stable/quickstarts/gke.html): This is a quickstart guide to help you set up a basic [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine) cluster quickly with local NVMes and solid performance.
* [EKS](https://operator.docs.scylladb.com/stable/quickstarts/eks.html): This is a quickstart guide to help you set up a basic [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/) cluster quickly with local NVMes and solid performance.
ScyllaDB Installation:
* [Generic](https://operator.docs.scylladb.com/stable/installation/kubernetes/generic.html): Follow this guide for the general way to use the operator.
* [GKE](https://operator.docs.scylladb.com/stable/installation/kubernetes/gke.html): An advanced guide for deploying Scylla with the **best performance settings** on [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine).
* [EKS](https://operator.docs.scylladb.com/stable/installation/kubernetes/eks.html): An advanced guide for deploying Scylla with the **best performance settings** on [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/).
* [Scylla University Lesson](https://university.scylladb.com/courses/scylla-operations/lessons/kubernetes-operator/): Follow this lesson on Scylla University to learn more about the Operator and how to use it. The lesson includes some hands-on examples which you can run yourself.
## Releases
To find out more about our releases, support matrix and how our CI/CD is set up there is a [dedicated docs page](https://operator.docs.scylladb.com/stable/support/releases.html).
## Documentation
Scylla Operator documentation is available on https://operator.docs.scylladb.com
## Features
* Deploying multi-zone clusters
* Scaling up or adding new racks
* Scaling down
* Monitoring with Prometheus and Grafana
* Integration with [Scylla Manager](https://docs.scylladb.com/operating-scylla/manager/)
* Dead node replacement
* Version Upgrade
* Backup
* Repairs
* Autohealing
## Roadmap
* Restore
## Support
If you find a bug please file an [issue](https://github.com/scylladb/scylla-operator/issues) for us.
We are also available on `#scylla-operator` channel on [Slack](https://scylladb-users.slack.com) if you have questions.
## Contributing
We would **love** you to contribute to Scylla Operator, help make it even better and learn together! Have a look at the [Contributing Guide](CONTRIBUTING.md) or reach out to us on `#scylla-operator` channel on [Slack](https://scylladb-users.slack.com/) if you have questions.