Implantar uma aplicação CakePHP no Elastic Beanstalk

CakePHP é uma framework MVC de código aberto para PHP. Este tutorial orienta você no processo de gerar um projeto CakePHP, implantá-lo em um ambiente do Elastic Beanstalk e configurá-lo para se conectar a uma instância de banco de dados do Amazon RDS.

Pré-requisitos

Este tutorial pressupõe que você tenha conhecimento das operações básicas e do console do Elastic Beanstalk. Caso ainda não tenha, siga as instruções em Introdução ao Elastic Beanstalk para iniciar seu primeiro ambiente do Elastic Beanstalk.

Para seguir os procedimentos neste manual, você precisa de um terminal de linha de comando ou de um shell para executar os comandos. Nas listagens, os comandos são mostrados precedidos por um símbolo de prompt ($) e pelo nome do diretório atual, quando apropriado.

~/eb-project$ this is a command
this is output

No Linux e no macOS, você pode usar seu gerenciador de pacotes e de shell preferido. No Windows, você pode instalar o Windows Subsystem for Linux para obter uma versão integrada ao Windows do Ubuntu e do Bash.

O CakePHP 4 requer PHP 7.2 ou posterior. Ele também requer as extensões PHP listadas na documentação oficial de instalação do CakePHP. Siga as instruções do tópico Configurando seu ambiente de PHP desenvolvimento para o Elastic Beanstalk para instalar o PHP e o Composer.

Iniciar um ambiente do Elastic Beanstalk

Use o console do Elastic Beanstalk para criar um ambiente do Elastic Beanstalk. Escolha a configuração da Plataforma PHP e aceite as configurações padrão e código de exemplo.

Para iniciar um ambiente (console)

1. Abra o console do Elastic Beanstalk usando este link pré-configurado: console.aws.amazon.com/elasticbeanstalk/home#/ newApplication?applicationName=Tutorials &EnvironmentType= LoadBalanced

2. Em Platform (Plataforma), selecione a plataforma e a ramificação da plataforma que correspondem à linguagem usada pelo seu aplicativo.

3. Para Application code, escolha Sample application.

4. Selecione Review and launch.

5. Examine as opções disponíveis. Escolha a opção disponível que deseja usar e, quando estiver pronto, escolha Create app (Criar aplicativo).

A criação de ambiente leva cerca de 5 minutos e cria os seguintes recursos:

• Instância do EC2: uma máquina virtual do Amazon Elastic Compute Cloud (Amazon EC2) configurada para executar aplicações Web na plataforma escolhida.

  Cada plataforma executa um conjunto específico de software, arquivos de configuração e scripts para oferecer suporte a uma versão de linguagem, framework, contêiner da web específicos ou a uma combinação deles. A maioria das plataformas usa o Apache ou o NGINX como um proxy reverso que fica na frente da aplicação Web, encaminha solicitações para ela, atende ativos estáticos e gera logs de acesso e de erro.

• Grupo de segurança de instância: um grupo de segurança do Amazon EC2 configurado para permitir tráfego de entrada na porta 80. Esse recurso permite que o tráfego HTTP do load balancer chegue à instância do EC2 que executa seu aplicativo Web. Por padrão, o tráfego não é permitido em outras portas.

• Balanceador de carga: um balanceador de carga do Elastic Load Balancing configurado para distribuir solicitações para as instâncias que executam a aplicação. Um load balancer também elimina a necessidade de expor suas instâncias diretamente à Internet.

• Grupo de segurança do balanceador de carga: um grupo de segurança do Amazon EC2 configurado para permitir tráfego de entrada na porta 80. Esse recurso permite que o tráfego HTTP da Internet acesse o load balancer. Por padrão, o tráfego não é permitido em outras portas.

• Grupo de Auto Scaling: grupo de Auto Scaling configurado para substituir uma instância se ela for encerrada ou ficar indisponível.

• Bucket do Amazon S3: um local de armazenamento do seu código-fonte, logs e outros artefatos criados quando o Elastic Beanstalk é utilizado.

• CloudWatch Alarmes da Amazon — Dois CloudWatch alarmes que monitoram a carga nas instâncias em seu ambiente e que são acionados se a carga for muito alta ou muito baixa. Quando um alarme é acionado, o seu grupo de Auto Scaling pode aumentar ou diminuir.

• AWS CloudFormation stack — O Elastic AWS CloudFormation Beanstalk usa para lançar os recursos em seu ambiente e propagar as alterações de configuração. Os recursos são definidos em um modelo que você pode visualizar no console do AWS CloudFormation.

• Nome de domínio: um nome de domínio que encaminha para a aplicação Web no formato subdomínio.região.elasticbeanstalk.com.

  nota

  Para aumentar a segurança de suas aplicações do Elastic Beanstalk, o domínio elasticbeanstalk.com é registrado na Lista Pública de Sufixos (PSL). Para maior segurança, recomendamos que você use cookies com um prefixo __Host- se precisar definir cookies confidenciais no nome de domínio padrão para suas aplicações do Elastic Beanstalk. Essa prática ajudará a defender seu domínio contra tentativas de falsificação de solicitação entre sites (CSRF). Para obter mais informações, consulte a página Set-Cookie na Mozilla Developer Network.

