Configure Django to use Elasticsearch

Author: sdarwin

README.md

@@ -117,6 +117,7 @@ mailman3_config:
     class: mailman.database.postgresql.PostgreSQLDatabase
     url: postgresql://mailman3_core:[email protected]/mailman3_core
 mailman3_django_config:
+  haystack_engine: haystack.backends.elasticsearch7_backend.Elasticsearch7SearchEngine
   secret_key: supersecret
   # Don't define hyperkitty_attachment_folder. If not set, it will store attachments in the db.
   # hyperkitty_attachment_folder: "{{ mailman3_web_var_dir }}/attachments"

defaults/main.yml

@@ -360,6 +360,7 @@ __mailman3_pip_packages:
   - mailman
   - mailman-web
   - mailman-hyperkitty  # ??
+  - elasticsearch==7.17.9
   - "{{ mailman3_python_wsgi_package }}"
 
 # Packages to install from PyPI if using the pip install method. Automatically includes libsass if mailman3_use_pysassc
@@ -467,3 +468,6 @@ elasticsearch_http_port: 9200
 elasticsearch_extra_options: ''
 elasticsearch_heap_size_min: 1g
 elasticsearch_heap_size_max: 2g
+# used by Django, not necessarily by elasticsearch itself:
+elasticsearch_index_name: mailman
+elasticsearch_url: "http://127.0.0.1:9200/"

templates/settings.py.j2

@@ -135,13 +135,23 @@ EMAIL_FILE_PATH = os.path.join("{{ mailman3_web_var_dir }}", 'emails')
 #
 # Full-text search engine
 #
+{% if 'Elasticsearch' in  __mailman3_django_config_merged.haystack_engine %}
+HAYSTACK_CONNECTIONS = {
+    'default': {
+        'ENGINE': '{{ __mailman3_django_config_merged.haystack_engine }}',
+        "URL": "{{ elasticsearch_url }}",
+        "INDEX_NAME": "{{ elasticsearch_index_name }}",
+    },
+}
+{% else %}
 HAYSTACK_CONNECTIONS = {
     'default': {
         'ENGINE': '{{ __mailman3_django_config_merged.haystack_engine }}',
         'PATH': os.path.join("{{ mailman3_web_var_dir }}", "fulltext_index"),
     },
 }
 {% endif %}
+{% endif %}
 {% if __mailman3_django_config_merged.socialaccount_providers is defined %}
 
 {% for provider in __mailman3_django_config_merged.socialaccount_providers | sort %}