Operator preview

DocumentDB Kubernetes Operator

Run DocumentDB on Kubernetes. Built on PostgreSQL for local, hybrid, and multi-cloud paths.

Install with Helm, manage with custom resources, and add failover, replication, backups, TLS, and day-2 workflows from a single operator model.

Open quick start GitHub repository

Document workloadsBuilt on PostgreSQLMIT licensedAutomatic failoverBackup + ScheduledBackup CRDsAKS / EKS / GKEkubectl plugin workflowsPrometheus-ready

Where it fits

Built for Kubernetes-native document database operations

Use the operator when you want DocumentDB on PostgreSQL with Kubernetes-native lifecycle management for local clusters, HA topologies, or multi-cluster deployments.

Teams moving document workloads from local clusters to managed Kubernetes.
Platform teams standardizing PostgreSQL-backed DocumentDB operations across cloud and on-prem clusters.
Operators that need failover, backup, promotion, and recovery workflows across clusters.

Preview status

The operator is still in preview. Use this page to assess fit, then follow the quick start or multi-cluster guides for the current support envelope.

What the operator adds

A better fit for Kubernetes-based DocumentDB environments

The operator adds Kubernetes-native lifecycle management, recovery, and cross-cluster workflows on top of DocumentDB.

Workloads

Document workloads

Run DocumentDB with client drivers and tools, then manage it with Kubernetes custom resources.

Client driversToolsCRDs

Foundation

Built on PostgreSQL

Use CloudNativePG and PostgreSQL under the hood while keeping a document database workflow on Kubernetes.

PostgreSQLCloudNativePGACID

Topology

Hybrid and multi-cloud

Use one operator model across kind, minikube, AKS, EKS, GKE, and connected on-prem clusters.

kind + minikubeAKS / EKS / GKEOn-prem

Resilience

Failover and recovery

Add automatic failover, cross-cluster replication, and Backup and ScheduledBackup workflows for recovery.

Automatic failoverCross-clusterBackup CRDs

Security

TLS and access controls

Choose from four TLS modes and integrate with secrets, SCRAM auth, RBAC, and secure cluster networking.

4 TLS modesSCRAMRBAC

Operations

Day-2 operations

Use the kubectl plugin plus events and metrics to inspect status, troubleshoot, and promote a new primary when needed.

kubectl pluginEventsMetrics

Setup at a glance

The operator flow in three steps

Use this page to understand the path. Use the docs for commands, topology setup, and current support details.

See the install shape

Install cert-manager first, then add the operator chart. The chart includes CloudNativePG as a dependency.

Helm

helm repo add documentdb https://documentdb.github.io/documentdb-kubernetes-operator
helm install documentdb-operator documentdb/documentdb-operator \
  --namespace documentdb-operator --create-namespace

Prepare the cluster

Use kind or minikube locally, or a Kubernetes 1.35+ cluster such as AKS, EKS, or GKE to run the operator preview.

Install the operator

Install cert-manager, then add the DocumentDB operator with Helm. CloudNativePG is included as a chart dependency.

Create a DocumentDB resource

Apply a DocumentDB custom resource to launch a document database built on PostgreSQL, then expand into replicated topologies as needed.

What to expect before you start

The operator preview targets Kubernetes 1.35+, requires cert-manager to be installed first, and uses CloudNativePG under the hood. Cross-cluster topologies also require network connectivity between clusters and the documented multi-cluster setup.

Open quick start

Next step

Start with the quick start, then expand

Use the quick start to launch the operator, then continue with replication, hybrid, and multi-cluster guides.

Open quick start GitHub repository