Skip to content

agodoi/EC2-RESTFull

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Semana 01 - Arquitetura de Computação em Nuvem com API

Neste encontro iremos apresentar os principais serviços utilizados e o funcionamento de uma aplicação simples na nuvem.

Desta forma conseguimos compreender como podemos distribuir, armazenar e analisar dados na nuvem eficientemente.

Iremos também abordar as regiões e como escolher adequadamente o local de armazenamento dos seus dados e dos clientes de forma segura e confiável.

Vamos resgatar o conceito de API aplicando uma prática usando FLASK (minimal application), utilizando o EC2 da AWS, e realizar requisições na API.

Contexto e Ganhos no Projeto da Vivo

Sabemos que o problema é sincronizar o estoque de telefones da Vivo entre as centenas de loja.

A sua solução será uma aplicação aplicação Web e que pode aproveitar essa arquitetura que vamos discutir, mas em especial, no projeto da Vivo, as consultas no banco de estoque terão maior fluidez e segurança.

Vamos entender como isso funciona?

O que é região e zona AWS?

Uma região é uma soma de zonas.

Em uma região da AWS, temos diferentes zonas de disponibilidade, essas zonas de disponibilidade estão a uma distância que permita latências de até 1 ms, além de ter sistemas redundantes.

Há uma distância com probabilidade calculada e segura entre elas para reduzir o risco de um evento natural que possa afetar mais de uma zona de disponibilidade.

Cada região AWS é totalmente independente, isto é, é projetada para ser isolada das outras regiões da AWS.

Esse design proporciona o máximo de tolerância a falhas e estabilidade possível.

Atualmente, a AWS possui 31 regiões no mundo, mas existe +4 em fase final de construção: Canadá, Israel, Nova Zelândia e Tailândia.

E de zonas, são 99 ao todo, porque dentro de uma região, tem-se vários zonas.

Região e Zonas AWS

Qual a melhor região?

Para definir a melhor região, deve-se usar a calculadora da AWS para simular os preços, pois depende da sua arquitetura e do SLA (Service Level Agreement) de cada componente (que basicamente é o nível de disponibilidade que ele oferece), a resiliência e a tolerência à falhas oferecidas.

Outra questão é a LGPD que a depender do seu negócio, exige que os dados pessoais e sensíveis dos usuários envolvidos estejam no território brasileiro. A AWS sabendo disso, pode cobrar valores maiores devido à exigência dos dados permanecerem sempre numa mesma região.

Região e Zonas AWS

Aula Prática

Arquitetura gunicorn

Nessa aula, vamos usar uma instância EC2 com:

  • NGINX (deployment):

    É um servidor web open source de alta performance que entrega o conteúdo estático de um site de forma rápida e fácil de configurar. É famoso entre grandes empresas da área de TI e concorre direto com o Apache. Não é preciso se preocupar com a quantidade de conexões simultâneas (concorrência) feitas no site, pois ele é altamente elástico.

    A função dele é receber as requisições HTTP do seu site e encaminhá-las para uma porta do Gunicorn.

    Ele também é um proxy reverso, o que significa que ele pode encaminhar solicitações de clientes para um ou mais servidores de backend (por exemplo, servidores de aplicação como Node.js, Python, Ruby on Rails, etc.). Isso é útil para distribuir carga, aumentar a segurança e cacheamento (armazenar em cache respostas do servidor backend para reduzir a carga e acelerar o tempo de resposta).

    Volte no gráfico para entender a arquitetura que vamos montar ou acesse mais informações sobre o que é NGINX aqui.

  • Gunicorn (backend):

    É uma abreviação de Green Unicorn. Trata-se de um servidor HTTP WSGI (Web Server Gateway Interface) para Python. Ele é um ambiente executável de aplicativos da web Python, como aplicativos Django ou Flask. No exemplo de hoje, vamos usar o Flask.

    Para executar um aplicativo Python com o Gunicorn, você normalmente precisa criar um arquivo de configuração, especificando o número de processos que o servidor deve utilizar. O Gunicorn então gerencia esses processos e cuida da comunicação entre o servidor da web e o aplicativo Python. Esse aplicativo será chamado de index.py mais para frente. Clique aqui para conhecer um exemplo didático.

  • Flask (backend):

    É uma biblioteca, um framework que utiliza a linguagem Python para criar aplicativos Web. Muito útil para a criação de API RESTful, que por sua vez, utiliza os métodos padrão do protocolo HTTP (como GET, POST, PUT, DELETE) ou CRUD (Create, Read, Update and Delete). No Flask vai o código Python que será executado no ambiente Gunicorn.

Objetivo dessa prática

Vamos criar uma API usando Flask que será executado no ambiente gunicorn pela porta 8000 e estará roteado pelo nginx pela porta 80.

