Arquivo de configuração do cluster

Nesta página

Configurações de cluster necessárias

Configurações de cluster opcionais e condicionais
Exemplo de arquivo de configuração do cluster
Exemplo de arquivo de configuração de cluster Multi-cloud
Exemplo de arquivo de configuração de cluster geofragmentado

Você pode utilizar um arquivo de configuração de cluster para especificar as configurações necessárias ao criar ou atualizar um cluster utilizando o Atlas CLI. O Atlas CLI aceita arquivos de configuração de cluster do .json .

Use os seguintes recursos para:

Aprenda asconfigurações necessárias que você pode especificar no arquivo de configuração do cluster.
Visualize e copie arquivos de configuração de exemplo.

Configurações de cluster necessárias

O Atlas requer as seguintes configurações para criar um cluster com a Atlas CLI. Você deve especificar essas configurações de cluster no arquivo de configuração ou como sinalizações no comando:

Campo	Tipo	Descrição
`clusterType`	string	Etiqueta legível para humanos que indica o tipo de cluster a ser criado. Os valores incluem: `REPLICASET`, `SHARDED` ou `GEOSHARDED`.
`name`	string	Etiqueta legível por humanos que identifica o cluster.
`replicationSpecs`	array	Lista que contém as definições de configuração das suas regiões de cluster e do hardware provisionado nelas.
`replicationSpecs.` `regionConfigs`	array	Lista que contém as especificações de hardware para os nós definidos dentro da região que você especifica. Cada objeto `regionConfigs` descreve a prioridade da região nas eleições e o número e tipo de nós do MongoDB que o Atlas implementa na região. Cada objeto `regionConfigs` deve ter um objeto `analyticsSpecs` , um objeto `electableSpecs` ou um objeto `readOnlySpecs` . O cluster compartilhado exige apenas `electableSpecs`. O cluster dedicado pode especificar qualquer uma dessas especificações, mas deve ter pelo menos um objeto `electableSpecs` dentro de um `replicationSpec`. Toda especificação de hardware deve usar o mesmo `instanceSize`.
`replicationSpecs.` `regionConfigs.electableSpecs`	objeto	Especificações de hardware para nós elegíveis na região. Os nós elegíveis podem se tornar os primary e podem habilitar leituras locais.
`replicationSpecs.` `regionConfigs.` `electableSpecs.instanceSize`	string	Especificação de hardware para os tamanhos de instância nesta região. Para saber mais, consulte Selecionar Camada do Cluster.
`replicationSpecs` `.regionConfigs.` `electableSpecs.nodeCount`	número	Número de nós elegíveis para implantação do Atlas na região. Os nós elegíveis podem se tornar os primary e podem habilitar leituras locais. O elegableSpecs.nodeCount combinado em todos os objetos replicationSpecs[n].regionConfigs[m] deve totalizar 3, 5 ou 7.
`replicationSpecs.` `regionConfigs.priority`	Inteiro	Precedência que é dada a esta região quando ocorre uma eleição primária. Se sua região definiu `electableSpecs.nodeCount` como `1` ou superior, ela deverá ter uma prioridade de exatamente um (1) a menos que outra região na array `replicationSpecs[n].regionConfigs[m]` . A região de maior prioridade deve ter uma prioridade de `7`. A prioridade mais baixa possível é `1`. A região de prioridade `7` identifica a região preferencial do cluster. O Atlas coloca o nó primário na região preferencial.
`replicationSpecs.` `regionConfigs.providerName`	string	Etiqueta legível por humanos que identifica seu provedor de serviços de cloud. Os valores incluem: `AWS`, `AZURE` ou `GCP`.
`replicationSpecs.` `regionConfigs.regionName`	string	Etiqueta legível por humanos que indica a localização física dos nós do cluster. A região escolhida pode afetar a latência da rede para os clientes que acessam seu reconhecimento de data center. Para obter uma lista completa de valores de nome de região, consulte as páginas de referência do fornecedor de nuvem: AWS GCP Azure

Configurações de cluster opcionais e condicionais

Seu arquivo de configuração de cluster pode conter configurações de cluster adicionais opcionais ou condicionais. Se você selecionou clusterType de GEOSHARDED, você deverá especificar as seguintes configurações de cluster no arquivo de configuração ou como sinalizadores no comando:

Campo	Tipo	Descrição
`replicationSpecs.` `numShards`	string	Inteiro positivo que especifica o número de fragmentos a serem implementados em cada zona especificada. Forneça este valor se você definir um `clusterType` de `SHARDED` ou `GEOSHARDED`. Omita este valor se você selecionou `clusterType` de `REPLICASET`. Este recurso de API aceita de `1` a `50`, inclusive. Este parâmetro é padronizado como `1`. Se você especificar um `numShards` valor de `1` e um `clusterType` de `SHARDED`, Atlas o implantará um cluster fragmentado de shard único. Não crie um cluster fragmentado com um único fragmento para ambientes de produção. Os clusters de fragmentos únicos não fornecem os mesmos benefícios que as configurações de vários fragmentos.
`replicationSpecs.` `zoneName`	string	Nome da zona em um cluster global. Forneça este valor se você configurar `clusterType` para `GEOSHARDED`.
`tags`	array	Lista que contém pares de valores-chave entre 1 e 255 caracteres para marcar e categorizar o cluster.
`tags.key`	string	Constante que define o conjunto da tag. Por exemplo, `environment` na marcação `environment : production` .
`tags.value`	string	Variável que pertence ao conjunto da tag. Por exemplo, `production` na marcação `environment : production` .

Para obter uma lista completa das configurações disponíveis, consulte a documentação da API para Criar um cluster de várias nuvens a partir de um projeto.

Exemplo de arquivo de configuração do cluster

Para criar um cluster usando um único cloud provider, especifique o mesmo provedor de serviços para seus objeto regionConfigs , conforme mostrado no arquivo de exemplo a seguir:

{
  "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"
        }
      ]
    }
  ]
}

Exemplo de arquivo de configuração de cluster Multi-cloud

Para criar um cluster de várias cloud, especifique mais de um provedor de serviços para seu objeto do regionConfigs como mostrado no seguinte arquivo de exemplo:

{
  "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"
        }
      ]
    }
  ]
}

Exemplo de arquivo de configuração de cluster geofragmentado

Para criar um cluster fragmentado, especifique zonas para seus objetos replicationSpecs como mostrado no seguinte arquivo de exemplo:

{
    "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"
          }
        ]
      }
    ]
  }

Voltar

Arquivos de configuração JSON

Agendamento de backup em cloud