DocumentDB Kubernetes Operator

A Kubernetes operator for managing DocumentDB clusters in your Kubernetes environment. This operator provides a native Kubernetes way to deploy, manage, and scale DocumentDB instances with MongoDB-compatible API.

🚀 What is DocumentDB Kubernetes Operator?

The DocumentDB Kubernetes Operator extends Kubernetes with Custom Resource Definitions (CRDs) to manage DocumentDB clusters declaratively. It leverages the power of Kubernetes controllers to ensure your DocumentDB deployments are always in the desired state.

Key Features

• Declarative Management: Define your DocumentDB clusters using Kubernetes manifests
• Automated Operations: Automatic deployment, scaling, and lifecycle management
• MongoDB Compatibility: MongoDB API–compatible for seamless integration
• Cloud Native: Built on CloudNative-PG for robust PostgreSQL foundation
• Helm Chart Support: Easy installation and configuration via Helm
• Enterprise Grade: Multi-cloud support and high availability

📚 Documentation

For installation guides, configuration options, and examples, visit our documentation.

📦 Install

The operator Helm chart is published as an OCI artifact to the GitHub Container Registry. Install the latest stable chart with:

helm install documentdb-operator oci://ghcr.io/documentdb/documentdb-operator \
  --namespace documentdb-operator \
  --create-namespace \
  --wait

For production or repeatable installs, pick a release from GitHub Releases and add --version <release-version> to the command. OCI registries do not support helm search repo.

Requires Helm 3.8+ (OCI support is on by default). For the full prerequisites (cert-manager, supported Kubernetes versions, container runtimes) and platform-specific setup, see the installation guide.

🚀 Quick Start

Ready to get started? Check out our Quick Start Guide for step-by-step instructions to deploy your first DocumentDB cluster in minutes.

Development Setup

For information on setting up your development environment to contribute to this project, see our Developer Guide.

🌐 Cloud Platform Setup Guides

Deploy DocumentDB clusters across different cloud platforms and configurations:

• Azure (AKS): Comprehensive deployment automation scripts for Azure Kubernetes Service
• AWS (EKS): Simple automation scripts for deploying on Amazon Elastic Kubernetes Service
• Multi-Cloud: High availability setup across multiple cloud providers using KubeFleet and Istio
• Azure Multi-Region (AKS + AzureFleet): Deployment scripts for deploying multi-regionally in Azure
• TLS Configuration: Gateway TLS setup with multiple certificate modes (self-signed, provided, cert-manager)
• Operator Upgrades: Local development guide for testing operator control plane upgrades

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔒 Security

For security concerns, please review our Security Policy.

💬 Support

• Create an issue for bug reports and feature requests
• Check our documentation for common questions
• Join our Discord and then contact us on #kubernetes