[UNOMI-828] Support for OpenSearch persistence

.github/workflows/unomi-ci-build-tests.yml

@@ -20,36 +20,56 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up JDK 17
-      uses: actions/setup-java@v1
+      uses: actions/setup-java@v4
       with:
-        java-version: 17
-        cache: maven
+        distribution: 'temurin'
+        java-version: '17'
+        cache: 'maven'
     - name: Build and Unit tests
       run: mvn -U -ntp -e clean install
 
   integration-tests:
     name: Execute integration tests
+    needs: unit-tests
     runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
+      matrix:
+        include:
+          - search-engine: elasticsearch
+            port: 9400
+          - search-engine: opensearch
+            port: 9401
+      fail-fast: false
     steps:
       - uses: actions/checkout@v4
       - name: Set up JDK 17
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v4
         with:
-          java-version: 17
-          cache: maven
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'maven'
       - name: Integration tests
-        run: mvn -ntp clean install -Pintegration-tests
+        run: |
+          FLAGS="-Pintegration-tests"
+          if [ "${{ matrix.search-engine }}" = "opensearch" ]; then
+            # Trigger OpenSearch profile activation via property; do not pass any -P profile toggles
+            FLAGS="$FLAGS -Duse.opensearch=true"
+          fi
+          mvn -ntp clean install $FLAGS \
+            -Dopensearch.port=${{ matrix.port }} \
+            -Delasticsearch.port=${{ matrix.port }}
       - name: Archive code coverage logs
         uses: actions/upload-artifact@v4
         if: false # UNOMI-746 Reactivate if necessary
         with:
-          name: unomi-code-coverage-jdk17-${{ github.run_number }}
+          name: unomi-code-coverage-jdk17-${{ matrix.search-engine }}-${{ github.run_number }}
           path: itests/target/site/jacoco
       - name: Archive unomi logs
         uses: actions/upload-artifact@v4
         if: failure()
         with:
-          name: unomi-log-jdk17-${{ github.run_number }}
+          name: unomi-log-jdk17-${{ matrix.search-engine }}-${{ github.run_number }}
           path: |
             itests/target/exam/**/data/log
             itests/target/elasticsearch0/data

.gitignore

@@ -1,5 +1,6 @@
 /NOTICE-generated
 .settings
+.vscode
 target
 .classpath
 .project
