Installing OpenSearch and OpenSearch Dashboards on Microsoft Windows Interactively

Use this procedure on physical or virtual Microsoft Windows hosts. Ensure that This procedure assumes that there is enough space on the host for the OpenSearch and OpenSearch Dashboards installation and your estimated indexing requirements.

Make a note of the values you supply for ports, passwords, and so on. When you configure the OpenSearch instance for PeopleSoft, the values must match those specified here.

Download the required OSK DPK for Microsoft Windows, OSK_FILENAME.zip, and save it in a newly created directory accessible to the Microsoft Windows host, referred to as OSK_INSTALL.
Go to OSK_INSTALL.
Extract the entire contents of OSK_FILENAME.zip in the same directory, OSK_INSTALL.

Note:

It is a good idea to extract into the same directory where you downloaded the zip files, and to extract into an empty directory for each new installation.

The extraction creates the following directories and files in OSK_INSTALL:
- setup directory — includes the setup script and a silent installation sample
- archives directory — includes archives for deployment
- readme.txt file
- opensearch–manifest — lists the versions of OpenSearch and JDK
Open a command prompt.
Change directory to OSK_INSTALL/setup.
Run the DPK setup script with these options:
```
psft-dpk-setup.bat --install --install_base_dir BASE_DIR
```
- For the install_base_dir option, specify the full path where you want OpenSearch and OpenSearch Dashboards installed. The installation directory is referred to in this documentation as BASE_DIR; for example:
```
psft-dpk-setup.bat --install --install_base_dir C:\opensearch
```
- Use double-dashes when specifying the script options; for example, --install.

Answer y (yes) to install OpenSearch, or n (no) to exit.

You've chosen to do a fresh installation of OpenSearch, 
Logstash and OpenSearch-dashboards. 
Do you want to install OpenSearch? (y/n): y

If you are using the PeopleTools Middleware DPK with the OSK DPK, verify that you see the progress message:
```
Extracting PTMW DPK
[OK]
```
Enter a name for the OpenSearch administrative user, or press ENTER to accept the default name, osadmin.

The OpenSearch administrative user is used to authenticate requests on OpenSearch.

Note:

The OpenSearch administrative user is not the same as the user who installs the OSK DPK and owns the files.
```
Enter the admin username for OpenSearch [ osadmin ] :
```
Enter the password two times for the OpenSearch administrative user that you specified, at the following prompt.

Note:

The script does not display the password or any masking characters as you type.
```
Enter the password for osadmin.
Re-enter the password for osadmin: 
```
Enter a name for the OpenSearch proxy user, or accept the default, people.

Note that this is not the same user as the PeopleSoft connect ID, which also has people as the default value.
```
Enter the proxy username for OpenSearch [ people ] :
```
Enter the password two times for the OpenSearch proxy user that you specified.
```
Enter the password for people. 
Re-enter the password for people: 
```
Enter the name for the OpenSearch cluster, or accept the default name, OSCLUSTER.
```
Enter the OS cluster name [ OSCLUSTER ] :
```
Enter the OpenSearch HTTP port.

This is the port on which OpenSearch listens for requests. The default is 9200.
```
Enter the HTTP port for OpenSearch [ 9200 ] :
```
Enter the host name for any nodes that are already members of a cluster.
```
Enter the list of discovery hosts [ ["127.0.0.1", "[::1]"] ] :
```
Be sure to use the following syntax:
- Enclose one or more host names in square brackets.
- Enclose the host name or IP address in double quotes (“ “).
- Use commas to list two or more hosts.
- Use this as an example for one host: [“host1.example.com”]
- Use this as an example for more than one host: [“host1.example.com”, “127.0.0.1”]
Enter the list of master-eligible nodes to be added to the OpenSearch cluster.
Press ENTER to accept the list of nodes you entered for the discovery hosts, or enter other eligible hosts.
```
Enter the list of master eligible nodes  [defaulted to discovery hosts]
```
Enter the full path location for the OpenSearch data.

Oracle recommends that you do not use the default location, BASE_DIR\pt\opensearch-3.2.0\data, with PeopleSoft environments. Instead, specify the full path for a data directory that is outside of BASE_DIR\pt\opensearch-3.2.0.
```
Enter the path where you want the OpenSearch data to reside 
[ C:\opensearch\pt\opensearch-3.2.0\data ] :
```

