buhe / cassandra-operator-cross-dc Goto Github PK

Build

Major planned features have yet to be completed and API changes are currently planned, we reserve the right to address bugs and API changes in a backwards incompatible way before the project is declared stable. See upgrade guide for safe upgrade process.

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.

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

• Install
• Create and destroy
• Resize
• Rolling upgrade - TODO
• Limitations

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

2. Best Practices for more information on how to better use Cassandra operator.

3. RBAC docs for how to setup RBAC rules for Cassandra operator if RBAC is in place.

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

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

6. Resources and Labels doc for an overview of the resources created by the Cassandra-operator.

7. Specific examples on setting up clusters with backup, restore, and other configurations.

8. PKS Setup for deploying on Pivotal Container service.

• Kubernetes 1.13+
• Cassandra 3.11+

See instructions on how to install/uninstall Cassandra operator .

• This operator is currently a work in progress and breaking changes are landing in master all the time until we reach our initial release. 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.