AtlasDeployment カスタム リソース

フレキシブルなクラスターへの移行

Atlas Kubernetes演算子 2.0 による重大な変更

AtlasDeployment カスタム リソースについて

AtlasDeployment カスタムリソースは、 Atlas のMongoDBクラスターまたは Flex クラスターを構成します。 AtlasDeployment カスタムリソースを作成すると、Atlas Kubernetes Operator は Atlas 内の クラスターまたは Flex クラスターを作成または更新しようとします。

Atlas Kubernetes Operator は、 AtlasDeploymentカスタム リソースで指定した値に応じて、次のいずれかのアクションを実行します。

• 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.

無料のクラスターの作成は 15 秒未満で完了します。

Flex クラスターまたは専有クラスターの作成または更新には最大 10 分かかる場合があります。Atlas Kubernetes Operator は更新プロセスをモニターします。

次のコマンドを実行して、ステータスを確認できます。

kubectl get atlasdeployment -o yaml

以下の例は、プロビジョニング中のクラスターのステータス セクションを示しています。

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

クラスターまたはサーバーレスインスタンスが準備完了すると、ClusterReady のステータスは True に変わります。

例

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

パラメーター

このセクションでは、使用可能な主要なAtlasDeploymentカスタム リソース パラメータの一部について説明します。

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

• Flex クラスターで使用可能なパラメーターの完全なリストについては、 Atlas Flex Clusters APIを参照してください。

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

仕様をカスタマイズするには、これらの説明、利用可能な例、およびAPIドキュメントを参照してください。

spec.backupRef

型: オブジェクト

任意

適用するAtlasBackupScheduleカスタム リソースの詳細を含むリスト。 クラスターごとに 1 つのバックアップ スケジュールを指定できます。

spec.backupRef.name

型: string

任意

metadata.name 適用するバックアップ スケジュールのAtlasBackupScheduleカスタム リソース内の値。 クラスターごとに指定できるバックアップ スケジュールは 1 つだけですが、複数のクラスターで同じバックアップ スケジュールを使用できます。

このパラメーターを省略すると、Atlas はこのクラスターにバックアップ構成を適用しません。

spec.backupRef.namespace

型: string

任意

適用するバックアップ スケジュールのAtlasBackupScheduleカスタム リソースを含む名前空間を示す string。

spec.configServerManagementMode

型: string

任意

デフォルト: ATLAS_MANAGED

シャーディングされたクラスターを作成または更新するための サーバー管理モード を定義する構成。可能な値は次のとおりです。

• ATLAS_MANAGED: Atlas は、最適なパフォーマンスと節約のためにクラスターのコンフィギュレーションサーバーのタイプを自動的に切り替える場合があります。

• FIXED_TO_DEDICATED: クラスターは常に専用のコンフィギュレーションサーバーを使用します。

Learn more about MongoDB Sharded Cluster Config Servers.

spec.connectionSecret.name

型: string

条件付き

Atlas Kubernetes Operator が Atlas に接続するために使用する組織IDとAPIキーを含む opaque secret の名前。指定されていない場合、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.

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

spec.deploymentSpec.name

型: string

条件付き

クラスターの名前を識別する string。 名前には文字、数字、ダッシュのみを含める必要があり、配置の作成後に変更することはできません。

spec.deploymentSpec.clusterType

型: string

条件付き

作成するクラスターのタイプを識別する、人間が判読可能なラベル。

このパラメーターをいつ使用するか？

条件	必要性
You set spec.deploymentSpec.replicationSpecs.	必須
You are deploying Global Clusters.	必須
非グローバルのレプリカセットとシャーディングされたクラスターを配置している。	任意

Atlas では以下に対応しています。

値	クラスター タイプ
レプリカセット	レプリカセット
シャード	シャーディングされたクラスター
GEOSHARDED	グローバル クラスター

spec.deploymentSpec.customZoneMapping

タイプ: 配列

必須

ゾーンを地理的リージョンにマッピングするグローバルクラスターパラメーターが格納されたリスト。 使用可能なパラメーターの完全なリストについては、 Atlas Global Clusters API を参照してください。

