Esta página descreve como usar o modelo Atlas para arquivos Terraform incluídos com a extensão MongoDB para Visual Studio Code para criar clusters Flex.
Após carregar o modelo, você configura o agrupamento e fornece detalhes sobre sua conta do Atlas. Em seguida, você usa os comandos do Terraform para planejar, aplicar e destruir seu Atlas cluster.
Pré-requisitos
Antes de usar o modelo Atlas para arquivos Terraform incluídos na Extensão MongoDB para Visual Studio Code, você deve:
Ter uma conta Atlas.
Ter uma organização Atlas.
Tenha uma conta de serviço em uma organização |service| com a
Organization OwnerouOrganization Project Creatorfunção.
Procedimentos
Crie um arquivo Atlas Terraform usando o modelo
Use o modelo Atlas para arquivos Terraform incluídos com a extensão VS Code para configurar um cluster Atlas:
No arquivo main.tf, digite atlas e pressione a tecla Enter ou Return.
A Extensão MongoDB para VSCode preenche o arquivo com uma configuração de exemplo utilizando o provedor de Terraform MongoDB Atlas para criar um cluster Flex.
Atualize a configuração do Terraform do Atlas para configurar seu agrupamento.
O cursor se move para selecionar o valor do argumento name do recurso mongodbatlas_project .
Para configurar o cluster, forneça valores para os seguintes argumentos:
Dica
Pressione a tecla Tab para selecionar o próximo argumento no modelo que você deve atualizar.
Atributo | Valor |
|---|---|
| Nome do projeto Atlas que esta configuração cria. |
| Nome do cluster Atlas Flex que esta configuração cria. |
| Provedor no qual o cluster Atlas Flex criado por esta configuração está hospedado. Escolha um dos seguintes valores aceitos:
|
| Região à qual o cluster Atlas Flex que esta configuração cria é implantar. Certifique-se de que a região que escolheu suporta clusters Flex. Para detalhes sobre as regiões que cada provedor suporta, consulte as seguintes seções na documentação do Atlas: |
Atualize as variáveis do local.
Aviso
As variáveis local contêm informações confidenciais. Não insira esses valores em um repositório que esteja disponível publicamente.
Forneça valores para as seguintes local variáveis:
Variável | Valor |
|---|---|
| ID de cliente da conta de serviço do Atlas. |
| Segredo do cliente da conta de serviço do Atlas. |
| ID da organização do Atlas em que você deseja criar um projeto. |
| Nome de usuário do usuário do banco de dados MongoDB que o Atlas cria para seu cluster. |
| Senha do usuário do banco de dados MongoDB nomeado em |
| Endereço IP ou bloco CIDR a partir do qual o seu Atlas cluster está acessível. |
Observação
O modelo autentica no Atlas com uma conta de serviço. Chaves de API também são suportadas, mas contas de serviço são o método de autenticação recomendado. Para aprender sobre ambos os métodos, consulte o guia de autenticação do provedor MongoDB Atlas Terraform.
Exemplo
Usar um arquivo de variáveis de entrada para maximizar a segurança
Para maximizar a segurança, considere seguir as seguintes etapas:
Defina as variáveis
localem um arquivo de variáveis de entrada.variable "mongodb_atlas_client_id" { default = "my-client-id"} variable "mongodb_atlas_client_secret" { default = "my-client-secret"}Exclua o arquivo de variáveis de entrada do repositório. Por exemplo, adicione o nome do arquivo ao arquivo
.gitignoredo seu repositório.Variáveis de referência do arquivo de variáveis de entrada no arquivo
main.tfprefaciando-as comvar..provider "mongodbatlas" { client_id = var.mongodb_atlas_client_id client_secret = var.mongodb_atlas_client_secret}
Adicione opções de configuração opcionais ao arquivo main.tf.
Para uma lista completa de opções de configuração suportadas, consulte a documentação do Provedor de Terraformes do Atlas do MongoDB.
Para implantações em produção, considere o módulo oficial do cluster do MongoDB Atlas, que agrupa o recurso de cluster com os padrões de melhores práticas de produção.
Observação
Os clusters Flex não suportam todas as configurações disponíveis com o provedor MongoDB Atlas Terraform. Para obter uma lista de configurações não suportadas, consulte a documentação do Atlas.
Criar o Cluster do Atlas utilizando Terraform
Após criar um arquivo de Terraform utilizando o modelo, crie o cluster do Atlas:
Execute o comando terraform apply para criar um cluster do Atlas a partir da configuração Terraform.
Digite yes quando solicitado para confirmar que você deseja aplicar a configuração.
Observação
O comando terraform apply pode levar vários minutos para ser concluído.
A seguinte saída indica que seu cluster do Atlas foi criado. Você pode criar uma conexão com essa implantação usando a VS Code Extension com a string de conexão exibida:
terraform applyExcluir o Atlas cluster utilizando Terraform
Aviso
Excluir um cluster destrói bancos de dados, coleções e documentos armazenados nele e todos os outros recursos definidos na configuração Terraform na qual você configurou o cluster.
Prossiga com cuidado.
Para excluir o Atlas cluster:
Execute o comando terraform destroy para excluir os recurso definidos na configuração.
terraform destroyDigite yes quando solicitado para confirmar que você deseja destruir os recursos definidos na configuração.
Observação
O comando terraform destroy pode levar vários minutos para ser concluído.
A seguinte saída indica que o agrupamento Atlas e todos os recursos associados são excluídos:
Destroy complete! Resources: 4 destroyed.