Procédure de mise à niveau

Cette page décrit la procédure de mise à niveau de Fess d’une version antérieure vers la dernière version.

Avertissement

Notes importantes avant la mise à niveau

• Veuillez obligatoirement effectuer une sauvegarde avant la mise à niveau

• Il est fortement recommandé de valider la mise à niveau dans un environnement de test au préalable

• Le service s’arrêtera pendant la mise à niveau, veuillez donc définir une fenêtre de maintenance appropriée

• Selon les versions, le format des fichiers de configuration peut avoir changé

Versions compatibles

Cette procédure de mise à niveau est compatible avec les mises à niveau entre les versions suivantes :

• Fess 14.x → Fess 15.3

• Fess 15.x → Fess 15.3

Note

Pour une mise à niveau depuis des versions plus anciennes (13.x ou antérieures), une mise à niveau progressive peut être nécessaire. Veuillez consulter les notes de version pour plus de détails.

Préparation avant la mise à niveau

Vérification de la compatibilité des versions

Vérifiez la compatibilité entre la version de destination et la version actuelle.

• Notes de version

• Guide de mise à niveau

Planification du temps d’arrêt

La mise à niveau nécessite l’arrêt du système. Planifiez le temps d’arrêt en tenant compte des éléments suivants :

• Temps de sauvegarde : 10 minutes à plusieurs heures (selon la quantité de données)

• Temps de mise à niveau : 10 à 30 minutes

• Temps de vérification du fonctionnement : 30 minutes à 1 heure

• Temps de réserve : 30 minutes

Fenêtre de maintenance recommandée : Total de 2 à 4 heures

Étape 1 : Sauvegarde des données

Avant la mise à niveau, sauvegardez toutes les données.

Sauvegarde des données de configuration

1. Sauvegarde depuis l’écran d’administration

   Connectez-vous à l’écran d’administration et cliquez sur « Système » → « Sauvegarde ».

   Téléchargez les fichiers suivants :

   • fess_basic_config.bulk

   • fess_user.bulk

2. Sauvegarde des fichiers de configuration

   Version TAR.GZ/ZIP

   $ cp /path/to/fess/app/WEB-INF/conf/system.properties /backup/
   $ cp /path/to/fess/app/WEB-INF/classes/fess_config.properties /backup/
   

   Version RPM/DEB

   $ sudo cp /etc/fess/system.properties /backup/
   $ sudo cp /etc/fess/fess_config.properties /backup/
   

3. Fichiers de configuration personnalisés

   Si vous avez des fichiers de configuration personnalisés, sauvegardez-les également

   $ cp /path/to/fess/app/WEB-INF/classes/log4j2.xml /backup/
   

Sauvegarde des données d’index

Sauvegardez les données d’index d’OpenSearch.

Méthode 1 : Utilisation de la fonction de snapshot (recommandé)

Sauvegardez l’index en utilisant la fonction de snapshot d’OpenSearch.

1. Configuration du dépôt

   $ curl -X PUT "http://localhost:9200/_snapshot/fess_backup" -H 'Content-Type: application/json' -d'
   {
     "type": "fs",
     "settings": {
       "location": "/backup/opensearch/snapshots"
     }
   }'
   

2. Création du snapshot

   $ curl -X PUT "http://localhost:9200/_snapshot/fess_backup/snapshot_1?wait_for_completion=true"
   

3. Vérification du snapshot

   $ curl -X GET "http://localhost:9200/_snapshot/fess_backup/snapshot_1"
   

Méthode 2 : Sauvegarde du répertoire entier

Après avoir arrêté OpenSearch, sauvegardez le répertoire de données.

$ sudo systemctl stop opensearch
$ sudo tar czf /backup/opensearch-data-$(date +%Y%m%d).tar.gz /var/lib/opensearch/data
$ sudo systemctl start opensearch

Sauvegarde de la version Docker

Sauvegardez les volumes Docker

$ docker compose -f compose.yaml -f compose-opensearch3.yaml stop
$ docker run --rm -v fess-es-data:/data -v $(pwd):/backup ubuntu tar czf /backup/fess-es-data-backup.tar.gz /data
$ docker run --rm -v fess-data:/data -v $(pwd):/backup ubuntu tar czf /backup/fess-data-backup.tar.gz /data
$ docker compose -f compose.yaml -f compose-opensearch3.yaml start

Étape 2 : Arrêt de la version actuelle

Arrêtez Fess et OpenSearch.

Version TAR.GZ/ZIP

$ kill <fess_pid>
$ kill <opensearch_pid>

Version RPM/DEB (systemd)

$ sudo systemctl stop fess.service
$ sudo systemctl stop opensearch.service

Version Docker

$ docker compose -f compose.yaml -f compose-opensearch3.yaml down

Étape 3 : Installation de la nouvelle version

Les procédures diffèrent selon la méthode d’installation.

Version TAR.GZ/ZIP

1. Téléchargez et décompressez la nouvelle version

   $ wget https://github.com/codelibs/fess/releases/download/fess-15.3.2/fess-15.3.2.tar.gz
   $ tar -xzf fess-15.3.2.tar.gz
   

2. Copiez la configuration de l’ancienne version

   $ cp /path/to/old-fess/app/WEB-INF/conf/system.properties /path/to/fess-15.3.2/app/WEB-INF/conf/
   $ cp /path/to/old-fess/bin/fess.in.sh /path/to/fess-15.3.2/bin/
   

3. Vérifiez les différences de configuration et ajustez si nécessaire

Version RPM/DEB

