AtlasDeployment カスタム リソース

例

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: default
  labels:
    app.kubernetes.io/version: 1.6.0
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: test-cluster
    tags:
    - key: "environment",
      value: "production"
    providerSettings:
      instanceSizeName: M10
      providerName: AWS
      regionName: US_EAST_1
    mongoDBMajorVersion: "4.4"
status:
  conditions:
  - lastTransitionTime: "2021-03-18T16:32:43Z"
    status: "True"
    type: Ready
  - lastTransitionTime: "2021-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: 4.4.4
  mongoURIUpdated: "2021-03-12T12:21:41Z"
  observedGeneration: 1
  stateName: IDLE

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: development
  deploymentSpec:
    autoScaling:
      compute:
        enabled: true
        scaleDownEnabled: true
    clusterType: REPLICASET
    name: service-name
    tags:
    - key: "environment",
      value: "production"
    providerBackupEnabled: true
    providerSettings:
      autoScaling:
        compute:
          maxInstanceSize: M40
          minInstanceSize: M30
      instanceSizeName: M30
      providerName: GCP
    replicationSpecs:
      - numShards: 1
        regionsConfig:
          EASTERN_US:
            analyticsNodes: 0
            electableNodes: 1
            priority: 6
            readOnlyNodes: 0
          SOUTH_AMERICA_EAST_1:
            analyticsNodes: 0
            electableNodes: 2
            priority: 7
            readOnlyNodes: 0
        zoneName: Zone 1

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  labels:
    app.kubernetes.io/version: 1.6.0
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: Test-cluster
    tags:
    - key: "environment",
      value: "production"
    providerSettings:
      instanceSizeName: M10
      providerName: AWS
      regionName: US_EAST_1
  processArgs:
    javascriptEnabled: false

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
  labels:
    app.kubernetes.io/version: 1.6.0
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
  labels:
    app.kubernetes.io/version: 1.6.0
spec:
  projectRef:
    name: my-project
  advancedDeploymentSpec:
    clusterType: REPLICASET
    name: tenantCluster
    tags:
    - key: "environment",
      value: "production"
    replicationSpecs:
      - regionConfigs:
        - electableSpecs:
            instanceSize: M5
          providerName: AWS
          regionName: US_EAST_1

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  labels:
    app.kubernetes.io/version: 1.6.0
spec:
  projectRef:
    name: my-project
  advancedDeploymentSpec:
    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

パラメーター

このセクションでは、使用可能な主要なAtlasDeploymentカスタム リソース パラメータの一部について説明します。 クラスターで使用可能なパラメーターの完全なリストについては、 Atlas Clusters APIおよび Atlas Advanced Clusters API を参照してください。 サーバーレスインスタンスで使用できるパラメーターの完全なリストについては、「 Atlas Serverless Instances API 」を参照してください。

これらの説明、利用可能な例、 APIドキュメントを参照して、仕様をカスタマイズします。

spec.advancedDeploymentSpec

タイプ: 配列

条件付き

APIからの高度なクラスター パラメーターが含まれるリスト。 使用可能なパラメーターの完全なリストについては、 Atlas Advanced Clusters API を参照してください。

重要

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

spec.advancedDeploymentSpec.customZoneMapping

タイプ: 配列

必須

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

spec.advancedDeploymentSpec.customZoneMapping.location

型: string

必須

グローバルクラスター内のゾーンにマッピングするロケーションを表すコード。

spec.advancedDeploymentSpec.customZoneMapping.zone

型: string

必須

グローバルクラスター内のゾーンを識別する、人間が判読できるラベル。

spec.advancedDeploymentSpec.diskSizeGB

タイプ: 数値

任意

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

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

注意

いずれのリージョンでdiskGBのオートスケーリングを有効にしている場合は、このオプションを編集することはできません。 詳しくは、 spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabledを参照してください。

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

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

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

