クラスター構成ファイル

項目一覧

必要なクラスター設定

任意および条件付きクラスター設定
クラスター構成ファイルの例
マルチクラウドクラスター構成ファイルの例
ジオシャーディングされたクラスターの構成ファイルの例

Atlas CLI を使用してクラスターを作成または更新する際に必要な設定を指定するには、クラスター構成ファイルを使用します。 Atlas CLI は .jsonクラスター構成ファイルを受け入れます。

以下のリソースを使用して、次のことを行います。

クラスター構成ファイルで指定できる必須設定について説明します。
サンプル構成ファイルの表示とコピー

必要なクラスター設定

Atlas では、 Atlas CLI を使用してクラスターを作成するには、次の設定が必要です。これらのクラスター設定は、構成ファイルで、またはコマンドのフラグとして指定する必要があります。

フィールド	タイプ	説明
`clusterType`	string	作成するクラスターのタイプを示す、人間が判読可能なラベル。 Values include: `REPLICASET`, `SHARDED`, or `GEOSHARDED`.
`name`	string	クラスターを識別する人間が判読できるラベル。
`replicationSpecs`	配列	クラスターリージョンとそのリージョンにプロビジョニングされたハードウェアの構成設定が格納されたリスト。
`replicationSpecs.` `regionConfigs`	配列	指定したリージョン内のノードセットのハードウェア仕様が格納されたリスト。各`regionConfigs`オブジェクトは、選挙におけるリージョンの優先順位と、Atlas がリージョンに配置する MongoDB ノードの数とタイプを表します。各`regionConfigs`オブジェクトには、 `analyticsSpecs`オブジェクト、 `electableSpecs`オブジェクト、または`readOnlySpecs`オブジェクトのいずれかが必要です。共有クラスターには`electableSpecs`のみが必要です。専有クラスターはこれらの仕様のいずれかを指定できますが、 `replicationSpec`内に少なくとも 1 つの`electableSpecs`オブジェクトが必要です。すべてのハードウェア仕様で同じ`instanceSize`を使用する必要があります。
`replicationSpecs.` `regionConfigs.electableSpecs`	オブジェクト	リージョン内の選択可能なノードのハードウェア仕様。選挙可能なノードはプライマリになることができ、ローカル読み取りを有効にできます。
`replicationSpecs.` `regionConfigs.` `electableSpecs.instanceSize`	string	このリージョンのインスタンスサイズのハードウェア仕様。詳細については、「クラスター階層の選択」を参照してください。
`replicationSpecs` `.regionConfigs.` `electableSpecs.nodeCount`	数値	Atlas がリージョンに配置する選択可能なノードの数。選挙可能なノードはプライマリになることができ、ローカル読み取りを有効にできます。すべての replicationSpecs[n].regionConfigs[m] オブジェクトにわたる選択可能なSpecs.nodeCount の合計は 3、5、または 7 である必要があります。
`replicationSpecs.` `regionConfigs.priority`	整数	予備選挙が行われたときにこのリージョンに与えられる優先順位。お使いのリージョンで`electableSpecs.nodeCount`が`1`以上に設定されている場合、 `replicationSpecs[n].regionConfigs[m]`配列の別のリージョンよりも優先度が 1（1）小さくなければなりません。最も優先度の高いリージョンの優先度は、 `7`である必要があります。最低の優先順位は`1`です。優先度`7`リージョンは、クラスターの推奨リージョンを識別します。 Atlas は、プライマリノードを優先リージョンに配置します。
`replicationSpecs.` `regionConfigs.providerName`	string	クラウドサービスプロバイダーを識別する、人間が判読可能なラベル。値には、 `AWS` 、 `AZURE` 、または`GCP`が含まれます。マルチクラウドクラスターを作成するには、`regionConfigs` オブジェクトに複数のサービスプロバイダーを指定します。詳しくは、マルチクラウドの例構成ファイルを参照してください
`replicationSpecs.` `regionConfigs.regionName`	string	クラスターノードの物理的なロケーションを示す、人間が判読可能なラベル。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。リージョン名の値の完全なリストについては、クラウドプロバイダーのリファレンスページを参照してください。 Amazon Web Services GCP Azure

任意および条件付きクラスター設定

クラスター構成ファイルには、追加のオプションまたは条件付きのクラスター設定が含まれている場合があります。 GEOSHARDEDのclusterTypeを選択した場合は、構成ファイルまたはコマンドのフラグとして次のクラスター設定を指定する必要があります。

フィールド	タイプ	説明
`replicationSpecs.` `numShards`	string	指定された各ゾーンに配置するシャードの数を指定する正の整数。 `SHARDED`または`GEOSHARDED`の`clusterType`を設定する場合は、この値を指定します。 `REPLICASET`の`clusterType`を選択した場合は、この値を省略します。この API リソースは、 `1`から`50`までを受け入れます。このパラメータのデフォルトは`1`です。の`numShards` 値と`1` `clusterType`の`SHARDED` 値を指定すると、Atlas は単一シャードのシャーディングされたクラスターを配置します。実稼働環境では、単一のシャードを含むシャーディングされたクラスターを作成しないでください。単一シャードのシャードクラスターでは、マルチシャード構成と同じ利点は得られません。
`replicationSpecs.` `zoneName`	string	グローバルクラスター内のゾーンの名前。 `clusterType`を`GEOSHARDED`に設定する場合は、この値を指定します。
`tags`	配列	クラスターにタグを付けて分類する、長さが1から255文字の間のキーと値のペアを含むリスト。
`tags.key`	string	タグのセットを定義する定数。たとえば、 `environment : production`タグ内の`environment` 。
`tags.value`	string	タグのセットに属する変数。たとえば、 `environment : production`タグ内の`production` 。

