Différences

Ci-dessous, les différences entre deux révisions de la page.

--- services:mattermost_upgrade [2018/04/02 13:54] – [Mise à jour] kyane
+++ services:mattermost_upgrade [2019/05/17 21:55] – [Build et tag des images] huetremy
@@ Ligne 1: / Ligne 1: @@
-====== Mise à jour de Mattermost ======
+====== Mattermost : Procédure de mise à jour ======
-[[https://about.mattermost.com/|Mattermost]] est le logiciel libre sur lequel se base Picasoft pour https://team.picasoft.net. Le logiciel est maintenu par la société [[https://github.com/mattermost|Mattermost Inc. sur Github]] qui propose, entre autre, [[https://github.com/mattermost/mattermost-docker|des images Docker]]. Cette documentation présente le processus pour mettre à jour les images utilisées par Picasoft, ainsi que le service en production.
 ===== Images Docker =====
@@ Ligne 6: / Ligne 5: @@
 ==== Récupération du code mis à jour ====
-Pour //builder// et pousser les images, on utilise la VM d'admin de Picasoft. Les //Dockerfiles// se trouvent dans le dossier ''/DATA/docker/Dockerfiles'', qui est un //repository// Git. Le sous-dossier ''mattermost'', qui nous intéressera ici, est lui aussi un //repository// Git qui pointe sur [[https://github.com/mattermost/mattermost-docker|l'upstream maintenue par Mattermost]]. \\
+Pour //builder// et pousser les images, on va récupérer le //repository// Git qui pointe sur [[https://github.com/mattermost/mattermost-docker|l'upstream maintenue par Mattermost]]. \\
-On se place dans le dossier et on //pull// pour mettre à jour le //repository// Git. Si la copie locale est modifié et que le //pull// ne se fait pas automatiquement, il est possible de retirer les modifications locales pour repartir d'une base propre.
+On clone le repository et on se place dans le dossier.
-<code>
-root@admin:~# cd /DATA/docker/Dockerfiles/mattermost
-root@admin:/DATA/docker/Dockerfiles/mattermost# git reset --hard    #(optionnel) retirer les modifications locales
-root@admin:/DATA/docker/Dockerfiles/mattermost# git pull origin master
-Depuis https://github.com/mattermost/mattermost-docker
- * branch            master     -> FETCH_HEAD
-Déjà à jour.
-root@admin:/DATA/docker/Dockerfiles/mattermost#
-</code>
-Il faut ensuite vérifier que le fichier ''docker-compose.yml'' du //repository// est bien modifié pour permettre de //builder// la version libre de Mattermost. Normalement, les lignes suivantes ne doivent pas être commentées :
+Il faut ensuite modifier fichier ''docker-compose.yml'' du //repository// pour permettre de //builder// la version libre de Mattermost. Normalement, les lignes suivantes ne doivent pas être commentées :
-<code>
+<code yaml>
 [...]
@@ Ligne 31: / Ligne 21: @@
 [...]
 </code>
-ENV MM_VERSION=4.3.0
 Pour finir, on vérifie que le //repository// va bien //builder// la version que l'on souhaite de Mattermost. On peux vérifier avec la commande suivante: <code>cat app/Dockerfile | grep "ENV MM_VERSION"</code> Si ce n'est pas la dernière version, alors il faut ouvrir une PR sur l'upstream pour demander la mise à jour.
@@ Ligne 37: / Ligne 26: @@
 ==== Build et tag des images ====
 Lorsque le dossier est prêt, on //build// très simplement les images à l'aide de ''docker-compose'' :
-<code>
+<code bash>
 docker-compose build
 </code>
-Le //build// peut durer un certain temps, une fois terminé on obtient trois images : ''mattermost_app'', ''mattermost_db'' et ''mattermost_web''. On peut les voir à l'aide de la commande ''docker images'' :
+Le //build// peut durer un certain temps, une fois terminé on obtient trois images : `mattermost_app`, ''mattermost_db'' et ''mattermost_web''. On peut les voir à l'aide de la commande ''docker images'' :
-<code>
+<code bash>
-root@admin:/DATA/docker/Dockerfiles/mattermost# docker images
+kyane@laptop:~ docker images
 REPOSITORY                                      TAG                 IMAGE ID            CREATED             SIZE
 mattermost_web                                  latest              bd616f47c38b        3 seconds ago       109MB
@@ Ligne 50: / Ligne 39: @@
 On ignore l'image ''mattermost_web'', nous ne l'utilisons pas pour Picasoft car nous avons notre propre reverse-proxy (Traefik). On peut la supprimer avec ''docker rmi mattermost_web''.
-On va maintenant ajouter des //tags// à nos images ''app'' et ''db'' pour ensuite les pousser sur le //registry// Docker de Picasoft. On va utiliser, pour chaque image, les tags ''latest'' et ''X.Y.Z'' (correspondant au numéro de version de Mattermost). On renomme les images pour les pousser sur le //registry// de Picasoft, elles auront donc la forme ''registry.picasoft.net:5000/NOMIMAGE:TAG''. \\
+On va maintenant ajouter des //tags// à nos images ''app'' et ''db'' pour ensuite les pousser sur le //registry// Docker de Picasoft. On va utiliser, pour chaque image, les tags ''latest'' et ''X.Y.Z'' (correspondant au numéro de version de Mattermost). On renomme les images pour les pousser sur le //registry// de Picasoft, elles auront donc la forme ''registry.picasoft.net:5000/NOMIMAGE:TAG''. Par exemple, si nous venons de //builder// la version ''4.3.0'' de Mattermost, on va lancer les commandes suivantes :
-Par exemple, si nous venons de //builder// la version ''4.3.0'' de Mattermost, on va lancer les commandes suivantes :
+<code bash>
-<code>
 # Tag de l'image app
 docker tag mattermost_app registry.picasoft.net:5000/pica-mattermost:latest
@@ Ligne 66: / Ligne 54: @@
 </code>
-Nos images sont prêtes et à jour dans le //registry//. On termine par un petit ménage des images Docker en local de la VM //admin//, maintenant qu'elles sont poussées ce n'est plus utile de les conserver :
+Nos images sont prêtes et à jour dans le //registry//. On termine par un petit ménage des images Docker en local, maintenant qu'elles sont poussées ce n'est plus utile de les conserver :
-<code>
+<code bash>
 docker rmi mattermost_app
 docker rmi mattermost_db
@@ Ligne 75: / Ligne 63: @@
 docker rmi registry.picasoft.net:5000/pica-mattermost-db:4.3.0
 </code>
-On quitte ensuite la VM //admin//.
 ===== Déploiement =====
@@ Ligne 82: / Ligne 69: @@
   * que l'on a une backup récente de la base de données. C'est normalement le cas puisqu'elles sont automatiques;
   * que Mattermost n'est pas trop utilisé. On ne fais pas un déploiement à 19H, la coupure va déranger tout le monde;
-  * que les autres bénévoles sont au courant de la mise à jour. Même si la coupure de service est courte, un.e sysadmin qui voit que le service est tombé va s'affoler pour rien :)
+  * que les autres bénévoles sont au courant de la mise à jour. Même si la coupure de service est courte, un⋅e sysadmin qui voit que le service est tombé va s'affoler pour rien :)
-Bref on ne se lance que lorsque l'on est prêt. Pour commencer il faut modifier les images Docker qui sont utilisées par les conteneurs de Mattermost et de sa base de données. Cela se passe dans le fichier ''/DATA/docker/docker-compose.yml'' de la machine, dans les services ''mattermost'' et ''mattermost-db''. Il suffit simplement de changer le numéro de version de l'image. **Attention !! On utilise uniquement les images ayant pour //tag// le numéro d'une version. On utilise JAMAIS ''latest'' pour éviter de tout casser, et en plus c'est plus clair comme cela.**
+Bref on ne se lance que lorsque l'on est prêt. Pour commencer il faut modifier les images Docker qui sont utilisées par les conteneurs de Mattermost et de sa base de données. Cela se passe dans le fichier ''/DATA/docker/docker-compose.yml'' de la machine, dans les services ''mattermost'' et ''mattermost-db''. Il suffit simplement de changer le numéro de version de l'image.
+**Attention !! On utilise uniquement les images ayant pour //tag// le numéro d'une version. On utilise JAMAIS ''latest'' pour éviter de tout casser, et en plus c'est plus clair comme cela.**
 Lorsque c'est prêt, on //pull// les nouvelles images Docker sur la machine. On n'est pas obligé de le faire manuellement, ''docker-compose'' se chargera de le faire au redémarrage des conteneurs. Cependant cela permet de réduire le downtime, puisque l'image sera déjà en local au moment du redémarrage (on économise le temps de //pull//).
-<code>
+<code bash>
 docker pull registry.picasoft.net:5000/pica-mattermost:4.3.0
 docker pull registry.picasoft.net:5000/pica-mattermost-db:4.3.0
 </code>
-==== Mise à jour ====
+==== Bascule en production ====
-Lorsque tout est bien prêt et que l'on a prévu les collègues, on peut enfin opérer à la bascule sur la nouvelle version. En pratique, on va simplement couper les conteneurs de l'application Mattermost, puis de sa base de données. On relance ensuite directement les deux services (dans l'ordre inverse), qui vont donc démarrer sur les nouvelles images. \\
+Lorsque tout est bien prêt et que l'on a prévu les collègues, on peut enfin opérer à la bascule sur la nouvelle version. En pratique, on va simplement couper les conteneurs de l'application Mattermost, puis de sa base de données. On relance ensuite directement les deux services (dans l'ordre inverse), qui vont donc démarrer sur les nouvelles images.
 Pour être sûr que tout se passe vite, sans typo ou autre problème, on peut faire tout ceci en une seule commande :
-<code>
+<code bash>
-cd /DATA/docker/ && docker stop -t 5 mattermost-app && docker stop -t 60 mattermost-db \
+cd /DATA/docker/ && docker stop mattermost-app && docker stop -t 60 mattermost-db \
 && docker rm mattermost-app && docker rm mattermost-db \
 && docker-compose up -d mattermost-db && sleep 5 && docker-compose up -d mattermost
 </code>
+Il est important de stopper les conteneurs avant de les effacer, pour éteindre correctement la base de données et minimiser le risque de corruption. L'option ''-t 60'' indique un timeout de 60 secondes ([[https://docs.docker.com/compose/reference/stop/|par défaut]] c'est 10 secondes).
 Normalement tout s'enchaine bien et les services repartent sur les nouvelles images. On peut vérifier rapidement en se connectant sur le [[https://team.picasoft.net|Mattermost de Picasoft]], que ça tourne bien. Dans le menu, l'onglet "À Propos" permet de vérifier la version du serveur. \\
@@ Ligne 105: / Ligne 97: @@
 En cas de soucis, on remet les anciennes images dans le ''docker-compose.yml'' puis on relance la commande ci-dessus pour revenir en arrière. Si cela crash toujours, on fait un rollback de la base de données. \\
-Si tout va bien, on fait un petit message sur le channel Général pour annoncer que la MAJ s'est bien passée, en ajoutant un petit lien vers le [[https://docs.mattermost.com/administration/changelog.html|changelog de Mattermost]]. On pense aussi à nettoyer les anciennes images Docker de la machine ''pica01'', comme sur la VM ''admin''.
+Si tout va bien, on fait un petit message sur le channel Général pour annoncer que la MAJ s'est bien passée, en ajoutant un petit lien vers le [[https://docs.mattermost.com/administration/changelog.html|changelog de Mattermost]]. On pense aussi à nettoyer les anciennes images Docker de la machine ''pica01''.
-==== Commit des modifications et push sur gitlab ====
-Si tout s'est bien déroulé, il faut commit les modifications effectués sur le fichier ''/DATA/docker/Dockerfiles/mattermost/docker-compose.yml'' de la VM d'admin, dans le repository ''/DATA/docker/Dockerfiles''.
-On se place dans le dossier ''/DATA/docker/Dockerfiles'' puis on effectue le commit
-<code>
-cd /DATA/docker/Dockerfiles
-git commit -am "Upgrade mattermost to 4.8.0"
-</code>
-Une fois le commit terminé, il faut push le commit dans le gitlab de picasoft. Pour faire le push, il faut avoir son compte gitlab ajouté dans le repository ''Dockerfiles'' avec les droits nécessaires.
-<code>
-git push origin master
-</code>
 ==== Réindexation de la base de donnée ====
@@ Ligne 128: / Ligne 106: @@
 **Attention avant toute opération de ce genre, veuillez effectuer une sauvegarde de la base de données**
-<code>
+<code bash>
 root@pica01:~# docker exec -it mattermost-db bash
 bash-4.3# psql -U postgres