search string side menu

Install full-text search services in Kubernetes using a Helm package

Installing OpenSearch and the fulltextsearcher and textextractor services in Kubernetes using a Helm package includes the following steps:

  1. Download the Helm chart and configuration file..
  2. Fill in the configuration file..
  3. Install the elma365-dbs chart in the Kubernetes cluster using Helm..
  4. Connect to the OpenSearch service..
  5. Apply full-text search settings for ELMA365 Enterprise..

Step 1. Download the Helm chart and configuration file

To install via the internet, obtain the values-elma365-dbs.yaml configuration file by running::

helm repo add elma365 https://charts.elma365.tech
helm repo update
helm show values elma365/elma365-dbs > values-elma365-dbs.yaml

Obtaining the configuration file for installation in a closed environment without internet access

  1. On a computer with internet access, download the BRIX images and upload them to your local image registry. For details, see Download BRIX images. Then run the following command:

helm repo add elma365 https://charts.elma365.tech
helm repo update
helm pull elma365/elma365-dbs

  1. Copy the downloaded elma365-dbs-X.Y.Z.tgz chart archive to the server where the installation will be performed.
  2. Extract the chart and copy the default configuration file values.yaml в values-elma365-dbs.yaml:

tar -xf elma365-dbs-X.Y.Z.tgz
cp elma365-dbs/values.yaml values-elma365-dbs.yaml

Step 2. Fill in the configuration file

The OpenSearch service can be installed together with the elma365-dbs chart or separately in another namespace. Below is an example of configuring the values-elma365-dbs.yaml file to install OpenSearch:

  1. In the global section, enable OpenSearch for the opensearch component by setting the enabled parameter:

# Select databases to install.
global:
  opensearch:
    # Install opensearch (Enabled for fulltextsearcher)
    enabled: true

  1. If necessary, specify OPENSEARCH_INITIAL_ADMIN_PASSWORD in the OpenSearch configuration and set a password for the admin user:

# Select databases to install.
global:
...
# Opensearch settings (Enabled for fulltextsearcher)
opensearch:
# cluster Mode — disable singleNode
  singleNode: true
  extraEnvs:
    - name: OPENSEARCH_INITIAL_ADMIN_PASSWORD
      value: 123456ASdlkjqweq
    - name: "plugins.security.ssl.http.enabled"
       value: "false"
  config:
    opensearch.yml: |
      network.host: '*'
  persistence:
    enabled: true
    size: 10Gi
  # storageClass: "-"
...

  1. To configure high availability, switch the singleNode parameter:

# Select databases to install.
global:
...
# Opensearch settings (Enabled for fulltextsearcher)
opensearch:
...
  # cluster Mode - disable singleNode
  singleNode: false
...

  1. To install the elma365-dbs chart in a closed environment without internet access, configure the connection parameters for the private registry.

Example of configuring parameters for a private registry connection

  1. Specify the address and path to the private registry in the opensearch.persistence.image parameter for the initialization container.
  2. Specify the address and path to the private registry in the opensearch.image.repository parameter.
  3. Manually create a secret with access credentials for the private registry and encode it in Base64.
  4. Enter the name of the created secret in the opensearch.image.pullSecrets parameter.

 

# Select databases to install
global:
...
# Postgres db settings
opensearch:
...
  # Enable initialization container
  # he container changes the owner and group of the volume mount point to `RunAsUser:fsGroup
  persistence:
    enabled: true
    # address and secret for the private registry of the initialization container image
    image: registry.example.com
...
  # address and secret for the private registry
  image:
    repository: registry.example.com/opensearch
    # secret with credentials for private registry must be created manually and encoded in Base64
    pullSecrets:
      - myRegistryKeySecretName
...

where the format of repository is:

  • address — registry.example.com;
  • path — /opensearch.

Step 3. Install the elma365-dbs chart in the Kubernetes cluster using Helm

Install the elma365-dbs chart in namespace elma365-dbs:

  • For installation via the internet:

helm upgrade --install opensearch elma365/elma365-dbs -f values-elma365-dbs.yaml -n opensearch --create-namespace

  • For installation without internet access, navigate to the directory with the downloaded chart and run:

helm upgrade --install opensearch ./elma365-dbs -f values-elma365-dbs.yaml -n opensearch --create-namespace

Step 4. Connect to the OpenSearch service

  1. Create a backup of the existing values-elma365.yaml configuration file that was obtained and completed during the BRIX installation. This helps prevent service disruption if configuration changes are made incorrectly.
  2. Update the existing values-elma365.yaml configuration file:
  • enable parameters global.extensions.name.fulltextsearcher.enabled and global.extensions.name.textextractor.enabled by setting them to true;
  • configure the OpenSearch connection in the global.extensions.opensearch parameter.

global:
  ...
  extensions:
# enable full-text search using OpenSearch
    - name: fulltextsearcher
      enabled: true
# requires OpenSearch connection settings
      opensearch:
        addresses: "http://opensearch-cluster-master.opensearch.svc.cluster.local:9200/"
        login: "admin"
        password: "123456ASdlkjqweq"
        textExtractorURL: "http://textextractor:3000/"
        itemsTransferPerIteration: 400
        itemsWorkers: 4
        taskWorkers: 1
# enable module for text extraction from office documents
    - name: textextractor
      enabled: true
...

Step 5. Apply full-text search settings

Update the BRIX application settings using the values-elma365.yaml configuration file

To update settings via the internet:

  1. Determine the chart version used to install BRIX by running:

helm show chart elma365/elma365

Example:

full-text-search-in-kubernetes-1

The version field indicates the chart version used to install BRIX.

  1. Run the update command, specifying the installed BRIX chart version::

helm upgrade --install elma365 elma365/elma365 -f values-elma365.yaml --version <elma365-chart-version> --timeout=30m --wait [-n namespace]

Instead of <elma365-chart-version>) for flag –version specify the chart version obtained at the previous step.

Updating parameters without internet access

  1. Go to the catalog with the BRIX chart and run:

helm upgrade --install elma365 ./elma365 -f values-elma365.yaml --timeout=30m --wait [-n namespace]

  1. Parameter update takes from 10 to 30 minutes. Wait for it to be completed.

Remove the OpenSearch chart from the Kubernetes cluster Using Helm

To remove the OpenSearch chart from namespace opensearch, run:

helm uninstall opensearch -n opensearch

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