Setting Up a Cluster During OpenSearch Installation

The setup script prompts you to enter a name for the OpenSearch cluster.

If you are performing a manual installation of OpenSearch, you need to enter a value for the cluster.name parameter in the opensearch.yml file.

A cluster is identified by a unique name. This name is important because a node can only be part of a cluster if the node is set up to join the cluster by its name. Make sure that you don’t reuse the same cluster names in different environments, otherwise you might end up with nodes joining the wrong cluster. For instance you could use logging-dev, logging-stage, and logging-prod for the development, staging, and production clusters.

Oracle PeopleSoft recommends a cluster with three nodes for high availability and to prevent a split-brain scenario. Then, depending on the hardware, memory availability, and search performance, you may add nodes to the existing cluster.

It is recommended to avoid having only two master-eligible nodes, since a quorum of two is two. Therefore, a loss of either master-eligible node will result in an inoperable cluster. To prevent the split-brain scenario, PeopleSoft recommends an odd number of nodes in the cluster, so configure the majority of nodes (total number of master-eligible nodes/ 2 + 1).

The setup script prompts you to enter host names of nodes present in the cluster.

If you are performing a manual installation of OpenSearch, you need to enter a value for the discovery.seed_hosts parameter in the opensearch.yml file.

A node name is a symbolic name for identifying the node. Host name is the IP or DNS of the machine where the search engine is installed. Host names(or IP/DNS) are required for letting each search engine server know where it can ping and find other search engine servers during booting up.

Enter the host name for any nodes that are already members of a cluster. Enclose one or more host names in square brackets, with the host name or IP address in double quotes.

For example:

• For one host, you would enter: ["host1.example.com"]

• To list two or more hosts, use commas: ["host1.example.com", "192.0.2.1"]

This section provides the high-level steps to set up a cluster when you are installing OpenSearch. For detailed instructions on steps 1 and 2, you may use the PeopleSoft Deployment Packages Installation for Search Components for the current release.

1. Obtain the OpenSearch DPK for your operating system.

2. Run the script to install OpenSearch. The script creates a cluster with one or multiple nodes, which you need to specify.

   While installing OpenSearch ensure that you provide values for the three configuration parameters that are essential to set up a cluster, which are discussed in an earlier section.

   • Cluster name.

   • List of host names where OpenSearch is installed.

3. Verify the cluster setup by executing the following command in a browser:

   http(s)://host:port/_cluster/stats?

   Where, host refers to the OpenSearch host.

   Enter the OpenSearch user credentials (osadmin) when prompted for login information.

   The cluster and node information can be found in the nodes/count/total section of the response.

   Other methods to verify the cluster and node setup, which involves using the PeopleSoft Search Framework and PeopleSoft Health Center, are discussed in a later section of this topic. See Verifying the Cluster and its Nodes.

To complete the search functionality setup, you will need to follow the post-installation instructions in the PeopleSoft Deployment Packages Installation for Search Components for the current release.

Also, refer to Understanding PeopleSoft Search Framework Administration.