OPSEXP-2450 Search Enterprise as default search engine (#783)

Alfresco · Feb 26, 2024 · 424ce9f · 424ce9f
1 parent 816078d
commit 424ce9f
Show file tree

Hide file tree

Showing 23 changed files with 166 additions and 101 deletions.
diff --git a/.envrc b/.envrc
@@ -4,7 +4,7 @@ export AWS_REGION=eu-west-1
 export MOLECULE_IT_AWS_VPC_SUBNET_ID=subnet-6bdd4223
 export BRANCH_NAME=local
 export BUILD_NUMBER=1
-export DTAS_VERSION=v1.2.0
+export DTAS_VERSION=v1.5.3
 export MOLECULE_IT_ID=$(echo "$LOGNAME" | sha256sum | cut -c1-6)
 ANSIBLE_VAULT_PASSWORD_FILE=$(expand_path ./.vault_pass.txt)
 export ANSIBLE_VAULT_PASSWORD_FILE

diff --git a/.github/workflows/enteprise.yml b/.github/workflows/enteprise.yml
@@ -10,7 +10,7 @@ on:
       - .pre-commit-config.yaml
 
 env:
-  DTAS_VERSION: v1.2.2
+  DTAS_VERSION: v1.5.3
   BUILD_NUMBER: ${{ github.run_id }}
   PY_COLORS: 1
   PYTHONUNBUFFERED: 1

diff --git a/.secrets.baseline b/.secrets.baseline
@@ -144,7 +144,7 @@
         "filename": "playbooks/acs.yml",
         "hashed_secret": "3a0b8a438a9efa61267357269709a946d797b9bd",
         "is_verified": false,
-        "line_number": 407,
+        "line_number": 391,
         "is_secret": false
       }
     ],
@@ -259,5 +259,5 @@
       }
     ]
   },
-  "generated_at": "2024-01-17T10:11:58Z"
+  "generated_at": "2024-02-22T16:12:32Z"
 }
diff --git a/docs/README.md b/docs/README.md
@@ -45,9 +45,9 @@ The playbook uses the following roles:
 * **nginx** - deploys and configures Nginx as a proxy
 * **postgres** - deploys and configures PostgreSQL
 * **repository** - deploys and configures Alfresco Repository and Alfresco Share
-* **search** - deploys and configures Alfresco Search Services
-* **search_enteprise** - deploys and configures Alfresco Search Enterprise (as
-  an alternative to Alfresco Search Services)
+* **search** - deploys and configures Alfresco Search Services (as
+  an alternative to Search Enterprise)
+* **search_enterprise** - deploys and configures Alfresco Search Enterprise
 * **sfs** - deploys and configures Alfresco Shared File Store
 * **sync** - deploys and configures Alfresco Sync Service
 * **tomcat** - deploys and configures Apache Tomcat

diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md
@@ -12,6 +12,7 @@ If it's your first time with Ansible, please have a read at [Ansible concepts](h
   * [Getting started](#getting-started)
     * [Get the playbook](#get-the-playbook)
     * [Setup runtime environment](#setup-runtime-environment)
+  * [Minimal configuration](#minimal-configuration)
   * [Understanding the playbook](#understanding-the-playbook)
     * [The control node](#the-control-node)
     * [Understanding the inventory file](#understanding-the-inventory-file)
@@ -274,15 +275,15 @@ An ACS inventory file has the following groups a host can belong to:
 * `external_activemq`: an alternative group to `activemq` in case you don't want
   to deploy ActiveMQ using our basic activemq role but instead use an ActiveMQ
   instance of yours which matches your hosting standards.
-* `search`: a single host on which to deploy Alfresco Search services.
-* `search_enterprise`: one or more hosts on which deploy Search Enterprise, as
-  an alternative to Alfresco Search.
+* `search`: a single host on which to deploy Alfresco Search services, as an
+  alternative to Search Enterprise.
+* `search_enterprise`: one or more hosts on which deploy Search Enterprise.
 * `elasticsearch`: one or more hosts on which deploy the ElasticSearch cluster
   backing Search Enterprise.
 * `external_elasticsearch`: an alternative group to `elasticsearch` in case you
   don't want to deploy ElasticSearch using the [community ElasticSearch
-  role](https://github.com/buluma/ansible-role-elasticsearch) but instead use an
-  ElasticSearch cluster of yours which matches your hosting standards.
+  role](https://github.com/geerlingguy/ansible-role-elasticsearch) but instead
+  use an ElasticSearch cluster of yours which matches your hosting standards.
 * `nginx`: a single host on which the playbook will deploy an NGINX reverse
   proxy configured for the numerous http based service in the platform.
 * `acc`: a single host where you want the Alfresco Control Center UI to be installed

diff --git a/docs/playbook-upgrade.md b/docs/playbook-upgrade.md
@@ -2,6 +2,15 @@
 
 ## Unreleased version
 
+### Search Enterprise is the new default search engine
+
+The example inventories have been updated to default to Search Enterprise /
+ElasticSearch (`search_enterprise` and `elasticsearch` groups) as the preferred
+search engine from Enterprise since ACS 23.1.1.
+
+Search Services are still supported as before by assigning hosts to the `search`
+group.
+
 ### Passing Alfresco global properties
 
 In previous version we provided an empty `alfresco-global.properties` file to

diff --git a/inventory_ha.yml b/inventory_ha.yml
@@ -16,59 +16,76 @@ all:
     database:
       hosts:
         db.infra.local:
+
     repository:
       hosts:
         ecm1.infra.local:
         ecm2.infra.local:
         ingester.infra.local:
           cluster_keepoff: true
+
     activemq:
       hosts:
         mq.infra.local:
+
+    # Solr search engine (alternative to Enterprise Search)
     search:
       hosts:
-        fts.infra.local:
-    # Enterprise Search section start
-    # alternative to `search` group
+
+    # Enterprise Search (default search engine)
     search_enterprise:
       hosts:
+        fts.infra.local:
     elasticsearch:
       hosts:
-    # Enterprise Search section end
+        fts.infra.local:
+
+    # Keycloak SSO support (optional)
     identity:
       hosts:
+
     nginx:
       hosts:
         proxy.infra.local:
+
     acc:
       hosts:
         web.infra.local:
+
     adw:
       hosts:
         web.infra.local:
+
     transformers:
       hosts:
         render.infra.local:
+
     syncservice:
       hosts:
         sync.infra.local:
+
     other_repo_clients:
       hosts:
+
+    trusted_resource_consumers:
+      children:
+        repository:
+        nginx:
+        adw:
+        other_repo_clients:
+
     external_activemq:
       hosts:
+
     external_elasticsearch:
       hosts:
+
     external_identity:
       hosts:
+
     external:
       children:
         external_activemq:
         external_elasticsearch:
         external_identity:
         other_repo_clients:
-    trusted_resource_consumers:
-      children:
-        repository:
-        nginx:
-        adw:
-        other_repo_clients:
diff --git a/inventory_local.yml b/inventory_local.yml
@@ -2,60 +2,78 @@
 all:
   vars:
     ansible_connection: local
+
   children:
     repository:
       hosts:
         localhost:
+
     database:
       children:
         repository:
+
     activemq:
       children:
         repository:
+
+    # Solr search engine (alternative to Enterprise Search)
     search:
       children:
-        repository:
-    # Enterprise Search section start
-    # alternative to `search` group
+
+    # Enterprise Search (default search engine)
     search_enterprise:
       children:
+        repository:
     elasticsearch:
       children:
-    # Enterprise Search section end
+        repository:
+
+    # Keycloak SSO support (optional)
     identity:
-      hosts:
+      children:
+
     nginx:
       children:
         repository:
+
     acc:
       children:
         repository:
+
     adw:
       children:
         repository:
+
     transformers:
       children:
         repository:
+
     syncservice:
       children:
         repository:
+
     other_repo_clients:
       hosts:
+
+    trusted_resource_consumers:
+      children:
+        repository:
+        nginx:
+        adw:
+        other_repo_clients:
+
     external_activemq:
       hosts:
+
     external_elasticsearch:
       hosts:
+
     external_identity:
       hosts:
+
     external:
       children:
         external_activemq:
         external_elasticsearch:
         external_identity:
         other_repo_clients:
-    trusted_resource_consumers:
-      children:
-        repository:
-        nginx:
-        adw:
-        other_repo_clients:
diff --git a/inventory_ssh.yml b/inventory_ssh.yml
@@ -16,61 +16,79 @@ all:
       hosts:
         database_1:
           ansible_host: targetIP
+
     repository:
       hosts:
         repository_1:
           ansible_host: targetIP
+
     activemq:
       hosts:
         activemq_1:
           ansible_host: targetIP
+
+    # Solr search engine (alternative to Enterprise Search)
     search:
       hosts:
-        search_1:
-          ansible_host: targetIP
-    # Enterprise Search section start
-    # alternative to `search` group
+
+    # Enterprise Search (default search engine)
     search_enterprise:
       hosts:
+        search_1:
+          ansible_host: targetIP
     elasticsearch:
       hosts:
-    # Enterprise Search section end
+        search_1:
+            ansible_host: targetIP
+
+    # Keycloak SSO support (optional)
     identity:
       hosts:
+
     nginx:
       hosts:
         nginx_1:
           ansible_host: targetIP
+
     acc:
       hosts:
         acc_1:
           ansible_host: targetIP
+
     adw:
       hosts:
         adw_1:
           ansible_host: targetIP
+
     transformers:
       hosts:
         transformers_1:
           ansible_host: targetIP
+
     syncservice:
       hosts:
         syncservice_1:
           ansible_host: targetIP
+
     other_repo_clients:
       hosts:
+
     trusted_resource_consumers:
       children:
         repository:
         nginx:
         adw:
         other_repo_clients:
+
     external_activemq:
       hosts:
+
     external_elasticsearch:
       hosts:
+
     external_identity:
       hosts:
+
     external:
       children:
         external_activemq:

diff --git a/molecule/default/verify.yml b/molecule/default/verify.yml
@@ -30,19 +30,24 @@
             replace: "https://{{ node_hostname }}"
 
         - name: Run pytest
-          vars:
-              selfsigned_cert_path: "{{ project_dir }}/configuration_files/ssl_certificates/{{ node_hostname }}.crt"
+          environment:
+            REQUESTS_CA_BUNDLE: "{{ project_dir }}/configuration_files/ssl_certificates/{{ node_hostname }}.crt"
           ansible.builtin.shell:
             chdir: "{{ dtas_dir }}"
             cmd: |
-              export REQUESTS_CA_BUNDLE={{ selfsigned_cert_path }}
               pytest --tb=line --color=no --configuration {{ test_config_file }} tests/ -s
       rescue:
         - name: Print multiline pytest stdout as best as we can
           debug:
             msg: "{{ ansible_failed_result.stdout_lines }}"
-        - name: Explicit failure after printing failure debug
-          fail: msg="Aborting due to pytest failure"
+        - name: Run pytest AGAIN only for failed tests
+          environment:
+            REQUESTS_CA_BUNDLE: "{{ project_dir }}/configuration_files/ssl_certificates/{{ node_hostname }}.crt"
+          ansible.builtin.shell:
+            chdir: "{{ dtas_dir }}"
+            cmd: |
+              pytest --tb=line --color=no --configuration {{ test_config_file }} tests/ -s --last-failed
+
 
 - name: Verify adw plugins state
   hosts: adw

diff --git a/molecule/elasticsearch/converge.yml b/molecule/elasticsearch/converge.yml
diff --git a/...search-enteprise-integration-instance.yml → ...cule/elasticsearch/host_vars/instance.yml b/...search-enteprise-integration-instance.yml → ...cule/elasticsearch/host_vars/instance.yml