spec.deploymentSpec.customZoneMapping.location

型: string

必須

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

spec.deploymentSpec.customZoneMapping.zone

型: string

必須

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

spec.deploymentSpec.diskSizeGB

タイプ: 数値

任意

ホストのルート ボリュームを示す容量（ギガバイト単位）。 この数を増やして、最大値4096 （4 TB）まで容量を追加します。 この値には正の数を指定する必要があります。

この値は、ローカル NVMe SSD を持つクラスターでは設定できません。

注意

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

専有クラスターの最小ディスクサイズは、Amazon Web Services と Google Cloud Platform の場合 10 GB です。最小ディスク サイズ値より小さいディスク サイズでこの設定を指定する場合、Atlas はデフォルトで最小ディスク サイズ値になります。

データベース配置に Azure ノードが含まれている場合、この値は、既存の Azure ディスク タイプ (8、16、32、64、128、256、512、1024、2048、または 4096)に対応する必要があります。

Atlas は、デフォルト値を選択するかカスタム値を選択するかに応じて、ストレージ料金の計算方法が異なります。

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 sharding for long-term expansion.

データベース配置が複数のクラウド サービス プロバイダーにまたがる場合、この値は関係するプロバイダーの最小デフォルトになります。

To learn more, see Storage Capacity.

spec.deploymentSpec.encryptionAtRestProvider

型: string

任意

このクラスターのカスタマー キーを管理するクラウド サービス プロバイダー。 このクラスターのカスタマー マネージド キーを使用して保管時の暗号化を有効にするには、この値を設定する必要があります。これにより、暗号化の追加レイヤーが提供されます。 詳細については、「 KMSを使用したデータの暗号化 」を参照してください。

Atlas は次の値を受け入れます。

値	クラウドプロバイダー
Amazon Web Services	Amazon Amazon Web Services
GCP	Google Cloud
Azure	Microsoft Azure
なし	プロバイダーなし。クラスターは、カスタマー マネージド キーを使用してデータを暗号化 しません 。

spec.deploymentSpec.managedNamespaces

タイプ: 配列

必須

List that contains information to create a managed namespace in a specified Global Cluster to create. For a full list of available parameters, see the Atlas Global Clusters API.

spec.deploymentSpec.managedNamespaces.collection

型: string

必須

このグローバルクラスターで管理するコレクションの、人間が判読可能なラベル。

spec.deploymentSpec.managedNamespaces.db

型: string

必須

このグローバルクラスターで管理する、人間が判読可能なデータベースのラベル。

spec.deploymentSpec.managedNamespaces.isCustomShardKeyHashed

タイプ: ブール値

任意

指定されたコレクションのカスタム シャードキーをハッシュするかどうかを示すフラグ。 このパラメータのデフォルトはfalseです。

• コレクションのカスタム シャードキーを有効にするには、 をtrueに設定します。

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

To learn more, see Hashed Shard Keys.

spec.deploymentSpec.managedNamespaces.isCustomShardKeyUnique

タイプ: ブール値

任意

指定されたコレクションのカスタム シャードキーが一意であるかどうかを示すフラグ。 このパラメータのデフォルトはfalseです。

• コレクションの一意のカスタム シャードキーを有効にするには、 をtrueに設定します。

• コレクションの一意のカスタム シャードキーを無効にするには、 をfalseに設定します。

spec.deploymentSpec.managedNamespaces.numInitialChunks

タイプ: 整数

任意

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

詳細については、「グローバル コレクションのシャーディング 」を参照してください。

spec.deploymentSpec.managedNamespaces.presplitHashedZones

タイプ: ブール値

任意

MongoDB Cloud が、空のコレクションや存在しないコレクションの初期チャンクを作成して配布するかどうかを示すフラグ。 このパラメータのデフォルトはfalseです。

• MongoDB Cloud が空のコレクションまたは存在しないコレクションの初期チャンクを作成して配布するには、 trueに設定します。

