/cassandra-operator

Kubernetes operator for Apache Cassandra

Primary LanguageGoApache License 2.0Apache-2.0

Cassandra operator

Build CircleCI

Project status: alpha

The Cassandra operator manages Cassandra clusters deployed to Kubernetes and automates tasks related to operating a Cassandra cluster.

Some planned features have yet to be completed and API changes are still possible, meaning that bug fixes, API and version changes may not be backwards compatible.

Currently user facing Cassandra cluster objects are created as Kubernetes Custom Resources.

We expect to consider the Cassandra operator stable soon; backwards incompatible changes will not be made once the project reaches stability.

Cassandra version support

We are currently building images for Cassandra 3.11.5 and 4.0-alpha3.

Documentation

  1. Operations Guide for how to run the operator and deploy, scale and decommission Cassandra clusters.

  2. Custom configuration how to configure Cassandra itself

  3. Developer Guide for setting up development environment if you want to contribute.

  4. Backup and Restore Guide for backing up and restoring Cassandra clusters managed by the operator.

  5. Service accounts, login and SSL documentation for authentication and how you can log in to cluster

  6. Using Helm to install and launch the operator and the clusters.

Requirements

  • Kubernetes 1.13+
  • Helm 2 (if you want to use the included helm charts)

Limitations

  • This operator is currently a work in progress and breaking changes are landing in master all the time. Here be dragons!
  • Do not use this in production... yet
  • Please see the Instaclustr supported projects page for the Enterprise support status of the Cassandra Operator.