Overview
Atlas Kubernetes Operator provides a set of custom resource definitions (CRDs) that are auto-generated from the MongoDB Atlas Administration API OpenAPI specification. These generated CRDs offer direct parity with the Atlas Administration API and are updated regularly as the API evolves. Over time, generated CRDs will replace the existing custom resources as the standard interface for managing Atlas resources through Atlas Kubernetes Operator.
Important
Incompatible with Existing Custom Resources
Generated CRDs are not compatible with the existing set of custom resources. You cannot mix generated and existing CRDs to manage the same Atlas resource. Choose one set of CRDs for each resource you manage through Atlas Kubernetes Operator.
Choosing Between CRD Sets
Because Atlas Kubernetes Operator currently offers a limited number of generated CRDs, you should evaluate which set best fits your needs:
Existing Custom Resources | Generated Custom Resources |
|---|---|
Full coverage of Atlas resource types. | Limited but expanding coverage of Atlas resource types. |
Will be deprecated in a future release. | Will become the standard for managing Atlas resources through Atlas Kubernetes Operator. |
Stable and well-established. | Closely tracks the Atlas Administration API OpenAPI specification. |
If the resource you need is available as a generated CRD, consider adopting it now to reduce the future effort of migrating from the existing CRDs. If a generated CRD is not yet available for your resource, continue to use the existing custom resources.
Available Generated CRDs
Atlas Kubernetes Operator currently supports the following generated CRDs:
Resource | Description |
|---|---|
Group in Atlas. | |
Cluster in Atlas. | |
Database user in Atlas. | |
Flex cluster in Atlas. | |
IP access list entry in Atlas. |
As the Atlas Administration API OpenAPI specification evolves, additional generated CRDs will become available. Check this page for updates.