• MongoDB Cloud が空のコレクションや存在しないコレクションの初期チャンクを作成して配布しないようにするには、 falseに設定します。

spec.deploymentSpec.mongoDBMajorVersion

型: string

任意

配置するクラスターのバージョン。 Atlas は、 M10+クラスターに対して次の MongoDB バージョンをサポートしています。

• 5.0

• 6.0

• 7.0

• 8.0

次の条件では、次の結果が得られます。

条件	結果
You omit this parameter and you omit the spec.deploymentSpec.versionReleaseSystem parameter.	Atlas は MongoDB 7.0 を実行するクラスターをデプロイします。
You omit this parameter and you set the spec.deploymentSpec.versionReleaseSystem parameter to LTS.	Atlas は 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.	MongoDB 7.0 以降を配置する必要があります。
このパラメーターを指定します。	Atlas は、指定されたバージョンの最新の安定したパッチ リリースを使用してクラスターを常にデプロイします。
You set the spec.deploymentSpec.versionReleaseSystem parameter to CONTINUOUS.	このパラメーターは省略する必要があります。

spec.deploymentSpec.pitEnabled

タイプ: ブール値

条件付き

注意

Atlas は M2 および M5 クラスターとサーバーレス インスタンスを非推奨にしました。Atlas は、すべての M2 クラスターと M5 クラスターを Flex クラスターに移行しました。サーバーレスインスタンスの場合、Atlas は使用状況に応じて インスタンスを 無料クラスター、 Flex クラスター、または 専有クラスターに移行しました。

API の下位互換性を一定期間維持するため、Atlas では、Atlas Kubernetes Operator を使用する場合を含め、これらの移行クラスターを同じ API（古い API と新しい API）で管理できるようにします。 API の下位互換性は、古い2026 API が削除され、Flex クラスターに関連する API のみが残ります。

サーバーレスインスタンス上のプライベートエンドポイントのサポートは 3 月 2025 日で終了しました。2025 までにプライベートエンドポイントを除くために、Atlas Kubernetes Operator の構成を更新する必要があります。残りのすべての M2、M5、およびサーバーレスインスタンス機能を Atlas Kubernetes Operator 構成から 2026 年 1 月前に除く必要があります。

If your workloads require Private Endpoints or Continuous Backup, switch to Atlas Dedicated Clusters. To learn more, see Migration to Flex Clusters and the Atlas Flex Migration Guide.

継続的なクラウドバックアップを可能にする構成。 継続的なクラウドバックアップを有効にするには、この設定にtrueを指定する必要があります。

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.

このパラメーターをいつ使用するか？

条件	必要性	Values
You are deploying Global Clusters.	必須	配列内の各オブジェクトは、Atlas がクラスターのノードを配置するゾーンを表します。
非グローバルのレプリカセットとシャーディングされたクラスターを配置している。	任意	この配列には、Atlas がクラスターのノードを配置する場所を表す 1 つのオブジェクトが含まれています。

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

spec.deploymentSpec.replicationSpecs.numShards

タイプ: 整数

条件付き

シャーディングされたクラスターに配置するシャードの数を指定する正の整数。

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

Atlas は1から50までを受け入れます。 デフォルト値は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.

  実稼働環境では、単一のシャードを含むシャーディングされたクラスターを作成しないでください。単一シャードのシャード クラスターでは、マルチシャード構成と同じ利点は得られません。

  Tip

  • シャーディング

  • ノード数

警告

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

タイプ: 配列

必須

特定のリージョンに設定されたノードのハードウェア仕様。 各regionConfigsオブジェクトは、選挙におけるリージョンの優先順位と、Atlas がリージョンに配置する MongoDB ノードの数とタイプを表します。

各regionConfigsオブジェクトには、 analyticsSpecsオブジェクト、 electableSpecsオブジェクト、またはreadOnlySpecsオブジェクトのいずれかが必要です。

• M0、 M2 、またはM5クラスターではelectableSpecsのみが必要です。

• 専有クラスターはこれらの仕様のいずれかを指定できますが、 replicationSpec内に少なくとも 1 つのelectableSpecsオブジェクトが必要です。

