public/subjects/devops/play-with-containers/audit/README.md

General

Check the Repo content

A README.md file and all files used to create, delete and manage the student infrastructure must be submitted in the repo.

Are all the required files present?

Was the .env file excluded from the git files?

Are all pushed files in the repo clean of any credentials or passwords?

Ask the following questions to the group or student:

• What are containers and what are their advantages?

• What is the difference between containers and virtual machines?

• What is Docker and what is it used for?

Did the student reply correctly to all the above questions?

Open and read the README.md file provided by the student.

Does the README.md file contain all the required information to run and manage the solution (prerequisites, configuration, setup, usage, etc)?

Check the student infrastructure:

The student must implement this architecture:

Run the student infrastructure:

user:~$ docker-compose up
<...>
inventory-database   ... done
billing-database     ... done
inventory-app        ... done
billing-app          ... done
RabbitMQ             ... done
api-gateway-app      ... done
<...>
user:~$

Does the student architecture reflect the infrastructure enforced by the subject?

Does the infrastructure start correctly?

Ask the following questions to the group or student

• What is a microservices' architecture?

• Why do we use microservices architecture?

• What is a queue and what is it used for?

• What is RabbitMQ?

Did the student reply correctly to all the above questions?

Verify the Dockerfiles:

Is there a Dockerfile for each service?

Are all Dockerfiles based on Debian or Alpine?

Are Dockerfiles or any other solution files free from sensitive data (sensitive data should only exist in .env file)?

Ask the following questions to the group or student

• What is a Dockerfile?

• Explain the instructions used on the Dockerfile.

Did the student reply correctly to all the above questions?

Check the Containers:

user:~$ docker ps
CONTAINER ID   IMAGE            COMMAND CREATED STATUS         PORTS                                 NAMES
<...>       inventory-database      <...> <...> <...>          5432/tcp                              inventory-database
<...>       billing-database        <...> <...> <...>          5432/tcp                              billing-database
<...>       inventory-app           <...> <...> <...>          8080/tcp                              inventory-app
<...>       billing-app             <...> <...> <...>          8080/tcp                              billing-app
<...>       RabbitMQ                <...> <...> <...>          5672/tcp                              RabbitMQ
<...>       api-gateway-app         <...> <...> <...>         0.0.0.0:3000->3000/tcp, :::3000->3000/tcp  api-gateway-app
user:~$

• inventory-db container is a SQL database server that contains your inventory database, it must be accessible via port 5432.
• billing-db container is a SQL database server that contains your billing database, it must be accessible via port 5432.
• inventory-app container is a Node.js server that contains your inventory-app. It will be connected to the inventory database and accessible via port 8080.
• billing-app container is a Node.js server that contains your billing-app. It will be connected to the billing database and consuming the messages from the RabbitMQ queue. It will be accessible via port 8080.
• rabbit-queue is a RabbitMQ server that contains the queue.
• api-gateway-app container is a Node.js server that contains your api-gateway-app. It will forward the requests to the other services and it's accessible via port 3000.

Check the Container restart policy:

user:~$ docker inspect -f "{{ .HostConfig.RestartPolicy }}" <container-name>
{on-failure 0}
user:~$

Do all containers have the correct configuration?

Are the containers configured to restart in case of failure?

Check the Docker volumes:

user:~$ docker volume ls
DRIVER    VOLUME NAME
<...>     inventory-database
<...>     billing-database
<...>     api-gateway-app
user:~$

• inventory-database volume contains the inventory database.
• billing-database volume contains the billing database.
• api-gateway-app volume contains the API gateway logs.

Do all volumes have the correct configuration?

Ask the following questions to the group or student

• What is a Docker volume?

• Why do we use Docker volumes?

Did the student reply correctly to all the above questions?

Check the solution network:

Is the connection to the api-gateway-app the only one exposed from outside of the Docker host?

Ask the following questions to the group or student

• What is the Docker network?

• Why do we use the Docker network?

Did the student reply correctly to all the above questions?

Check the Docker images:

user:~$ docker images
REPOSITORY              TAG          IMAGE ID       CREATED        SIZE
inventory-database     <...>          <...>         <...>          <...>
billing-database       <...>          <...>         <...>          <...>
inventory-app          <...>          <...>         <...>          <...>
billing-app            <...>          <...>         <...>          <...>
RabbitMQ               <...>          <...>         <...>          <...>
api-gateway-app        <...>          <...>         <...>          <...>
user:~$

Is there a Docker image for each service with the same service name?

Ask the following questions to the group or student

• What is a Docker image?

• Why do we use Docker images?

Did the student reply correctly to all the above questions?

Inventory API Endpoints

Open Postman and make a POST request to http://[GATEWAY_IP]:[GATEWAY_PORT]/api/movies/ address with the following body as Content-Type: application/json:

{
    "title": "A new movie",
    "description": "Very short description"
}

Can you confirm the response was the success code 200?

In Postman make a GET request to http://[GATEWAY_IP]:[GATEWAY_PORT]/api/movies/ address.

Can you confirm the response was success code 200 and the body of the response is in json with the information of the last added movie?

Billing API Endpoints

Open Postman and make a POST request to http://[GATEWAY_IP]:[GATEWAY_PORT]/api/billing/ address with the following body as Content-Type: application/json:

{
    "user_id": "20",
    "number_of_items": "99",
    "total_amount": "250"
}

Can you confirm the response was success code 200?

Stop the billing-app container

Can you confirm the billing-app container was correctly stopped?

Open Postman and make a POST request to http://[GATEWAY_IP]:[GATEWAY_PORT]/api/billing/ address with the following body as Content-Type: application/json:

{
    "user_id": "22",
    "number_of_items": "10",
    "total_amount": "50"
}

Can you confirm the response was success code 200 even if the billing_app is not working?

Bonus

+Did the student use his/her own crud-master solution?

+Did the student add any optional bonus?

+Is this project an outstanding project?