A newer version of this documentation is available.

View Latest

Prerequisites and System Requirements

      +

      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 Red Hat CodeReady Containers (single-node OpenShift cluster) make great free 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.

      Couchbase Server Compatibility

      Couchbase Server versions 6.5-6.6 are susceptible to the 'log4shell' CVE, read our blog on this vulnerability for more details.

      It is strongly recommended that users upgrade to at least server version 6.6.4, when using the analytics service.

      Software Version

      Couchbase Server Enterprise Edition

      Certified 6.5.1, 6.6

      Unless otherwise stated, maintenance/patch releases (x.x.X) inherit the same support level.

      Kubernetes Platform Compatibility

      Platform Version

      Open Source Kubernetes

      Certified 1.17, 1.18

      Supported 1.15, 1.16, 1.19

      Red Hat OpenShift Container Platform

      Certified 4.4, 4.5, 4.6

      Supported 4.3

      The Operator can function on Kubernetes 1.20, however custom resource definitions (CRDs) will have a NonStructuralSchema condition associated with them. This can be ignored, and does not affect functionality.

      We recommend that Kubernetes 1.20 not be used for production workloads, only proof-of-concept work. Full support for Kubernetes 1.20 will be provided in Operator 2.2.

      Public Kubernetes Service Compatibility

      Service Support Level

      Amazon EKS

      Certified

      Google GKE

      Certified

      Microsoft AKS

      Certified

      Persistent Volume Compatibility

      Persistent volumes are mandatory for production deployments. Review the Operator best practices for more information about cluster supportability requirements.

      Table 1. Persistent Volume Compatibility List
      Volume Support Level

      AWS EBS

      Certified

      Azure Disk

      Certified

      Ceph RBD

      Certified

      GCE PD

      Certified

      GlusterFS

      Certified

      Portworx Volume

      Certified

      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

      As you’re setting up your Kubernetes environment, make sure that you’re following the recommended best practices.

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