• すべてのハードウェア仕様で同じinstanceSizeを使用する必要があります。

spec.deploymentSpec.replicationSpecs.regionConfigs.analyticsSpecs

型: オブジェクト

任意

リージョンで必要とされる分析ノードのハードウェア仕様。 分析ノードは、BI Connector for Atlas からのクエリのレポートなどの分析データを処理します。 分析ノードは読み取り専用であり、プライマリになることはできません。

このパラメーターを指定しない場合、Atlas はこのリージョンに分析を配置しません。

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

タイプ: ブール値

任意

このデータベース配置でディスクのオートスケーリングが有効になっているかどうかを示すフラグ。 このパラメータのデフォルトはtrueです。

• ディスクのオートスケーリングを有効にするには、 trueに設定します。

• ディスクのオートスケーリングを無効にするには、 falseに設定します。

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

タイプ: ブール値

任意

インスタンス サイズのオートスケーリングが有効になっているかどうかを示すフラグ。 このパラメータのデフォルトはfalseです。

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

• インスタンス サイズのオートスケーリングを無効にするには、 をfalseに設定します。

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

型: string

条件付き

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.

注意

オートスケーリングを有効にして、データベース配置の現在のインスタンスサイズよりも小さい最大インスタンスサイズを設定すると、Atlas は現在のインスタンスサイズを指定された最大値に自動的にスケーリングします。

たとえば、データベース配置の現在のインスタンス サイズがM40で、最大インスタンス サイズをM30に設定すると、Atlas は現在のインスタンス サイズを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 auto-scaling.

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

型: string

条件付き

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.

注意

オートスケーリングを有効にして、データベース配置の現在のインスタンスサイズよりも大きい最小インスタンスサイズを設定すると、Atlas は現在のインスタンスサイズを指定された最小値に自動的にスケーリングします。

たとえば、データベース配置の現在のインスタンス サイズがM10で、最小インスタンス サイズをM30に設定すると、Atlas は現在のインスタンス サイズを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 auto-scaling.

spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs

型: オブジェクト

任意

リージョン内の選択可能なノードのハードウェア仕様。 選挙可能なノードはプライマリになることができ、ローカル読み取りを有効にできます。

このオプションを指定しない場合、Atlas は選択可能なノードを リージョンに配置しません。

spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSize

型: string

条件付き

このリージョンのインスタンス サイズのハードウェア仕様。 各インスタンス サイズには、デフォルトのストレージとメモリ容量が設定されています。 選択したインスタンス サイズは、インスタンス サイズ内のすべてのデータを保持するホストに適用されます。 詳しくは、「 Amazon Web Services 」、「 GCP 」、およびAzureのカスタム ストレージ サイズを参照してください。

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 auto-scaling enabled. To learn more, see spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSize and spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSize.

注意

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

注意

この設定を変更して、M0 または Flex クラスターを M10+ クラスターにアップグレードできます。ただし、この設定を使用して、M0 または Flex クラスターを別の無料または Flex クラスターにアップグレードすることはできません

spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.nodeCount

タイプ: 整数

条件付き

Atlas が リージョンに配置する選択可能なノードの数。 選挙可能なノードはプライマリになることができ、ローカル読み取りを有効にできます。

すべてのreplicationSpecs.regionConfigsオブジェクトにわたるelectableSpecs.nodeCountの合計は、 3 、 5 、または7の合計が必要です。

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

spec.deploymentSpec.replicationSpecs.regionConfigs.priority

タイプ: 整数

必須

予備選挙が行われると、このリージョンに優先順位が与えられます。

regionConfigsにreadOnlySpecs 、 analyticsSpecs 、またはその両方がある場合は、この値を0に設定します。

複数のregionConfigsオブジェクト（クラスターがマルチリージョンまたはマルチクラウド）がある場合、それらの優先順位は降順である必要があります。 最も優先順位は7です。

例

