AtlasDeployment 사용자 지정 리소스

Migration to Flex Clusters

Breaking Changes with Atlas Kubernetes Operator 2.0

About the AtlasDeployment Custom Resource

The AtlasDeployment custom resource configures your MongoDB cluster or Flex cluster in Atlas. When you create the AtlasDeployment custom resource, Atlas Kubernetes Operator tries to create or update a cluster or Flex cluster in Atlas.

Atlas 쿠버네티스 운영자 does one of the following actions depending on the values you specify in the AtlasDeployment custom resource:

• If you specify values for fields under spec.deploymentSpec, Atlas Kubernetes Operator uses the Atlas Clusters API Resource to create a new cluster or update an existing cluster.

• If you specify values for fields under spec.flexSpec, Atlas Kubernetes Operator uses the Atlas Flex Instance API Resource to create a new Flex cluster or update an existing Flex cluster.

Creating or updating a cluster or Flex cluster can take up to 10 minutes. Atlas Kubernetes Operator monitors the update process.

You can run the following command to check on the status:

kubectl get atlasdeployment -o yaml

The following example shows the status section of a cluster that is provisioning:

status:
  conditions:
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "False"
    type: ClusterReady
    reason: ClusterCreating
    message: Cluster is provisioning

The ClusterReady status will change to True when the cluster or Serverless instance is ready.

예시

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: test-cluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: US-Zone
        numShards: 3
        regionConfigs:
          - regionName: CENTRAL_US
            providerName: GCP
            backingProviderName: GCP
            priority: 7
            electableSpecs:
              instanceSize: M10
              nodeCount: 3
status:
  conditions:
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "True"
    type: Ready
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "True"
    type: ClusterReady
  connectionStrings:
    standard: mongodb://test-cluster-shard-00-00.kpc8f.mongodb.net:27017,test-cluster-shard-00-01.kpc8f.mongodb.net:27017,test-cluster-shard-00-02.kpc8f.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-1gm1pv-shard-0
    standardSrv: mongodb+srv://test-cluster.kpc8f.mongodb.net
  mongoDBVersion: 6.0
  mongoURIUpdated: "2024-03-12T12:21:41Z"
  observedGeneration: 1
  stateName: IDLE

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: development
  deploymentSpec:
    clusterType: REPLICASET
    name: service-name
    tags:
    - key: "environment"
      value: "production"
    backupEnabled: true
    replicationSpecs:
      - numShards: 1
        regionConfigs:
         - regionName: EASTERN_US
           providerName: GCP
           autoScaling:
             diskGB:
               enabled: true
             compute:
               enabled: true
               scaleDownEnabled: true
               minInstanceSize: M30
               maxInstanceSize: M40
           analyticsSpecs:
             instanceSize: M30
             nodeCount: 1
           electableSpecs:
             instanceSize: M30
             nodeCount: 3
           priority: 7
           readOnlySpecs:
             instanceSize: M30
             nodeCount: 1

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: test-cluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: Zone 1
        regionConfigs:
         - electableSpecs:
             instanceSize: M10
             nodeCount: 3
           providerName: AWS
           regionName: US_EAST_1
           priority: 7
  processArgs:
    javascriptEnabled: false

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: my-project
  flexSpec:
    name: flex-cluster
    tags:
      - key: "environment"
        value: "production"
    providerSettings:
      backingProviderName: AWS
      regionName: US_EAST_1

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: development
  serverlessSpec:
    name: serverless-instance
    tags:
    - key: "environment"
      value: "production"
    providerSettings:
      providerName: AWS
      regionName: US_EAST_1

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: tenantCluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: Zone 1
        regionConfigs:
        priority: 7
        - electableSpecs:
            instanceSize: M10
            nodeCount: 3
          providerName: AWS
          regionName: US_EAST_1

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: tenantCluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - regionConfigs:
        - electableSpecs:
            instanceSize: M10
            nodeCount: 3
          providerName: AWS
          regionName: US_EAST_1
          priority: 7
        - electableSpecs:
            instanceSize: M10
            nodeCount: 2
          providerName: AZURE
          regionName: US_EAST_2
          priority: 6
        - electableSpecs:
            instanceSize: M10
            nodeCount: 2
          providerName: GCP
          regionName: CENTRAL_US
          priority: 5

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  deploymentSpec:
    backupEnabled: true
    clusterType: REPLICASET
    name: Test-cluster-M10
    replicationSpecs:
    - regionConfigs:
      - backingProviderName: AWS
        electableSpecs:
          instanceSize: M10
          nodeCount: 3
        priority: 7
        providerName: AWS
        regionName: US_EAST_1
      zoneName: Zone 1
    searchIndexes:
    - DBName: sample_training
      collectionName: grades
      name: test-vector-search-index
      type: vectorSearch
      vectorSearch:
        fields:
        - numDimensions: 1000
          path: student_id
          similarity: euclidean
          type: vector
    - DBName: sample_airbnb
      collectionName: listingsAndReviews
      name: my-index
      search:
        mappings:
          dynamic: true
        searchConfigurationRef:
          name: atlassearchindexconfig-sample
          namespace: mongodb-atlas-system
      type: search
    terminationProtectionEnabled: false
  projectRef:
    name: my-project
    namespace: mongodb-atlas-system

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  deploymentSpec:
    backupEnabled: true
    clusterType: REPLICASET
    name: Test-cluster-M10
    replicationSpecs:
    - regionConfigs:
      - backingProviderName: AWS
        electableSpecs:
          instanceSize: M10
          nodeCount: 3
        priority: 7
        providerName: AWS
        regionName: US_EAST_1
      zoneName: Zone 1
    searchNodes:
    - instanceSize: S20_HIGHCPU_NVME
      nodeCount: 2

