tommyreilly/cassandra-operator

Kubernetes operator for Apache Cassandra

Cassandra operator

Build

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.

Documentation

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

2. RBAC docs for how to setup RBAC rules for Cassandra operator and Cassandra containers if RBAC is in place.

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. Resources and Labels doc for an overview of the resources created by the Cassandra-operator.

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.

Roadmap

• Support node-to-node security via certificates
• Support cluster-client security via certificates
• Allow multi-DC clusters via the operator