最も優先度の高いリージョンを7に、2 番目に優先度の高いリージョンを6に、3 番目の優先度のリージョンを5に設定します。 選択可能なノードがない場合は、この値を0に設定します。

お使いのリージョンでelectableSpecs.nodeCountが1以上に設定されている場合、プライマリでない限り、 replicationSpecs.regionConfigs配列内の別のリージョンよりも優先度が 1 つだけ低い必要があります。 最も優先度の高いリージョンの優先度は、 7である必要があります。 最低の優先順位は1です。

優先度7リージョンは、クラスターの優先リージョンを識別します。 Atlas は優先リージョンにプライマリ ノードを配置します。 優先順位1から7は排他的です。特定の優先順位をクラスターごとに複数のリージョンに割り当てることはできません。

例

3 つのリージョンがある場合、優先順位はそれぞれ7 、 6 、 5になります。 選択可能なノードをサポートするためにさらに 2 つのリージョンを追加した場合、それらのリージョンの優先順位はそれぞれ4と3になります。

spec.deploymentSpec.replicationSpecs.regionConfigs.providerName

型: string

条件付き

Atlas がホストをプロビジョニングするクラウド サービス プロバイダー。

Amazon Web Services	Amazon Amazon Web Services
GCP	Google Cloud Platform
Azure	Microsoft Azure

spec.deploymentSpec.replicationSpecs.regionConfigs.regionName

型: string

条件付き

MongoDB クラスターの物理的なロケーション。 選択したリージョンは、データベースにアクセスするクライアントのネットワーク レイテンシに影響する可能性があります。

リージョン名の値の完全なリストについては、クラウドプロバイダーのリファレンス ページを参照してください。

• Amazon Web Services

• 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

型: オブジェクト

任意

リージョン内の読み取り専用ノードのハードウェア仕様。 読み取り専用ノードは プライマリ ノードになることはできませんが、ローカル読み取りを有効にできます。

このパラメーターを指定しない場合、Atlas は リージョンに読み取り専用ノードを配置しません。

spec.deploymentSpec.replicationSpecs.zoneName

型: string

任意

Human-readable label that identifies the zone in a Global Cluster. Provide this value only if you set spec.deploymentSpec.clusterType to GEOSHARDED.

spec.deploymentSpec.searchIndexes

タイプ: 配列

任意

検索インデックスを記述するフィールドを持つSearchIndexオブジェクトの配列。 各SearchIndexオブジェクトには次のフィールドが含まれています。

フィールド	タイプ	説明
name	string	このインデックスを識別する、人間が判読できるラベル。 配置に対して一意である必要があります。
DBName	string	1 つ以上の Atlas Search インデックスを持つコレクションを含む既存のデータベースを識別する、人間が判読できるラベル。 重要:指定するデータベースはすでに存在している必要があります。 既存のデータベースがない場合は、作成します 。
collectionName	string	1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。
type	string	インデックスのタイプ。 Atlas は次の値を受け入れます。 search vectorSearch
search	オブジェクト	typeがsearchである場合は、このオブジェクトを含める必要があります。 それ以外の場合は、省略します。
vectorSearch	オブジェクト	typeがvectorSearchである場合は、このオブジェクトを含める必要があります。 それ以外の場合は、省略します。

spec.deploymentSpec.searchIndexes.search

型: オブジェクト

任意

フィールド	タイプ	説明
synonyms	配列	このインデックス内の単語を同義語にマッピングするルール セット
mappings	オブジェクト	コレクションのフィールドのインデックス仕様 必須
searchConfigurationRef	オブジェクト	AtlasSearchIndexConfig カスタム リソースへの名前/名前空間参照（以下で説明）。 必須

spec.deploymentSpec.searchIndexes.search.synonyms

タイプ: 配列

任意

このインデックス内の単語を同義語にマッピングするルールセットを記述するフィールドを持つSynonymオブジェクトの配列。 各Synonymオブジェクトには次のフィールドが含まれています。

