Installation options

Starting with the 1.7.0 release (May 7, 2021), the GitHub repo for Kubernetes Operator for Apache Cassandra moved from https://github.com/datastax/cass-operator to https://github.com/k8ssandra/cass-operator. Ongoing development of Kubernetes Operator for Apache Cassandra and subsequent releases have been migrated to the K8ssandra project. See the k8ssandra/cass-operator GitHub repo for more information on using Kubernetes Operator for Apache Cassandra.

Kubernetes Operator for Apache Cassandra is available on its own or packaged with other tools.

Mission Control

cass-operator is included with Mission Control. You don’t need to install cass-operator separately.

K8ssandra

If you are using K8ssandra or a component of K8ssandra, you have the following options for installing cass-operator:

k8ssandra-operator: cass-operator is included by default, and you don’t need to install cass-operator separately.
K8ssandra Helm deployment: cass-operator is packaged with K8ssandra, and it can be deployed using Helm as part of a K8ssandra install. To install only the cass-operator with K8ssandra, run the following helm commands:
```
helm repo add k8ssandra https://helm.k8ssandra.io/stable
helm repo update
helm install cass-operator k8ssandra/cass-operator -n cass-operator --create-namespace --set clusterScoped=true
```
See the cass-operator README for more information and options for installing the operator with Helm.
Complete K8ssandra install: To install all the K8ssandra components, including cass-operator, Cassandra, Medusa, Reaper, and others, see the K8ssandra documentation.

Standalone install

You can manually install cass-operator on a supported container orchestration platform.

Install on Kubernetes

Follow the kubectl commands in Quickstart for Kubernetes Operator for Apache Cassandra. These steps also explain how to deploy a supported Apache Cassandra or Datastax Enterprise (DSE) releases to your Kubernetes cluster.

Install on Openshift

You can install cass-operator on Openshift using the Operator Lifecycle Manager (OLM) or the Openshift UI.

Openshift UI
Operator Lifecycle Manager

When running on Openshift, you can install Kubernetes Operator for Apache Cassandra directly from the Openshift UI. See the Openshift documentation for information about installing operators.

cass-operator is available in the OperatorHub as a community version as well as certified version. If running outside Openshift, you can install the operator using the Operator Lifecycle Manager (OLM). You can find cass-operator from the OperatorHub under the name cass-operator-community. A certified version is available from the Openshift UI.

To install OLM, run the following command:

curl -sL https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.28.0/install.sh | bash -s v0.28.0

If OLM is already installed in your cluster, the operator can be installed with the following command:

kubectl create -f https://operatorhub.io/install/cass-operator-community.yaml

You can follow the installation progress by running the following command:

kubectl get csv -n operators

The OLM installation supports running the operator in a cluster scope and namespace scope settings. Use OLM to configure the operator deployment. If you don’t want to use OperatorHub to install the operator, you can also use the following bundle and catalogs for manual installation:

Install with Kustomize

See the cass-operator README for instructions and options for installing the operator with Kustomize.