Introducción
Cuando la configuración de un sistema de búsqueda se gestiona manualmente, resulta difícil reproducir los entornos y aumenta el riesgo de errores de configuración. Adoptando prácticas modernas de DevOps, gestionemos y automaticemos también la infraestructura de búsqueda como código.
En este artículo se presenta un enfoque para gestionar las configuraciones de Fess como código y automatizar los despliegues.
Público objetivo
Personas que desean automatizar las operaciones del sistema de búsqueda
Personas que desean aplicar métodos DevOps/IaC a la infraestructura de búsqueda
Personas con conocimientos básicos de Docker y CI/CD
Aplicación de Infrastructure as Code
Los siguientes elementos se gestionan como «código» para los entornos de Fess.
Definición de entornos con Docker Compose
Archivo Docker Compose para producción
Ampliamos la configuración básica utilizada en la Parte 2 para definir una configuración adecuada para entornos de producción.
Los puntos clave son los siguientes.
Definición del health check: Fess se inicia solo cuando OpenSearch está listo
Persistencia de volúmenes: Los datos se mantienen de forma permanente
Política de reinicio: Recuperación automática ante fallos
Configuración explícita del heap de la JVM
Automatización de la configuración con la API de administración
Mediante el uso de la API de administración de Fess, puede gestionar las configuraciones de forma programática sin utilizar la interfaz gráfica.
Exportar configuración
Exporte la configuración actual de Fess y guárdela como código.
Puede exportar desde la consola de administración en [Información del sistema] > [Respaldo]. También es posible exportar mediante scripts utilizando la API de administración.
Importar configuración
Aplique la configuración a un nuevo entorno de Fess utilizando los archivos de configuración guardados. Esto facilita la reconstrucción o replicación de entornos.
Uso de la CLI fessctl
fessctl es una herramienta de línea de comandos para Fess. Muchas de las operaciones que se pueden realizar en la consola de administración también se pueden ejecutar desde la línea de comandos.
Operaciones principales
Crear, actualizar y eliminar configuraciones de rastreo (web, sistema de archivos, almacén de datos)
Ejecutar trabajos del planificador
Gestionar usuarios, roles y grupos
Gestionar configuraciones de búsqueda como key match, etiquetas y boosts
Mediante el uso de la CLI, puede convertir los cambios de configuración en scripts e integrarlos en pipelines CI/CD.
Construcción de pipelines CI/CD
Flujo de trabajo para cambios de configuración
Gestione los cambios de configuración del sistema de búsqueda con el siguiente flujo de trabajo.
Cambio: Modificar los archivos de configuración y gestionarlos en una rama de Git
Revisión: Revisar los cambios mediante pull requests
Prueba: Verificar el comportamiento en un entorno de staging
Despliegue: Aplicar la configuración al entorno de producción
Ejemplo de automatización con GitHub Actions
Este es un ejemplo de aplicación automática de cambios al entorno de producción cuando se fusionan cambios en los archivos de configuración.
Automatización de respaldos
Automaticemos también los respaldos periódicos.
Script de respaldo
Utilice cron o las funciones de programación de CI/CD para realizar respaldos periódicos.
Procedimiento de reconstrucción del entorno
Documente el procedimiento para reconstruir completamente un entorno para la recuperación ante desastres o la creación de entornos de prueba.
Iniciar los contenedores con Docker Compose
Esperar hasta que el health check de OpenSearch devuelva green/yellow
Importar la configuración de Fess (mediante la API de administración o la función de restauración)
Colocar los archivos de diccionario
Ejecutar los trabajos de rastreo
Verificar el funcionamiento (pruebas de búsqueda)
Al convertir este procedimiento en un script, puede reconstruir los entornos rápidamente.
Resumen
En este artículo se presentó un enfoque para gestionar la infraestructura de búsqueda de Fess utilizando prácticas de DevOps.
Codificación de las definiciones de entorno con Docker Compose
Automatización de la configuración con la API de administración y fessctl
Automatización del despliegue de cambios de configuración con pipelines CI/CD
Automatización de respaldos y procedimientos de reconstrucción de entornos
Evolucione las operaciones de su infraestructura de búsqueda de «leer manuales y configurar manualmente» a «ejecutar código y desplegar automáticamente».
En el próximo artículo se tratará la extensión de Fess mediante el desarrollo de plugins.