フィールド	タイプ	説明
name	string	シノニム（同意語）の定義を識別する、人間が判読可能なラベル。 各名前は同じインデックス定義内で一意である必要があります 必須
analyzer	string	検索するシノニム（同意語）に適用するために選択された特定の定義済みメソッド。 可能な値は次のとおりです。 lucene.standard lucene.standard lucene.simple lucene.whitespace lucene.keyword lucene.arabic lucene.argenian lucene.basque lucene. envelope 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	オブジェクト	1 つ以上の単語が、それらの単語の 1 つ以上のシノニム（同意語）にマップされるのを保存するデータセット 必須

spec.deploymentSpec.searchIndexes.search.synonyms.source

型: オブジェクト

必須

フィールド	タイプ	説明
collection	string	単語とそのシノニム（同意語）を保存する MongoDB コレクションを識別する、人間が判読可能なラベル 必須

spec.deploymentSpec.searchIndexes.search.mappings

型: オブジェクト

必須

コレクションのフィールドのインデックス仕様を持つオブジェクト:

dynamic	ブール値	インデックスが動的マッピングを使用するか、静的マッピングを使用するかを示すフラグ。 mappings.fields が省略されている場合は必須です。
fields	JSON/YAML	Atlas Search インデックスの 1 つ以上のフィールド仕様。 mappings.dynum が省略されているか、false に設定されている場合は必須です。

spec.deploymentSpec.searchIndexes.vectorSearch

型: オブジェクト

任意

フィールド	タイプ	説明
fields	JSON/YAML	JSONオブジェクトの配列。https://docub.mongodb.org/core/avs-vector-type 必須

spec.deploymentSpec.searchNodes

タイプ: 配列

任意

検索ノード構成の配列。 各要素には 2 つのフィールドが含まれています。

フィールド	タイプ	説明
nodeCount	integer	クラスター内の検索ノードの数。 Atlas は2から32までの値を受け入れます。 デフォルトの数値は2です。
instanceSize	string	検索ノード インスタンス サイズのハードウェア仕様。 Atlas は次のいずれかを受け付けます。 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 デフォルトのインスタンス サイズはS20_HIGHCPU_NVMEです。

spec.deploymentSpec.tags

タイプ: 配列

任意

データベース配置をよりよく理解、整理し、識別するためのタグ（キーと値のペア）を含むリスト。 詳細については、「クラスターのタグ 」を参照してください。

spec.deploymentSpec.terminationProtectionEnabled

タイプ: ブール値

クラスターの終了保護が有効になっているか無効になっているかを示します。 true に設定されていると、Atlas はクラスターを削除しません。 false に設定されていると、Atlas はクラスターを削除します。 デフォルトはfalse です。

spec.deploymentSpec.versionReleaseSystem

型: string

条件付き

Atlas がこのクラスターに使用するリリース ケイデンス。 Atlas では以下に対応しています。

• CONTINUOUS: Atlas は、最新の MongoDB リリースを使用してクラスターを作成します。 Atlas は、MongoDB の最新のメジャー リリースと Rapid Release が利用可能になると、クラスターを自動的に更新します。

• 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

型: string

条件付き

配置が属するプロジェクトのID 。 既存の Atlas プロジェクト のプロジェクトIDを指定する必要があります。このパラメーターは、次のいずれかによって管理されるプロジェクトに属する配置に必要です。

• Atlas Kubernetes Operator の別のインスタンス

• Atlas Kubernetes Operator 以外のツール

Atlas Kubernetes Operator の同じインスタンスによって管理されるプロジェクトに属する配置では、 spec.externalProjectRef.id を使用しない場合は spec.projectRef.name を使用します。

spec.flexSpec

タイプ: 配列

条件付き

注意

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

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

Flex クラスターの名前を識別する string。

spec.flexSpec.tags

タイプ: 配列

任意

データベース配置をよりよく理解、整理し、識別するためのタグ（キーと値のペア）を含むリスト。 詳細については、「クラスターのタグ 」を参照してください。

spec.flexSpec.terminationProtectionEnabled

タイプ: ブール値

