集群配置文件

在此页面上

所需的集群设置

可选和条件集群设置
集群配置文件示例
多云集群配置文件示例
地理分片集群配置文件示例

您可以使用集群配置文件来指定使用 Atlas CLI 创建或更新集群时所需的设置。 Atlas CLI 接受 .json集群配置文件。

使用以下资源：

了解您可以在集群配置文件中指定的必需设置。
查看和复制示例配置文件。

所需的集群设置

Atlas 需要以下设置才能使用 Atlas CLI 创建集群。您必须在配置文件中指定这些集群设置或在命令中指定为标志：

字段	类型	说明
`clusterType`	字符串	人类可读标签，指示要创建的集群类型。值包括： `REPLICASET` 、 `SHARDED`或`GEOSHARDED` 。
`name`	字符串	用于标识集群的人类可读标签。
`replicationSpecs`	阵列	列表，其中包含集群地区及其中预配硬件的配置设置。
`replicationSpecs.` `regionConfigs`	阵列	列表，其中包含您指定地区内节点集的硬件规格。每个`regionConfigs`对象都描述了该地区在选举中的优先级以及 Atlas 部署到该地区的 MongoDB 节点的数量和类型。每个`regionConfigs`对象必须具有`analyticsSpecs`对象、 `electableSpecs`对象或`readOnlySpecs`对象。共享集群仅需要`electableSpecs` 。专用集群可以指定任何这些规范，但必须在`replicationSpec`中至少有一个`electableSpecs`对象。每个硬件规格必须使用相同的`instanceSize` 。
`replicationSpecs.` `regionConfigs.electableSpecs`	对象	该地区可选举节点的硬件规格。可选举节点可以成为主节点 (primary node in the replica set)节点，并且可以启用本地读取。
`replicationSpecs.` `regionConfigs.` `electableSpecs.instanceSize`	字符串	此区域中实例大小的硬件规格。要了解更多信息，请参阅选择集群层。
`replicationSpecs` `.regionConfigs.` `electableSpecs.nodeCount`	数字	Atlas 部署到该区域的可选举节点数量。可选举节点可以成为主节点，并且可以启用本地读取。所有 replicationSpecs[n].regionConfigs[m] 对象的 electableSpecs.nodeCount 总和必须为 3、5 或 7。
`replicationSpecs.` `regionConfigs.priority`	整型	进行主选举时地区的优先级。如果您的地区已将`electableSpecs.nodeCount`设置为`1`或更高，则其优先级必须比`replicationSpecs[n].regionConfigs[m]`数组中的另一个地区低一 (1) 级。最高优先级区域的优先级必须为`7` 。可能的最低优先级是`1` 。优先级`7`地区标识集群的首选地区。 Atlas将主节点 (primary node in the replica set)节点置于首选地区。
`replicationSpecs.` `regionConfigs.providerName`	字符串	用于标识云服务提供商的人类可读标签。值包括： `AWS` 、 `AZURE`或`GCP` 。要创建多云集群，请为您的`regionConfigs` 对象指定多个服务提供商。要学习；了解详情，请参阅多云示例配置文件
`replicationSpecs.` `regionConfigs.regionName`	字符串	人类可读标签，指示集群节点的物理位置。您选择的地区可能会影响客户端访问您的数据库的网络延迟。有关地区名称值的完整列表，请参阅云提供商的参考页面： AWS GCP AZURE

可选和条件集群设置

集群配置文件可能包含其他可选或条件集群设置。如果选择的clusterType为GEOSHARDED ，则必须在配置文件中指定以下集群设置或在命令中指定为标志：

字段	类型	说明
`replicationSpecs.` `numShards`	字符串	正整数，用于指定要在每个指定区域中部署的分片数量。如果您将`clusterType`设置为`SHARDED`或`GEOSHARDED` ，请提供此值。如果选择了`clusterType` `REPLICASET`，请忽略此值。此 API 资源接受`1`至`50` （含）。此参数默认为`1` 。如果您指定`numShards`值为`1`且`clusterType`为`SHARDED` ，则 Atlas 将部署单分片集群。不要为生产环境创建单分片的分片集群。单分片的分片集群无法提供与多分片配置相同的优势。
`replicationSpecs.` `zoneName`	字符串	全球集群中区域的名称。如果将`clusterType`设置为`GEOSHARDED` ，请提供此值。
`tags`	阵列	包含长度在1到255字符之间的键值对的列表，用于对集群进行标记和分类。
`tags.key`	字符串	定义标签集的常量。例如， `environment : production`标签中的`environment` 。
`tags.value`	字符串	属于该标签集的变量。例如， `environment : production`标签中的`production` 。

有关可用设置的完整列表，请参阅从一个项目创建一个多云集群的 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 配置文件

来年