매개변수

This section describes some of the key AtlasDeployment custom resource parameters available.

• For a full list of available parameters for clusters, see the Atlas Clusters API.

• For a full list of available parameters for Flex clusters, see the Atlas Flex Clusters API.

See Notes on Transition To Flex Clusters for full information on changes.

To customize your specifications, refer to these descriptions, the available examples, and the API documentation.

spec.backupRef

유형: 객체

옵션

List that contains the details for the AtlasBackupSchedule 사용자 지정 리소스 that you want to apply. You can specify one backup schedule per cluster.

spec.backupRef.name

유형: 문자열

옵션

metadata.name value within the AtlasBackupSchedule 사용자 지정 리소스 for the backup schedule that you want to apply. You can specify only one backup schedule per cluster, but you can use the same backup schedule for multiple clusters.

If you omit this parameter, Atlas doesn't apply your backup configuration to this cluster.

spec.backupRef.namespace

유형: 문자열

옵션

String that indicates the namespace that contains the AtlasBackupSchedule 사용자 지정 리소스 for the backup schedule that you want to apply.

spec.connectionSecret.name

유형: 문자열

조건부

Atlas Kubernetes Operator 가 Atlas 에 연결하는 데 사용하는 조직 ID 및 API 키가 포함된 불투명 시크릿의 이름입니다. 지정되지 않은 경우 Atlas Kubernetes Operator 는 다음 중 하나로 대체됩니다.

• 상위 atlasProject의 spec.connectionSecretRef.name 매개 변수

• 기본값 global 시크릿(상위 atlasProject에 대해 spec.connectionSecretRef.name 이 정의되지 않은 경우)

이 매개변수는 독립적인 CRD의 경우 필수입니다.

spec.deploymentSpec

유형: 배열

조건부

List that contains the cluster parameters from the API. For a full list of available parameters, see the Atlas Clusters API.

중요

You must specify spec.deploymentSpec or spec.flexSpec in your configuration.

See Notes on Transition To Flex Clusters for full information on changes.

spec.deploymentSpec.clusterType

유형: 문자열

조건부

Human-readable label that identifies cluster type to create.

When should you use this parameter?

조건	필요성
You set spec.deploymentSpec.replicationSpecs.	필수 사항
You are deploying 글로벌 클러스터.	필수 사항
You are deploying non-Global replica sets and sharded clusters.	옵션

Atlas accepts:

값	클러스터 유형
REPLICASET	replicaSet
SHARDED	샤딩된 클러스터
GEOSHARDED	global cluster

spec.deploymentSpec.customZoneMapping

유형: 배열

필수 사항

List that contains 글로벌 클러스터 parameters that map zones to geographic regions. For a full list of available parameters, see the Atlas Global Clusters API.

spec.deploymentSpec.customZoneMapping.location

유형: 문자열

필수 사항

Code that represents a location that maps to a zone in your Global Cluster.

spec.deploymentSpec.customZoneMapping.zone

유형: 문자열

필수 사항

Human-readable label that identifies the zone in your Global Cluster.

spec.deploymentSpec.diskSizeGB

유형: 숫자

옵션

Capacity, in gigabytes, that indicates the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). You must specify a positive number for this value.

You can't set this value for clusters with local NVMe SSDs.

참고

If you enable autoscaling for diskGB in any region, you can't edit this option. To learn more, see spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabled.