Todos esses recursos são gerenciados pelo Elastic Beanstalk. Quando você encerra o ambiente, o Elastic Beanstalk encerra todos os recursos dele.

nota

O bucket do Amazon S3 que o Elastic Beanstalk cria é compartilhado entre ambientes e não é excluído durante o encerramento do ambiente. Para ter mais informações, consulte Usar o Elastic Beanstalk com o Amazon S3.

Instalar o CakePHP e gerar um site

O Composer pode instalar o CakePHP e criar um projeto de trabalho com um comando:

~$ composer create-project --prefer-dist cakephp/app eb-cake

O Composer instala o CakePHP e cerca de 20 dependências e gera um projeto padrão.

Se tiver problemas ao instalar o CakePHP, visite o tópico de instalação na documentação oficial: http://book.cakephp.org/4.0/en/installation.html

Implantar o aplicativo

Crie um pacote de origem com os arquivos criados pelo Composer. O comando a seguir cria um pacote de origem chamado cake-default.zip. Ele exclui arquivos na pasta vendor, que tomam muito espaço e não são necessários para implantação da aplicação no Elastic Beanstalk.

eb-cake zip ../cake-default.zip -r * .[^.]* -x "vendor/*"

Faça upload do pacote de origem para o Elastic Beanstalk para implantar o CakePHP no ambiente.

Para implantar um pacote de origem

1. Abra o console do Elastic Beanstalk e, na lista Regiões, selecione sua. Região da AWS

2. No painel de navegação, selecione Ambientes e selecione o nome do ambiente na lista.

   nota

   Se você tiver muitos ambientes, use a barra de pesquisa para filtrar a lista de ambientes.

3. Na página de visão geral do ambiente, escolha Upload and deploy (Fazer upload e implantar).

4. Use a caixa de diálogo na tela para carregar o pacote de origem.

5. Escolha Deploy (Implantar).

6. Quando a implantação for concluída, é possível escolher o URL do site para abri-lo em uma nova guia.

nota

Para otimizar mais o pacote de origem, inicie um repositório Git e use o comando git archivepara criar o pacote de origem. O projeto do Symfony padrão inclui um arquivo .gitignore que diz para o Git excluir a pasta vendor e outros arquivos que não são necessários para implantação.

Quando o processo for concluído, clique na URL para abrir a aplicação CakePHP no navegador:

Até agora, tudo tranquilo. Em seguida, adicione um banco de dados ao ambiente e configure o CakePHP para se conectar a ele.

Adicionar um banco de dados ao seu ambiente

Execute uma instância de banco de dados do Amazon RDS no ambiente do Elastic Beanstalk. Você pode usar bancos de dados MySQL, SQLServer ou PostgreSQL com o CakePHP no Elastic Beanstalk. Neste exemplo, usaremos o PostgreSQL.

Como adicionar uma instância de banco de dados do Amazon RDS ao ambiente do Elastic Beanstalk

1. Abra o console do Elastic Beanstalk e, na lista Regiões, selecione sua. Região da AWS

2. No painel de navegação, selecione Ambientes e selecione o nome do ambiente na lista.

   nota

   Se você tiver muitos ambientes, use a barra de pesquisa para filtrar a lista de ambientes.

3. No painel de navegação, escolha Configuration (Configuração).

4. Em Database (Banco de dados), escolha Edit (Editar).

5. Em DB engine, escolha postgres.

6. Digite um username (nome de usuário) e uma password (senha) principais. O Elastic Beanstalk fornecerá esses valores para a aplicação usando propriedades de ambiente.

7. Para salvar as alterações, escolha Apply (Aplicar) na parte inferior da página.

A criação de uma instância de banco de dados leva cerca de 10 minutos. Enquanto isso, atualize o código-fonte para ler as informações de conexão do ambiente. O Elastic Beanstalk fornece detalhes de conexão usando variáveis de ambiente, como RDS_HOSTNAME, que você pode acessar na aplicação.

A configuração de banco de dados do CakePHP é armazenada em um arquivo chamado app.php na pasta config no código do projeto. Abra este arquivo e adicione um código que leia as variáveis de ambiente do $_SERVER e as atribua às variáveis locais. Insira as linhas realçadas no exemplo abaixo após a primeira linha (<?php):

exemplo ~/Eb-cake/config/app.php