Flex クラスターの終了保護が有効になっているか無効になっているかを示します。 true に設定されていると、Atlas はクラスターを削除しません。 false に設定されていると、Atlas はクラスターを削除します。 デフォルトはfalse です。

spec.flexSpec.providerSettings.backingProviderName

型: string

Flex クラスターのクラウドプロバイダーの名前。 providerSettings には、 MongoDB が実行されるプロビジョニングされたホストの 設定を指定する構成が含まれます。

Atlas は、次のいずれかの値を受け入れます。

• AWS

• AZURE

• GCP

spec.flexSpec.providerSettings.regionName

型: string

MongoDB Flex クラスターの物理的なロケーション。 選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。

リージョン名の値の完全なリストについては、クラウドプロバイダーのリファレンス ページを参照してください。

• Amazon Web Services

• GCP

• Azure

spec.processArgs

型: オブジェクト

任意

Object that contains the additional configuration options for your cluster.

spec.processArgs.defaultReadConcern

型: string

任意

このクラスターの読み取り操作に対して MongoDB から要求される確認応答のデフォルト レベルを示す string。

MongoDB 5.0クラスターのデフォルトはローカルです。

spec.processArgs.defaultWriteConcern

型: string

任意

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

タイプ: ブール値

任意

クラスターが JavaScript のサーバー側実行を実行する操作の実行を許可するかどうかを示すフラグ。

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

spec.processArgs.minimumEnabledTlsProtocol

タイプ: 整数

任意

string で、着信接続に対してクラスターが許可する最小 TLS バージョンを示します。TLS1.0 または1.1 1.2を使用するクラスターでは、最小 TLS プロトコル バージョンとして TLS を設定することを検討する必要があります。

詳細については、「 Atlas はどのバージョンの TLS をサポートしていますか 」を参照してください。

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

spec.processArgs.noTableScan

タイプ: ブール値

任意

結果を返すためにコレクションスキャンが必要なクエリについて、クラスターで実行が無効化されているかどうかを示すフラグ。

This option corresponds to the notablescan mongod parameter.

spec.processArgs.oplogSizeMB

タイプ: 整数

任意

クラスターの oplog のストレージ制限をメガバイト単位で示す数値。 nullの値は、Atlas が計算するデフォルトの oplog サイズをクラスターが使用することを示します。

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

spec.processArgs.sampleRefreshIntervalBIConnector

タイプ: 整数

任意

スキーマ情報の収集時にサンプリングするデータベースあたりのドキュメント数を示す数値。

このパラメーターは、 sampleSize mongosqldオプションに対応します。

spec.processArgs.sampleSizeBIConnector

タイプ: 整数

任意

mongosqld プロセスがデータを再サンプリングしてリレーショナル スキーマを作成する間隔を秒単位で示す数値。

This parameter corresponds to the sampleRefreshIntervalSecs mongosqld option.

spec.projectRef.name

型: string

条件付き

配置が属するプロジェクトの名前。 既存のAtlasProject カスタム リソース を指定する必要があります。このパラメーターは、同じインスタンスAtlas Kubernetes Operator によって管理されるプロジェクトに属する配置にのみ適用されます。

次のいずれかによって管理されるプロジェクトに属する配置の場合、次のいずれかによって管理されます。

• Atlas Kubernetes Operator の別のインスタンス

• Atlas Kubernetes Operator 以外のツール

spec.externalProjectRef.id を使用します。

spec.serverlessSpec

タイプ: 配列

条件付き

注意

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

APIからのサーバーレスインスタンスパラメーターが格納されたリスト。利用可能なパラメーターの完全なリストについては、 Atlas Flex Clusters API を参照してください。

重要

構成でspec.deploymentSpecまたはspec.flexSpecを指定する必要があります。

spec.upgradeToDedicated

タイプ: ブール値

任意

このフラグで、true に設定すると、Flex クラスターから Device 専用クラスターへのインプレース アップグレードがトリガーされます。

省略した場合、デフォルトは false になります。移行プロセスの詳細なウォークスルーについては、「Flex クラスターを専用クラスターに移行する」を参照してください。

重要

