Neste projeto, você será capaz de:

• Usar comandos dockers no CLI - Interface de linha de comando;
• Criar um contêiner Docker para uma aplicação de front-end;
• Criar um contêiner Docker para uma aplicação de back-end;
• Criar um contêiner Docker para uma aplicação de testes;
• Orquestrar os três contêineres utilizando o Docker compose.

Temos, neste projeto, uma série de comandos com diferentes níveis de complexidade que devem ser resolvidos cada um em seu arquivo próprio.

1. Leia o requisito e crie um arquivo chamado commandN.dc no diretório docker-commands, em que N é o número do desafio.

2. O arquivo deve conter apenas o comando do CLI (Interface de Linha de Comando) do Docker do requisito resolvido. Um exemplo de como vai ficar seu arquivo:

docker network inspect bridge

3. Faça isso até finalizar todos os requisitos e depois siga as instruções de como entregar o projeto em Instruções para entregar seu projeto.

4. Os arquivos principais do projeto estão na pasta docker, na raiz do projeto, nele estão contidos:

• Pasta docker-commands: Onde ficarão os comandos exigidos pelos requisitos;
  • ⚠️ Importante: você deve assumir que essa é a pasta raiz para os comandos.
  • Por exemplo, se você precisa referenciar um caminho em um comando, você deve assumir que sua pasta raiz esta partindo de ./docker
• Pasta todo-app: Onde fica nossa pseudo-aplicação, que servirá como base para nossos Dockerfiles e Compose;
  • ⚠️ Essa aplicação conta com um README.md próprio, que deve ser usado como referência na criação dos scripts!
• A pasta docker deve receber o arquivo docker-compose.yml para orquestração de aplicações

5. Para entregar o seu projeto você deverá criar um Pull Request neste repositório. Este Pull Request deverá conter no diretório docker-commands os arquivos command01.dc, command02.dc e assim por diante até o command12.dc, que conterão seu comando docker de cada requisito, respectivamente.

⚠️ É importante que seus arquivos tenham exatamente estes nomes! ⚠️

O avaliador cria um container especial para executar a avaliação de comandos, Dockerfiles e docker-compose.

Esse container é temporário, por tanto, ao começar ou terminar os testes locais, o avaliador remove automaticamente esse mesmo container, assim como seu volume associado.

O volume desse container, mapeia a pasta ./docker/ do seu projeto, para dentro dele, ou seja, a raiz desse container vai conter as pastas ./docker-commands/, ./todo-app/ e seu arquivo ./docker-compose.yml, quando estiver pronto.

Isso significa, que se pudessemos olhar para dentro do container de avaliação, veriamos a seguinte estrutura:

.
├── docker-commands
└── todo-app
    ├── back-end
    │   └── *
    ├── front-end
    │   └── *
    └── tests
        └── *

Por tanto, é importante entender que os comandos docker escritos em command*.dc estarão rodando dentro desse container especial (e não a partir da raiz do projeto, como em projetos anteriores).

Você irá "conteinerizar" as aplicações de frontend, backend e testes, criar uma conexão entre elas e orquestrar seu funcionamento.

Crie imagens das aplicações e os configure com o docker-compose.

• Projeto individual.

• Serão dois dias de projeto.

• Data de entrega para avaliação final do projeto: DD/MM/YYYY - 14:00h.

⚠️ Importante:

Esse projeto tem como intuito te treinar para ter mais familiaridade com a documentação de aplicações, por tanto, poderão haver alguns comandos ou atributos que não estão no course, mas que devem ser descritos no decorrer dos requisitos.

Nesses casos, é importante se atentar a aquilo que o requisito pede, e lembrar sempre de utilizar a documentação oficial do Docker para pesquisar detalhes sobre comandos.

Ao criar um Dockerfile para o nosso pseudo-aplicativo, seu README (./docker/tests/README.md) deve servir como "tradutor" para os passos de execução. Lembre-se de que o Dockerfile é como uma receita para execução dessas aplicações.

Aqui, também é importante a utilização do comando --help no CLI (docker <comando> <subcomando> --help), dado que para cada comando do docker, é possível aplicar subcomandos ou parâmetros, exemplo: docker network --help

⚠️ Importante ⚠️ Para que o avaliador funcione corretamente, é importante que a instalação do Docker (vista no dia 1) seja feita corretamente. Aqui também é importante que o seu usuário esteja no grupo docker (para que não haja a necessidade de rodar comandos utilizando o sudo)

Nesse projeto, temos uma aplicação completa (Um aplicativo de tarefas) que precisa ser conteinerizada para funcionar, aqui, você desenvolver os respectivos arquivos de configuração para cada frente específica: Front-end, Back-end e no nosso caso um aplicativo de teste que deve validar se as aplicações estão se comunicando.

⚠ É necessário ter o Docker instalado corretamente na sua máquina para rodar os testes locais

Todos os requisitos do projeto serão testados automaticamente por meio do Jest. Basta executar o comando abaixo:

npm test

Você pode rodar um arquivo de test por vez, exemplo:

npm test 01container

⚠ Atenção: ⚠ Não utilize a função .only ou .skip após o describe. Os testes precisam rodar por completo para que seja avaliado localmente.

• Observações técnicas:

  • O container não deve ser inicializado, somente criado;
  • O container deve estar preparado para acesso interativo;

