/scylla-operator

The Kubernetes Operator for ScyllaDB

Primary LanguageGoApache License 2.0Apache-2.0

Scylla Operator

GitHub release Go Go Report Card Language LICENSE

Scylla Operator is a Kubernetes Operator for managing and automating tasks related to managing Scylla clusters.

Scylla 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.

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.

Helm Charts

You can also use Helm charts to deploy both Scylla Operator and Scylla clusters:

Stable

helm repo add scylla-operator https://storage.googleapis.com/scylla-operator-charts/stable

Latest

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:

  • Generic: Follow this guide for the general way to use the operator.
  • GKE: An advanced guide for deploying Scylla with the best performance settings on Google Kubernetes Engine.
  • EKS: An advanced guide for deploying Scylla with the best performance settings on Amazon Elastic Kubernetes Service.
  • Scylla University Lesson: 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.

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
  • Dead node replacement
  • Version Upgrade
  • Backup
  • Repairs
  • Autohealing

Roadmap

  • Restore

Support

If you find a bug please file an issue for us.

We are also available on #scylla-operator channel on Slack 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 or reach out to us on #scylla-operator channel on Slack if you have questions.