The minimum disk size for dedicated clusters is 10 GB for AWS and Google Cloud. If you specify this setting with a lower disk size, Atlas defaults to the minimum disk size value.

If your database deployment includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4096).

Atlas calculates storage charges differently depending on whether you choose the default value or a custom value.

Atlas has disk capacity limits on single replica sets, scaling up to 4 TB for higher cluster tiers. To expand the total cluster storage beyond default limits, you can enable extended storage in the Project Settings. To accommodate further scaling in the future, we recommend that you enable 샤딩 for long-term expansion.

If your database deployment spans cloud service providers, this value defaults to the minimum default of the providers involved.

To learn more, see 저장 용량.

spec.deploymentSpec.encryptionAtRestProvider

유형: 문자열

옵션

Cloud service provider that manages the customer key for this cluster. You must set this value to enable encryption at rest using customer-managed keys for this cluster, which provides an additional layer of encryption. To learn more, see 키 관리 서비스를 사용하여 데이터 암호화.

Atlas accepts the following values:

값	클라우드 제공자
AWS	Amazon AWS
GCP	Google Cloud
AZURE	Microsoft Azure
none	No provider; the cluster doesn't encrypt data using customer-managed keys.

spec.deploymentSpec.managedNamespaces

유형: 배열

필수 사항

List that contains information to create a managed namespace in a specified 글로벌 클러스터 to create. For a full list of available parameters, see the Atlas Global Clusters API.

spec.deploymentSpec.managedNamespaces.collection

유형: 문자열

필수 사항

Human-readable label of the collection to manage in this Global Cluster.

spec.deploymentSpec.managedNamespaces.db

유형: 문자열

필수 사항

Human-readable label of the database to manage in this Global Cluster.

spec.deploymentSpec.managedNamespaces.isCustomShardKeyHashed

유형: 부울

옵션

Flag that indicates whether to hash the custom shard key for the specified collection. This parameter defaults to false.

• Set to true to enable a custom shard key for the collection.

• Set to false to disable a custom shard key for the collection. If diabled, MongoDB uses ranged sharding.

To learn more, see 해시 샤드 키.

spec.deploymentSpec.managedNamespaces.isCustomShardKeyUnique

유형: 부울

옵션

Flag that indicates whether the custom shard key for the specified collection is unique. This parameter defaults to false.

• Set to true to enable a unique custom shard key for the collection.

• Set to false to disable a unique custom shard key for the collection.

spec.deploymentSpec.managedNamespaces.numInitialChunks

유형: integer

옵션

Minimum number of chunks to initially create when sharding an empty collection with a hashed shard key.

To learn more, see 글로벌 컬렉션 샤딩.

spec.deploymentSpec.managedNamespaces.presplitHashedZones

유형: 부울

옵션

Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. This parameter defaults to false.

• Set to true to have MongoDB Cloud create and distribute initial chunks for an empty or non-existing collection.

• Set to false to not have MongoDB Cloud create and distribute initial chunks for an empty or non-existing collection..

spec.deploymentSpec.mongoDBMajorVersion

유형: 문자열

옵션

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:

• 5.0

• 6.0

• 7.0

The following conditions produce the following results:

조건	결과
You omit this parameter and you omit the spec.deploymentSpec.versionReleaseSystem parameter.	Atlas deploys a cluster that runs MongoDB 7.0.
You omit this parameter and you set the spec.deploymentSpec.versionReleaseSystem parameter to LTS.	Atlas deploys a cluster that runs MongoDB 7.0.
Atlas deprecated M2 and M5 clusters and Serverless instances. To learn more, see Migration to Flex Clusters. Set the spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSize parameter to M0, M2, or M5.	You must deploy MongoDB 7.0 or later.
You specify this parameter.	Atlas always deploys the cluster with the latest stable patch release of the specified version.
You set the spec.deploymentSpec.versionReleaseSystem parameter to CONTINUOUS.	You must omit this parameter.

spec.deploymentSpec.pitEnabled

유형: 부울

조건부

참고

Atlas M2 및 M5 클러스터와 서버리스 인스턴스를 더 이상 사용하지 않습니다. 가까운 미래에 Atlas 모든 M2 및 M5 클러스터를 Flex 클러스터로 자동 마이그레이션 . 서버리스 인스턴스의 경우, Atlas 사용량에 따라 인스턴스를 무료 클러스터, Flex 클러스터 또는 전용 클러스터로 마이그레이션 할지 여부를 결정한 다음 서버리스 인스턴스를 자동으로 마이그레이션 .

