Este projeto é uma aplicação Java 21 usando Gradle para automação de builds e Flyway para migração de banco de dados. Ele é configurado para rodar em um ambiente Docker, utilizando docker compose para orquestrar os contêineres do banco de dados PostgreSQL e da aplicação.
Video Fase 2: https://youtu.be/3O_Ujf5kH8w
| Nome: | Matrícula: | E-mail: |
|---|---|---|
| Alexandre Casella Speltri | RM354896 | alexandreporks@gmail.com |
| Gabriel Henrique da Silva Gava | RM355695 | nero.gava@gmail.com |
| Gabriela Oliveira De Freitas Gomes | RM353369 | gabriella_gomes@ymail.com |
- Pré-requisitos
- Estrutura Geral
- Executando o Projeto com Docker
- Executando com Kubernetes
- Configurações adicionais
- Limpeza e parada dos serviços
- Swagger e Debug
- Docker instalado
- Docker Compose instalado
- Minikube e Kubectl (Opcional)
build.gradle- Configuração do Gradle.settings.gradle- Configuração dos projetos Gradle.src/main/java- Código fonte da aplicação.src/main/resources- Recursos da aplicação, incluindo scripts de migração Flyway.Dockerfile- Instruções para criar a imagem Docker da aplicação.docker-compose.yml- Configuração para iniciar os serviços Docker.
Antes de executar a aplicação, você precisa construir as imagens e contêineres Docker. Com o Docker Desktop aberto (Windows) ou com serviço do Docker rodando (macOS/Linux), navegue até o diretório do projeto e execute o seguinte comando:
docker compose up -dO "-d" significa "detached mode". Assim o docker compose inicia os contêineres em segundo plano.
Este comando criará e iniciará dois contêineres:
postgres: um contêiner rodando PostgreSQL.tech-challenge: um contêiner rodando a aplicação Java.
Após iniciar os serviços, você pode verificar se a aplicação está funcionando corretamente acessando a rota de HealthCheck em http://localhost:8080/healthcheck. A resposta esperada é:
API is up and running
Você também pode verificar os logs para garantir que a aplicação e o banco de dados iniciaram corretamente:
docker compose logs -fOu utilize o Docker Desktop.
Para executar o projeto dentro de um cluster Kubernetes (K8s), é necessário, primeiramente, criar seu cluster usando Minikube ou Docker Desktop. Após a criação do cluster, siga os passos abaixo utilizando o terminal na pasta de deployment (src/main/resources/deployment):
kubectl apply -f postgres-secrets.yamlkubectl apply -f postgres-deployment.yamlkubectl apply -f app-deploy.yaml
O Kubernetes será responsável por criar toda a estrutura de deployments, load balancer, services e pods.
Para visualizar todos os pods em execução, bem como seus IDs e portas, use o comando:
kubectl get pods
Para acessar um pod a partir de sua máquina, é necessário fazer um "port forward" com o seguinte comando:
kubectl port-forward spring-rest-api-${id} 8080:8080
Onde ${id} é o identificar do POD.
O banco de dados PostgreSQL está configurado com as seguintes credenciais (definidas no docker-compose.yml):
- Nome do Banco de Dados:
galega_burguer - Usuário:
postgres - Senha:
postgres
As variáveis de ambiente para a configuração da fonte de dados do Spring Boot estão definidas no docker-compose.yml:
environment:
SPRING_DATASOURCE_URL: jdbc:postgresql://postgres:5432/galega_burguer
SPRING_DATASOURCE_USERNAME: postgres
SPRING_DATASOURCE_PASSWORD: postgresOs scripts de migração do Flyway devem ser colocados no diretório src/main/resources/db/migration. O Flyway irá automaticamente detectar esses scripts e aplicá-los ao banco de dados ao iniciar a aplicação.
Para parar os serviços e remover os contêineres, volumes e redes criados pelo docker compose, execute:
docker compose down -vOu utilize o Docker Desktop.
Para acessar nossa documentação de API REST no padrão Swagger, basta acessar a seguinte URL no seu navegador:
Tanto o Dockerfile quanto o docker-compose.yml estão configurados para expor a porta 5005 para debug. Basta conectar o JVM debug de sua IDE em:
localhost:5005