Rôle Ansible : Apache Solr

Installe Apache Solr sur des serveurs Linux.

Exigences

Java doit être disponible sur le serveur. Vous pouvez facilement installer Java en utilisant le rôle geerlingguy.java. Assurez-vous que la version de Java installée répond aux exigences minimales de Solr (par exemple, Java 8 pour Solr 6+).

Ce rôle est actuellement testé et fonctionne avec les versions Solr 3.x, 4.x, 5.x, 6.x, 7.x et 8.x.

Variables du Rôle

Les variables disponibles sont listées ci-dessous, avec leurs valeurs par défaut (voir defaults/main.yml):

solr_workspace: /root

Les fichiers seront téléchargés vers ce chemin sur le serveur distant avant d'être déplacés à leur emplacement final.

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

Solr sera exécuté sous l'utilisateur solr_user. Mettez solr_create_user à false si solr_user est créé avant l'exécution de ce rôle, ou si vous utilisez Solr 5+ et souhaitez que le script d'installation de Solr crée l'utilisateur. Par défaut, solr_group est égal à solr_user, mais cela peut être modifié pour s'adapter à votre propre configuration.

solr_version: "8.11.2"

La version d'Apache Solr à installer. Pour une liste complète, voir versions disponibles d'Apache Solr.

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

Le miroir du Projet Apache à partir duquel le fichier tar de Solr sera téléchargé. En cas de vitesse de téléchargement lente ou de délais d'attente, il est utile de régler le miroir sur celui suggéré par le site de téléchargement miroir d'Apache.

solr_remove_cruft: false

Si oui ou non supprimer la documentation et les exemples inutiles du répertoire solr.

solr_service_manage: true
solr_service_name: solr
solr_service_state: started

Par défaut, ce rôle gérera le service solr, en s'assurant qu'il est activé au démarrage du système et qu'il fonctionne. Vous pouvez vous assurer que Solr est arrêté en mettant solr_service_state: stopped, ou vous pouvez désactiver complètement la gestion du service solr par ce rôle en mettant solr_service_manage: false. Vous voudrez peut-être également mettre solr_restart_handler_enabled: false (documenté plus tard) dans ce cas.

solr_install_dir: /opt
solr_install_path: /opt/solr

Le chemin où Apache Solr sera installé. Pour Solr 5+, le solr_install_dir sera utilisé par le script d'installation de Solr. Pour Solr < 5, les fichiers d'installation de Solr seront copiés à leur emplacement dans le solr_install_path.

solr_home: /var/solr

Le chemin où les données locales de Solr (collections de recherche et configuration) seront stockées. Devrait généralement être en dehors du solr_path, pour faciliter les mises à niveau de Solr.

solr_port: "8983"

Le port sur lequel Solr fonctionnera.

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

Paramètres de mémoire pour la JVM. Ceux-ci devraient être réglés aussi haut que possible pour de meilleures performances et pour réduire le risque que Solr redémarre en raison de situations OOM.

solr_timezone: "UTC"

Fuseau horaire par défaut de la JVM exécutant Solr. Vous pouvez le remplacer si nécessaire lors de l'importation de données et des importations delta (p. ex. : comparaison avec une source de données externe MySQL). Lisez la documentation d'Apache Solr sur Travailler avec les Dates pour plus d'informations.

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

Options pour Solr. Cette option a été ajoutée au rôle en partie pour atténuer CVE-2021-44228.

solr_cores:
  - collection1

Une liste de cœurs / collections qui devraient exister sur le serveur. Chacun d'eux sera créé (s'il n'existe pas déjà) en utilisant la configuration d'exemple par défaut fournie avec Solr. Notez que cette variable ne s'applique que si vous utilisez Solr 5+.

solr_connect_host: localhost

Le nom d'hôte ou l'adresse IP sur lequel Solr sera accessible. localhost devrait fonctionner dans la plupart des cas, mais il y a des cas spéciaux où vous ne pourrez accéder à l'instance locale de Solr que via une autre IP ou un autre nom d'hôte.

solr_restart_handler_enabled: true

Si le gestionnaire restart solr doit être utilisé ou non. Si vous construisez des conteneurs ou des AMI, vous pourriez avoir besoin de désactiver le gestionnaire de redémarrage pour une exécution de provisionnement.

Variables utilisées uniquement pour Solr < 5.

Les variables suivantes s'appliquent uniquement aux installations de Solr 4 et inférieures :

solr_log_file_path: /var/log/solr.log

Chemin où le fichier journal de Solr sera créé.

solr_host: "0.0.0.0"

Le nom d'hôte ou l'adresse IP sur laquelle Solr sera lié. Par défaut, cela se fixe à 0.0.0.0, ce qui permet à Solr d'écouter sur toutes les interfaces.

Dépendances

Aucune.

Exemple de Playbook

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

Licence

MIT / BSD

Informations sur l'Auteur

Ce rôle a été créé en 2014 par Jeff Geerling, auteur de Ansible for DevOps.