일정 기간 동안 API의 이전 버전과의 호환성을 유지하기 위해, Atlas Atlas Kubernetes Operator 사용할 때를 포함하여 이러한 마이그레이션된 클러스터를 동일한 API(이전 API 및 새 API)를 통해 managed 할 수 있도록 계속 허용합니다. API의 이전 버전과의 호환성은 2026 1월까지 유지되며, 이 때 이전 API는 제거되고 Flex 클러스터와 관련된 API만 유지됩니다.

서버리스 인스턴스의 비공개 엔드포인트 에 대한 지원이 2025 3월에 종료됩니다. 비공개 엔드포인트 제거 하려면 2025 3월까지 Atlas Kubernetes Operator 구성을 업데이트 해야 합니다. 2026 1월 이전에 Atlas Kubernetes Operator 구성에서 나머지 M2, M5 및 서버리스 인스턴스 기능을 모두 제거 해야 합니다.

If your workloads require 비공개 엔드포인트 or 연속 백업 및 특정 시점 복원, switch to Atlas Dedicated Clusters. To learn more, see Migration to Flex Clusters and the Atlas Flex Migration Guide.

Configuration that enables continuous cloud backup. To enable continuous cloud backup, you must specify true for this setting.

spec.deploymentSpec.replicationSpecs

유형: 객체 배열

조건부

List that contains the configurations for your cluster regions. Use this parameter for multi-region clusters. You must set either spec.deploymentSpec.replicationSpecs.regionConfigs.regionName or spec.deploymentSpec.replicationSpecs.

When should you use this parameter?

조건	필요성	Values
You are deploying 글로벌 클러스터.	필수 사항	Each object in the array represents a zone where Atlas deploys your cluster's nodes.
You are deploying non-Global replica sets and sharded clusters.	옵션	This array has one object representing where Atlas deploys your cluster's nodes.

If you specify this parameter, you must also specify spec.deploymentSpec.clusterType and spec.deploymentSpec.replicationSpecs.numShards.

spec.deploymentSpec.replicationSpecs.numShards

유형: integer

조건부

Positive integer that specifies the number of shards to deploy for a sharded cluster.

If you use the spec.deploymentSpec.replicationSpecs parameter, you must set this parameter.

Atlas accepts 1 through 50, inclusive. The default value is 1.

• If you specify a value of 1 and you set spec.deploymentSpec.clusterType to SHARDED, Atlas deploys a single-shard sharded cluster.

• If you specify 1 and you set spec.deploymentSpec.clusterType to REPLICASET, Atlas deploys a replica set.

  Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

  팁

  다음도 참조하세요.

  • 샤딩

  • 노드 수

경고

When you use a sharded cluster, MongoDB requires that your applications connect to a mongos instance to ensure that your applications interact with the shards and other components of the sharded cluster properly. If you migrate from a replica set to a sharded cluster, your applications must restart to enable the connection to the cluster's mongos. As a result, the Atlas Admin API prevents you from migrating a replica set directly to a sharded cluster with more than one shard. After you successfully migrate your replica set to a single shard cluster and reset your application connections, you can add additional shards to the cluster.

spec.deploymentSpec.replicationSpecs.regionConfigs

유형: 배열

필수 사항

Hardware specifications for nodes set for a given region. Each regionConfigs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region.

각 regionConfigs 객체에는 analyticsSpecs 객체, electableSpecs 객체 또는 readOnlySpecs 객체가 있어야 합니다.

• M0, M2또는 M5 clusters require only electableSpecs.

• Dedicated clusters can specify any of these specifications, but must have at least one electableSpecs object within a replicationSpec.

• 모든 hardware 사양은 동일한 instanceSize 을 사용해야 합니다.

spec.deploymentSpec.replicationSpecs.regionConfigs.analyticsSpecs

유형: 객체

옵션

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary.

If you don't specify this parameter, Atlas deploys no analytics to this region.

spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabled

유형: 부울

옵션

Flag that indicates whether this database deployment enables disk autoscaling. This parameter defaults to true.

• Set to true to enable disk autoscaling.

• Set to false to disable disk autoscaling.

The maximum amount of RAM for the selected cluster tier and the oplog size can limit storage auto-scaling. To learn more, see Customize Your Storage.

spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabled

유형: 부울

옵션

Flag that indicates whether instance size autoscaling is enabled. This parameter defaults to false.

• Set to true to enable instance size autoscaling. If enabled, you must specify a value for spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSize.

• Set to false to disable instance size autoscaling.

spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSize

유형: 문자열

조건부

