2.7 Setting Up an OpenSearch ML Node

OpenSearch semantic search uses large amounts of resources and very high CPU. It is recommended to isolate the machine learning (ML) processing associated with the semantic search on a dedicated ML node so that regular search operations on the data node are not impacted.

To set up a dedicated ML node, use the --ml option with one of the installation commands. The --ml option can be combined with any of the following installation command options:

  • --install_silent
  • --install_silent_secure
  • --install_secure
  • --install

Example for Linux:

./psft-dpk-setup.sh --install --install_base_dir <BASE_DIR> --ml

Example for Microsoft Windows:

psft-dpk-setup.bat --install --install_base_dir <BASE_DIR> --ml

For silent mode installations, use the applicable silent installation command and configuration file.

For example:

psft-dpk-setup.bat --install_silent_secure --install_base_dir E:\SF --ml --config E:\SysAdmin\SFRelated\SSL\silentinstall.config

Setting Up a Dedicated ML Node in an Existing Cluster

You can add a dedicated ML node as a fourth node in an existing three-node OpenSearch cluster. This example uses the host names host1, host2, host3, and host4, where host4 is the dedicated ML node.

To set up a dedicated ML node in a cluster:

  1. Stop the existing three-node OpenSearch cluster.
  2. On each of the three existing nodes, edit the opensearch.yml file to add the fourth node to the discovery.seed_hosts list. Include all four nodes in the list, as shown in this example:
    discovery.seed_hosts: ["host1", "host2", "host3", "host4"]
  3. On each of the three existing nodes, remove the ml role from the node.roles setting. For example:
    node.roles: ["cluster_manager", "data", "ingest"]
  4. Start the existing three-node cluster.
  5. On the fourth (ML) node, run the OSK DPK setup script with the --ml option. On Linux, run the following command from OSK_INSTALL/setup:
    ./psft-dpk-setup.sh --install --install_base_dir <BASE_DIR> --ml
  6. When prompted to install OpenSearch, answer y (yes).
    Do you want to install OpenSearch (y/n): y
  7. Enter the same OpenSearch cluster name used by the existing three nodes. At the discovery hosts prompt, enter the host names or IP addresses of all four nodes:
    Enter the list of discovery hosts [ ["127.0.0.1", "[::1]"] ] :
    
    ["host1", "host2", "host3", "host4"]
    
  8. Continue with the remaining installation prompts.
  9. After installation, the fourth node has only the ml role and joins the existing OpenSearch cluster.
  10. Verify that the dedicated ML node has joined the cluster by using the /_cat/nodes API. The following sample output shows three nodes with cluster_manager, data, and ingest roles and one node with only the ml role:

See PeopleTools Search Technology, "Working with PeopleSoft Search," Working with Semantic Search.