Installez le package de la nouvelle version

# RPM
$ sudo rpm -Uvh fess-15.3.2.rpm

# DEB
$ sudo dpkg -i fess-15.3.2.deb

Note

Les fichiers de configuration (/etc/fess/*) sont automatiquement conservés. Cependant, si de nouvelles options de configuration ont été ajoutées, un ajustement manuel peut être nécessaire.

Version Docker

1. Obtenez les fichiers Compose de la nouvelle version

   $ wget https://raw.githubusercontent.com/codelibs/docker-fess/v15.3.2/compose/compose.yaml
   $ wget https://raw.githubusercontent.com/codelibs/docker-fess/v15.3.2/compose/compose-opensearch3.yaml
   

2. Récupérez la nouvelle image

   $ docker compose -f compose.yaml -f compose-opensearch3.yaml pull
   

Étape 4 : Mise à niveau d’OpenSearch (si nécessaire)

Si vous mettez également à niveau OpenSearch, suivez les procédures suivantes.

Avertissement

Procédez avec précaution lors d’une mise à niveau majeure d’OpenSearch. Des problèmes de compatibilité d’index peuvent survenir.

1. Installez la nouvelle version d’OpenSearch

2. Réinstallez les plugins

   $ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-fess:3.3.1
   $ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-extension:3.3.1
   $ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-minhash:3.3.1
   $ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-configsync:3.3.1
   

3. Démarrez OpenSearch

   $ sudo systemctl start opensearch.service
   

Étape 5 : Démarrage de la nouvelle version

Version TAR.GZ/ZIP

$ cd /path/to/fess-15.3.2
$ ./bin/fess -d

Version RPM/DEB

$ sudo systemctl start opensearch.service
$ sudo systemctl start fess.service

Version Docker

$ docker compose -f compose.yaml -f compose-opensearch3.yaml up -d

Étape 6 : Vérification du fonctionnement

1. Vérification des journaux

   Vérifiez qu’il n’y a pas d’erreurs

   $ tail -f /path/to/fess/logs/fess.log
   

2. Accès à l’interface Web

   Accédez à http://localhost:8080/ via un navigateur.

3. Connexion à l’écran d’administration

   Accédez à http://localhost:8080/admin et connectez-vous avec le compte administrateur.

4. Vérification des informations système

   Cliquez sur « Système » → « Informations système » dans l’écran d’administration et vérifiez que la version a été mise à jour.

5. Vérification du fonctionnement de la recherche

   Effectuez une recherche sur l’écran de recherche et vérifiez que les résultats sont retournés normalement.

Étape 7 : Recréation de l’index (recommandé)

En cas de mise à niveau majeure, il est recommandé de recréer l’index.

1. Vérifiez la planification d’exploration existante

2. Exécutez « Default Crawler » depuis « Système » → « Planificateur »

3. Attendez la fin de l’exploration

4. Vérifiez les résultats de recherche

Procédure de retour arrière

En cas d’échec de la mise à niveau, vous pouvez revenir en arrière avec les procédures suivantes.

Étape 1 : Arrêt de la nouvelle version

$ sudo systemctl stop fess.service
$ sudo systemctl stop opensearch.service

Étape 2 : Restauration de l’ancienne version

Restaurez les fichiers de configuration et les données depuis la sauvegarde.

Version RPM/DEB

$ sudo rpm -Uvh --oldpackage fess-<old-version>.rpm

Ou

$ sudo dpkg -i fess-<old-version>.deb

Étape 3 : Restauration des données

Restauration depuis le snapshot

$ curl -X POST "http://localhost:9200/_snapshot/fess_backup/snapshot_1/_restore?wait_for_completion=true"

Ou restauration du répertoire depuis la sauvegarde

$ sudo systemctl stop opensearch
$ sudo rm -rf /var/lib/opensearch/data/*
$ sudo tar xzf /backup/opensearch-data-backup.tar.gz -C /
$ sudo systemctl start opensearch

Étape 4 : Démarrage et vérification du service

$ sudo systemctl start opensearch.service
$ sudo systemctl start fess.service

Vérifiez le fonctionnement et confirmez le retour à la normale.

Questions fréquemment posées

Q : Peut-on effectuer une mise à niveau sans temps d’arrêt ?

R : La mise à niveau de Fess nécessite l’arrêt du service. Pour minimiser le temps d’arrêt, envisagez ce qui suit :

• Vérifier les procédures dans un environnement de test au préalable

• Effectuer la sauvegarde à l’avance

• Assurer suffisamment de temps pour la fenêtre de maintenance

Q : Est-il nécessaire de mettre à niveau OpenSearch également ?

R : Selon la version de Fess, une version spécifique d’OpenSearch peut être requise. Vérifiez la version d’OpenSearch recommandée dans les notes de version.

Q : Est-il nécessaire de recréer l’index ?

R : Pour une mise à niveau mineure, ce n’est généralement pas nécessaire, mais pour une mise à niveau majeure, la recréation est recommandée.

Q : Les résultats de recherche ne s’affichent pas après la mise à niveau

R : Vérifiez les points suivants :

1. Vérifiez qu’OpenSearch est démarré

2. Vérifiez que l’index existe (curl http://localhost:9200/_cat/indices)

3. Réexécutez l’exploration

Étapes suivantes

Une fois la mise à niveau terminée :

• Démarrage, arrêt et configuration initiale - Vérification du démarrage et de la configuration initiale

• Configuration de la sécurité - Révision de la configuration de sécurité

• Vérifiez les nouvelles fonctionnalités dans les notes de version