Tester une modification sur un service

Avant de mettre en production un service, il faut s’assurer que la mise à jour n’a rien cassé. Même si vous avez testé la nouvelle image sur votre machine, il faut également la tester sur l’infrastructure de Picasoft, en particulier parce que les services ont souvent besoin de Traefik pour fonctionner.

Le script docker_test.sh permet d’automatiser toutes les étapes pour tester un service et s’assurer qu’il fonctionne bien indépendamment des données précédentes, qui auraient été conservées dans un volume, par exemple. Il permet aussi de remplacer toutes les URL de production par des URL de test.

Il a le désavantage qu’on comprend moins ce que l’on fait. Pour s’en servir, lancez :

snippet.bash

$ ./docker_test.sh <nom du dossier, e.g. pica-mattermost>

Vérifiez que les logs ne produisent aucune erreur et que le service fonctionne bien sur l’infrastructure de test, en y accédant via son URL par exemple (attention : remplacer picasoft.net par test.picasoft.net dans votre navigateur).

Si vous voulez tester le service “à la main”, ou que le script ne fonctionne pas pour vous, ou pour toute autre raison, suivez ces étapes :

Synchronisez vous exactement avec le dépôt :

snippet.bash

# master ou votre branche perso
git checkout <votre branche>
git pull

Si le service était déjà lancé sur la machine de test, éteignez-le et remettez les volumes à 0 :

snippet.bash

docker-compose down -v

Si des volumes sont déclarés comme external dans le fichier Compose, supprimez-les manuellement :

snippet.bash

docker volume rm <volume>

Si le service utilise des images “maison”, il faut les construire. Si le fichier Compose est bien fait, il suffit de lancer :

snippet.bash

docker-compose build

Sinon, il faut construire les images à la main. À répéter pour chaque image maison du service concerné :

snippet.bash

docker build [-f <Dockerfile>] -t <image> <context>

• Si le Dockerfile a un nom différent, on utilise le switch -f
• <image> doit avoir rigoureusement la valeur de la directive image du fichier Compose
• <context> est le contexte que reçoit Docker pour construire l’image (base pour copier les fichiers). En général, c’est le dossier du service (donc ., puisqu’on est dedans).

Si nécessaire. Certains services ne sont pas accessibles depuis Internet.

Remplacez les URL de production (.picasoft.net) par des URL de tests (.test.picasoft.net), sauf dans le nom de l’image :

• Si le service utilise Traefik, voir du côté de traefik.http.services.<service>.loadbalancer.server.port dans le fichier Compose
• Si le service utilise des fichiers de configuration, remplacez les références aux URL…

Copier tous les .secrets.example en .secrets.

Si le service utilise des images officielles, on s’assure qu’elles sont bien à jour avec la commande :

snippet.bash

docker-compose pull

snippet.bash

docker-compose up -d

snippet.bash

docker-compose logs -f

On constate l’absence d’erreurs dans les logs, et si le service est accessible via Internet, on regarde que tout fonctionne bien depuis l’URL de test.

À partir de là, c’est carte blanche : on peut modifier la configuration, le Dockerfile, reconstruire les images, etc. L’infrastructure de test est un bac à sable.

Si jamais les modifications ont permis de résoudre le problème, on les commit et on les synchronise avec le dépôt.

On se resynchronise avec l’état du dépôt en enlevant toutes les modifications induites par les tests.

snippet.bash

git reset --hard

Une fois qu’on est convaincu que la nouvelle version du service fonctionne bien, on peut le mettre en production.

Au préalable, si le service utilise des images maison, on les pousse sur le registre de production. Pour ce faire, vous devez connecté au registre de production : on s’assure de bien avoir exécuté la commande docker login registry.picasoft.net. Les identifiants sont sur le pass.

snippet.bash

docker-compose push

Cette commande pratique indique à Docker Compose de pousser toutes les images du fichier.

On peut aussi le faire manuellement, pour chaque image maison (i.e. dont le nom commence par registry.picasoft.net) :

snippet.bash

# <image> doit correspondre exactement
# à la directive image du fichier Compose
# et commencer par registry.picasoft.net
docker push <image>

Une fois les images poussées, on se rend sur la machine de production et on lance le service.