# TP Docker

## Introduction

Ce TP a pour but de vous familiariser avec Docker et Docker Compose.
Dans un premier temps, nous allons _dockeriser_ une application Java qui utilise OpenCV. Cela consiste à créer un Dockerfile contenant les dépendances nécessaires pour compiler et exécuter l'application.
Ensuite, nous allons configurer Docker Compose pour déployer plusieurs instances de l'application avec un serveur web en reverse proxy.

## Liens Utiles

<details>
<summary>Cliquer pour déplier</summary>

- [Documentation Docker](https://docs.docker.com/)
- [Tutoriel Docker](https://docs.docker.com/get-started/)
- [Reverse Proxy Nginx Automatisé pour Docker](http://jasonwilder.com/blog/2014/03/25/automated-nginx-reverse-proxy-for-docker/)
- [Compilation OpenCV sur Ubuntu](https://advancedweb.hu/2016/03/01/opencv_ubuntu/)

</details>

# Modalités de rendu

Tous les rendus TLC se font à travers le gitlab de l'ISTIC : https://gitlab.istic.univ-rennes1.fr/

Si vous ne l'avez pas déjà fait, créez sur Gitlab ISTIC un groupe nommé `TLC_2025_<votre_nom>_<votre_prenom>` 

Pour chaque TP, vous devrez créer un projet dans ce groupe, nommé `TP<numero>_<votre_nom>_<votre_prenom>` et le projet finale nommé `Projet_<votre_nom>_<votre_prenom>`

Pour chaque TP, vous devrez ajouter votre enseignant en tant que membre du projet avec le rôle de "Reporter" pour permettre la correction.

### Étape 0: Prérequis
Il est fortement conseillé de dérouler ce TP sur une machine Linux (Ubuntu, Fedora, etc.) ou en utilisant une machine virtuelle (VirtualBox, Vagrant, etc.).

1. Installez Docker dans votre environnement de développement.
2. Clonez ce dépot.

## [PARTIE 1] Dockerisation de l'Application

### Commandes Utiles

<details>
<summary>pour interagir avec les images</summary>

- `docker build -t <nom_image> .` : Construit une image Docker à partir d'un Dockerfile situé dans le répertoire courant et lui donne un nom.
- `docker rmi <nom_image>` : Supprime une image.
- `docker images` : Liste les images.
- `docker pull <nom_image>` : Télécharge une image depuis le Docker Hub.

</details>

<details>
<summary>pour interagir avec les conteneurs</summary>

- `docker run [nom_image]` : Démarre un conteneur à partir d'une image.
- `docker ps` : Liste les conteneurs en cours d'exécution.
- `docker exec -it [nom_conteneur] /bin/bash` : Exécute la commande `/bin/bash` dans un conteneur avec le mode interactif -] ça donne un shell (si bash est installé).
- `docker stop [nom_conteneur]` : Arrête un conteneur.
- `docker rm [nom_conteneur]` : Supprime un conteneur.
- `docker logs [nom_conteneur]` : Affiche les logs d'un conteneur.
</details>

D'autres commandes sont disponibles [ici](https://docs.docker.com/reference/cli/docker/).

<details>
<summary>Étape 1 : version scratch À EFFACER SI NON RETENU</summary>

### Étape 1: Créer une Image Docker à partir de `scratch`
> Pour la syntaxe du Dockerfile, vous pouvez consulter la documentation officielle de Docker, lien ci-dessous.

1. Création d'un `Dockerfile` à partir d'une image vierge:
    - Utilisez une image de base `scratch`.
    - Ajoutez le binaire `hello` en commande de démarrage.
    - Build, run et vérifiez que tout fonctionne correctement.

2. Ici on va étendre l'image scratch avec l'application Java.
    - Installez les dépendances nécessaires pour OpenCV.
    - Ajoutez les fichiers sources et compilez l'application.
    - Assurez d'avoir la bonne commande de démarrage du conteneur.
</details>

<details> 
<summary>Étape 1 : version non scratch À EFFACER SI NON RETENUE</summary>

### Étape 1: Premiers pas avec Docker
1. Création d'un `Dockerfile` à partir d'une image de base:
    - Utilisez une image de base de votre choix (debian, ubuntu, etc.).
    - Ajoutez `echo "Hello World"` en commande de démarrage.
    - Build, run et vérifiez que tout fonctionne correctement.

2. Ici on va étendre l'image de base avec l'application Java.
    - Installez les dépendances nécessaires pour OpenCV.
    - Ajoutez les fichiers sources et compilez l'application.
    - Assurez d'avoir la bonne commande de démarrage du conteneur.
</details>

<details>
<summary>Cliquer pour des liens utiles</summary>

- [Dockerfile Reference](https://docs.docker.com/reference/dockerfile)
</details>

<details>
<summary>Cliquer pour des indices</summary>
    
- Installez des dépendances comme OpenJDK, Maven, et OpenCV. 
```shell
    apt-get update
    apt-get install -y openjdk-8-jdk
    apt-get install -y maven
    apt-get install -f libpng16-16
    apt-get install -f libjasper1
    apt-get install -f libdc1394-22
```
- Utilisez `mvn package` pour compiler l'application.
- Utilisez `java -Djava.library.path=lib/ -jar target/fatjar-0.0.1-SNAPSHOT.jar` pour exécuter l'application. (Utilisez lib/ubuntuupperthan18 si vous avez comme image une version d'Ubuntu supérieure à 18.04)
- L'application est accessible sur le port 8080. Assurez-vous d'exposer ce port ou de le bind à un port de votre choix au démarrage du conteneur. Si tout est correct, http://localhost:8080 devrait être ouvert depuis votre navigateur.
</details>

### Étape 2: Créer une version _Light_ de l'Image

Maintenant que vous avez une image fonctionnelle, vous allez essayer de la rendre plus légère. 

1. Proposez un nouveau fichier Dockerfile qui permet de créer une image de taille réduite.

<details>
<summary>Cliquer pour des liens utiles</summary>

- [Build Multi-Stage Docker 1](https://learnk8s.io/blog/smaller-docker-images)
- [Build Multi-Stage Docker 2](https://docs.docker.com/develop/develop-images/multistage-build/)

</details>

## [PARTIE 2] Configuration d'un reverse proxy sous Docker



### Étape 1: Simple reverse proxy avec ligne de commande `docker`

<details>
<summary> Cliquer pour des liens utiles</summary>

Pour le nginx en reverse proxy, nous allons partir de l'image [suivante](https://github.com/jwilder/nginx-proxy).

L'explication du fonctionnement est disponible [ici](http://jasonwilder.com/blog/2014/03/25/automated-nginx-reverse-proxy-for-docker/).
</details>

> Si vous n'avez pas la tête à lire ça, la version abrégée est que le reverse proxy vous permet tout un tas de choses, y compris de gérer le fait que les containers ont des adresses IP (un peu) trop dynamiques, ce qui fait qu'à chaque changement/lancement de container, il y aurait des problèmes de binding de port. Le reverse proxy va vous permettre de cacher ces aspects-là, puisqu'ils seront gérés par ce composant. Ainsi, les chargements de versions modifiées de votre service n'auront pas besoin d'une gestion fine à la main des connexions, les différents utilisateurs qui voudront envoyer des requêtes simultanées au même service ne seront pas embêtés par des ports qui ne sont pas accessibles, etc.

1. Lancement de nginx en reverse proxy :

```bash
docker run -d -p 8080:80 -v /var/run/docker.sock:/tmp/docker.sock -t jwilder/nginx-proxy
```

⚠️ Pour certaines installations comme sur la dernière édition de Fedora, les règles de sécurité par défaut ont évolué. Pour que le container puisse accéder à la socket Docker, il faut ajouter l'option suivante :

```bash
docker run --security-opt=label:type:docker_t -d -p 8080:80 -v /var/run/docker.sock:/tmp/docker.sock -t jwilder/nginx-proxy
```

2. Si vous êtes sur votre propre portable, modifiez votre fichier `/etc/hosts` pour faire correspondre **m** vers localhost. Ce serait à faire sur votre gestionnaire de nom de domaine en temps normal.
Vous devez avoir une ligne qui ressemble à cela :

```txt
127.0.0.1    localhost localhost.localdomain localhost4 localhost4.localdomain m
```

Pour ceux qui n'ont pas les droits root, exécutez les commandes suivantes :

```bash
echo 'm localhost' >> ~/.hosts
export HOSTALIASES=~/.hosts
curl m:8080
```

3. Puis créez plusieurs fenêtres dans votre terminal. Ce seront vos différentes machines host émulées. Vous pouvez en créer au moins 3 ou 4. Dans ces terminaux, lancez la commande suivante pour tester votre reverse proxy :

```bash
docker run -e VIRTUAL_HOST=m -t -i nginx
```

4. Testez votre reverse proxy en lançant la commande suivante dans votre terminal originel :

```bash
curl m:8080
```

En l'exécutant plusieurs fois et suffisamment rapidement, vous devriez voir tantôt une fenêtre terminator se mettre à jour, tantôt une autre. C'est l'effet du load balancer (un autre service qui est géré par votre nginx).

En tapant la commande suivante, vous pouvez regarder le fichier de configuration nginx qui sera généré à l'adresse suivante `/etc/nginx/conf.d/default.conf`. 

(N'oubliez pas de remplacer `865c1e67a00e` par l'id de votre nginx en reverse proxy (`docker ps`) pour récupérer la liste des containers en cours d'exécution) :
```bash
docker exec -it 865c1e67a00e bash
```


️️⚠️ N'oubliez pas de tuer les conteneurs lancés :

```bash
docker ps # pour avoir la liste
docker kill "IDDOCKER" # pour tuer un docker
```


### Étape 2: Configuration du reverse proxy avec Docker Compose
<details>
<summary>pour interagir avec un deploiement compose</summary>

- `docker-compose up` : Démarre les services.
- `docker-compose down` : Arrête les services.
- `docker-compose up -f <fichier>` : Démarre les services à partir d'un fichier spécifique.
- D'autres commandes sont disponibles [ici](https://docs.docker.com/reference/cli/docker/compose/).
</details>

1. Créez un fichier docker-compose.yml avec jwilder/nginx-proxy

<details>
<summary>Cliquer pour un exemple</summary>

```yaml
    version: '3'
    services:
      nginx-proxy:
        image: jwilder/nginx-proxy
        ports:
          - "8080:80"
        volumes:
          - /var/run/docker.sock:/tmp/docker.sock
```
</details>

2. Ajoutez un service nginx classique qui utiliserait le reverse proxy et donnez lui un nom vhost.
3. Assurez-vous que votre fichier **/etc/hosts** contient une entrée pour le nom de domaine que vous avez choisi (vhost).
4. Vérifiez que tout fonctionne correctement en accédant à l'URL du vhost.


<details>
<summary>Cliquer pour des liens utiles</summary>

- [Docker compose services options](https://docs.docker.com/reference/compose-file/services/)
- [Repo officiel jwilder/nginx-proxy](https://hub.docker.com/r/jwilder/nginx-proxy/)
</details>

### Étape 3: Docker Compose avec 4 Instances
1. Maintenant que vous avez familiarisé avec Docker Compose et le reverse proxy, remplacez le service nginx par votre application Java en veillant à bien configurer les fichiers nécessaires.
2. Vérifiez que l'application fonctionne correctement en accédant à l'URL du vhost.
3. Créez un fichier `docker-compose-inst.yml` qui permet de deployer 4 instances de l'application.

<details>
<summary>Cliquer pour des liens utiles</summary>

- [Docker compose services options](https://docs.docker.com/reference/compose-file/services/)
</details>



## Rendu TP Docker
- Un fichier `Dockerfile` pour l'application Java.
- Un fichier `Dockerfile` pour l'application Java version light.
- Un fichier `docker-compose.yml` avec le reverse proxy et un service web simple.
- Un fichier `docker-compose-inst.yml` avec 4 instances de l'application Java.


# Annexes
<details>
<summary>Annexe 1: Description de l'Application Java</summary>

# How to compile this application

Simple example of using OpenCV in a Web application build using jersey.

This application takes a picture using web browsers camera API (available  in modern browsers) 
and runs OpenCV face recognition algorithm (using [CascadeClassifier](http://docs.opencv.org/java/org/opencv/objdetect/CascadeClassifier.html) ) for it. If a face is detected a "troll face" is added  on top of it.

![Screenshot](/screenshot.png?raw=true "Screenshot")

This application was inspired by the ingenious ["Trollator" mobile Android application](https://play.google.com/store/apps/details?id=com.fredagapps.android.trollator).

1. OpenCV Installation for local Maven repository
---
OpenCV is a native library with Java bindings so you need to install this to your system.
 - *libopencv_java3410.so* installed in you java.library.path (
 - *opencv-3410.jar* availble for application

There are good instructions how to build OpenCV with Java bindings for your own platform here: http://docs.opencv.org/doc/tutorials/introduction/desktop_java/java_dev_intro.html

Once you have built the Java library you can install the resulting jar file to your local Maven repository using
     mvn install:install-file -Dfile=./lib/opencv-3410.jar \
     -DgroupId=org.opencv  -DartifactId=opencv -Dversion=3.4.10 -Dpackaging=jar


2. Building this application
----
Once OpenCV jar library is available as a local Maven dependency, you can clone and build this application simply using Git and Maven:

```bash
     mvn install
```

And run the application using the embedded Jetty plugin in http://localhost:8080

```bash
     mvn package

     java -Djava.library.path=lib/ -jar target/fatjar-0.0.1-SNAPSHOT.jar
	# Do not forget to update the path to your opencv install in Main.java
	# You can change the image trollface ;)
```

</details>
```