Enter the location for the OpenSearch logs.

The default location is BASE_DIR\pt\opensearch-3.2.0\logs.

Enter the path where you want the OpenSearch logs to be written to 
[ C:\opensearch\pt\opensearch-3.2.0\logs ] :

Enter the heap size in GB.

Enter a number as shown in this example:

See Prerequisites.
```
Enter the Java Heap size for OpenSearch in GB [ 2 ] : 7
```
Enter the list master-eligible nodes to be added to the OpenSearch cluster.
Press ENTER to accept the list of nodes you entered for the discovery hosts, or enter other eligible hosts.
```
Enter the list of master eligible nodes [defaulted to discovery hosts]
```

Review the status messages as the script installs OpenSearch.

Extracting the new OpenSearch Binary.......[OK]
Extracting the new JDK......................[OK]
Setting users/roles in OpenSearch...........[OK]
Configuring OpenSearch......................[OK]
Starting OpenSearch server..................[OK]
Registering and Deploying models............[OK]
Cluster is ready............................[OK]
ml_backup_repo created successfully.........[OK]
Snapshot restore completed successfully.....[OK]
ML Index ready..............................[OK]
All model deployments completed.............[OK]
Opensearch Installation Completed...........[OK]

Answer n (no) to skip the Logstash installation.
```
Do you want to install Logstash: (y/n): n
```
Answer y (yes) to install OpenSearch Dashboards, or n (no) to exit.
```
Do you want to install OpenSearch-dashboards: (y/n): y
```
The script displays the server name and port for the current server.
```
OpenSearch Host: server1.example.com
OpenSearch Port: 9200
```
Answer y (yes) to set up OpenSearch Dashboards to connect to the OpenSearch server you are currently installing, or n (no) to enter information about a different OpenSearch server.
```
Do you want to use the same OpensSearch(as above) 
for OpenSearch-dashboards: (y/n): 
```
Enter the OpenSearch Dashboards port, or accept the default, 5601.
```
Enter the server port for OpenSearch-dashboards [ 5601 ] :
```
If you answered no to the prompt asking whether to use the current OpenSearch server, enter the host name and port for the OpenSearch server to connect to.
```
Enter the Opensearch host[http(s)://hostname]: 

Enter the Opensearch port [ 9200 ] :
```

Wait until the installation is complete.

Checking whether OpenSearch service is running.......
Extracting the new OpenSearch Dashboards Binary........[OK]
Configuring OpenSearch Dashboards......
OpenSearch Dashboards Keystore updated.................[OK]
OpenSearch Dashboards installation is completed.

Answer y (yes) to install Data Prepper, or n (no) to exit.
```
Do you want to install Data-prepper: (y/n): 
```
If you answer yes you see the status message.
```
Extracting the Data-prepper Binary........[OK]
```

Enter the configuration path for Data-prepper.

Enter the config path for data-prepper:
Data-prepper configuration completed.

Answer y (yes) to install Fluent Bit, or n (no) to exit.
```
Do you want to install Fluent-bit: (y/n): 
```
If you answer yes you see the status message.
```
Extracting the Fluent-bit Binary........[OK]
```

Enter the configuration path for Fluent Bit.

Enter the config path for fluent-bit:
Fluent-bit configuration completed.

After you complete the OpenSearch and OpenSearch Dashboards installation, you must configure the integration with the PeopleSoft environment.

See "Integrating OpenSearch with the PeopleSoft Environment."
To start and use OpenSearch Dashboards, see the Search Technology product documentation.

See PeopleTools: Search Technology, "Working with Insights Dashboards for PeopleSoft Application Data."

A successful deployment includes the following:

The OpenSearch home directory is found in BASE_DIR\pt\opensearch-3.2.0.
The OpenSearch data and logs directories are installed to the locations you specified.
The OpenSearch service is installed and running.
The OpenSearch Dashboards home directory is found in BASE_DIR\pt\opensearch-dashboards-3.2.0
Java is installed to BASE_DIR\pt\os_jdk21.0.yy, where yy is the JDK version.
The JAVA_HOME environment variable is set to BASE_DIR\pt\os_jdk21.0.yy.

This environment variable is set at the system level.