Anatomie d'un environnement

Arborescence des fichiers

Le répertoire par défaut d'un environnement est /var/environment. Vous y êtes automatiquement positionné lorsque vous vous connectez en SSH avec votre IDE ou votre terminal, et lorsque vous ouvrez l'interface web de Visual Studio Code.

À l'intérieur du répertoire /var/environment, se trouvent les différents dépôts qui composent votre projet :

└── /var/environment/
   ├── my-repository/
   └── my-other-repository/

Lorsqu'un environnement est démarré, Protocode génère un dossier .protocode-runtime qui est stocké à la racine de chaque dépôt du projet. Ce dossier contient tous les fichiers nécessaires au fonctionnement de l'environnement:

└── /var/environment/
   ├── my-dépôt/
   │   └── .protocode-runtime/
   │      └── .env 
   │      └── docker-compose.yml
   │      └── lifecycle/
   │         └── prePull.sh
   │         └── postPull.sh
   │         └── preUp.sh
   │         └── postUp.sh
   │         └── preFreeze.sh
   │         └── preDown.sh
   │      └── version
   │ ... Rest of my files

Ces fichiers ont les rôles suivants :

• .env : ce fichier contient toutes les variables d'environnement saisies dans la configuration du dépôt. Ces variables seront injectées dans chaque commande de docker-compose.

• docker-compose.yml : c'est le fichier de configuration généré par Protocode à destination de Docker Compose. C'est lui qui sera pris en compte lorsque vous ferez appel à docker-compose depuis la racine d'un dépôt (même si un autre fichier docker-compose.yml se trouve au même niveau). Vous pourrez donc, par exemple, stopper tous les conteneurs avec une commande telle que :

cd my-dépôt # Je me déplace du répertoire par défaut au dépôt
docker-compose down

Puis éventuellement modifier certaines valeurs du fichier de démarrage (.protocode-runtime/docker-compose.yml), et relancer les conteneurs en lançant :

cd /var/environment/my-dépôt
docker-compose up -d

• lifecycle : c'est un dossier qui contient tous les scripts d'initialisation de l'environnement créés au démarrage de l'environnement, et qui seront joués pendant les différentes étapes de son cycle de vie.

• version : c'est un fichier contenant des informations de version nécessaires au fonctionnement.

Outils préinstallés

Un environnement est une instance Debian 11 qui embarque un certain nombre d'outils nécessaires à son fonctionnement, notamment :

• Pour la virtualisation : Docker, Docker Compose
• Pour le versionning des sources : Git, Git LFS
• Pour le terminal : Bash, Zsh
• Pour l'édition de fichiers : Vim, Nano
• Pour la récupération de fichiers : Curl, Wget

Conteneurs Docker

Votre environnement est comme un poste de travail distant faisant tourner des conteneurs avec Docker. Lorsque vous vous connectez, vous êtes positionné dans le répertoire par défaut et à l'extérieur de vos conteneurs. Si vous ouvrez un terminal et entrez la commande suivante pour voir la liste de vos conteneurs :

docker ps

Vous verrez un retour du type :

CONTAINER ID   IMAGE              COMMAND                  CREATED       STATUS       PORTS                 NAMES
3a70f7c8c765   node:16            "docker-entrypoint.s…"   10 days ago   Up 10 days   80/tcp                protocode-web_app
6703eddacc5d   protocode-api_app  "docker-php-entrypoi…"   3 weeks ago   Up 3 weeks   80/tcp, 9000/tcp      protocode-api-app
82c3d52d0e50   mysql:8.0          "docker-entrypoint.s…"   3 weeks ago   Up 3 weeks   3306/tcp, 33060/tcp   protocode-api-database

Comme vous êtes dans le répertoire par défaut, et non à l'intérieur d'un de vos dépôts, toute commande docker-compose déboucherait sur une erreur, puisque Docker Compose ne trouverait pas de fichier de configuration dans le répertoire par défaut. Il vous faut donc tout d'abord vous déplacer, pour ensuite lancer une commande docker-compose :

cd my-dépôt
docker-compose exec app bash # Pour cet exemple, j'entre dans le terminal d'un conteneur

En somme, ce n'est pas différent d'une utilisation de Docker en local.

Git

Git est installé au niveau de l'environnement, et a été paramétré pour communiquer avec les différents dépôts qui composent votre projet, afin de récupérer les sources et pousser des modifications.

Par défaut, chaque dépôt est positionné sur la branche sélectionnée comme "Par défaut" dans sa configuration (voir Ajout de source). Il revient au développeur, comme en local, de créer sa propre branche de travail sur chaque dépôt et de se mettre à jour (via git pull / git rebase selon vos habitudes).