@@ -16,4 +17,5 @@ rest/.miredot-offline.json
 /extensions/salesforce-connector/test.properties
 **/*.versionsBackup
 itests/src/main
-.mvn/.develocity/develocity-workspace-id
+dependency_tree.txt
+.mvn/.develocity/develocity-workspace-id

docker/README.md

@@ -30,16 +30,16 @@ required Unomi tarball.
 
 ## Launching docker-compose using Maven project
 
-Unomi requires ElasticSearch so it is recommended to run Unomi and ElasticSearch using docker-compose:
+Unomi requires a search engine (ElasticSearch or OpenSearch) so it is recommended to run Unomi and the search engine using docker-compose:
 
 ```
 mvn docker:start
 ```
 
-You will need to wait while Docker builds the containers and they boot up (ES will take a minute or two). Once they are 
+You will need to wait while Docker builds the containers and they boot up (the search engine will take a minute or two). Once they are 
 up you can check that the Unomi services are available by visiting http://localhost:8181 in a web browser.
 
-## Manually launching ElasticSearch & Unomi docker images
+## Manually launching Search Engine & Unomi docker images
 
 If you want to run it without docker-compose you should then make sure you setup the following environments properly.
 
@@ -48,21 +48,66 @@ For ElasticSearch:
     docker pull docker.elastic.co/elasticsearch/elasticsearch:7.4.2
     docker network create unomi
     docker run --name elasticsearch --net unomi -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -e cluster.name=contextElasticSearch docker.elastic.co/elasticsearch/elasticsearch:7.4.2
+
+For OpenSearch:
+
+    docker pull opensearchproject/opensearch:3.0.0
+    docker network create unomi
+    export OPENSEARCH_ADMIN_PASSWORD=enter_your_custom_admin_password_here
+    docker run --name opensearch --net unomi -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -e OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_ADMIN_PASSWORD} opensearchproject/opensearch:3.0.0
 
-For Unomi:
+For Unomi (with ElasticSearch):
+
+    docker pull apache/unomi:3.0.0-SNAPSHOT
+    docker run --name unomi --net unomi -p 8181:8181 -p 9443:9443 -p 8102:8102 \
+        -e UNOMI_ELASTICSEARCH_ADDRESSES=elasticsearch:9200 \
+        apache/unomi:3.0.0-SNAPSHOT
 
-    docker pull apache/unomi:2.0.0-SNAPSHOT
-    docker run --name unomi --net unomi -p 8181:8181 -p 9443:9443 -p 8102:8102 -e UNOMI_ELASTICSEARCH_ADDRESSES=elasticsearch:9200 apache/unomi:2.0.0-SNAPSHOT
+For Unomi (with OpenSearch):
 
-## Using a host OS ElasticSearch installation (only supported on macOS & Windows)
+    docker pull apache/unomi:3.0.0-SNAPSHOT
+    docker run --name unomi --net unomi -p 8181:8181 -p 9443:9443 -p 8102:8102 \
+        -e UNOMI_AUTO_START=opensearch \
+        -e UNOMI_OPENSEARCH_ADDRESSES=opensearch:9200 \
+        -e UNOMI_OPENSEARCH_PASSWORD=${OPENSEARCH_ADMIN_PASSWORD} \
+        apache/unomi:3.0.0-SNAPSHOT
+
+## Using a host OS Search Engine installation (only supported on macOS & Windows)
+
+For ElasticSearch:
 
-    docker run --name unomi -p 8181:8181 -p 9443:9443 -p 8102:8102 -e UNOMI_ELASTICSEARCH_ADDRESSES=host.docker.internal:9200 apache/unomi:2.0.0-SNAPSHOT
+    docker run --name unomi -p 8181:8181 -p 9443:9443 -p 8102:8102 \
+        -e UNOMI_ELASTICSEARCH_ADDRESSES=host.docker.internal:9200 \
+        apache/unomi:3.0.0-SNAPSHOT
+
+For OpenSearch:
+
+    docker run --name unomi -p 8181:8181 -p 9443:9443 -p 8102:8102 \
+        -e UNOMI_AUTO_START=opensearch \
+        -e UNOMI_OPENSEARCH_ADDRESSES=host.docker.internal:9200 \
+        -e UNOMI_OPENSEARCH_PASSWORD=${OPENSEARCH_ADMIN_PASSWORD} \
+        apache/unomi:3.0.0-SNAPSHOT
 
 Note: Linux doesn't support the host.docker.internal DNS lookup method yet, it should be available in an upcoming version of Docker. See https://github.com/docker/for-linux/issues/264
 
+## Environment Variables
+
+### Common Variables
+- `UNOMI_AUTO_START`: Specifies the search engine type (`elasticsearch` or `opensearch`, defaults to `elasticsearch`)
+
+### ElasticSearch-specific Variables
+- `UNOMI_ELASTICSEARCH_ADDRESSES`: ElasticSearch host:port (default: localhost:9200)
+- `UNOMI_ELASTICSEARCH_USERNAME`: Optional username for ElasticSearch
+- `UNOMI_ELASTICSEARCH_PASSWORD`: Optional password for ElasticSearch
+- `UNOMI_ELASTICSEARCH_SSL_ENABLE`: Enable SSL for ElasticSearch connection (default: false)
+
+### OpenSearch-specific Variables
+- `UNOMI_OPENSEARCH_ADDRESSES`: OpenSearch host:port (default: localhost:9200)
+- `UNOMI_OPENSEARCH_PASSWORD`: Required admin password for OpenSearch (SSL and authentication are mandatory)
+
 # Using docker build tools
 
 If you want to rebuild the images or use docker compose directly, you must still first use `mvn clean install` to generate
 the filtered project in `target/filtered-docker`.
 
-You can then use `docker-compose up` to start the project
+You can then use `docker compose -f docker-compose-es.yml up` to start the project with ElasticSearch or `docker compose -f docker-compose-os.yml up` to start the project with OpenSearch.

docker/pom.xml

@@ -94,17 +94,21 @@
                                     <directory>${project.basedir}/src/main/docker</directory>
                                     <filtering>true</filtering>
                                     <includes>
-                                        <include>docker-compose.yml</include>
-                                        <include>docker-compose-build.yml</include>
+                                        <include>docker-compose-es.yml</include>
+                                        <include>docker-compose-build-es.yml</include>
+                                        <include>docker-compose-os.yml</include>
+                                        <include>docker-compose-build-os.yml</include>
                                     </includes>
                                 </resource>
                                 <!-- # Unfiltered Resources -->
                                 <resource>
                                     <directory>${project.basedir}/src/main/docker</directory>
                                     <filtering>false</filtering>
                                     <excludes>
-                                        <exclude>docker-compose.yml</exclude>
-                                        <include>docker-compose-build.yml</include>
+                                        <exclude>docker-compose-es.yml</exclude>
+                                        <exclude>docker-compose-build-es.yml</exclude>
+                                        <exclude>docker-compose-os.yml</exclude>
+                                        <exclude>docker-compose-build-os.yml</exclude>
                                     </excludes>
                                 </resource>
                             </resources>
@@ -133,7 +137,7 @@
                             <external>
                                 <type>compose</type>
                                 <basedir>${project.build.directory}/filtered-docker</basedir>
-                                <composeFile>${project.build.directory}/filtered-docker/docker-compose-build.yml</composeFile>
+                                <composeFile>${project.build.directory}/filtered-docker/docker-compose-build-es.yml</composeFile>
                             </external>
                         </image>
                     </images>
@@ -161,10 +165,17 @@
                             <artifacts>
                                 <artifact>
                                     <file>
-                                        ${project.build.directory}/filtered-docker/docker-compose.yml
+                                        ${project.build.directory}/filtered-docker/docker-compose-es.yml
                                     </file>
                                     <type>yml</type>
-                                    <classifier>docker-compose</classifier>
+                                    <classifier>docker-compose-es</classifier>
+                                </artifact>
+                                <artifact>
+                                    <file>
+                                        ${project.build.directory}/filtered-docker/docker-compose-os.yml
+                                    </file>
+                                    <type>yml</type>
+                                    <classifier>docker-compose-os</classifier>
                                 </artifact>
                             </artifacts>
                         </configuration>

docker/src/main/docker/Dockerfile

@@ -20,8 +20,16 @@ FROM library/eclipse-temurin:17
 # Unomi environment variables
 ENV UNOMI_HOME=/opt/apache-unomi
 ENV PATH=$PATH:$UNOMI_HOME/bin
-ENV KARAF_OPTS="-Dunomi.autoStart=true"
+
+ENV UNOMI_AUTO_START=true
+
+# Debug configuration (disabled by default)
+ENV KARAF_DEBUG=false
+ENV KARAF_DEBUG_PORT=5005
+ENV KARAF_DEBUG_SUSPEND=n
+
 ENV UNOMI_ELASTICSEARCH_ADDRESSES=localhost:9200
+ENV UNOMI_OPENSEARCH_ADDRESSES=localhost:9200
 
 WORKDIR $UNOMI_HOME
 
@@ -34,8 +42,11 @@ RUN mv unomi-*/* . \
 
 COPY entrypoint.sh ./entrypoint.sh
 
