A newer version of this documentation is available.

View Latest

Prerequisites

To install the Couchbase Autonomous Operator, all you need is a running Kubernetes or OpenShift cluster.

If you don’t have access to a Kubernetes cluster, but still want to use the Operator for development, Minikube (single-node Kubernetes cluster) and Minishift (single-node OpenShift cluster) make great alternatives. Both of these products are much easier to install and deploy when compared to setting up and running an actual Kubernetes or OpenShift cluster.

Platform Compatibility

Support Definitions:
Certified

Couchbase has performed an extensive testing and review process to make sure that the Operator runs well out of the box on the specified platform.

Supported

Couchbase believes that the Operator will run well out of the box on the specified platform, but extensive testing has not been performed. Couchbase will make a best effort to investigate issues on a Supported platform version, but it is recommended that you run the Operator on a Certified platform version.

Developer Preview

Couchbase is still developing functionality for the specified platform, but you are encouraged to start your own testing and provide early feedback.

Table 1. Platform Compatibility List
Couchbase Server Open Source Kubernetes Red Hat OpenShift

Operator 1.0

Certified 5.5.x

Certified 1.9

Supported 1.10+

Certified 3.9

Supported 3.10+

Table 2. Public Container Service Compatibility List
Amazon EKS Google GKE Microsoft AKS

Operator 1.0

Developer Preview

Developer Preview

Developer Preview

Persistent Volume Compatibility

Table 3. Persistent Volume Compatibility List
AWS Azure Disk Ceph RBD GCE Glusterfs Portworx Volume

Operator 1.0

Only dynamic volume provisioning using storage classes is currently supported.

RBAC and Networking Requirements

Preparing the Kubernetes cluster to run the Operator may require setting up proper RBAC and network settings in your Kubernetes cluster. Before moving forward, review the following documentation:

Next Steps

Once your Kubernetes environment is set up, you can move on to installing the Operator.

For information about how the Operator deployment is defined, as well as documentation about the fields that you might want to customize, see Couchbase Operator Configuration.