String that indicates the maximum instance size to which your database deployment can automatically scale (such as M40). You must specify this parameter if you set spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabled to true.

참고

If you set a maximum instance size smaller than the database deployment's current instance size with autoscaling enabled, Atlas automatically scales the current instance size to the maximum value you specify.

For example, if the database deployment's current instance size is M40 and you set the maximum instance size to M30, Atlas automatically scales the current instance size to M30.

If Atlas changes the current instance size and you don't change the spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSize in Atlas Kubernetes Operator to match the new instance size, Atlas Kubernetes Operator displays a warning in the logs but doesn't prevent autoscaling.

spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSize

유형: 문자열

조건부

String that indicates the minimum instance size to which your database deployment can automatically scale (such as M10). You must specify this parameter if you set spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabled to true.

참고

If you set a minimum instance size larger than the database deployment's current instance size with autoscaling enabled, Atlas automatically scales the current instance size to the minimum value you specify.

For example, if the database deployment's current instance size is M10 and you set the minimum instance size to M30, Atlas automatically scales the current instance size to M30.

If Atlas changes the current instance size and you don't change the spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSize in Atlas Kubernetes Operator to match the new instance size, Atlas Kubernetes Operator displays a warning in the logs but doesn't prevent autoscaling.

spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs

유형: 객체

옵션

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads.

If you don't specify this option, Atlas deploys no electable nodes to the region.

spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSize

유형: 문자열

조건부

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. To learn more, see the AWS, GCP, and Azure custom storage sizes.

If you deploy a sharded cluster, or global cluster, you must choose an instance size of M30 or greater.

If you change the instance size name after you deploy your cluster, Atlas changes the database deployment to the instance size you specify unless it falls outside the range you specify in spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSize and spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSize with autoscaling enabled. To learn more, see spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSize and spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSize.

참고

If you have autoscaling enabled for the compute field, you can't edit this option. To learn more, see spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabled.

참고

You can change this setting to upgrade an M0, M2, M5, or Flex cluster to an M10+ cluster. However, you can't use this setting to upgrade an M0, M2, M5, or Flex cluster to another free or shared cluster.

spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.nodeCount

유형: integer

조건부

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can enable local reads.

The combined electableSpecs.nodeCount across all replicationSpecs.regionConfigs objects must total 3, 5, or 7.

You can't create electable nodes if spec.deploymentSpec.replicationSpecs.regionConfigs.priority is 0.

spec.deploymentSpec.replicationSpecs.regionConfigs.priority

유형: integer

필수 사항

Precedence is given to this region when a primary election occurs.

If your regionConfigs has only readOnlySpecs, analyticsSpecs, or both, set this value to 0.

If you have multiple regionConfigs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.

예시

Set your highest priority region to 7, your second-highest priority to 6, and your third-priority region to 5. If you have no electable nodes, set this value to 0.

If your region has set electableSpecs.nodeCount to 1 or higher, it must have a priority of exactly one less than another region in the replicationSpecs.regionConfigs array unless it is the primary. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive: you can't assign a given priority to more than one region per cluster.

예시

If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

spec.deploymentSpec.replicationSpecs.regionConfigs.providerName

유형: 문자열

조건부

Cloud service provider on which Atlas provisions the hosts.

AWS	Amazon AWS
GCP	Google Cloud Platform
AZURE	Microsoft Azure

spec.deploymentSpec.replicationSpecs.regionConfigs.regionName

유형: 문자열

조건부

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases.

For a complete list of region name values, refer to the cloud provider reference pages:

• AWS

• GCP

• Azure

For multi-region clusters, see spec.deploymentSpec.replicationSpecs. You must set either spec.deploymentSpec.replicationSpecs.regionConfigs.regionName or spec.deploymentSpec.replicationSpecs.

spec.deploymentSpec.replicationSpecs.regionConfigs.readOnlySpecs

유형: 객체

옵션

Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.

If you don't specify this parameter, Atlas deploys no read-only nodes to the region.

spec.deploymentSpec.replicationSpecs.zoneName

유형: 문자열

옵션

Human-readable label that identifies the zone in a 글로벌 클러스터. Provide this value only if you set spec.deploymentSpec.clusterType to GEOSHARDED.

spec.deploymentSpec.searchIndexes

유형: 배열

옵션

An array of SearchIndex objects with fields that describe the search index. Each SearchIndex object contains the following fields:

