Registre, autentique, crie e acesse um cluster do Atlas.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Esse comando o conduz pelo registro, login, criação de perfil padrão, criando seu primeiro cluster de camada grátis e conectando-se a ele usando o MongoDB Shell.
Sintaxe
atlas setup [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--accessListIp | strings | false | Endereço IP para conceder acesso ao sistema. Mutuamente exclusivo com --currentIp. |
--autoScalingMode | string | false | Modo em que o cluster é dimensionado. Os valores válidos são clusterWideScaling ou independenteShardScaling. Este valor é padronizado como "clusterWideScaling". |
--clusterName | string | false | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--connectWith | string | false | Método para se conectar ao cluster. Os valores válidos são compass, mongosh, vscode e skip. Mutualmente exclusivo com --skipMongosh. |
--currentIp | false | Sinalizador que adiciona o endereço IP do host que está executando o comando no momento à lista de acesso. Mutuamente exclusivo com --accessListIp. | |
--enableTerminationProtection | false | Habilita a proteção contra encerramento para seu cluster. Não é possível excluir um cluster com a proteção de encerramento habilitada. | |
--force | false | Sinalizador que indica se você deve ignorar a solicitação de entrada e criar um cluster com as configurações padrão para quaisquer opções não especificadas. | |
--gov | false | Registre-se no Atlas for Government. | |
-h, --help | false | ajuda para configuração | |
--mdbVersion | string | false | Versão MongoDB principal da implantação. |
--noBrowser | false | Não tente abrir uma sessão do navegador. | |
--password | string | false | Senha para o usuário. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
--provider | string | false | Nome do seu provedor de serviços de cloud. Os valores válidos são Amazon Web Services, Azure ou GCP. |
-r, --region | string | false | Localização física do cluster MongoDB . Para obter uma lista completa das regiões AWS compatíveis, consulte: https://dochub.mongodb.org/core/aws-atlas. Para obter uma lista completa das regiões Azure compatíveis, consulte: https://dochub.mongodb.org/core/azure-atlas. Para obter uma lista completa de regiões GCP compatíveis, consulte: https://dochub.mongodb.org/core/gcp-atlas. |
--skipSampleData | false | Sinalizador que indica se o carregamento de dados de amostra deve ser ignorado no MongoDB cluster. | |
--tag | chave=valor | false | Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. |
--tier | string | false | Camada para cada servidor que contém dados no cluster. Para saber mais sobre camadas de cluster, consulte https://dochub.mongodb.org/core/cluster-tier-atlas. Este valor padrão é "M0". |
--username | string | false | Nome de usuário para autenticar no MongoDB. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Exemplos
# Override default cluster settings like name, provider, or database username by using the command options atlas setup --clusterName Test --provider GCP --username dbuserTest