Rol de Ansible: Apache Solr

Instala Apache Solr en servidores Linux.

Requisitos

Java debe estar disponible en el servidor. Puedes instalar Java fácilmente usando el rol geerlingguy.java. Asegúrate de que la versión de Java instalada cumple con los requisitos mínimos de Solr (por ejemplo, Java 8 para Solr 6+).

Este rol se ha probado y funciona con Solr 3.x, 4.x, 5.x, 6.x, 7.x y 8.x.

Variables del Rol

Las variables disponibles se enumeran a continuación, junto con los valores predeterminados (ver defaults/main.yml):

solr_workspace: /root

Los archivos se descargarán en esta ruta en el servidor remoto antes de ser movidos a su lugar.

solr_create_user: true
solr_user: solr
solr_group: "{{ solr_user }}"

Solr se ejecutará bajo el solr_user. Establece solr_create_user a false si el solr_user ya fue creado antes de que este rol se ejecute, o si estás usando Solr 5+ y quieres que el script de instalación de Solr configure el usuario. Por defecto, solr_group es igual a solr_user, pero se puede sobrescribir para ajustarse a tu propia configuración.

solr_version: "8.11.2"

La versión de Apache Solr que se instalará. Para una lista completa, consulta versiones de Apache Solr disponibles.

solr_mirror: "https://archive.apache.org/dist"

El espejo del Proyecto Apache desde el cual se descargará el archivo tar de Solr. En caso de tener una velocidad de descarga lenta o tiempos de espera, es útil establecer el espejo en el propuesto por el sitio de descarga de espejos de Apache.

solr_remove_cruft: false

Si se debe eliminar la documentación y ejemplos innecesarios del directorio de solr.

solr_service_manage: true
solr_service_name: solr
solr_service_state: started

Por defecto, este rol gestionará el servicio solr, asegurándose de que esté habilitado al iniciar el sistema y esté en funcionamiento. Puedes asegurarte de que Solr esté detenido estableciendo solr_service_state: stopped, o puedes desactivar completamente la gestión del servicio solr por este rol estableciendo solr_service_manage: false. En este caso, también puedes querer establecer solr_restart_handler_enabled: false (documentado más adelante).

solr_install_dir: /opt
solr_install_path: /opt/solr

La ruta donde se instalará Apache Solr. Para Solr 5+, solr_install_dir será utilizado por el script de instalación de Solr. Para Solr < 5, los archivos de instalación de Solr se copiarán en solr_install_path.

solr_home: /var/solr

La ruta donde se almacenará la información local de Solr (colecciones de búsqueda y configuración). Generalmente, debe estar fuera de solr_path, para facilitar las actualizaciones de Solr.

solr_port: "8983"

El puerto en el que se ejecutará Solr.

solr_xms: "256M"
solr_xmx: "512M"

Configuraciones de memoria para la JVM. Deben establecerse lo más alto posible para obtener el mejor rendimiento y reducir la posibilidad de que Solr se reinicie debido a situaciones de OOM.

solr_timezone: "UTC"

Zona horaria predeterminada de la JVM que ejecuta solr. Puedes sobrescribir esto si es necesario al usar importación de datos e importaciones delta (por ejemplo: comparando con una fuente de datos MySQL externa). Revisa la documentación de Apache Solr sobre Trabajar con Fechas para más información.

solr_opts: "$SOLR_OPTS -Dlog4j2.formatMsgNoLookups=true"

Opciones de Solr. Esta opción se agregó al rol en parte para mitigar CVE-2021-44228.

solr_cores:
  - collection1

Una lista de núcleos / colecciones que deben existir en el servidor. Cada uno se creará (si no existe ya) usando la configuración de ejemplo predeterminada que se incluye con Solr. Ten en cuenta que esta variable solo se aplica al usar Solr 5+.

solr_connect_host: localhost

El nombre de host o la dirección IP en la que Solr será accesible. localhost debería funcionar en la mayoría de los casos, pero hay casos especiales donde solo puedes acceder a la instancia local de Solr a través de otra IP o nombre de host.

solr_restart_handler_enabled: true

Si se debe usar o no el manejador reiniciar solr. Si estás construyendo contenedores o AMIs, es posible que debas desactivar el manejador de reinicio para una ejecución de provisión.

Variables usadas solo para Solr < 5.

Las siguientes variables solo se aplican actualmente a instalaciones de Solr 4 y anteriores:

solr_log_file_path: /var/log/solr.log

Ruta donde se creará el archivo de registro de Solr.

solr_host: "0.0.0.0"

El nombre de host o la dirección IP a la que Solr se vinculará. Por defecto es 0.0.0.0, lo que permite que Solr escuche en todas las interfaces.

Dependencias

Ninguna.

Ejemplo de Playbook

- hosts: solr-servers
  roles:
    - geerlingguy.java
    - geerlingguy.solr

Licencia

MIT / BSD

Información del Autor

Este rol fue creado en 2014 por Jeff Geerling, autor de Ansible for DevOps.