필드	유형	설명
name	문자열	Human-readable label that identifies this index. Must be unique for a deployment.
DBName	문자열	Human-readable label that identifies the existing database that contains the collection with one or more Atlas Search indexes. IMPORTANT: The database that you specify must already exist. If you don't have an existing database, create one.
collectionName	문자열	Human-readable label that identifies the collection that contains one or more Atlas Search indexes.
type	문자열	인덱스의 유형입니다. Atlas에서 허용하는 값은 다음과 같습니다. search vectorSearch
search	객체	You must include this object if type is search. Otherwise, omit it.
vectorSearch	객체	You must include this object if type is vectorSearch. Otherwise, omit it.

spec.deploymentSpec.searchIndexes.search

유형: 객체

옵션

필드	유형	설명
synonyms	배열	Rule sets that map words to their synonyms in this index
mappings	객체	Index specifications for the collection's fields 필수 사항
searchConfigurationRef	객체	A name/namespace reference to the AtlasSearchIndexConfig custom resource, described below. 필수 사항

spec.deploymentSpec.searchIndexes.search.synonyms

유형: 배열

옵션

An array of Synonym objects with fields that describe rule sets that map words to their synonyms in this index. Each Synonym object contains the following fields:

필드	유형	설명
name	문자열	Human-readable label that identifies the synonym definition. Each name must be unique within the same index definition 필수 사항
analyzer	문자열	Specific pre-defined method chosen to apply to the synonyms to be searched. Possible values are: lucene.standard lucene.standard lucene.simple lucene.whitespace lucene.keyword lucene.arabic lucene.armenian lucene.basque lucene.bengali lucene.brazilian lucene.bulgarian lucene.catalan lucene.chinese lucene.cjk lucene.czech lucene.danish lucene.dutch lucene.english lucene.finnish lucene.french lucene.galician lucene.german lucene.greek lucene.hindi lucene.hungarian lucene.indonesian lucene.irish lucene.italian lucene.japanese lucene.korean lucene.kuromoji lucene.latvian lucene.lithuanian lucene.morfologik lucene.nori lucene.norwegian lucene.persian lucene.portuguese lucene.romanian lucene.russian lucene.smartcn lucene.sorani lucene.spanish lucene.swedish lucene.thai lucene.turkish lucene.ukrainian 필수 사항
source	객체	Data set that stores the mapping one or more words map to one or more synonyms of those words 필수 사항

spec.deploymentSpec.searchIndexes.search.synonyms.source

유형: 객체

필수 사항

필드	유형	설명
collection	문자열	Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms 필수 사항

spec.deploymentSpec.searchIndexes.search.mappings

유형: 객체

필수 사항

An object with Index specifications for the collection's fields:

dynamic	부울	Flag that indicates whether the index uses dynamic or static mappings. Required if mappings.fields is omitted.
fields	JSON/YAML	One or more field specifications for the Atlas Search index. Required if mappings.dynamic is omitted or set to false.

spec.deploymentSpec.searchIndexes.vectorSearch

유형: 객체

옵션

필드	유형	설명
fields	JSON/YAML	Array of JSON objects. See examples https://dochub.mongodb.org/core/avs-vector-type 필수 사항

spec.deploymentSpec.searchNodes

유형: 배열

옵션

An array of search nodes configurations. Each element contains two fields:

필드	유형	설명
nodeCount	integer	cluster의 검색 노드 수입니다. Atlas accepts values 2 through 32, inclusive. The default number is 2.
instanceSize	문자열	Hardware specification for the search node instance sizes. Atlas accepts one of the following: S20_HIGHCPU_NVME S30_HIGHCPU_NVME S40_HIGHCPU_NVME S50_HIGHCPU_NVME S60_HIGHCPU_NVME S70_HIGHCPU_NVME S80_HIGHCPU_NVME S30_LOWCPU_NVME S40_LOWCPU_NVME S50_LOWCPU_NVME S60_LOWCPU_NVME S80_LOWCPU_NVME S90_LOWCPU_NVME S100_LOWCPU_NVME The default instance size is S20_HIGHCPU_NVME.

spec.deploymentSpec.tags

유형: 배열

옵션

List that contains tags (key-value pairs) to better understand, organize, and identify your database deployments. To learn more, see 클러스터의 태그.

spec.deploymentSpec.terminationProtectionEnabled

유형: 부울

Indicates whether termination protection is enabled or disabled for your cluster. If set to true, Atlas won't delete the cluster. If set to false, Atlas will delete the cluster. The default is false.

spec.deploymentSpec.versionReleaseSystem

유형: 문자열

조건부

Release cadence that Atlas uses for this cluster. Atlas accepts:

• CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.

• LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the spec.deploymentSpec.mongoDBMajorVersion parameter. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

  생략하는 경우 기본값은 LTS입니다.

  If you set this parameter to CONTINUOUS, you must omit the spec.deploymentSpec.mongoDBMajorVersion parameter.

spec.externalProjectRef.id

유형: 문자열

조건부

ID of the project to which the deployment belongs. You must specify the project ID of an existing Atlas Project. This parameter is required for deployments who belong to projects managed by either:

• Atlas Kubernetes Operator 의 다른 인스턴스

• Atlas Kubernetes Operator 이외의 도구

Atlas Kubernetes Operator 의 동일한 인스턴스 에서 managed 하는 프로젝트에 속한 배포서버의 경우 spec.externalProjectRef.id을(를) 사용하지 않는 경우 spec.projectRef.name 을(를) 사용하세요.

spec.flexSpec

유형: 배열

조건부

참고

See Notes on Transition To Flex Clusters for full information on changes.

List that contains the Flex cluster parameters from the API. For a full list of available parameters, see the Atlas Flex Clusters API.

중요

You must specify spec.deploymentSpec or spec.flexSpec in your configuration.

spec.flexSpec.name

유형: 문자열

String that identifies the name of the Flex cluster.

spec.flexSpec.tags

유형: 배열

옵션

List that contains tags (key-value pairs) to better understand, organize, and identify your database deployments. To learn more, see 클러스터의 태그.

spec.flexSpec.terminationProtectionEnabled

유형: 부울

Indicates whether termination protection is enabled or disabled for your Flex cluster. If set to true, Atlas won't delete the cluster. If set to false, Atlas will delete the cluster. The default is false.

spec.flexSpec.providerSettings.backingProviderName

유형: 문자열

The name of the cloud provider for your Flex cluster. providerSettings include the configuration that specifies the settings for the provisioned hosts on which MongoDB runs.

Atlas accepts one of the following values:

• AWS

• AZURE

• GCP

spec.flexSpec.providerSettings.regionName

유형: 문자열

Physical location of your MongoDB Flex cluster. The region you choose can affect network latency for clients accessing your databases.

For a complete list of region name values, refer to the cloud provider reference pages:

• AWS

• GCP

• Azure

spec.processArgs

유형: 객체

옵션

Object that contains the additional configuration options for your cluster.

spec.processArgs.defaultReadConcern

유형: 문자열

옵션

String that indicates the default level of acknowledgment requested from MongoDB for read operations set for this cluster.

MongoDB 5.0 clusters default to local.

spec.processArgs.defaultWriteConcern

유형: 문자열

옵션

String that indicates the default level of acknowledgment requested from MongoDB for write operations set for this cluster.

MongoDB versions 5.0 and later clusters default to majority.

spec.processArgs.failIndexKeyTooLong

유형: 부울

옵션

Flag that indicates whether to fail the operation and return an error when you insert or update documents where all indexed entries exceed 1024 bytes. If you set this to false, mongod writes documents that exceed this limit, but doesn't index them.

This option corresponds to the param.failIndexKeyTooLong mongod parameter.

spec.processArgs.javascriptEnabled

유형: 부울

옵션

Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.

• This option corresponds to modifying the security.javascriptEnabled configuration file option for each mongod and mongos in the cluster.

spec.processArgs.minimumEnabledTlsProtocol

유형: integer

옵션

String that indicates the minimum TLS version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.

To learn more, see Atlas는 어떤 버전의 TLS를 지원하나요?.

This option corresponds to the net.ssl.disabledProtocols mongod configuration file option.

spec.processArgs.noTableScan

유형: 부울

옵션

Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.

This option corresponds to the notablescan mongod parameter.

spec.processArgs.oplogSizeMB

유형: integer

옵션

Number that indicates the storage limit of a cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that Atlas calculates.

This option corresponds to the replication.oplogSizeMB mongod configuration file option.

spec.processArgs.sampleRefreshIntervalBIConnector

유형: integer

옵션

Number that indicates the documents per database to sample when gathering schema information.

This parameter corresponds to the sampleSize mongosqld option.

spec.processArgs.sampleSizeBIConnector

유형: integer

옵션

Number that indicates the interval in seconds at which the mongosqld process re-samples data to create its relational schema.

This parameter corresponds to the sampleRefreshIntervalSecs mongosqld option.

spec.projectRef.name

유형: 문자열

조건부

Name of the project to which the deployment belongs. You must specify an existing AtlasProject 사용자 지정 리소스. This parameter applies only to deployments that belong to projects managed by the same instance Atlas Kubernetes Operator.

