Tech Challenge - Fase 1: Plataforma "ToggleMaster"

Bem-vindo à primeira fase do Tech Challenge do curso de DevOps! Neste projeto, construiremos uma plataforma de Feature Flag as a Service chamada ToggleMaster.

📖 Cenário

A DevOps Solutions Inc. precisa de uma forma para que seus times de desenvolvimento possam lançar novas funcionalidades de forma segura e controlada. A solução é o ToggleMaster, uma plataforma interna que permitirá ativar ou desativar features em produção sem a necessidade de um novo deploy.

Nesta primeira fase, nosso foco é criar e implantar o MVP (Produto Mínimo Viável) da plataforma, que consiste em uma API monolítica simples para gerenciar as feature flags.

🎯 Objetivos da Fase 1

O objetivo principal é aplicar os conceitos fundamentais de DevOps e Cloud. Ao final desta fase, você deverá ser capaz de:

• Analisar uma aplicação monolítica e discutir suas vantagens e desvantagens.
• Desenhar uma arquitetura de nuvem inicial para uma aplicação web na AWS.
• Provisionar manualmente recursos essenciais na AWS (VPC, EC2, RDS, Security Groups).
• Realizar o deploy de uma aplicação, configurando a conexão com um banco de dados externo.
• Compreender e aplicar práticas básicas de segurança na AWS (IAM, Security Groups).

🛠️ Pré-requisitos

Antes de começar, garanta que você tenha:

• Docker e Docker Compose instalados.
• Uma conta na AWS Academy (você também pode usar o Free Tier para a maioria das tarefas).
• Um cliente de API como Postman ou Insomnia, ou conhecimento em curl.

Instalando o Docker

Escolha o guia para o seu sistema operacional.

🐧 Para Linux (Ubuntu, Debian, CentOS)

O método mais simples é usar o script de conveniência oficial do Docker.

1. Baixe o script de instalação:

   curl -fsSL [https://get.docker.com](https://get.docker.com) -o get-docker.sh

2. Execute o script para instalar o Docker:

   sudo sh get-docker.sh

3. Adicione seu usuário ao grupo do Docker (Passo Pós-Instalação Importante): Para poder executar comandos docker sem precisar usar sudo toda vez, adicione seu usuário ao grupo docker.

   sudo usermod -aG docker $USER

   Atenção: Após executar o comando acima, você precisa fazer logout e login novamente na sua sessão (ou reiniciar a máquina) para que a alteração tenha efeito.

🪟 Para Windows ou 🍏 Para macOS

A forma recomendada é instalar o Docker Desktop, que é uma aplicação gráfica que inclui o Docker Engine, o docker compose e outras ferramentas.

1. Acesse a página oficial e baixe o instalador: Docker Desktop
2. Siga as instruções do instalador gráfico. Ele cuidará de toda a configuração para você.

Nota sobre o docker-compose: As versões mais recentes do Docker (instaladas pelos métodos acima) já vêm com o docker compose como um plugin. O comando moderno é docker compose (com espaço). A versão antiga, docker-compose (com hífen), está sendo descontinuada. Este projeto usará a sintaxe moderna.

---

🚀 Como Executar Localmente (com Docker)

Para facilitar o desenvolvimento, o projeto está configurado para rodar com Docker Compose. Ele irá subir a aplicação e um banco de dados PostgreSQL com um único comando.

1. Clone o repositório:

   git clone <url-do-seu-repositorio>

2. Navegue até a pasta do projeto:

   cd toggle-master-monolith

3. Construa e inicie os contêineres:

   docker-compose up --build

4. Verifique se a aplicação está no ar: Abra um novo terminal e execute o seguinte comando curl:

   curl http://localhost:5000/health

   Você deve receber a seguinte resposta:

   {
     "status": "ok"
   }

5. Para encerrar a execução: No terminal onde o docker-compose está rodando, pressione Ctrl + C. Em seguida, para garantir que os contêineres e a rede sejam removidos, execute:

   docker-compose down

Endpoints da API

Você pode usar o Postman ou curl para interagir com a API rodando localmente (http://localhost:5000) ou na sua instância EC2 (http://<ip-publico-ec2>:5000).

Método	Endpoint	Body (Exemplo)	Descrição
POST	/flags	{"name": "new-feature", "is_enabled": true}	Cria uma nova feature flag.
GET	/flags	N/A	Lista todas as flags existentes.
GET	/flags/<nome-da-flag>	N/A	Retorna o status de uma flag.
PUT	/flags/<nome-da-flag>	{"is_enabled": false}	Atualiza o status de uma flag.

Exemplos com curl

Abra seu terminal e utilize os comandos abaixo para interagir com a API.

1. Criar uma nova flag (new-feature)

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"name": "new-feature", "is_enabled": true}' \
  http://localhost:5000/flags

Saída esperada:

{
  "message": "Flag 'new-feature' created successfully"
}

2. Listar todas as flags:

curl -X GET http://localhost:5000/flags

Saída esperada:

[
  {
    "is_enabled": true,
    "name": "new-feature"
  }
]

3. Consultar uma flag específica (new-feature):

curl -X GET http://localhost:5000/flags/new-feature

Saída esperada:

{
  "is_enabled": true,
  "name": "new-feature"
}

4. Atualizar uma flag (desativar a new-feature):

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"is_enabled": false}' \
  http://localhost:5000/flags/new-feature

Saída esperada:

{
  "message": "Flag 'new-feature' updated"
}

