Rola Ansible: Apache Solr

Instaluje Apache Solr na serwerach Linux.

Wymagania

Na serwerze musi być zainstalowana Java. Możesz łatwo zainstalować Javę używając roli geerlingguy.java. Upewnij się, że zainstalowana wersja Javy spełnia minimalne wymagania Solr (np. Java 8 dla Solr 6+).

Ta rola jest aktualnie testowana i działa z wersjami Solr 3.x, 4.x, 5.x, 6.x, 7.x i 8.x.

Zmienne Roli

Dostępne zmienne są wymienione poniżej, wraz z wartościami domyślnymi (zobacz defaults/main.yml):

solr_workspace: /root

Pliki zostaną pobrane do tej ścieżki na zdalnym serwerze przed przeniesieniem na właściwe miejsce.

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

Solr będzie działał pod użytkownikiem solr_user. Ustaw solr_create_user na false, jeśli solr_user został utworzony przed uruchomieniem tej roli, lub jeśli używasz Solr 5+ i chcesz, by skrypt instalacyjny Solr utworzył użytkownika. Domyślnie solr_group równa się solr_user, ale można to nadpisać, aby dopasować do własnej konfiguracji.

solr_version: "8.11.2"

Wersja Apache Solr do zainstalowania. Pełną listę znajdziesz na dostępnych wersjach Apache Solr.

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

Lustro projektu Apache, z którego zostanie pobrany archiwum Solr. W przypadku wolnego transferu lub problemów z czasem oczekiwania, warto ustawić lustro zgodne z stroną pobierania luster Apache.

solr_remove_cruft: false

Czy usunąć zbędną dokumentację i przykłady z katalogu Solr.

solr_service_manage: true
solr_service_name: solr
solr_service_state: started

Domyślnie ta rola zarządza usługą solr, zapewniając, że jest ona włączona podczas uruchamiania systemu i działa. Możesz zatrzymać Solr, ustawiając solr_service_state: stopped, lub możesz całkowicie wyłączyć zarządzanie usługą solr przez tę rolę, ustawiając solr_service_manage: false. W takim przypadku warto także ustawić solr_restart_handler_enabled: false (opisane poniżej).

solr_install_dir: /opt
solr_install_path: /opt/solr

Ścieżka, w której Apache Solr będzie zainstalowany. Dla Solr 5+, solr_install_dir będzie używane przez skrypt instalacyjny Solr. Dla Solr < 5, pliki instalacyjne Solr zostaną skopiowane do solr_install_path.

solr_home: /var/solr

Ścieżka, gdzie będą przechowywane lokalne dane Solr (kolekcje wyszukiwania i konfiguracja). Powinno być to zazwyczaj poza solr_path, aby ułatwić aktualizacje Solr.

solr_port: "8983"

Port, na którym będzie działał Solr.

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

Ustawienia pamięci dla JVM. Powinny być ustawione na jak najwyższą wartość, jaką możesz pozwolić, dla najlepszej wydajności i aby zminimalizować ryzyko ponownego uruchamiania Solr z powodu sytuacji OOM.

solr_timezone: "UTC"

Domyślna strefa czasowa JVM uruchamiającej Solr. Możesz to nadpisać, jeśli zajdzie taka potrzeba przy użyciu importu danych i importów delta (np. porównywanie z zewnętrznym źródłem danych MySQL). Przeczytaj dokumentację Apache Solr na temat Pracy z datami dla dodatkowych informacji.

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

Opcje Solr. Ta opcja została dodana do roli częściowo w celu złagodzenia CVE-2021-44228.

solr_cores:
  - collection1

Lista rdzeni / kolekcji, które powinny istnieć na serwerze. Każda z nich zostanie utworzona (jeśli jeszcze nie istnieje) przy użyciu domyślnej konfiguracji przykładowej, która jest dołączona do Solr. Zauważ, że ta zmienna ma zastosowanie tylko przy użyciu Solr 5+.

solr_connect_host: localhost

Nazwa hosta lub adres IP, pod którym Solr będzie dostępny. localhost powinien działać w większości przypadków, ale są specjalne sytuacje, w których możesz mieć dostęp tylko do lokalnej instancji Solr za pomocą innego adresu IP lub nazwy hosta.

solr_restart_handler_enabled: true

Czy powinien być używany handler restart solr czy nie. Jeśli budujesz kontenery lub AMI, może być konieczne wyłączenie handlera ponownego uruchamiania dla wykonania procesów provisioningowych.

Zmienne używane tylko dla Solr < 5.

Następujące zmienne mają zastosowanie tylko do instalacji Solr 4 i niższych:

solr_log_file_path: /var/log/solr.log

Ścieżka, w której zostanie utworzony plik dziennika Solr.

solr_host: "0.0.0.0"

Nazwa hosta lub adres IP, do którego Solr będzie się wiązał. Domyślnie 0.0.0.0, co umożliwia Solr nasłuch na wszystkich interfejsach.

Zależności

Brak.

Przykładowy Playbook

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

Licencja

MIT / BSD

Informacje o autorze

Ta rola została stworzona w 2014 roku przez Jeffa Geerlinga, autora Ansible for DevOps.