<?php
if (!defined('RDS_HOSTNAME')) {
  define('RDS_HOSTNAME', $_SERVER['RDS_HOSTNAME']);
  define('RDS_USERNAME', $_SERVER['RDS_USERNAME']);
  define('RDS_PASSWORD', $_SERVER['RDS_PASSWORD']);
  define('RDS_DB_NAME', $_SERVER['RDS_DB_NAME']);
}
return [
...

A conexão do banco de dados está configurada mais abaixo no arquivo app.php. Encontre a seção a seguir e modifique a configuração de fontes de dados padrão com o nome do driver que corresponde ao seu mecanismo de banco de dados (Mysql, Sqlserver ou Postgres) e defina as variáveis host, username, password e database para ler os valores correspondentes do Elastic Beanstalk:

exemplo ~/Eb-cake/config/app.php

...
     /**
     * Connection information used by the ORM to connect
     * to your application's datastores.
     * Drivers include Mysql Postgres Sqlite Sqlserver
     * See vendor\cakephp\cakephp\src\Database\Driver for complete list
     */
    'Datasources' => [
        'default' => [
            'className' => 'Cake\Database\Connection',
            'driver' => 'Cake\Database\Driver\Postgres',
            'persistent' => false,
            'host' => RDS_HOSTNAME,
            /*
             * CakePHP will use the default DB port based on the driver selected
             * MySQL on MAMP uses port 8889, MAMP users will want to uncomment
             * the following line and set the port accordingly
             */
            //'port' => 'non_standard_port_number',
            'username' => RDS_USERNAME,
            'password' => RDS_PASSWORD,
            'database' => RDS_DB_NAME,
            /*
             * You do not need to set this flag to use full utf-8 encoding (internal default since CakePHP 3.6).
             */
            //'encoding' => 'utf8mb4',
            'timezone' => 'UTC',
            'flags' => [],
            'cacheMetadata' => true,
            'log' => false,
...

Quando a instância de banco de dados tiver iniciado, crie um pacote e implante o aplicativo atualizado no ambiente:

Como atualizar o ambiente do Elastic Beanstalk

1. Crie um novo pacote de origem:

   ~/eb-cake$ zip ../cake-v2-rds.zip -r * .[^.]* -x "vendor/*"

2. Abra o console do Elastic Beanstalk e, na lista Regiões, selecione sua. Região da AWS

3. No painel de navegação, selecione Ambientes e selecione o nome do ambiente na lista.

   nota

   Se você tiver muitos ambientes, use a barra de pesquisa para filtrar a lista de ambientes.

4. Escolha Upload and Deploy.

5. Escolha Browse e faça upload de cake-v2-rds.zip.

6. Escolha Implantar.

Implantar uma nova versão do seu aplicativo leva menos de um minuto. Quando a implantação for concluída, atualize a página da web novamente para verificar se a conexão com o banco de dados foi bem-sucedida:

Limpeza

Ao terminar de trabalhar com o Elastic Beanstalk, você pode encerrar o ambiente. O Elastic Beanstalk AWS encerra todos os recursos associados ao seu ambiente, como instâncias do Amazon EC2, instâncias de banco de dados, balanceadoresde carga, grupos de segurança e alarmes.

Para encerrar seu ambiente do Elastic Beanstalk a partir do console

1. Abra o console do Elastic Beanstalk e, na lista Regiões, selecione sua. Região da AWS

2. No painel de navegação, selecione Ambientes e selecione o nome do ambiente na lista.

   nota

   Se você tiver muitos ambientes, use a barra de pesquisa para filtrar a lista de ambientes.

3. Escolha Actions (Ações) e depois Terminate Environment (Encerrar ambiente).

4. Use a caixa de diálogo na tela para confirmar o encerramento do ambiente.

Com o Elastic Beanstalk, é possível criar facilmente um ambiente para a aplicação a qualquer momento.

Além disso, é possível encerrar recursos do banco de dados que você criou fora do ambiente do Elastic Beanstalk. Ao encerrar uma instância de banco de dados do Amazon RDS, você poderá criar um snapshot e restaurar os dados em outra instância posteriormente.

Para encerrar sua instância de banco de dados do RDS

1. Abra o console do Amazon RDS.

2. Escolha Databases (Bancos de dados).

3. Escolha a instância de banco de dados.

4. Escolha Ações e, em seguida, escolha Excluir.

5. Escolha se deseja criar um snapshot. Depois, escolha Excluir.

Próximas etapas

Para obter mais informações sobre o CakePHP, leia o livro em book.cakephp.org.

À medida que você desenvolva a aplicação, provavelmente vai precisar de uma maneira de gerenciar ambientes e implantá-la sem criar manualmente um arquivo .zip e carregá-la no console do Elastic Beanstalk. A interface de linha de comando do Elastic Beanstalk (EB CLI easy-to-use ) fornece comandos para criar, configurar e implantar aplicativos nos ambientes do Elastic Beanstalk a partir da linha de comando.

A execução de uma instância de banco de dados do Amazon RDS no ambiente do Elastic Beanstalk é ideal para desenvolvimento e teste, mas vincula o ciclo de vida do banco de dados ao ambiente. Para obter instruções sobre como se conectar a um banco de dados em execução fora de seu ambiente, consulte Adicionar uma instância de RDS banco de dados Amazon ao seu ambiente do PHP Elastic Beanstalk.

Por fim, se você planeja usar seu aplicativo em um ambiente de produção, configure um nome de domínio personalizado para seu ambiente e habilite HTTPS para conexões seguras.