Pré-requisitos

  1. Tenha uma conta AWS "logada", seja acadêmica, seja particular.
  2. Possuir matrícula no curso LearnLab da AWS.
  3. Estar numa rede local com conectividade SSH externo.

Passo-01

Crie uma instância EC2 no console AWS com as seguintes características:

1.1) Sugestão de nome EC2-flask

1.2) Sistema operacional Ubuntu

1.3) Salve a chave SSH na pasta download para evitar problemas de restrição de arquivo do Windows. Sugestão de nome "EC2-flask". Chave tipo PEM.

1.4) Configurações de Rede (clique no botão EDITAR) e faça:

1.4.1) Clique no botão Adicionar regra de segurança que está na parte final da opção Configurações de Rede

1.4.2) Escolha em Tipo bote HTTPS e Tipo de Origem bote Qualquer lugar

1.4.3) Clique novamente em Adicionar regra de segurança e adicione TCP personalizado, Qualquer lugar, digite 8000 no campo Intervalo de portas (apague o 0 e coloque 8000).

1.5) Confirme tudo no botão laranja Executar instância e aguarde o EC2 subir.

Arquitetura gunicorn

Passo-02

Abra o terminal Power Shell ou CMD do Windows ou qualquer outro terminal que suporte a conexão SSH (Secure Shell) e cole a linha de acesso da instância do seu EC2. Você consegue essa linha de acesso clicando em CONECTAR que está no seu console AWS, na opção EC2. Exemplo de linha de acesso:

ssh -i "FlaskServerUbuntu.pem" [email protected]

A sua chave PEM que você fez download da AWS precisa estar no mesmo diretório que você está apontado no seu terminal Power Shell.

Passo-02 (teste)

Se a conexão SSH com o seu EC2 tiver ocorrido com sucesso, você terá instanciado um computador virtual na infraestrutura da AWS e terá as seguintes impressões de mensagens na seu terminal:

Welcome to Ubuntu 22.04.2 LTS (GNU/Linux 5.19.0-1025-aws x86_64)

>Documentation: https://help.ubuntu.com

>Management: https://landscape.canonical.com

>Support: https://ubuntu.com/advantage

System information as of Wed Aug 2 19:08:03 UTC 2023 [...]

e você estará parado num diretório raiz do tipo ubuntu@ip-172-31-93-207:~$ onde o IP será exclusivo da sua instância e não igual a esse.

Passo-03:

Atualize sua instância EC2 com os seguintes comandos:

3.1) Dê o comando sudo apt-get update [enter]

3.2) Dê o comando sudo apt-get install python3.12-venv [enter]

Caso após a instalação com sucesso, apareça essa tela abaixo, você marca a primeira opção e confirma com [enter]. Se não aparecer, tudo bem, segue em frente.

Tela-01

Passo-04:

Nessa etapa, vamos criar um diretório e um subdiretório dentro dele:

4.1) Crie o diretório: mkdir projeto-flask [enter]

4.2) Entre no diretóario projeto-flask e crie o subdiretório: projeto-flask\ mkdir main [enter]

4.3) Esteja no diretório raiz projeto-flask/

Passo-05:

Vamos instalar um ambiente virtual chamado venv (segundo venv do comando) para você criar as dependências python exclusivas para essa prática. Daqui para frente, mantenha-se no path projeto-flask/

O -m indica que você deseja executar um módulo específico no python3, que nesse caso, é o venv (primeiro venv do comando)

5.1) Comando no diretório raiz projeto-flask: python3 -m venv venv

Passo-06:

Vamos ativar o seu ambiente virtual chamado venv:

6.1) Na raiz **projeto-flask**: source venv/bin/activate [enter]

O resultado será o surgimento do (venv) no início do seu path raiz. Exemplo: (venv) ubuntu@ip-172-31-32-65:~/projeto-flask$

Passo-07:

Instale o Flask no seu ambiente virtual:

7.1) Na raiz (venv) ubuntu@ip-172-31-32-65:~/projeto-flask$ pip install flask

Passo-08:

8.1) Cuidado! Agora você precisa entrar na subpasta (venv)projeto-flask/main para criar e editar a aplicação que se chamará index.py. Depois, retorne para (venv)projeto-flask/

8.2) Dê o comando sudo nano index.py na subpasta

E adicione o seguinte código dentro do index.py. Copie e cole esse código, cuidado com os aninhamentos. Dê um Ctrl+S para Salvar e Ctrl+X para sair do editor.

from flask import Flask, jsonify, request

app = Flask(__name__)

incomes = [
    { 'description': 'salary', 'amount': 12.200 }
]

@app.route('/incomes')

def get_incomes():
    return jsonify(incomes)


@app.route('/incomes', methods=['POST'])

def add_income():
    incomes.append(request.get_json())
    return '', 204


if __name__ == "__main__":
    app.run()

Caso queira conferir como ficou a sua edição, faça:

8.3) Comando cat index.py [enter]

Caso queira testar o seu código index.py, faça:

8.4) Comando python3 index.py [enter]

E o resultado será essa tela abaixo:

Tela-02

Passo-09:

9.1) Atenção! Volte para (venv)projeto-flask/ dando o comando cd ... Agora vamos instalar o servidor python gunicorn:

9.2)Comando pip install gunicorn [enter]

Passo-10:

Agora vamos criar o script de boot no seu EC2:

10.1) Comando: sudo nano /etc/systemd/system/projeto.service

E copie e cole esse script no seu arquivo projeto.service:

[Unit]
Description=Gunicorn serve para instanciar uma simples aplicacao main.service
After=network.target

[Service]
User=ubuntu
Group=www-data
WorkingDirectory=/home/ubuntu/projeto-flask
ExecStart=/home/ubuntu/projeto-flask/venv/bin/gunicorn -b localhost:8000 main.index:app
Restart=always

[Install]
WantedBy=multi-user.target

Passo-11:

Agora execute o serviço main.index:

11.1) Comando: sudo systemctl start projeto.service

11.2) Comando: sudo systemctl restart projeto.service

Caso altere alguma coisa no projeto.service, faça:

11.3) Comando opcional nessa etapa: sudo systemctl daemon-reload

Caso queira iniciar automaticamente o serviço projeto.service no booting da sua instância EC2, faça:

11.4) Comando opcinoal nessa etapa: sudo systemctl enable projeto.service

Caso queira testar localmente como está sua aplicação, faça:

11.5) É bão fazer esse teste: curl localhost:8000/incomes

E o resultado será o que está na figura a seguir:

Tela-03

Se você não viu a figura acima, faça o seguinte: senta e chora!

11.6) Comando: sudo systemctl stop projeto.service [enter]

11.7) Comando: sudo systemctl restart projeto.service [enter]

Passo-12:

Falta instalar o NGINX no seu ambiente virtual, então faça:

12.1) Comando: sudo apt install nginx

Caso você terá essa tela abaixo, marque a opção e confirme com [enter]. Caso não, siga em frente que está tudo bem.

Tela-04

Passo-13:

Agora vamos ajustar o servidor NGINX para endereçar a nossa aplicação:

13.1) Comando: sudo nano /etc/nginx/sites-available/default na raiz do projeto.

Adicione essas linhas logo no começo, após os comentários

#Please see /usr/share/doc/nginx-doc/examples/ for more detailed examples.
#Default server configuration

upstream flaskhelloworld {
  server 127.0.0.1:8000;
}

e dentro do location, comente esse linha:

try_files $uri $uri/ =404;

e adicione essa:

proxy_pass http://flaskhelloworld;

ficando assim:

location / {
                # First attempt to serve request as file, then
                # as directory, then fall back to displaying a 404.
                # try_files $uri $uri/ =404;
                proxy_pass http://flaskhelloworld;
        }

13.2) Salve e saia desse arquivo.

Passo-14:

Vamos iniciar o servidor:

14.1) Comando sudo systemctl start nginx

14.2) Comando sudo systemctl restart nginx

Passo-15:

Agora está na hora de testar a sua API. Então faça:

Copie seu link externo do EC2 (que está no console da AWS, em EC2, na opção DNS IPv4 público) e cole no navegador acrescido de /incomes

Exemplo: ec2-54-161-205-18.compute-1.amazonaws.com/incomes

Um ponto de atenção. Se você esqueceu de Adicionar Regra de Segurança HTTPS na ETAPA 01, seu endereço do navegador não pode ter HTTPS e sim, HTTP, pois sua aplicação não está usando HTTP criptografado. Cuidado com isso, pois vai parecer que não está funcionando direito.

Quando fizer isso, você fará um GET e deverá retornar o seguinte:

Tela-05

Passo-16:

Agora vamos fazer testes usando o https://www.postman.com/ (você terá que abrir uma conta, é gratuito).

Tela-06

Dentro do Postman, crie um novo My Workspace, coloque um nome que desejar

Clique no sinal de + para adicionar uma aba;

a) Clique em Headers e preencha:

  • Na coluna Key coloque Content-Type
  • Na coluna value coloque application/json

b) Clique em Body e preencha com json abaixo e clique em raw

{
    "amount": 2024,
    "description": "teste"
}

c) Selecione o método POST e cole seu link EC2 acrescido de /incomes

Tela-07

d) Clique em SEND e depois vá na aba do seu navegador onde está o link EC2/incomes e atualize a tela, e você terá o resultado do POST que acabou de fazer

e) Você pode fazer um GET nesse ambiente Postman que retornará os POST que você acabou de fazer.

FIM!

Você acabou de fazer uma aplicação API usando uma arquitetura profissional que usa o NGINX, Flask com Gunicorn!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published