다음 중 하나에서 managed 되는 프로젝트에 속한 배포의 경우:

• Atlas Kubernetes Operator 의 다른 인스턴스

• Atlas Kubernetes Operator 이외의 도구

spec.externalProjectRef.id 을(를) 사용하세요.

spec.serverlessSpec

유형: 배열

조건부

참고

See Notes on Transition To Flex Clusters for full information on changes.

List that contains the Serverless instance parameters from the API. For a full list of available parameters, see the Atlas Flex Clusters API.

중요

You must specify spec.deploymentSpec or spec.flexSpec in your configuration.

spec.serverlessSpec.privateEndpoints

유형: 배열

옵션

참고

Atlas M2 및 M5 클러스터와 서버리스 인스턴스를 더 이상 사용하지 않습니다. 가까운 미래에 Atlas 모든 M2 및 M5 클러스터를 Flex 클러스터로 자동 마이그레이션 . 서버리스 인스턴스의 경우, Atlas 사용량에 따라 인스턴스를 무료 클러스터, Flex 클러스터 또는 전용 클러스터로 마이그레이션 할지 여부를 결정한 다음 서버리스 인스턴스를 자동으로 마이그레이션 .

일정 기간 동안 API의 이전 버전과의 호환성을 유지하기 위해, Atlas Atlas Kubernetes Operator 사용할 때를 포함하여 이러한 마이그레이션된 클러스터를 동일한 API(이전 API 및 새 API)를 통해 managed 할 수 있도록 계속 허용합니다. API의 이전 버전과의 호환성은 2026 1월까지 유지되며, 이 때 이전 API는 제거되고 Flex 클러스터와 관련된 API만 유지됩니다.

서버리스 인스턴스의 비공개 엔드포인트 에 대한 지원이 2025 3월에 종료됩니다. 비공개 엔드포인트 제거 하려면 2025 3월까지 Atlas Kubernetes Operator 구성을 업데이트 해야 합니다. 2026 1월 이전에 Atlas Kubernetes Operator 구성에서 나머지 M2, M5 및 서버리스 인스턴스 기능을 모두 제거 해야 합니다.

If your workloads require 비공개 엔드포인트 or 연속 백업 및 특정 시점 복원, switch to Atlas Dedicated Clusters. To learn more, see Migration to Flex Clusters and the Atlas Flex Migration Guide.

Deprecated. Remove this parameter if it exists. List that contains the private endpoint configurations for the Serverless instance.

spec.serverlessSpec.providerSettings

유형: Object

조건부

참고

See Notes on Transition To Flex Clusters for full information on changes.

Configuration that specifies the settings for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider. To learn more, see the AWS, GCP, and Azure Serverless instance configuration options.

If you want to create or update a Serverless instance, you must specify this setting.

중요

The following settings are deprecated and will be removed in a future release:

• spec.serverlessSpec.providerSettings.DiskIOPS

• spec.serverlessSpec.providerSettings.DiskTypeName

• spec.serverlessSpec.providerSettings.EncryptEBSVolume

• spec.serverlessSpec.providerSettings.InstanceSizeName

• spec.serverlessSpec.providerSettings.VolumeType

• spec.serverlessSpec.providerSettings.AutoScaling

Providing values for any of these settings has no effect.

spec.serverlessSpec.providerSettings.providerName

유형: 문자열

조건부

참고

See Notes on Transition To Flex Clusters for full information on changes.

Cloud service provider on which Atlas provisions the host for a Serverless instance.

Atlas accepts the following values:

AWS	Amazon AWS
GCP	Google Cloud Platform
AZURE	Microsoft Azure

spec.serverlessSpec.providerSettings.regionName

유형: string

조건부

참고

See Notes on Transition To Flex Clusters for full information on changes.

Physical location of your MongoDB Serverless instance. The region you choose can affect network latency for clients accessing your databases.

For a complete list of region name values, refer to the cloud provider reference pages:

• AWS

• GCP

• Azure

spec.serverlessSpec.tags

참고

See Notes on Transition To Flex Clusters for full information on changes.

유형: 배열

옵션

List that contains tags (key-value pairs) to better understand, organize, and identify your database deployments. To learn more, see 클러스터의 태그.

status.connectionStrings

유형: 배열

필수 사항

List that contains the connection URLs for accessing the cluster. This parameter appears after you create or update a cluster.

참고

.. include:: /includes/fact-ak8so-connection-strings.rst

For the configuration parameters available for a cluster from the API, see the Atlas Clusters API.