fix: CMD-176 conditional elastic search

docs/upgrade-project.md

@@ -12,8 +12,15 @@
 
 ## from v4.N to v4.14
 
+- [Rename `PORTAL_ES_ENABLED` Setting](#rename-portal_es_enabled-settings)
 - [Upgrade Docker Compose](#upgrade-docker-compose)
 
+### Rename `PORTAL_ES_ENABLED` Setting
+
+| from | to |
+| - | - |
+| `PORTAL_ES_ENABLED` | `PORTAL_SEARCH_INDEX_IS_AUTOMATIC` |
+
 ### Upgrade Docker Compose
 
 Update to _at least_ the latest Docker Compose v2.

taccsite_cms/_settings/search.py

@@ -1,52 +1,38 @@
-"""Configure search plugins"""
+"""Configure deprecated search solution"""
 
 ########################
-# TACC: SEARCH
+# SEARCH
 ########################
 
-PORTAL_ES_ENABLED = True
-
+# To support any search
 PORTAL_SEARCH_PATH = '/search'
 
-if PORTAL_ES_ENABLED:
-    # Elasticsearch
-    PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string'
-else:
-    # Google
-    PORTAL_SEARCH_QUERY_PARAM_NAME = 'q'
-
-########################
-# ELASTICSEARCH
-########################
-
-if PORTAL_ES_ENABLED:
-    ES_AUTH = 'username:password'
-    ES_HOSTS = 'http://elasticsearch:9200'
-    ES_INDEX_PREFIX = 'cms-dev-{}'
-    ES_DOMAIN = 'http://localhost:8000'
-
-    # Elasticsearch Indexing
-    HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter', ]
-    HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor'
-    ALDRYN_SEARCH_DEFAULT_LANGUAGE = 'en'
-    ALDRYN_SEARCH_REGISTER_APPHOOK = True
-    HAYSTACK_CONNECTIONS = {
-        'default': {
-            'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
-            'URL': ES_HOSTS,
-            'INDEX_NAME': ES_INDEX_PREFIX.format('cms'),
-            'KWARGS': {'http_auth': ES_AUTH}
-        }
+# To support Google search
+# PORTAL_SEARCH_QUERY_PARAM_NAME = 'q'
+# PORTAL_SEARCH_INDEX_IS_AUTOMATIC = False
+
+# To support Elasticsearch
+PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string'
+PORTAL_SEARCH_INDEX_IS_AUTOMATIC = True
+
+ES_AUTH = 'username:password'
+ES_HOSTS = 'http://elasticsearch:9200'
+ES_INDEX_PREFIX = 'cms-dev-{}'
+ES_DOMAIN = 'http://localhost:8000'
+
+HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter', ]
+HAYSTACK_CONNECTIONS = {
+    'default': {
+        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
+        'URL': ES_HOSTS,
+        'INDEX_NAME': ES_INDEX_PREFIX.format('cms'),
+        'KWARGS': {'http_auth': ES_AUTH}
     }
+}
 
-########################
-# DJANGO CMS
-########################
+ALDRYN_SEARCH_DEFAULT_LANGUAGE = 'en'
+ALDRYN_SEARCH_REGISTER_APPHOOK = True
 
-if PORTAL_ES_ENABLED:
-    _INSTALLED_APPS = [
-        'haystack',                # search index
-        'aldryn_apphooks_config',  # search index & django CMS Blog
-    ]
-else:
-    _INSTALLED_APPS = []
+_INSTALLED_APPS = [
+    'haystack',                # search index
+]

taccsite_cms/settings.py

@@ -481,6 +481,7 @@ def gettext(s): return s
 ] + search_INSTALLED_APPS + [
 
     # miscellaneous
+    'aldryn_apphooks_config',  # search index & django CMS Blog
     'test_without_migrations', # run tests faster
 
 ] + form_plugin_INSTALLED_APPS + [
@@ -723,6 +724,8 @@ def get_subdirs_as_module_names(path):
     (CORTAL_ICONS, 'icon', _('TACC "Cortal" Icons')),
 ]
 
+
+
 ########################
 # SETTINGS IMPORT
 ########################
@@ -754,8 +757,9 @@ def get_subdirs_as_module_names(path):
 
 ########################
 # SETTINGS DEPRECATED
-########################
 # TODO: Make clients not use nor set these
+########################
+
 deprecated_SETTINGS_EXPORT = []
 
 # For header_branding.html
@@ -801,6 +805,13 @@ def get_subdirs_as_module_names(path):
             if 'INCLUDES_SEARCH_BAR' == old_setting_name:
                 PORTAL_HAS_SEARCH = INCLUDES_SEARCH_BAR
 
+########################
+# SETTINGS CONDITIONAL
+########################
+
+if PORTAL_SEARCH_INDEX_IS_AUTOMATIC:
+    HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor'
+
 ########################
 # SETTINGS EXPORT
 ########################

taccsite_cms/settings_custom.example.py

@@ -135,6 +135,16 @@
     "img_file_src": "https://cdn.jsdelivr.net/gh/TACC/Core-CMS-Custom@813aa7c/ptdatax_assets/favicon.ico",
 }
 
+########################
+# SEARCH
+########################
+
+# To support Google search
+PORTAL_SEARCH_QUERY_PARAM_NAME = 'q'
+
+# To disable Elasticsearch
+PORTAL_SEARCH_INDEX_IS_AUTOMATIC = False
+
 ########################
 # DJANGOCMS_BLOG
 ########################
@@ -143,6 +153,7 @@
 
 tacc_app_index = INSTALLED_APPS.index('taccsite_cms')
 INSTALLED_APPS[tacc_app_index:tacc_app_index] = [
+    # 'aldryn_apphooks_config' # already in Core
     # 'filer',              # already in Core
     # 'easy_thumbnails',    # already in Core
     'parler',