+# Expose standard ports
 EXPOSE 9443
 EXPOSE 8181
 EXPOSE 8102
+# Expose debug port
+EXPOSE 5005
 
 CMD ["/bin/bash", "./entrypoint.sh"]

docker/src/main/docker/docker-compose-build.yml → docker/src/main/docker/docker-compose-build-es.yml

@@ -35,7 +35,12 @@ services:
     build: .
     image: apache/unomi:${project.version}
     environment:
+      - UNOMI_AUTO_START=elasticsearch
       - UNOMI_ELASTICSEARCH_ADDRESSES=elasticsearch:9200
+      # Debug settings
+      - KARAF_DEBUG=${DEBUG:-false}
+      - KARAF_DEBUG_PORT=${DEBUG_PORT:-5005}
+      - KARAF_DEBUG_SUSPEND=${DEBUG_SUSPEND:-n}
     ports:
       - 8181:8181
       - 9443:9443

docker/src/main/docker/docker-compose-build-os.yml

@@ -0,0 +1,122 @@
+################################################################################
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+################################################################################
+version: '2.4'
+
+# Define networks first
+networks:
+  unomi-net:
+    driver: bridge
+
+services:
+  opensearch-node1:
+    image: opensearchproject/opensearch:3.0.0
+    container_name: opensearch-node1
+    environment:
+      - cluster.name=opensearch-cluster
+      - node.name=opensearch-node1
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
+      - bootstrap.memory_lock=true
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
+      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_INITIAL_ADMIN_PASSWORD}
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    volumes:
+      - opensearch-data1:/usr/share/opensearch/data
+    ports:
+      - 9200:9200
+      - 9600:9600
+    networks:
+      unomi-net:
+        aliases:
+          - opensearch-node1
+
+  opensearch-node2:
+    image: opensearchproject/opensearch:3.0.0
+    container_name: opensearch-node2
+    environment:
+      - cluster.name=opensearch-cluster
+      - node.name=opensearch-node2
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
+      - bootstrap.memory_lock=true
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
+      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_INITIAL_ADMIN_PASSWORD}
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    volumes:
+      - opensearch-data2:/usr/share/opensearch/data
+    networks:
+      unomi-net:
+        aliases:
+          - opensearch-node2
+
+  opensearch-dashboards:
+    image: opensearchproject/opensearch-dashboards:3.0.0
+    container_name: opensearch-dashboards
+    ports:
+      - 5601:5601
+    environment:
+      OPENSEARCH_HOSTS: '["https://opensearch-node1:9200","https://opensearch-node2:9200"]'
+    networks:
+      unomi-net:
+        aliases:
+          - opensearch-dashboards
+    depends_on:
+      - opensearch-node1
+      - opensearch-node2
+
+  unomi:
+    build: .
+    image: apache/unomi:${project.version}
+    container_name: unomi
+    environment:
+      - UNOMI_AUTO_START=opensearch
+      - UNOMI_OPENSEARCH_ADDRESSES=opensearch-node1:9200
+      - UNOMI_OPENSEARCH_USERNAME=admin
+      - UNOMI_OPENSEARCH_PASSWORD=${OPENSEARCH_INITIAL_ADMIN_PASSWORD}
+      # Debug settings
+      - KARAF_DEBUG=${DEBUG:-false}
+      - KARAF_DEBUG_PORT=${DEBUG_PORT:-5005}
+      - KARAF_DEBUG_SUSPEND=${DEBUG_SUSPEND:-n}
+    ports:
+      - 8181:8181
+      - 9443:9443
+      - 8102:8102
+      # Debug port
+      - "${DEBUG_PORT:-5005}:5005"
+    depends_on:
+      - opensearch-node1
+      - opensearch-node2
+    networks:
+      unomi-net:
+        aliases:
+          - unomi
+
+volumes:
+  opensearch-data1:
+  opensearch-data2: