Introduction
Lorsque la configuration d’un système de recherche est gérée manuellement, la reproduction des environnements devient difficile et le risque d’erreurs de configuration augmente. En adoptant les pratiques modernes de DevOps, gérons et automatisons également l’infrastructure de recherche en tant que code.
Cet article présente une approche pour gérer les configurations de Fess en tant que code et automatiser les déploiements.
Public cible
Les personnes souhaitant automatiser les opérations du système de recherche
Les personnes souhaitant appliquer les méthodes DevOps/IaC à l’infrastructure de recherche
Les personnes ayant des connaissances de base en Docker et CI/CD
Application de l’Infrastructure as Code
Les éléments suivants sont gérés en tant que « code » pour les environnements Fess.
Définition d’environnement avec Docker Compose
Fichier Docker Compose pour la production
Nous étendons la configuration de base utilisée dans la Partie 2 pour définir une configuration adaptée aux environnements de production.
Les points clés sont les suivants.
Définition du health check : Fess ne démarre qu’une fois OpenSearch prêt
Persistance des volumes : Les données sont conservées de manière permanente
Politique de redémarrage : Récupération automatique en cas de défaillance
Configuration explicite du heap JVM
Automatisation de la configuration avec l’API d’administration
En utilisant l’API d’administration de Fess, vous pouvez gérer les configurations de manière programmatique sans passer par l’interface graphique.
Exporter les paramètres
Exportez les paramètres actuels de Fess et enregistrez-les sous forme de code.
Vous pouvez exporter depuis la console d’administration sous [Informations système] > [Sauvegarde]. Il est également possible d’exporter via des scripts en utilisant l’API d’administration.
Importer les paramètres
Appliquez les paramètres à un nouvel environnement Fess en utilisant les fichiers de configuration sauvegardés. Cela facilite la reconstruction ou la réplication des environnements.
Utilisation de la CLI fessctl
fessctl est un outil en ligne de commande pour Fess. De nombreuses opérations réalisables dans la console d’administration peuvent également être exécutées depuis la ligne de commande.
Opérations principales
Créer, mettre à jour et supprimer des configurations de crawl (web, système de fichiers, magasin de données)
Exécuter des tâches planifiées
Gérer les utilisateurs, les rôles et les groupes
Gérer les paramètres de recherche tels que le key match, les labels et les boosts
En utilisant la CLI, vous pouvez scripter les changements de configuration et les intégrer dans les pipelines CI/CD.
Construction de pipelines CI/CD
Workflow pour les changements de configuration
Gérez les changements de configuration du système de recherche avec le workflow suivant.
Modification : Modifier les fichiers de configuration et les gérer dans une branche Git
Revue : Examiner les changements via des pull requests
Test : Vérifier le comportement dans un environnement de staging
Déploiement : Appliquer les paramètres à l’environnement de production
Exemple d’automatisation avec GitHub Actions
Voici un exemple d’application automatique des modifications à l’environnement de production lorsque des changements de fichiers de configuration sont fusionnés.
Automatisation des sauvegardes
Automatisons également les sauvegardes régulières.
Script de sauvegarde
Utilisez cron ou les fonctionnalités de planification CI/CD pour effectuer des sauvegardes régulières.
Procédure de reconstruction de l’environnement
Documentez la procédure de reconstruction complète d’un environnement pour la reprise après sinistre ou la mise en place d’environnements de test.
Démarrer les conteneurs avec Docker Compose
Attendre que le health check d’OpenSearch renvoie green/yellow
Importer les paramètres Fess (via l’API d’administration ou la fonction de restauration)
Placer les fichiers de dictionnaire
Exécuter les tâches de crawl
Vérifier le fonctionnement (tests de recherche)
En scriptant cette procédure, vous pouvez reconstruire rapidement les environnements.
Résumé
Cet article a présenté une approche pour gérer l’infrastructure de recherche Fess avec les pratiques DevOps.
Codification des définitions d’environnement avec Docker Compose
Automatisation de la configuration avec l’API d’administration et fessctl
Automatisation du déploiement des changements de configuration avec les pipelines CI/CD
Automatisation des sauvegardes et procédures de reconstruction d’environnement
Faites évoluer les opérations de votre infrastructure de recherche de « lire des manuels et configurer manuellement » à « exécuter du code et déployer automatiquement ».
Le prochain article traitera de l’extension de Fess par le développement de plugins.