Como executar o Rails 5 no ambiente flexível do App Engine

Dê os primeiros passos no desenvolvimento de aplicativos Ruby on Rails executados no ambiente flexível do App Engine. Os aplicativos que você cria são executados na mesma infraestrutura que capacita todos os produtos do Google. Assim, você tem a certeza de que eles são escalonados para suprir todos os usuários, sejam eles poucos ou milhões.

Para acompanhar o tutorial, é preciso conhecer o desenvolvimento do Rails para a Web. Nele, você verá as etapas de implantação de um novo aplicativo do Rails.

Este tutorial requer o Ruby 2.6 ou 2.7.

Antes de começar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Install the Google Cloud CLI.

7. To initialize the gcloud CLI, run the following command:

   gcloud init

Configurar o ambiente local para o Rails

Para configurar o ambiente local para desenvolvimento do Rails, faça o seguinte:

1. Instale o Ruby versão 2.6 ou 2.7.

2. Instale a gem do Rails 5.

3. Instale a gem do Bundler.

Outra opção é usar o Cloud Shell, que já vem com o Ruby, o Rails e o CLI do Google Cloud instalados.

Para mais informações sobre como instalar o Rails e as respectivas dependências, consulte o guia oficial Primeiros passos com o Rails (em inglês).

Depois de concluir os pré-requisitos, é possível criar e implantar um aplicativo do Rails. Veja nas seções a seguir as etapas para configurar, executar e implantar um aplicativo.

Criar um novo aplicativo

1. Crie um novo app de exemplo do Rails.

   rails new appengine_example
   

2. Acesse o diretório que contém a amostra do código.

   cd appengine_example
   

Executar o aplicativo localmente

Para executar o novo aplicativo do Rails no computador local, siga estas etapas:

1. Instale dependências usando o Bundler.

    bundle install
   

2. Inicie um servidor da Web local.

    bundle exec rails server
   

3. No navegador, acesse http://localhost:3000/.

Você verá na página a mensagem "Yay! Você está no Rails!" do app de amostra exibido na página.

Observação: na janela do terminal, pressione Ctrl+C para sair do servidor da Web.

Adicionar uma página simples

Agora, adicione uma página de boas-vindas ao aplicativo Rails gerado.

1. Para gerar a estrutura de uma nova página, crie um novo controlador do Rails chamado WelcomeController com uma ação index.

   bundle exec rails generate controller Welcome index
   

2. Abra o arquivo app/views/welcome/index.html.erb para ver o seguinte HTML padrão.

   appengine/rails-hello_world/app/views/welcome/index.html.erb

   Ver no GitHub
   <h1>Welcome#index</h1>
   <p>Find me in app/views/welcome/index.html.erb</p>

3. Modifique o arquivo como quiser. Por exemplo, você pode usar o seguinte conteúdo:

   appengine/rails-hello_world/app/views/welcome/index.html.erb

   Ver no GitHub
   <h1>Welcome</h1>
   <p>This is a home page for a new Rails App on Google Cloud Platform!</p>

4. Defina a ação do controlador index como a ação raiz para o Rails. Sempre que um usuário acessar o aplicativo do Rails, ele verá sua página de boas-vindas.

5. Abra o arquivo config/routes.rb para ver o seguinte conteúdo gerado.

   appengine/rails-hello_world/config/routes.rb

   Ver no GitHub
   Rails.application.routes.draw do
     get 'welcome/index'
   
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
   end

6. Para modificar esse arquivo, adicione root 'welcome#index'.

   appengine/rails-hello_world/config/routes.rb

   Ver no GitHub
   Rails.application.routes.draw do
     get 'welcome/index'
   
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
     root 'welcome#index'
   end

7. Salve e feche o arquivo. Teste o aplicativo do Rails como você fez antes.

Implantar o app no ambiente flexível do App Engine

O ambiente flexível do App Engine usa um arquivo denominado app.yaml. para descrever a configuração de implantação de um aplicativo. Se esse arquivo não estiver presente, a CLI gcloud tentará adivinhar a configuração de implantação. Porém, é uma boa ideia fornecer esse arquivo, porque o Rails requer uma chave secreta em um ambiente de produção.

Para configurar o aplicativo de amostra para implantação no App Engine, crie um novo arquivo chamado app.yaml na raiz do diretório do aplicativo e adicione o seguinte:

appengine/rails-hello_world/app.yaml

Ver no GitHub

entrypoint: bundle exec rackup --port $PORT
env: flex
runtime: ruby

Configurar a chave secreta do Rails

Ao implementar um aplicativo do Rails no ambiente de produção, defina a variável de ambiente SECRET_KEY_BASE como uma chave secreta usada para proteger os dados da sessão do usuário. Essa variável de ambiente é lida no arquivo config/secrets.yml.

1. Gere uma nova chave secreta.

   bundle exec rails secret
   

2. Copie a chave secreta gerada. Você usará essa chave na próxima etapa.

