Mises à jour

Cette documentation présente les étapes pour mettre à jour la solution LockSelf On-Premises.

____________________________________________________________________________________

Mises à jour de version

Les mises à jour vous sont communiquées par les équipes LockSelf et sont prévues à l’avance. Les mises à jour se font via l’envoi d’une nouvelle image Docker.

Comme pour le déploiement initial, les équipes LockSelf enverront le package de mise à jour. Ce package comprendra :

  • L’image du conteneur : lockself-api-X.X.X.tar.gz
  • La signature de l’image du conteneur : lockself-api-X.X.X.tar.gz.sig
⚠️ Avant toutes opérations, vous devez vérifier la signature apposée sur l’image du conteneur.

Le downtime sera de quelques minutes, le temps de reconstruire le conteneur (sauf dans le cas d’un environnement clusterisé).

Pour charger l’image LockSelf sur le serveur web : 

docker load --input lockself-api-X.X.X.tar.gz

Vous pouvez vérifier la présence de l'image via la commande:

docker images | grep lockself-api

Avant toute mise à jour

Avant toute mise à jour, nous vous recommandons d'effectuer une sauvegarde complète de votre environnement conformément à vos procédures habituelles de sauvegarde.

Déploiement via un lancement manuel

Dans le cas d'une installation manuelle de LockSelf sur votre serveur (sans Docker Compose ni Docker Swarm), voici les étapes à suivre :

  1. Arrêter le conteneur actuel : 
    # Lister les conteneurs en cours d'exécution
    docker ps

    # Arrêter le conteneur LockSelf
    docker stop CONTAINER_ID
  2. (Optionnel) Supprimer l'ancien conteneur : 
    # Supprimer le conteneur arrêté (conserve les données si vous utilisez des volumes)
    docker rm CONTAINER_ID
  3. Lancer le nouveau conteneur :
    Utilisez la même commande que celle employée lors de votre dernier déploiement. Si besoin, vous pouvez consulter la commande proposée dans notre documentation à l'adresse suivante : Paragraphe 6.5.1

    ⚠️ Important : Utilisez exactement les mêmes paramètres que votre commande docker run initiale :
    - Mêmes ports (-p)
    - Mêmes volumes (-v)
    - Mêmes variables d'environnement (-e)
    - Mêmes options réseau
    - Seule la version de l'image change

    Si des modifications de la base de données sont nécessaires, elles seront appliquées automatiquement lors du démarrage du conteneur. Aucune action de votre part n'est requise.

  4. Vérifier le démarrage :
    # Suivre les logs en temps réel
    docker logs -f CONTAINER_ID
  5. (Optionnel) Nettoyage des anciennes images :
    # Lister les images
    docker images

    # Supprimer l'ancienne version
    docker rmi lockself-api-v3:ancienne-version


Déploiement via docker compose

Dans le cas d'une installation manuelle de LockSelf sur votre serveur (sans Docker Compose ni Docker Swarm), voici les étapes à suivre :

  1. Mettre à jour le fichier docker-compose.yml :
    Modifiez la version de l'image dans votre docker-compose.yml :
    version: '3.8'

    services:
      lockself-api-3:
        image: lockself-api-v3:X.X.X # ← Modifier cette ligne avec la nouvelle version
  2. Relancer avec la nouvelle version :
    # Démarrer avec la nouvelle image
    docker-compose up -d
    Docker compose recréera automatiquement le nouveau conteneur.

  3. Vérifier le démarrage :
    # Suivre les logs en temps réel
    docker logs -f lockself-api-3
  4. (Optionnel) Nettoyage des anciennes images :
    # Lister les images
    docker images

    # Supprimer l'ancienne version
    docker rmi lockself-api-v3:ancienne-version

Déploiement via docker swarm

Comme indiqué dans la documentation d'installation, Docker Swarm peut être utilisé de différentes manières. Il vous appartient donc d'enrichir cette procédure avec vos propres commandes de déploiement et de vérifications. Vous pourrez retrouver tous les détails concernant son fonctionnement sur son site officiel : https://docs.docker.com/engine/swarm/

Mettre à jour votre fichier de configuration docker-swarm pour modifier la version utilisée:

version: '3.7'

services:
  lockself-api-3:
    image: lockself-api-v3:X.X.X # ← Modifier cette ligne avec la nouvelle version

Optimisation de l'espace disque

Après chaque mise à jour des conteneurs, vous pouvez si vous le souhaiter supprimer les anciennes images au fur et à mesure.

Mise à jour du certificat SSL

Deux étapes sont nécessaires afin de mettre à jour le certificat SSL (pour la connexion HTTPS) sur votre installation :

  • Changer les certificats sur les serveurs applicatifs. Pour notre exemple, dans le dossier /home/user/lockself/ssl/), charger les nouvelles informations :

    • Le certificat suivi de la chaine de certification sous le nom : ssl-certificate.crt
    • La clé privée sous le nom : ssl-certificate.key
    • Seulement dans le cadre d'une connexion SSO :
      • Le certificat SANS la chaine de certification sous le nom : sp.crt

  • Relancer le conteneur suivant la méthode utilisée.

Changement du nom de domaine

Si vous souhaitez changer le nom de domaine de votre installation LockSelf, vous devrez suivre la procédure suivante : 

  • Relier le nouveau nom de domaine à l'IP de votre serveur applicatif
  • Dans le fichier "env", modifier la variable "domain" par le nouveau domaine que vous souhaitez exploiter

  • Dans le dossier comportant les certificats SSL (par exemple : /home/user/lockself/ssl/) :

    • Modifier le certificat suivi de la chaine de certification sous le nom : ssl-certificate.crt
    • Modifier la clé privée non chiffrée sous le nom : ssl-certificate.key
    • Seulement dans le cadre d'une connexion SSO :
      • Modifier le certificat SANS la chaine de certification sous le nom : sp.crt
  • Redémarrer le conteneur applicatif

Attention, si une interconnexion SSO est active, il devra refaire la procédure de création du connecteur.

Mise à jour