• Dica:

  • Lembre-se aqui, que um parâmetro não é necessariamente aplicável a apenas um comando.

• O que será testado:

  • O container vai ter o name: 01container;
  • O container vai estar uzando a imagem alpine na versão 3.12.

• Observações técnicas:

  • O container que está parado, deve ser iniciado;
  • Se o container tiver sido iniciado de modo interativo, ele deve se manter ativo ao inicia-lo.

• O que será testado:

  • O avaliador verificará se o container está parado;
  • O avaliador rodará o comando;
  • O avaliador verificará se o container está rodando.

• Dica:

  • Praticamente todo comando de listagem no Docker possui uma forma de filtragem.

• O que será testado:

  • Que o comando retornará uma lista com os dados corretos.

• Observações técnicas:

  • O container deve estar rodando, e você deve ser capaz de executar um comando nesse container.

• Dica:

  • É possível fazer isso sem usar o comando attach.

• O que será testado:

  • Que o comando retornará os dados corretos da distro no container.

• O que será testado:
  • O avaliador rodará o comando 5;
  • O avaliador validará o processo com o comando 3.

• O que será testado:
  • Que a imagem correta foi baixada;
  • Que nenhum container foi iniciado para isso.

• O que será testado:
  • Que o container foi iniciado corretamente;
  • Que é possível ter acesso ao container pelo endereço localhost:3000;
  • Que a página retorna o valor esperado.

• O que será testado:
  • Que não há nenhum container ativo após seu comando.

⚠️ As aplicações a seguir contam com um README.md próprio, que deve ser usado como referência na criação dos scripts!

Dica: O comando ADD do Dockerfile, também pode ser utilizado para descompactar arquivos dentro do container.

• O que será testado: - Se existe um arquivo Dockerfile em ./docker/todo-app/back-end/:
  • O Dockerfile deve rodar uma imagem node utilizando a versão 14 ou mais;
    • Recomenda-se o uso da variante -alpine, pois ela é otimizada para desempenho;
    • Lembre-se de consultar o README do todo-app para validar os requisitos da aplicação.
  • Deve estar com a porta 3001 exposta;
  • Deve adicionar o arquivo node_modules.tar.gz a imagem;
  • Deve copiar todos os arquivos da pasta back-end para a imagem;
  • Ao iniciar a imagem deve rodar o comando npm start. - Se ao buildar o Dockerfile o nome da imagem gerada é igual a todobackend.

Dica: O comando ADD do Dockerfile, também pode ser utilizado para descompactar arquivos dentro do container.

• O que será testado:
  • Se existe um arquivo Dockerfile em ./docker/todo-app/front-end/:
    • O Dockerfile pode rodar uma imagem node utilizando a versão 14 ou mais;
      • Recomenda-se o uso da variante -alpine, pois ela é otimizada para desempenho;
      • Lembre-se de consultar o README do todo-app para validar os requisitos da aplicação.
    • Deve estar com a porta 3000 exposta;
    • Deve adicionar o arquivo node_modules.tar.gz a imagem, de maneira que ele seja extraído dentro do container;
    • Deve copiar todos os arquivos da pasta front-end para a imagem;
    • Ao iniciar a imagem deve rodar o comando npm start;
  • Se ao buildar o Dockerfile o nome da imagem gerada é igual a todofrontend.

Dica: O comando ADD do Dockerfile, também pode ser utilizado para descompactar arquivos dentro do container.

Observação: A aplicação todotests só funciona corretamente se estiver dockerizada e dentro de uma rede docker configurada corretamente.

• O que será testado:
  • Se existe um arquivo Dockerfile em ./docker/todo-app/tests/:
    • O Dockerfile deve rodar a imagem mjgargani/puppeteer:trybe1.0 para que os testes funcionem;
    • Deve adicionar o arquivo node_modules.tar.gz a imagem;
    • Deve copiar todos os arquivos da pasta tests para a imagem;
    • Ao iniciar a imagem deve rodar o comando npm test;
  • Se ao buildar o Dockerfile o nome da imagem gerada é igual a todotests.

Dica: use as imagens já "buildadas" que foram executadas nos requisitos 9,10 e 11 para a criação do compose.

• O que será testado:

  • Se existe um arquivo docker-compose.yml na pasta ./docker/:

    • O docker-compose deve rodar na versão 3.

  • tests

    • O container de todotests deve ter como dependencia os containers frontend e backend;
    • O nome do service deverá ser todotests;
    • Deve ter uma variável de ambiente FRONT_HOST que recebe como valor o nome do container do frontend
      • Lembrando que, dentro de uma rede docker, o host de um container é indentificado pelo seu nome.

  • front-end

    • O container de todofrontend deve rodar na porta 3000;
    • O nome do service deverá ser todofront;
    • Deve ter como dependencia o container backend;
    • Deve ter uma variável de ambiente REACT_APP_API_HOST que recebe como valor o nome do container do backend.
      • Lembrando que, dentro de uma rede docker, o host de um container é indentificado pelo seu nome.

  • back-end

    • O container de todobackend deve rodar na porta 3001;
    • O nome do service deverá ser todoback;

• Dica:

  • Consulte a documentação em ./docker/todo-app/README.md;
  • É possível adicionar e extrair arquivos .tar.gz no Dockerfile com apenas um comando.