3. Abra o arquivo app.yaml criado anteriormente e adicione uma seção env_variables. O env_variables define variáveis de ambiente no ambiente production no ambiente flexível do App Engine. O app.yaml será semelhante ao exemplo abaixo. Substitua [SECRET_KEY] pela chave secreta na área de transferência.

   appengine/rails-hello_world/app.yaml

   Ver no GitHub
   entrypoint: bundle exec rackup --port $PORT
   env: flex
   runtime: ruby
   
   env_variables:
     SECRET_KEY_BASE: [SECRET_KEY]

Configurar um aplicativo de ambiente flexível do App Engine

Se esta for a primeira vez que você está implantando um aplicativo, é necessário criar um aplicativo de ambiente flexível do App Engine para ajudar a selecionar a região em que o aplicativo do Rails será executado. Leia mais sobre regiões e zonas.

1. Crie um aplicativo do App Engine. Por padrão, duas funções do comando são criadas a seguir:

   gcloud app create
   

2. Selecione uma região compatível com o ambiente flexível do App Engine para aplicativos Ruby.

Implantar no ambiente flexível do App Engine

Execute o seguinte comando para implantar o app de exemplo:

gcloud app deploy

Aguarde a notificação sobre a conclusão da atualização. Isso pode demorar alguns minutos.

Acessar o aplicativo do Rails implantado

1. Para recuperar o ID do projeto, execute gcloud info.

2. No navegador, digite o seguinte URL:

   https://PROJECT_ID.REGION_ID.r.appspot.com

   Substitua:

   • PROJECT_ID: é o ID do projeto do Google Cloud.
   • REGION_ID: um código que o App Engine atribui ao aplicativo

O conteúdo a seguir é exibido.

Desta vez, sua solicitação é veiculada pelo aplicativo do Rails em execução no ambiente flexível do App Engine.

Esse comando implanta o aplicativo conforme descrito em app.yaml e define a versão recém-implantada como padrão. Com isso, ela veicula todo o tráfego novo. Durante a implantação do app, várias mensagens repetidas podem ser vistas, enquanto é verificado pela plataforma se o app está veiculando. Isso é normal. Aguarde a mensagem notificando que a atualização do app foi concluída.

Para atualizar o app, implante a versão atualizada digitando o mesmo comando usado para implantá-lo pela primeira vez. A implantação cria uma nova versão do app e a define como padrão. As versões mais antigas são mantidas, bem como as instâncias de VM associadas. Lembre-se de que essas versões do aplicativo e instâncias de VM são recursos passíveis de cobrança.

Ler registros do App Engine

Agora que você já implantou o aplicativo Rails, será possível ler os registros. Para ler os registros do aplicativo, use o Explorador de registros localizado no Console do Cloud ou use gcloud app logs read. Saiba mais sobre como ler registros usando a CLI gcloud.

Fazer a limpeza dos recursos

Depois de concluir o tutorial, limpe os recursos que você criou para que eles parem de usar a cota e incorrer em cobranças. Nas seções a seguir, você aprenderá a excluir e desativar esses recursos.

Excluir projeto

O jeito mais fácil de evitar cobranças é excluindo o projeto que você criou para o tutorial.

Para excluir o projeto:

Cuidado: excluir um projeto tem os seguintes efeitos:

• Tudo no projeto é excluído. Se você tiver usado um projeto existente para as tarefas neste documento, a exclusão dele incluirá a exclusão de quaisquer outros trabalhos feitos no projeto.
• Os IDs do projeto personalizados são perdidos. Ao criar o projeto, você pode ter criado um código do projeto personalizado para ser usado no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, exclua recursos específicos do projeto, em vez de excluir o projeto inteiro.

Se você planeja passar por várias arquiteturas, tutoriais ou guias de início rápido, a reutilização de projetos pode evitar que você exceda os limites da cota do projeto.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Excluir uma versão do aplicativo do App Engine

Para excluir uma versão do app:

1. In the Google Cloud console, go to the Versions page for App Engine.

   Go to Versions

2. Select the checkbox for the non-default app version that you want to delete.
   Observação: A única maneira de excluir a versão padrão do seu aplicativo do App Engine é excluir o projeto. No entanto, é possível interromper a versão padrão no Console do Google Cloud. Isso encerra todas as instâncias associadas à versão. Você pode reiniciar essas instâncias posteriormente, se necessário.

   No ambiente padrão do App Engine, apenas será possível interromper a versão padrão se o aplicativo tiver uma escala manual ou básica.

3. Para excluir a versão do app, clique em Excluir.

A seguir

• Saiba como usar o Cloud SQL para MySQL com o Rails.

• Saiba como usar o Cloud SQL para PostgreSQL com o Rails.

• Saiba como executar a amostra do Ruby Bookshelf no ambiente flexível do App Engine.

• Saiba como executar a amostra do Ruby Bookshelf no Compute Engine.

• Saiba como executar a amostra do Bookshelf em Ruby no GKE.