Atlas は単一のレプリカセットのディスク容量に制限があり、上位のクラスター階層では4 TB までスケールアップされます。 デフォルトの制限を超えてクラスターの合計ストレージを拡張するには、プロジェクト設定で拡張ストレージを有効にします。 将来のさらなるスケーリングに対応するため、長期的に展開できるようシャーディングを有効にすることをお勧めします。

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

詳細については、「ストレージ容量 」を参照してください。

spec.advancedDeploymentSpec.managedNamespaces

タイプ: 配列

必須

作成する指定されたグローバルクラスターに管理対象名前空間を作成するための情報を含むリスト。 使用可能なパラメーターの完全なリストについては、 Atlas Global Clusters API を参照してください。

spec.advancedDeploymentSpec.managedNamespaces.collection

型: string

必須

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

spec.advancedDeploymentSpec.managedNamespaces.db

型: string

必須

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

spec.advancedDeploymentSpec.managedNamespaces.isCustomShardKeyHashed

タイプ: ブール値

任意

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

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

• コレクションのカスタム シャードキーを無効にするには、 をfalseに設定します。 無効にすると、MongoDB は範囲シャーディングを使用します。

詳細については、「ハッシュされたシャードキー 」を参照してください。

spec.advancedDeploymentSpec.managedNamespaces.isCustomShardKeyUnique

タイプ: ブール値

任意

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

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

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

spec.advancedDeploymentSpec.managedNamespaces.numInitialChunks

タイプ: 整数

任意

空の コレクションをハッシュされたシャードキー でシャーディングするときに最初に作成するチャンクの最小数。

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

spec.advancedDeploymentSpec.managedNamespaces.presplitHashedZones

タイプ: ブール値

任意

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

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

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

spec.advancedDeploymentSpec.pitEnabled

タイプ: ブール値

条件付き

高度なクラスターの継続的なクラウドバックアップを可能にする構成。 継続的なクラウドバックアップを有効にするには、 trueの値を指定してこの設定を指定する必要があります。 標準クラスターについては、 spec.deploymentSpec.pitEnabledを参照してください。

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs

タイプ: 配列

必須

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

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