💻 O Desafio

Sua missão é pegar esta aplicação monolítica e implantá-la na AWS. O ambiente local com Docker serve para você entender e testar a aplicação, mas a entrega final deve ser a aplicação rodando na nuvem.

Suas tarefas são:

1. Análise da Aplicação: Estude o arquivo app.py e os demais arquivos para entender a estrutura básica de como a aplicação funciona, principalmente o Dockerfile e Docker compose.
2. Arquitetura na Nuvem: Desenhe a arquitetura de implantação e estime os custos.
3. Deploy Manual na AWS: Crie a infraestrutura (EC2, RDS, etc.) e siga o guia de instalação abaixo para implantar a aplicação.

---

⚙️ Guia de Instalação e Deploy na EC2

Este guia assume que você já criou uma instância EC2 e um banco de dados RDS, e que consegue se conectar à sua EC2 via SSH.

Importante: Lembre-se de configurar o Security Group da sua instância EC2 para permitir tráfego de entrada na porta 5000 (para a aplicação) e na porta 22 (para o SSH). O Security Group do RDS deve permitir tráfego na porta 5432 vindo do Security Group da sua EC2.

Escolha a opção correspondente ao sistema operacional da sua instância EC2.

Opção A: Para Amazon Linux 2 ou Amazon Linux 2023

1. Atualize o sistema e instale as ferramentas:

   sudo yum update -y
   sudo yum install -y git python3 python3-pip

2. Clone o repositório do seu projeto:

   git clone <url-do-seu-repositorio>
   cd toggle-master-monolith

3. Crie e ative um ambiente virtual para o Python:

   python3 -m venv venv
   source venv/bin/activate
   # Seu prompt do terminal deve mudar, indicando que o ambiente virtual está ativo.

4. Instale as dependências da aplicação:

   pip install -r requirements.txt

Opção B: Para Ubuntu Server 20.04 / 22.04 LTS

1. Atualize o sistema e instale as ferramentas:

   sudo apt update && sudo apt upgrade -y
   sudo apt install -y git python3-pip python3-venv

2. Clone o repositório do seu projeto:

   git clone <url-do-seu-repositorio>
   cd toggle-master-monolith

3. Crie e ative um ambiente virtual para o Python:

   python3 -m venv venv
   source venv/bin/activate
   # Seu prompt do terminal deve mudar, indicando que o ambiente virtual está ativo.

4. Instale as dependências da aplicação:

   pip install -r requirements.txt

---

Executando a Aplicação (Comandos iguais para ambos os sistemas)

Após instalar as dependências, siga estes passos para configurar e rodar a aplicação.

1. Exporte as variáveis de ambiente: A aplicação precisa saber como se conectar ao banco de dados RDS. Execute os comandos export abaixo, substituindo os valores pelos dados do seu RDS.

   ⚠️ AVISO DE SEGURANÇA: Estes comandos armazenam as credenciais apenas na sessão atual do terminal. NUNCA salve suas senhas e endpoints diretamente no código ou em scripts versionados no Git!

   export DB_HOST='<aqui-vai-o-endpoint-do-seu-rds>'
   export DB_NAME='<nome-do-banco-de-dados-que-voce-criou>'
   export DB_USER='<usuario-admin-do-rds>'
   export DB_PASSWORD='<senha-do-usuario-admin>'

2. Inicie a aplicação com Gunicorn: Gunicorn é um servidor WSGI recomendado para produção. O comando 0.0.0.0 faz com que a aplicação escute em todas as interfaces de rede da EC2, tornando-a acessível publicamente.

   gunicorn --bind 0.0.0.0:5000 app:app

3. Verifique o acesso: A aplicação estará rodando. Agora você pode acessá-la usando o IP Público ou o DNS Público da sua instância EC2, seguido da porta 5000. Exemplo: http://54.207.111.222:5000/health

Nota: O comando gunicorn acima executa a aplicação no foreground. Se você fechar sua sessão SSH, a aplicação irá parar. Em um ambiente de produção real, usaríamos um gerenciador de processos como systemd para rodar a aplicação como um serviço, mas para este desafio, rodar no foreground é suficiente.

---

딜 Entregáveis da Fase 1

Você deve entregar os seguintes itens:

1. Vídeo de Demonstração (até 15 minutos):

   • Apresentação rápida da aplicação rodando localmente com Docker.
   • Explicação do seu diagrama de arquitetura para a AWS.
   • Demonstração da aplicação rodando na EC2, provando que está conectada ao RDS.
   • Mostre as configurações de Security Group que garantem a segurança do ambiente.

2. Documentação:

   • Link para o seu diagrama de arquitetura (Miro, Diagrams.net, etc.).

3. Relatório de Entrega (ENTREGA.md ou .pdf):

   • Nomes dos participantes.
   • Link para o vídeo e para a documentação.
   • Resumo dos desafios encontrados e das decisões tomadas.

💡 Dicas e Pontos de Atenção

• ⚠️ SEGURANÇA: Nunca, jamais, suba suas chaves de acesso da AWS para o seu repositório Git.
• 💸 CUSTOS: Fique atento aos recursos que você cria na AWS. Utilize o AWS Academy ou Free Tier sempre que possível e lembre-se de desligar ou remover os recursos após a avaliação do desafio.
• 📝 DOCUMENTAÇÃO: Uma boa documentação é parte crucial da cultura DevOps. Descreva suas escolhas e justifique-as.

Boa sorte!