Cette documentation expose un projet de containerisation
Docker que j'ai mené lors de
mon BTS.
L'objectif était de "dockeriser" une application web existante en développant tous les fichiers de
configuration requis (
Docker Compose et
Dockerfiles) afin
d'automatiser et de faciliter son déploiement.
En substance, il s'agissait d'isoler l'application avec ses dépendances dans des conteneurs pour
permettre un déploiement unifié sur toute machine hôte via une unique commande.
Même si l'ensemble des fichiers sources du projet initial n'est plus accessible, j'ai fait le choix de
présenter exclusivement la documentation technique que j'avais rédigée. Cette dernière illustre
efficacement mes compétences et mon expertise avec Docker, notamment parce que ce projet couvre de
multiples facettes de la containerisation. Voici un schéma représentatif du travail accompli :
Mise en contexte :
Network Manager est une application Web développée par les étudiants de l'option
SLAM, qui permet, via une interface graphique, la création, suppression et modification d'entrées
DNS sur le domaine de CUB, et a vocation de simplifier l'administration de tous les autres services
offerts. Les étudiants qui travaillent sur cette application doivent pouvoir la déployer rapidement
dans leur environnement de développement et peuvent être amenés à tester (tout en conservant les
données) plusieurs environnements (comme une version différente de PHP).
Il a donc été décidé de déployer cette application avec Docker.
Cette documentation détaille la version déployable de NetworkManager, incluant le contenu et
l'explication des fichiers:
dockerfile_webdockerfile_bddcompose.yaml
Elle explique l'utilité et la fonction de chaque fichier, leurs interactions, la persistance des
données, et le déploiement de NetworkManager.
Utilisation :
Pour faire fonctionner NetworkManager, deux conteneurs sont définis :
Le conteneur WEB pour l'application, et le conteneur BDD pour la
base de données. Pour chaque conteneur, un dockerfile est créé. Ces derniers sont une sorte de
template, ils créent une image personnalisée et on peut ensuite créer un conteneur à partir de cette
image. L'image définit comment un conteneur se comporte et exécute des commandes à la création. Cela
permet que chaque conteneur créé à partir d'une même image soit créé à partir d'une même base.
Le fichier compose, quant à lui, orchestre le déploiement, il construit les images à partir des
dockerfiles, crée des conteneurs basés sur ces images, les met en relation, et crée un volume, un
espace sur lequel les données persisteront même si les conteneurs sont supprimés. Il suffit de
l'éxecuter et NetworkManager est instantanément opérationnel, peu importe la machine (du moment que
docker est installé et que les fichiers sont tous au même endroit).
Installation de Docker sur Debian
apt update && apt upgrade -y
apt install apt-transport-https ca-certificates curl gnupg lsb-release -y
curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
apt update && apt upgrade -y
apt install docker-ce docker-ce-cli containerd.io -y
curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
Déploiement de l'application
Pour déployer NetworkManager, une fois docker installé, et les fichiers importés, il suffit
d'éxecuter cette commande :
docker compose -f compose.yaml -p network_manager up -d
Ici, nous avons lancé le déploiement de NetworkManager via le fichier compose.yaml, et
créé un projet nommé network_manager. Cela a créé deux conteneurs,
conteneur_web et conteneur_bdd, qui resteront actifs. Nous pouvons les
visualiser avec la commande docker ps. Pour utiliser l'un d'entre eux via un terminal
bash, il suffit d'éxecuter la commande docker exec -it conteneur_xxx bash.
Le compose a également créé un volume, un espace sur lequel les données seront persistantes, et
conservées même si les conteneurs sont supprimés. Ce volume, nommé
network_manager_volume_bdd et visible en utilisant docker volume list, est
dédié à la protection des données de la base de données.
Enfin, ces deux conteneurs web et bdd sont basés sur les images image_web et
image_bdd construites à partir de leurs dockerfiles respectifs lors du compose. On peut
les voir en utilisant la commande docker images.
Si, à des fins de test, il est nécessaire de modifier un de ces fichiers et de redéployer le site,
j'ai mis à disposition un script bash, clean.sh (inclus dans les fichiers à
télécharger) permettant de supprimer tout le contenu d'un précédent déploiement (à noter qu'il ne
supprime pas le volume, pour que les données de la base de données persistent même après suppression
du conteneur_bdd). Pour l'exécuter, il suffit d'entrer :
bash clean.sh
Le fichier compose.yaml :
Contenu
services:
WEB:
build:
context: .
dockerfile: dockerfile_web
image: image_web
container_name: conteneur_web
ports:
- "443:443"
depends_on:
- BDD
environment:
DB_HOST: conteneur_bdd
DB_PORT: 3306
DB_DATABASE: network_manager
DB_USERNAME: root
DB_PASSWORD: DBpassword
BDD:
build:
context: .
dockerfile: dockerfile_bdd
image: image_bdd
container_name: conteneur_bdd
environment:
MYSQL_ROOT_PASSWORD: DBpassword
MYSQL_DATABASE: network_manager
ports:
- "3306:3306"
restart: unless-stopped
volumes:
- volume_bdd:/var/lib/mysql
volumes:
volume_bdd:
Explications
Le fichier compose.yaml est utilisé pour orchestrer ce processus de déploiement. Il
définit deux "services" :
- WEB : Ce service correspond au conteneur qui héberge l'application web
NetworkManager. Il se base sur l'image
image_web construite à partir du fichier
dockerfile_web. Le port 443 du conteneur s'expose sur le port 443 de la machine sur
laquelle il est hébergé. Il dépend du service BDD pour se connecter à la base
de données, c'est à dire qu'il écoute ce qu'il s'y passe. Les variables d'environnement
nécessaires à la connexion à la base de données sont définies afin que le conteneur ait
l'autorisation de la consulter.
- BDD : Ce service correspond au conteneur qui héberge la base de données de
NetworkManager. Il se base sur l'image
image_bdd construite à partir du fichier
dockerfile_bdd. Le port 3306 du conteneur s'expose sur le port 3306 de la machine
sur laquelle il est hébergé. Les variables d'environnement définissent le mot de passe root de
la base de données ainsi que le nom de la base de données, ces variables doivent correspondre à
celles fournies au conteneur_web. Le conteneur est configuré pour redémarrer
automatiquement sauf s'il est arrêté manuellement (car contrairement au service web, mariadb ne
tourne pas en arrière plan). Un volume, nommé volume_bdd, est également créé pour
faire persister les données de la base de données même si les conteneurs sont supprimés. Ainsi,
on peut déployer une nouvelle version de NetworkManager tout en conservant les modifications
ayant été faites sur la bdd depuis l'ancien déploiement. Lors du déploiement, ce volume
s'attache au nom du projet, il devient network_manager_volume_bdd (si on utilise ma
commande).
Le fichier dockerfile_web :
Contenu
FROM debian:latest
RUN apt update && apt install -y \
apache2 \
ca-certificates \
ssl-cert \
composer \
apt-transport-https \
gpg \
php \
php-xml \
php-curl \
php-twig \
php-twig-i18n-extension \
php-zip \
php-tcpdf \
php-webmozart-assert \
php-symfony-yaml \
php-symfony-var-exporter \
php8.2-bz2 \
php8.2-gd \
php8.2-mysql \
php8.2-zip \
unzip \
git \
mariadb-client \
vim \
nano \
sudo \
net-tools \
dnsutils \
iputils-ping \
wget \
curl \
nmap \
tcpdump \
openssh-server \
locales
RUN wget -O composer-setup.php https://getcomposer.org/installer && \
php composer-setup.php --install-dir=/usr/local/bin --filename=composer && \
composer self-update
WORKDIR /var/www/html/
RUN git clone https://gitlab.com/siollb/NetworkManager.git && \
chown -R www-data:www-data NetworkManager
WORKDIR /var/www/html/NetworkManager
RUN composer install
RUN echo "APP_NAME=NetworkManager\n\
APP_ENV=local\n\
APP_KEY=base64:6lBl6mDUsxlF34f6V0Imc6KI2jZYi67GVhqW6VffmhE=\n\
APP_DEBUG=true\n\
WWWUSER=root\n\
WWWGROUP=root\n\
\n\
LOG_CHANNEL=stack\n\
LOG_LEVEL=debug\n\
\n\
DB_CONNECTION=mysql\n\
DB_HOST=conteneur_bdd\n\
DB_PORT=3306\n\
DB_DATABASE=network_manager\n\
DB_USERNAME=root\n\
DB_PASSWORD=DBpassword\n\
\n\
BIND_BASE_URL=172.31.30.109:8000\n\
BIND_API_KEY=tfgz0FUNHop4JRtLw2st/YyFavu3UMow8vsadVC7t44f5EkVQ4o4IsDZHXO/MLHg\n\
\n\
BROADCAST_DRIVER=log\n\
CACHE_DRIVER=file\n\
QUEUE_CONNECTION=sync\n\
SESSION_DRIVER=file\n\
SESSION_LIFETIME=120\n\
\n\
MEMCACHED_HOST=memcached" > .env
WORKDIR /etc/apache2/sites-available/
RUN echo "\n\
\n\
ServerAdmin webmaster@localhost\n\
DocumentRoot /var/www/html/NetworkManager/public\n\
\n\
\n\
Options Indexes FollowSymLinks MultiViews\n\
AllowOverride All\n\
\n\
\n\
\n\
Options Indexes FollowSymLinks MultiViews\n\
AllowOverride None\n\
Order allow,deny\n\
allow from all\n\
\n\
\n\
ErrorLog ${APACHE_LOG_DIR}/error.log\n\
CustomLog ${APACHE_LOG_DIR}/access.log combined\n\
SSLEngine on\n\
SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem\n\
SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key\n\
\n\
\n\
SSLOptions +StdEnvVars\n\
\n\
\n\
SSLOptions +StdEnvVars\n\
\n\
\n\
" > default-ssl.conf
RUN a2enmod rewrite && \
a2enmod ssl && \
a2ensite default-ssl.conf
CMD ["apache2ctl", "-D", "FOREGROUND"]
Explications
Le fichier dockerfile_web définit l'image Docker qui sera utilisée pour le conteneur
WEB de l'application NetworkManager. Il se base sur la dernière image de Debian
(debian:latest), et procède à l'installation de tous les paquets nécessaires au
fonctionnement de l'application :
- Apache2 pour le serveur web,
- PHP et ses extensions nécessaires,
- Composer pour la gestion des dépendances PHP,
- Git pour récupérer le contenu de l'application web,
- Des outils pratiques pour debugger
Une fois les paquets installés, le Dockerfile clone le dépôt Git de l'application NetworkManager dans
le répertoire /var/www/html/NetworkManager et installe les dépendances PHP de
l'application à l'aide de Composer. Ensuite, il crée un fichier .env avec les
paramètres de configuration de l'application. À noter que BIND_BASE_URL utilise une ip
et non un nom de domaine, car la résolution DNS était impossible (mais l'IP ping, et avec NMAP, on
constate que le port 8000 est effectivement ouvert).
Puis il crée un fichier de configuration Apache default-ssl.conf pour configurer le
serveur web et activer le support SSL (car l'application utilise https, même si le certificat est
expiré).
Enfin, il active les modules Apache nécessaires à la mise en ligne du site et démarre le serveur
Apache en tant que processus principal du conteneur (qui tournera en arrière plan, et donc laissera
le conteneur actif).
Le fichier dockerfile_bdd :
Contenu
FROM mariadb:lts
RUN apt update && apt install -y \
vim \
nano \
sudo \
net-tools \
dnsutils \
iputils-ping \
wget \
curl \
nmap \
tcpdump \
openssh-server \
locales
COPY network_manager.sql /docker-entrypoint-initdb.d/
Explications
Le fichier dockerfile_bdd définit l'image Docker qui sera utilisée pour le conteneur
BDD de la base de données de l'application NetworkManager. Il se base sur l'image
mariadb:lts (qui signifie Long Term Support et non latest :))
En plus de l'image de base, le Dockerfile installe quelques outils supplémentaires pour pouvoir
debugger facilement.
Enfin, il copie le contenu du fichier network_manager.sql dans le répertoire
/docker-entrypoint-initdb.d/. Ce répertoire exécute automatiquement son contenu lors du
démarrage du conteneur. Cela permet d'initialiser la base de données avec les tables et les données
nécessaires au fonctionnement de l'application NetworkManager durant le déploiement. Pour des
raisons de lisibilité (et par manque de compétence), la documentation n'inclut pas le contenu du
fichier SQL, car il est très long et difficile à comprendre.
