Como implantar o MongoDB no Heroku
Avalie esse Tutorial
À medida que começamos a criar mais aplicativos nativos da nuvem, escolher os serviços e as ferramentas certos pode ser muito difícil. Felizmente, quando se trata de escolher um serviço de banco de dados em nuvem, o MongoDB Atlas pode ser a escolha mais fácil!
Quando emparelhado com Heroku, uma das soluções PaaS mais populares para desenvolvedores, você poderá criar e implantar aplicativos de nuvem totalmente gerenciados em pouco tempo. A melhor parte? O MongoDB Atlas integra-se facilmente com aplicativos Heroku. Tudo o que você precisa fazer é definir a string do cluster do Atlas para uma variável de configuração Heroku. Só isso é necessário!
Se você já está familiarizado com o MongoDB, usar o MongoDB Atlas com seus aplicativos de nuvem é uma escolha natural. O MongoDB Atlas é um serviço de banco de dados em nuvem totalmente gerenciado para MongoDB que automatiza o gerenciamento de clusters MongoDB na nuvem. Oferecendo recursos como backup automatizado, dimensionamento automático, tolerância a falhas multi-AZ e um conjunto completo de ferramentas de gerenciamento e análise, o Atlas é o DBaaS mais sofisticado do mundo e está a apenas alguns cliques de distância.
Para ver como é rápido entrar em operação com o MongoDB Atlas, basta seguir as próximas etapas para configurar seu primeiro cluster gratuito. Em seguida, veja com que rapidez você pode conectar seu novo cluster do Atlas ao seu aplicativo Heroku seguindo as instruções passo a passo mais adiante neste tutorial.
Este tutorial pressupõe o seguinte:
- Você está familiarizado com o MongoDB e escreveu aplicativos que usam o MongoDB.
- Você está familiarizado com o Heroku e sabe como implantar aplicativos Heroku. - Você tem o Heroku CLI instalado.
Com essas suposições em mente, vamos começar!
💡 Se você já criou uma conta MongoDB usando seu endereço de e-mail, pode pular esta etapa! Acesse sua conta.
Após o registro, o Atlas solicitará que você crie uma organização e um projeto onde possa implantar seu cluster.
Agora você poderá selecionar entre uma variedade de opções de cluster. Para este tutorial, selecionaremos a opção Clusters compartilhados, que é o cluster da camada grátis do Atlas. Clique em "Criar um cluster" na opção Clusters compartilhados:
Na próxima página, você será solicitado a escolher algumas opções para seu cluster:
Provedor de nuvem e região
Escolha onde você deseja implantar seu cluster. É importante selecionar a região disponível mais próxima do seu aplicativo e, idealmente, a mesma região, a fim de minimizar a latência. No nosso caso, vamos escolher a região N. Virginia (us-east-1), com a AWS como nosso provedor de nuvem (já que estamos implantando no Heroku, e é onde o Heroku hospeda sua infraestrutura):
Camada do cluster
Aqui, você verá as camada do cluster disponíveis para a opção de clusters compartilhados. Você pode ver uma comparação de RAM, armazenamento, vCPU e preço base entre os níveis para ajudá-lo a escolher o nível certo. Para nosso tutorial, deixe o nível padrão do M0 Sandbox selecionado:
Configurações adicionais
Dependendo do nível escolhido, algumas opções adicionais podem estar disponíveis para você. Isso inclui a versão do MongoDB que você deseja implantar e, para clusters M2 e superiores, opções de backup. Para este tutorial, selecione a versão mais recente, MongoDB 4.4:
Nome do cluster
Por último, você pode dar um nome ao seu cluster. Lembre-se de que, depois de criar seu cluster, você não poderá alterá-lo! Aqui, nomearemos nosso cluster
leaflix-east para nos ajudar a saber qual projeto e região esse cluster suportará:
É isso ai! Certifique-se de revisar suas opções uma última vez antes de clicar no botão "Criar cluster".
O Atlas exige que os clientes se autentiquem como usuários do MongoDB database para acessar clusters, portanto, vamos criar um rapidamente para seu cluster.
Como você pode ver no GIF acima, criar um usuário de banco de dados é simples. Primeiro, navegue até a seção "Acesso ao banco de dados" (localizada em "Segurança" na barra de navegação à esquerda). Clique em “Criar um novo usuário de banco de dados”. Um prompt aparecerá onde você poderá escolher o método de autenticação desse usuário e os privilégios de usuário de banco de dados.
Selecione o método de autenticação "Senha" e forneça a esse usuário um nome de usuário e uma senha. Por conveniência, você pode até gerar automaticamente uma senha segura diretamente no Atlas, o que é altamente recomendável.
💡 Depois de gerar automaticamente sua senha, clique em Copiar e armazene-a em um local seguro por enquanto. Precisaremos dela mais tarde ao nos conectarmos ao nosso cluster!
Escolha uma função integrada para este usuário. Neste tutorial, estou escolhendo "Administrador do Atlas", que concede a maioria dos privilégios.
Por fim, clique no botão "Adicionar usuário". Você criou o primeiro usuário de banco de dados do seu cluster!
A última etapa da configuração do cluster é escolher quais endereços IP têm permissão para acessá-lo. Para entrar em operação rapidamente, defina seu cluster para permitir acesso de qualquer lugar:
Parabéns! Você acabou de configurar seu cluster Atlas com sucesso!
💡 Observação: você provavelmente não deseja permitir esse tipo de acesso em um ambiente de produção. Em vez disso, você deve identificar os endereços IP exatos nos quais você sabe que seu aplicativo será hospedado e definir explicitamente quais endereços IP, ou intervalos de IP, devem ter acesso ao seu cluster. Depois de configurar seu aplicativo Heroku, siga as etapas na seção "Configurando endereços IP do Heroku no Atlas" abaixo para ver como adicionar os endereços IP adequados ao seu aplicativo Heroku.
A configuração rápida do nosso cluster do Atlas foi bastante empolgante, mas acreditamos que você achará esta seção ainda mais emocionante!
Os aplicativos no Heroku por meio do Atlas são simples de configurar. Tudo o que você precisa fazer é criar uma variável de configuração no nível do aplicativo que contenha a string de conexão do cluster. Uma vez configurado, você pode acessar com segurança essa variável de configuração em seu aplicativo!
Veja como fazer isso:
1 heroku login
Esse comando abre seu navegador na página de login do Heroku. Se você já estiver conectado, basta clicar no botão "Entrar". Alternativamente, você pode usar o sinalizador -i para fazer login por meio da linha de comando.
Para continuar este tutorial, criei um aplicativo Node de demonstração que usa o MongoDB Atlas e é um aplicativo que gostaria de implantar no Heroku. Clone-o e navegue até seu diretório:
1 git clone https://github.com/adriennetacke/mongodb-atlas-heroku-leaflix-demo.git 2 3 cd mongodb-atlas-heroku-leaflix-demo
1 heroku create leaflix
Como você pode ver, eu nomeei o meu
leaflix.Volte para o painel do seu cluster do Atlas, pois precisaremos pegar nossa string de conexão.
Clique no botão "Conectar".
Escolha a opção "Conectar seu aplicativo".
Aqui, você verá a string de conexão de que precisaremos para nos conectar ao nosso cluster. Copie a string de conexão.
Cole a string em um editor; precisaremos modificá-la um pouco antes de podermos defini-la como uma variável de configuração do Heroku.
Como você pode ver, o Atlas adicionou o nome de usuário do usuário do banco de dados que criamos anteriormente. Para concluir a string de conexão e torná-la válida, substitua a <senha> por sua senha de usuário do banco de dados e
<dbname> por sample_mflix, que é o conjunto de dados de amostra que nosso aplicativo de demonstração usará.💡 Se você não tiver a senha do usuário de banco de dados à mão, gere uma nova automaticamente e use-a em sua string de conexão. Lembre-se de atualizá-la se você gerá-la automaticamente de novo! Você pode encontrar a senha acessando Acesso ao banco de dados > clicando em "Editar" no usuário de banco de dados desejado > Editar senha > Gerar senha segura automaticamente
Agora que formamos adequadamente nossa string de conexão, é hora de armazená-la em uma variável de configuração do Heroku. Vamos definir nossa string de conexão como uma variável de configuração chamada MONGODB_URI:
1 heroku config:set MONGODB_URI="mongodb+srv://yourUsername:yourPassword@yourClusterName.n9z04.mongodb.net/sample_mflix?retryWrites=true&w=majority"
Algumas coisas importantes a serem observadas:
- Este comando é uma linha inteira.
- Como o formato de nossa string de conexão contém caracteres especiais, é necessário colocá-la entre aspas.
Você só precisa fazer isso! Agora você adicionou corretamente a string de conexão do seu cluster do Atlas como uma variável de configuração do Heroku, o que significa que você pode acessar essa string com segurança quando o aplicativo for implantado no Heroku.
💡 Você também pode adicionar esta variável de configuração através da aba "Configurações" do seu aplicativo no dashboard do Heroku. Vá para seus aplicativos > leaflix > Configurações. Na seção Variáveis de configuração, clique no botão "Revelar variáveis de configuração" e adicione sua variável de configuração lá.
A última etapa é modificar o código do seu aplicativo para acessar essas variáveis.
Em nosso aplicativo de demonstração, você verá que codificamos a string de conexão do cluster do Atlas. Devemos refatorar nosso código para usar a variável de configuração do Heroku que criamos anteriormente.
As variáveis de configuração são expostas ao código do seu aplicativo como variáveis de ambiente. O acesso a essas variáveis depende da linguagem do seu aplicativo; por exemplo, você usaria chamadas
System.getenv('key') em Java ou chamadas ENV['key'] em Ruby.Sabendo disso, e sabendo que nosso aplicativo está escrito em Node, podemos acessar nosso cluster do Atlas através da propriedade
process.env, disponibilizada para nós em Node.js. No arquivo server.js, altere a constante uri para isto:1 const uri = process.env.MONGODB_URI;
É isso ai! Como adicionamos nossa string de conexão do cluster do Atlas como uma variável de configuração do Heroku, nosso aplicativo poderá acessá-la com segurança depois de implantada.
Salve esse arquivo, confirme essa alteração e implante seu código no Heroku.
1 git commit -am "fix: refactor hard coded connection string to Heroku config var" 2 3 git push heroku master
Seu aplicativo agora está implantado! Você pode verificar se pelo menos uma instância do Leaflix está em execução usando este comando:
1 heroku ps:scale web=1
Se você vir uma mensagem que diz
Scaling dynos... done, now running web at 1:Free, saberá que pelo menos uma instância está ativa e em execução.Finalmente, vá visitar seu aplicativo. Você pode fazer isso com este comando útil:
1 heroku open
Se tudo estiver bem, você verá algo assim:
Quando você clicar no botão "Precisar dar risada?", nosso aplicativo escolherá aleatoriamente um filme que tenha o gênero "Comédia" no campo de gêneros. Isso vem diretamente do nosso cluster do Atlas e usa o conjunto de dados
sample_mflix.Temos nosso cluster instalado e funcionando e nosso aplicativo está implantado no Heroku!
Para nos guiar neste tutorial, inicialmente configuramos nosso cluster para aceitar conexões de qualquer endereço IP. Idealmente, você gostaria de restringir o acesso apenas ao seu aplicativo, e há algumas maneiras de fazer isso no Heroku.
A primeira maneira é usar um complemento para fornecer um endereço IP de saída estático para seu aplicativo que você pode usar para restringir o acesso no Atlas. Você pode encontrar alguns listados aqui:
Outra forma seria usar os Espaços Privados do Heroku e usar os IPs estáticos de saída para seu espaço. Essa é uma opção mais cara, mas não requer um complemento separado.
Existem alguns documentos e artigos que sugerem que você pode usar intervalos de IP publicados pela AWS ou pelo Heroku para permitir o acesso aos IPs originados na sua região da AWS ou ao Heroku Dynos localizado nessas regiões. Embora isso seja possível, não é recomendado, pois esses intervalos estão sujeitos a alterações ao longo do tempo. Em vez disso, recomendamos um dos dois métodos acima.
Depois de ter o(s) endereço(s) IP do seu aplicativo, você pode usá-lo(s) para configurar o firewall no Atlas.
Acesse seu cluster do Atlas, exclua todas as faixas de IP existentes e adicione-as à sua lista de permissões:
É claro que, o tempo todo, você estará se comunicando entre seu aplicativo e o banco de dados do Atlas com segurança por meio da criptografia TLS.
Fizemos muita coisa em um tempo relativamente curto! Recapitulando:
- Configuramos e implantamos um cluster do Atlas em cinco etapas ou menos.
- Criamos uma variável de configuração no Heroku para armazenar com segurança nossa string de conexão do Atlas, permitindo-nos conectar o cluster do Atlas ao nosso aplicativo Heroku.
- Aprendemos que as variáveis de configuração do Heroku são expostas ao código do nosso aplicativo como variáveis de ambiente.
- Refatoramos a string URI codificada em nosso código para apontar para uma variável
process.env.MONGODB_URI.
Tem perguntas adicionais ou um caso de uso específico não abordado aqui? Vá para os fóruns da comunidade de desenvolvedores do MongoDB e inicie uma discussão! Estamos ansiosos para ouvir você.
E para saber mais sobre o MongoDB Atlas, confira esta excelente introdução ao MongoDB Atlas em 10 minutos, feita por Jesse Hall, um colega defensor dos desenvolvedores!
Avalie esse Tutorial
Relacionado
Tutorial
Criação de um agente de IA com memória usando MongoDB, Fireworks AI e LangChain
Aug 12, 2024 | 21 min read
Tutorial
Java encontra Queryable Encryption: desenvolvendo um aplicativo de conta bancária seguro
Oct 08, 2024 | 14 min read