• M0、 M2 、またはM5` clusters require only ``electableSpecs 。

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

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

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.analyticsSpecs

型: オブジェクト

任意

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

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

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabled

タイプ: ブール値

任意

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

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

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

選択したクラスター階層の RAM の最大量と oplog サイズによって、ストレージのオートスケーリングが制限される可能性があります。 詳しくは、「ストレージをカスタマイズする 」を参照してください。

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabled

タイプ: ブール値

任意

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

• インスタンス サイズのオートスケーリングを有効にするには、 trueに設定します。 有効にする場合は、 spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSizeの値を指定する必要があります。

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

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSize

型: string

条件付き

データベース配置がオートスケーリングできる最大インスタンス サイズを示すstring （M40 など）。 spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabledをtrueに設定する場合は、このパラメータを指定する必要があります。

注意

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

たとえば、データベース配置の現在のインスタンス サイズがM40で、最大インスタンス サイズをM30に設定すると、Atlas は現在のインスタンス サイズをM30に自動的にスケーリングします。

Atlas が現在のインスタンス サイズを変更しており、Atlas Kubernetes Operator のspec.deploymentSpec.providerSettings.instanceSizeNameを変更して新しいインスタンス サイズと一致しない場合、Atlas Kubernetes Operator はログに警告を表示しますが、オートスケーリングを妨げるものではありません。

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSize

型: string

条件付き

データベース配置がオートスケーリングできる最小インスタンスサイズを示すstring （M10 など）。 spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabledをtrueに設定する場合は、このパラメータを指定する必要があります。

注意

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

たとえば、データベース配置の現在のインスタンス サイズがM10で、最小インスタンス サイズをM30に設定すると、Atlas は現在のインスタンス サイズをM30に自動的にスケーリングします。

Atlas が現在のインスタンス サイズを変更しており、Atlas Kubernetes Operator のspec.deploymentSpec.providerSettings.instanceSizeNameを変更して新しいインスタンス サイズと一致しない場合、Atlas Kubernetes Operator はログに警告を表示しますが、オートスケーリングを妨げるものではありません。

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.electableSpecs

型: オブジェクト

任意

リージョン内の選択可能なノードのハードウェア仕様。 選挙可能なノードは :primary になり、ローカル読み取りを有効にできます。

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

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSize

型: string

条件付き

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

シャーディングされたクラスター 、またはグローバルクラスターを配置する場合は、 M30以上のインスタンス サイズを選択する必要があります。

注意

コンピュート フィールドでオートスケーリングを有効にしている場合、このオプションは編集できません。 詳しくはspec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabledを参照してください。

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.electableSpecs.nodeCount

タイプ: 整数

条件付き

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

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

spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.priorityが0の場合、選択可能なノードを作成することはできません。

spec.advancedDeploymentSpec.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.advancedDeploymentSpec.replicationSpecs.regionConfigs.readOnlySpecs

型: オブジェクト

任意

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

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

spec.advancedDeploymentSpec.tags

タイプ: 配列

任意

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

spec.backupRef

型: オブジェクト

任意

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

spec.backupRef.name

型: string

任意

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

このパラメーターを指定しない場合、Atlas はこのクラスターにバックアップ構成を適用しません。

spec.backupRef.namespace

型: string

任意

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

spec.deploymentSpec

タイプ: 配列

条件付き

APIからのクラスター パラメーターが含まれるリスト。 使用可能なパラメーターの完全なリストについては、 Atlas Clusters API を参照してください。

重要

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

spec.deploymentSpec.clusterType

型: string

条件付き

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

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

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

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

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

spec.deploymentSpec.customZoneMapping

タイプ: 配列

必須

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

spec.deploymentSpec.customZoneMapping.location

型: string

必須

グローバルクラスター内のゾーンにマッピングするロケーションを表すコード。

spec.deploymentSpec.customZoneMapping.zone

型: string

必須

グローバルクラスター内のゾーンを識別する、人間が判読できるラベル。

spec.deploymentSpec.encryptionAtRestProvider

型: string

任意

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

詳細については、「 KMSを使用したデータの暗号化 」を参照してください。

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

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

spec.deploymentSpec.managedNamespaces

タイプ: 配列

必須

作成する指定されたグローバルクラスターに管理対象名前空間を作成するための情報を含むリスト。 使用可能なパラメーターの完全なリストについては、 Atlas Global Clusters API を参照してください。

spec.deploymentSpec.managedNamespaces.collection

型: string

必須

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

spec.deploymentSpec.managedNamespaces.db

型: string

必須

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

spec.deploymentSpec.managedNamespaces.isCustomShardKeyHashed

タイプ: ブール値

任意

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

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

• コレクションのカスタム シャードキーを無効にするには、 をfalseに設定します。 無効にすると、MongoDB は範囲シャーディングを使用します。

詳細については、「ハッシュされたシャードキー 」を参照してください。

spec.deploymentSpec.managedNamespaces.isCustomShardKeyUnique

タイプ: ブール値

任意

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

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

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

spec.deploymentSpec.managedNamespaces.numInitialChunks

タイプ: 整数

任意

空の コレクションをハッシュされたシャードキー でシャーディングするときに最初に作成するチャンクの最小数。

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

spec.deploymentSpec.managedNamespaces.presplitHashedZones

タイプ: ブール値

任意

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

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

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

spec.deploymentSpec.mongoDBMajorVersion

型: string

任意

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

• 4.4

• 5.0

• 6.0

• 7.0

• 8.0

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

条件	結果
このパラメータを省略し、spec.deploymentSpec.versionReleaseSystem パラメータを省略します。	Atlas は MongoDB 6.0 を実行するクラスターを配置します。
このパラメータを省略し、spec.deploymentSpec.versionReleaseSystem パラメータをLTS に設定します。	Atlas は MongoDB 6.0 を実行するクラスターを配置します。
spec.deploymentSpec.providerSettings.instanceSizeNameパラメータをM0 、M2 、またはM5 に設定します。	MongoDB 6.0 を配置する必要があります。
このパラメーターを指定します。	Atlas は、指定されたバージョンの最新の安定したパッチ リリースを使用してクラスターを常にデプロイします。
spec.deploymentSpec.versionReleaseSystemパラメータをCONTINUOUS に設定します。	このパラメーターは省略する必要があります。

spec.deploymentSpec.pitEnabled

タイプ: ブール値

条件付き

継続的なクラウドバックアップを可能にする構成。 継続的なクラウドバックアップを有効にするには、 trueの値を指定してこの設定を指定する必要があります。 高度なクラスターについては、 spec.advancedDeploymentSpec.pitEnabledを参照してください。

spec.deploymentSpec.providerSettings

型: オブジェクト

条件付き

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

クラスターを作成または更新する場合は、この設定を指定する必要があります。

spec.deploymentSpec.providerSettings.providerName

型: string

条件付き

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

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

spec.deploymentSpec.providerSettings.instanceSizeName

型: string

必須

Atlas には、それぞれデフォルトのストレージ容量と RAM サイズが設定されたさまざまなクラスター階層が提供されています。 選択したクラスターは、クラスター内のすべてのデータ保持サーバーに使用されます。 詳しくは、「 Amazon Web Services 」、「 GCP 」、およびAzureのカスタム ストレージ サイズを参照してください。

クラスターを配置した後にインスタンス サイズ名を変更すると、Atlas はデータベース配置を指定したインスタンス サイズに変更します。ただし、オートスケーリングが有効になっている状態でspec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSizeとspec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSizeで指定した範囲外である場合に限ります。 詳しくは、 spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSizeとspec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSizeを参照してください。

注意

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

spec.deploymentSpec.providerSettings.regionName

型: string

条件付き

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

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

• Amazon Web Services

• GCP

• Azure

マルチリージョンクラスターについては、 spec.deploymentSpec.replicationSpecsを参照してください。 spec.deploymentSpec.providerSettings.regionNameまたはspec.deploymentSpec.replicationSpecsのいずれかを設定する必要があります。

spec.deploymentSpec.replicationSpecs

タイプ: オブジェクトの配列

条件付き

クラスター リージョンの構成を含むリスト。 マルチリージョンクラスターには、このパラメーターを使用します。 spec.deploymentSpec.providerSettings.regionNameまたはspec.deploymentSpec.replicationSpecsのいずれかを設定する必要があります。

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

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

このパラメータを指定する場合は、 spec.deploymentSpec.clusterTypeとspec.deploymentSpec.replicationSpecs.numShardsも指定する必要があります。

spec.deploymentSpec.replicationSpecs.numShards

タイプ: 整数

条件付き

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

spec.deploymentSpec.replicationSpecsパラメーターを使用する場合は、このパラメーターを設定する必要があります。

Atlas は1から50までを受け入れます。 デフォルト値は1です。

• 1の値を指定し、 spec.deploymentSpec.clusterTypeをSHARDEDに設定すると、Atlas は単一シャードのシャーディングされたクラスターを配置します。

• 1を指定し、 spec.deploymentSpec.clusterTypeをREPLICASETに設定すると、Atlas はレプリカセットを配置します。

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

  Tip

  • シャーディング

  • ノード数

spec.deploymentSpec.replicationSpecs.zoneName

型: string

任意

グローバルクラスター内の ゾーンを識別する、人間が判読可能なラベル。 この値は、 spec.deploymentSpec.clusterTypeをGEOSHARDEDに設定した場合にのみ指定します。

spec.deploymentSpec.tags

タイプ: 配列

任意

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

spec.deploymentSpec.versionReleaseSystem

型: string

条件付き

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

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

• LTS: Atlas は、 spec.deploymentSpec.mongoDBMajorVersionパラメータで指定した MongoDB バージョンの最新パッチ リリースを使用してクラスターを作成します。 Atlas は、クラスターをこの MongoDB バージョンの後続のパッチ リリースに自動的に更新します。 Atlas は、MongoDB の新しい Rapid Release またはメジャー リリースが利用可能になると、クラスターを更新しません。

  省略した場合、デフォルトは LTS になります。

  このパラメータをCONTINUOUSに設定する場合は、 spec.deploymentSpec.mongoDBMajorVersionパラメータを省略する必要があります。

spec.processArgs

型: オブジェクト

任意

クラスターの詳細構成オプションを含むオブジェクト。

spec.processArgs.defaultReadConcern

型: string

任意

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

MongoDB 4.4クラスターはデフォルトで利用可能です。

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

spec.processArgs.defaultWriteConcern

型: string

任意

このクラスターに対して設定された書込み (write) 操作に対して MongoDB から要求される確認応答のデフォルト レベルを示す string。

MongoDB 4.4クラスターのデフォルトは1です。

MongoDB バージョン5.0以降のクラスターのデフォルトは過半数です。

spec.processArgs.failIndexKeyTooLong

タイプ: ブール値

任意

すべてのインデックスエントリが1024バイトを超えるドキュメントを挿入または更新するときに、操作を失敗させエラーを返すかどうかを示すフラグ。 これをfalseに設定すると、 mongodはこの制限を超えるドキュメントを書込みますが、インデックスは作成しません。

このオプションはparam.failIndexKeyTooLong mongodパラメータに相当します。

spec.processArgs.javascriptEnabled

タイプ: ブール値

任意

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

• MongoDB 4.4未満のバージョンでクラスターを実行する場合、このオプションはクラスター内の各mongodのsecurity.javascriptEnabled 構成ファイル オプションの変更に対応します。

• MongoDB バージョン4.4以上でクラスターを実行している場合、このオプションは、クラスター内の各mongodおよびmongosのsecurity.javascriptEnabled 構成ファイル オプションの変更に対応します。

spec.processArgs.minimumEnabledTlsProtocol

タイプ: 整数

任意

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

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

このオプションは、 net.ssl.disabledProtocols mongod構成ファイル オプションに相当します。

spec.processArgs.noTableScan

タイプ: ブール値

任意

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

このオプションはnotablescan mongodパラメーターに相当します。

spec.processArgs.oplogSizeMB

タイプ: 整数

任意

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

このオプションは、 replication.oplogSizeMB mongod構成ファイル オプションに相当します。

spec.processArgs.sampleRefreshIntervalBIConnector

タイプ: 整数

任意

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

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

spec.processArgs.sampleSizeBIConnector

タイプ: 整数

任意

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

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

spec.projectRef.name

型: string

必須

クラスターが属するプロジェクトの名前。 既存のAtlasProjectカスタム リソースを指定する必要があります。

spec.serverlessSpec

タイプ: 配列

条件付き

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

重要

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

spec.serverlessSpec.privateEndpoints

タイプ: 配列

任意

サーバーレスインスタンスのプライベートエンドポイント構成が格納されたリスト。

spec.serverlessSpec.providerSettings

型: オブジェクト

条件付き

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

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

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 が格納されたリスト。 このパラメーターは、クラスターを作成またはアップデートした後に表示されます。

注意

接続URL を直接使用することはできません。Atlas クラスターには認証が必要です。Kubernetesクラスター内のアプリケーションがAtlas クラスターに接続する前に、少なくとも 1 つのAtlasDatabaseUser カスタム リソースを作成する必要があります。Atlas Kubernetes Operator は、プロジェクト内の各クラスターとデータベースユーザーの組み合わせに対して特別なシークレットを作成します。Kubernetesクラスター内のアプリケーションは、このシークレットを使用して Atlas クラスターに接続できます。AtlasDatabaseUser カスタムリソースの spec.scopes パラメータは、データベースユーザーを作成するクラスターを制限します。

APIからクラスターおよび高度なクラスターで使用できる構成パラメーターについては、 Atlas Clusters APIおよびAdvanced Clusters API を参照してください。