search string side menu

Install full-text search services

The BRIX Full-Text Search solution allows you to configure integration for data transfer between BRIX and the OpenSearch service using the services included in the solution.

 

To ensure the solution is operational, install the OpenSearch service, then install the fulltextsearcher and textextractor solution services.

начало внимание

The customer independently performs server and network infrastructure administration for the BRIX Full-Text Search solution.

конец внимание

 

Install the OpenSearch service

 

Use a separate virtual machine to install the OpenSearch service. Follow these steps:

  1. Install Docker.
  2. Install Docker Compose and the OpenSearch services using your preferred method:

 

  • Follow the instructions on the official Docker Compose and Opensearch websites.
  • Create and run the docker-compose-opensearch.yml file with the script below.

 

Script for the docker-compose-opensearch.yml file

 
Create a file with the following contents:

#version: '3.1'
services:
  postgres:
    image: dreg.elewise.com:5005/docker/databases/postgres:11.22-alpine3.19
    restart: always
    ports:
      - "5432:5432"
    environment:
      POSTGRES_PASSWORD: postgres
      POSTGRES_USER: postgres
      POSTGRES_DB: test
 
  redis:
    image: dreg.elewise.com:5005/docker/databases/redis:7.4.0-alpine3.20
    ports:
      - "6379:6379"
 
  rabbitmq:
    image: dreg.elewise.com:5005/docker/databases/rabbitmq:3.10.25-management-alpine
    ports:
    - 5672:5672
    - 15672:15672
    networks:
      - opensearch-net
 
  opensearch-node:
    image: dreg.elewise.com:5005/docker/opensearch/opensearch:2.18.0
    container_name: opensearch-node
    environment:
      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=123456ASdlkjqweq
      - discovery.type=single-node
      - bootstrap.memory_lock=true # along with the memlock settings below, disables swapping
      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" # minimum and maximum Java heap size, 
recommend setting both to 50% of system RAM
        # - plugins.security.disabled=true
      - plugins.security.ssl.http.enabled=false
    ulimits:
      memlock:
        soft: -1
        hard: -1
      nofile:
        soft: 65536 # maximum number of open files for the OpenSearch user, set to at
least 65536 on modern systems
        hard: 65536
    ports:
      - 9200:9200
      - 9600:9600 # required for Performance Analyzer
    networks:
      - opensearch-net
 
  opensearch-dashboards:
    image: dreg.elewise.com:5005/docker/opensearch/opensearchdashboards:2.18.0 # Make sure the
version of opensearch-dashboards matches the version of opensearch installed on other nodes
    container_name: opensearch-dashboards
    ports:
      - 5601:5601 # Map host port 5601 to container port 5601
    expose:
      - "5601" # Expose port 5601 for web access to OpenSearch Dashboards
    environment:
      OPENSEARCH_HOSTS: '["https://opensearch-node:9200","http://opensearch-node:9200"]' 
# Define the OpenSearch nodes that OpenSearch Dashboards will query
    networks:
      - opensearch-net
 
networks:
  opensearch-net:

 

  1. The OpenSearch control panel will be accessible at http://service_ip_address:5601. To log in, use the admin username and the password you specified in the docker-compose.yml file:

environment:
      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=password

  1. Run the OpenSearch service using the following command:

compose up -d 

Please note that ports 9200 and 5601 must be open for the OpenSearch service and control panel to function.

Full-text search limits and performance are limited by the capabilities of the client-side server hardware.

 

Install the solution’s services for integration with OpenSearch

 

To transfer data between BRIX and the OpenSearch service, install the textextractor and fulltextsearcher services:

 

  1. Download the Helm charts for installing the services. They are available at the following links:

 

 

  1. Install the textextractor service via the appropriate Helm chart by running the command:

helm install textextractor ./.helm -n default

  1. Install the fulltextsearcher service via the appropriate Helm chart by running the command:

helm upgrade --install fulltextsearcher ./.helm -n default

  1. Configure the fulltextsearcher service for operation. To do this:
  1. In the fulltextsearcher service settings, specify the IP address of the server where the textextractor service is installed. You can find the IP address by running the command:

kubectl get po -o wide | grep textextractor

  1. Add the above IP address and 8080 port to the fulltextsearcher service configuration file:

.helm/templates/configmap.yaml
ELMA365_ITEMS_TRANSFER_TEXT_EXTRACTOR_URL: "http://10.244.0.227:8080"

  1. In the .helm/values.yaml file, in the opensearch: block, specify the following values:

opensearch:
  addresses: "http://XXX.XXX.XX.XX:XXXX" # add the Opensearch address from the first step 
  login: "admin"
  password: "password"
  textExtractorURL: "http://10.244.0.227:8080"

  1. Complete the installation of the fulltextsearcher service by running the command:

helm upgrade --install fulltextsearcher ./.helm -n default

full-text-search.html full-text-search-licenses.html