利用可能な設定の完全なリストについては、「 1 つのプロジェクトから 1 つのマルチクラウドクラスターを作成する」の API ドキュメントを参照してください。

クラスター構成ファイルの例

単一のクラウドプロバイダーを使用してクラスターを作成するには、次のサンプルファイルに示すように、 regionConfigsオブジェクトに同じサービスプロバイダーを指定します。

{
  "name":"myCluster",
  "clusterType":"REPLICASET",
  "replicationSpecs":[
    {
      "regionConfigs":[
        {
          "electableSpecs":{
            "instanceSize":"M30",
            "nodeCount":1
          },
          "priority":7,
          "providerName":"AWS",
          "regionName":"EU_WEST_1"
        },
        {
          "electableSpecs":{
            "instanceSize":"M30",
            "nodeCount":1
          },
          "priority":6,
          "providerName":"AWS",
          "regionName":"US_EAST_1"
        },
        {
          "electableSpecs":{
            "instanceSize":"M30",
            "nodeCount":1
          },
          "priority":5,
          "providerName":"AWS",
          "regionName":"US_WEST_1"
        }
      ]
    }
  ]
}

マルチクラウドクラスター構成ファイルの例

マルチクラウドクラスターを作成するには、次の例ファイルに示すように、 regionConfigsオブジェクトに複数のサービスプロバイダーを指定します。

{
  "name":"myCluster",
  "clusterType":"REPLICASET",
  "replicationSpecs":[
    {
      "regionConfigs":[
        {
          "electableSpecs":{
            "instanceSize":"M30",
            "nodeCount":1
          },
          "priority":7,
          "providerName":"AWS",
          "regionName":"EU_WEST_1"
        },
        {
          "electableSpecs":{
            "instanceSize":"M30",
            "nodeCount":1
          },
          "priority":6,
          "providerName":"GCP",
          "regionName":"CENTRAL_US"
        },
        {
          "electableSpecs":{
            "instanceSize":"M30",
            "nodeCount":1
          },
          "priority":5,
          "providerName":"AZURE",
          "regionName":"US_EAST_2"
        }
      ]
    }
  ]
}

ジオシャーディングされたクラスターの構成ファイルの例

地理シャーディングされたクラスターを作成するには、次の例ファイルに示すようにreplicationSpecsオブジェクトのゾーンを指定します。

{
    "backupEnabled": false,
    "biConnector": {
      "enabled": false,
      "readPreference": "secondary"
    },
    "clusterType": "GEOSHARDED",
    "diskSizeGB": 100,
    "encryptionAtRestProvider": "NONE",
    "mongoDBMajorVersion": "5.0",
    "name": "myCluster",
    "paused": false,
    "pitEnabled": false,
    "stateName": "IDLE",
    "replicationSpecs": [
      {
        "numShards": 1,
        "zoneName": "US-1",
        "regionConfigs": [
          {
            "analyticsSpecs": {
              "diskIOPS": 3000,
              "ebsVolumeType": "STANDARD",
              "instanceSize": "M30",
              "nodeCount": 0
            },
            "electableSpecs": {
              "diskIOPS": 3000,
              "ebsVolumeType": "STANDARD",
              "instanceSize": "M30",
              "nodeCount": 3
            },
            "readOnlySpecs": {
              "diskIOPS": 3000,
              "ebsVolumeType": "STANDARD",
              "instanceSize": "M30",
              "nodeCount": 0
            },
            "autoScaling": {
              "diskGB": {
                "enabled": true
              },
              "compute": {
                "enabled": false,
                "scaleDownEnabled": false
              }
            },
            "priority": 7,
            "providerName": "AWS",
            "regionName": "US_EAST_1"
          }
        ]
      },
      {
        "numShards": 1,
        "zoneName": "US-2",
        "regionConfigs": [
          {
            "analyticsSpecs": {
              "diskIOPS": 3000,
              "ebsVolumeType": "STANDARD",
              "instanceSize": "M30",
              "nodeCount": 0
            },
            "electableSpecs": {
              "diskIOPS": 3000,
              "ebsVolumeType": "STANDARD",
              "instanceSize": "M30",
              "nodeCount": 3
            },
            "readOnlySpecs": {
              "diskIOPS": 3000,
              "ebsVolumeType": "STANDARD",
              "instanceSize": "M30",
              "nodeCount": 0
            },
            "autoScaling": {
              "diskGB": {
                "enabled": true
              },
              "compute": {
                "enabled": false,
                "scaleDownEnabled": false
              }
            },
            "priority": 7,
            "providerName": "AWS",
            "regionName": "US_EAST_2"
          }
        ]
      }
    ]
  }

戻る

JSON 構成ファイル

クラウドバックアップのスケジュール

必要なクラスター設定

任意および条件付きクラスター設定

クラスター構成ファイルの例

マルチクラウド クラスター構成ファイルの例

ジオシャーディングされたクラスターの構成ファイルの例

マルチクラウドクラスター構成ファイルの例