Trabalho Individual 2021.2

Os conhecimentos de Gestão de Configuração de Software são fundamentais no ciclo de vida de um produto de software. As técnicas para a gestão vão desde o controle de versão, automação de build e de configuração de ambiente, testes automatizados, isolamento do ambiente até o deploy do sistema. Todo este ciclo nos dias de hoje são integrados em um pipeline de DevOps com as etapas de Integração Contínua (CI) e Deploy Contínuo (CD) implementadas e automatizada.

Para exercitar estes conhecimentos, neste trabalho, você deverá aplicar os conceitos estudados ao longo da disciplina no produto de software contido neste repositório.

O sistema se trata de uma aplicação em Ruby on Rails composta por:

Aplicação de Gerência de Biblioteca;
Banco de Dados Postgres;

Para executar a aplicação em sua máquina, basta seguir o passo-a-passo descrito no arquivo README da pasta.

Resumo da aplicação

A aplicação é um simples sistema de cadastro de livros. Porém, o foco do trabalho é na automação da build, testes, conteinerização e configuração dos pipelines de CI/CD. Está escrita em Ruby on Rails, utiliza o banco de dados Postgres e inclui testes.

Etapas de trabalho

O trabalho deve ser elaborado através de etapas. Cada uma das etapas deve ser realizada em um commit separado com o resultado funcional desta etapa.

As etapas de 1 a 3 são relacionadas ao isolamento do ambiente utilizando a ferramenta Docker e Docker Compose. Neste sentido o tutorial abaixo cobre os conceitos fundamentais para o uso destas tecnologias.

Tutorial de Docker

As etapas de 4 e 5 são relacionadas à configuração do pipeline de CI e CD.

Tutorial CI - Gitlab

1. Containerização do Banco

A versão inicial do sistema é uma aplicação Ruby on Rails cujo funcionamento requer uma instalação de um banco de dados Postgres. A primeira etapa do trabalho é de configurar um container somente para o banco de dados com as credenciais especificadas na descrição da aplicação e testar o funcionamento do mesmo.

2. Containerização da Aplicação + Banco

Nesta segunda etapa, tanto a aplicação quanto o banco de dados deverão estar funcionando em containers individuais.

Deverá ser utilizado um orquestrador (Docker Compose) para gerenciar comunicação entre os containers além do uso de credenciais, networks, volumes, entre outras configurações necessárias para a correta execução da aplicação.

3. Adição de um container do Nginx

A aplicação originalmente está configurada para rodar com um servidor web simples interno na porta 3000. Nesta etapa será necessário adicionar o servidor Nginx para servir a aplicação através da porta 80. O resultado final também estará expresso utilizando o Docker Compose.

4. Integração Contínua (CI)

Para a realização desta etapa, a aplicação já deverá ter seu ambiente completamente containerizado.

Deverá ser utilizada uma ferramenta de Integração Contínua para garantir o build, os testes e os deploy para o Docker Hub dos serviços principais.

Esta etapa do trabalho poderá ser realizada utilizado os ambientes de CI do GitLab-CI. ou Github Actions.

Requisitos da configuração da Integração Contínua (Gitlab ou Github) incluem:

Build
Test
Lint

5. Deploy Contínuo (CD)

A etapa final do trabalho deverá ser realizada à partir do deploy automático da aplicação que deve ser realizado à partir após passar sem erros em todas as etapas de CI.

Avaliação

A avaliação do trabalho será feita à partir da correta implementação de cada etapa 1 a 5. A avaliação será feita de maneira quantitativa (se foi realizado a implementação + documentação), e qualitativa (como foi implementado, entendimento dos conceitos na prática, complexidade da solução). Para isso, faça os commits atômicos, bem documentados, completos a fim de facilitar o entendimento e avaliação do seu trabalho. Lembrando o trabalho é individual.

Item	Peso
Containerização do Banco	1.0
Containerização da Aplicação + Banco	2.0
Containerização da Aplicação + Banco + Nginx	2.0
Integração Contínua (Build, Test, Lint)	3.0
Deploy Contínuo	2.0

Exemplo de Trabalhos Anteriores

Alguns trabalhos de trabalhos anteriores:

Instruções para utilização

Pré-requisitos

Docker
Docker Compose
Git

1. Realizar clone do repositório

git clone https://github.com/MaiconMares/Trabalho-Individual-2021-2.git

2. Fazer build da imagem

sudo docker-compose build

Ou para versões mais recentes do compose:

sudo docker compose build

3. Subir os containers

sudo docker-compose up

sudo docker compose up

4. Abrir o servidor

Repare que nessa etapa o banco já terá sído criado e migrado. Basta apenas ir no navegador de sua preferência e acessar a aplicação. As urls são:

aplicação: http://0.0.0.0:3000
nginx: http://0.0.0.0:80

Comando alternativos

Criar banco de dados, rodar migrações e executar seed:

sudo docker-compose run app rails db:setup

sudo docker compose run app rails db:setup

Derrubar containers

sudo docker-compose down

sudo docker compose down

Rodar comandos dentro de um container: Pode ser mais fácil executar comandos separadamente dentro do container, para isto rode:

sudo docker exec -it <nome-container> bash

Obs.: Em alguns computadores pessoais pode não ser necessário utilizar sudo se o docker e docker compose já estiverem incluídos em um grupo.

Nome dos containers:

app: container da aplicação
database: container do banco de dados PostgreSQL
nginx: container do servidor Nginx

Informações úteis

Usuário do banco: tesla
Senha do banco: tesla

Nota: Isso se aplica a todos os bancos.