また、spec.deploymentSpec ブロックには、ターゲット専有クラスターの完全な構成を指定する必要があります。この操作は一方向であり、元に戻すことができません。

spec.serverlessSpec.privateEndpoints

タイプ: 配列

任意

注意

Atlas は M2 および M5 クラスターとサーバーレス インスタンスを非推奨にしました。Atlas は、すべての M2 クラスターと M5 クラスターを Flex クラスターに移行しました。サーバーレスインスタンスの場合、Atlas は使用状況に応じて インスタンスを 無料クラスター、 Flex クラスター、または 専有クラスターに移行しました。

API の下位互換性を一定期間維持するため、Atlas では、Atlas Kubernetes Operator を使用する場合を含め、これらの移行クラスターを同じ API（古い API と新しい API）で管理できるようにします。 API の下位互換性は、古い2026 API が削除され、Flex クラスターに関連する API のみが残ります。

サーバーレスインスタンス上のプライベートエンドポイントのサポートは 3 月 2025 日で終了しました。2025 までにプライベートエンドポイントを除くために、Atlas Kubernetes Operator の構成を更新する必要があります。残りのすべての M2、M5、およびサーバーレスインスタンス機能を Atlas Kubernetes Operator 構成から 2026 年 1 月前に除く必要があります。

If your workloads require Private Endpoints or Continuous Backup, switch to Atlas Dedicated Clusters. To learn more, see Migration to Flex Clusters and the Atlas Flex Migration Guide.

非推奨。 このパラメーターが存在する場合は削除します。 サーバーレスインスタンスのプライベートエンドポイント構成が格納されたリスト。

spec.serverlessSpec.providerSettings

型: オブジェクト

条件付き

注意

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

MongoDB が実行されるプロビジョニングされたホストの 設定を指定する構成。 利用可能なオプションは、クラウドサービス プロバイダーに固有です。 詳しくは、「 Amazon Web Services 」 、 「 GCP 」 、およびAzure Serverlessインスタンスの構成オプションを参照してください。

サーバーレスインスタンスを作成または更新する場合は、この設定を指定する必要があります。

重要

次の設定は非推奨であり、将来のリリースで削除される予定です。

• spec.serverlessSpec.providerSettings.DiskIOPS

• spec.serverlessSpec.providerSettings.DiskTypeName

• spec.serverlessSpec.providerSettings.EncryptEBSVolume

• spec.serverlessSpec.providerSettings.InstanceSizeName

• spec.serverlessSpec.providerSettings.VolumeType

• spec.serverlessSpec.providerSettings.AutoScaling

これらの設定のいずれかに値を指定しても効果はありません。

spec.serverlessSpec.providerSettings.providerName

型: string

条件付き

注意

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

Atlas が サーバーレスインスタンスのホストをプロビジョニングするクラウド サービス プロバイダー。

Atlas は次の値を受け入れます。

Amazon Web Services	Amazon Amazon Web Services
GCP	Google Cloud Platform
Azure	Microsoft Azure

spec.serverlessSpec.providerSettings.regionName

型: string

条件付き

注意

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

MongoDBサーバーレスインスタンスの物理的なロケーション。 選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。

リージョン名の値の完全なリストについては、クラウドプロバイダーのリファレンス ページを参照してください。

• Amazon Web Services

• GCP

• Azure

spec.serverlessSpec.tags

注意

変更に関する詳細な情報については、「 フレキシブルなクラスターへの移行に関するノート 」を参照してください。

タイプ: 配列

任意

データベース配置をよりよく理解、整理し、識別するためのタグ（キーと値のペア）を含むリスト。 詳細については、「クラスターのタグ 」を参照してください。

status.connectionStrings

タイプ: 配列

必須

クラスターにアクセスするための接続 URL が格納されたリスト。 このパラメーターは、クラスターを作成またはアップデートした後に表示されます。

注意

... include:：/includes/fact-ask8so- connection-strings.rst

APIからクラスターで利用可能な構成パラメーターについては、「 Atlas Clusters API 」を参照してください。