Installing OpenSearch and OpenSearch Dashboards on Microsoft Windows in Silent Mode

Encrypting the OpenSearch Passwords on Microsoft Windows

You can use the setup script to install OpenSearch and OpenSearch Dashboards in silent mode by preparing a text file that includes installation details.

The passwords that you include in the silent mode text file must be encrypted. For the OpenSearch installation, encrypt the OpenSearch administrative user and proxy user passwords using the PSCipher utility. You must use the pscipher.jar and psvault files that are part of the OSK DPK. The psvault that is delivered with PeopleSoft PeopleTools will not work for OpenSearch.

  1. Go to OSK_INSTALL.

  2. Extract the entire contents of OSK_FILENAME.zip in the same directory, OSK_INSTALL. 

    unzip OSK_FILENAME.zip

    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 in OSK_INSTALL:

    • setup directory — includes the setup script and sample configuration file

    • archives directory — includes archives for deployment

    • readme.txt file and other files

    • opensearch-manifest — lists the version information for OpenSearch and JDK included in the DPK

  3. Go to OSK_INSTALL\archives and extract pt-jdk21.0.yy.tgz into a temporary folder, or a folder with a different name.

    It may be necessary to extract the file twice. The sample uses pt-jdk-temp as the directory name

  4. Go to OSK_INSTALL\archives and extract pt-opensearch-3.2.0.tgz into a temporary folder, or a folder with a different name.

    It may be necessary to extract the file twice. The sample uses pt-opensearch-temp as the directory name. The extraction creates the following folders:

    • bin

    • config

    • lib

    • logs

    • modules

    • plugins

  5. Copy psvault from the folder OSK_INSTALL\pt-opensearch-temp\plugins\orcl-security-plugin\config\properties to OSK_INSTALL\pt-opensearch-temp\plugins\orcl-security-plugin.

  6. In a command prompt, run the following command, specifying the passwords for the OpenSearch administrative user and proxy user.

    <path_to_java>\java -Dpscipher.path=<path_to_which_files_are_extracted> -cp <path_to_which_files_are_extracted>\pscipher.jar com.peoplesoft.pt.opensearch.pscipher.PSESEncrypt <admin_user> <password> <proxy_user> <password> <output_path>\<outputfile>

    For example uses the default OpenSearch administrative user, osadmin, and proxy user, people.

    C:\OSK_INSTALL\archives\pt-jdk-temp\bin\java -Dpscipher.path=C:\OSK_INSTALL\archives\pt-opensearch-temp\plugins\orcl-security-plugin -cp C:\OSK_INSTALL\archives\pt-opensearch-temp\plugins\orcl-security-plugin\pscipher.jar com.peoplesoft.pt.opensearch.pscipher.PSESEncrypt osadmin password1 people password2 C:\OSK_INSTALL\os_output.txt

  7. Copy the encrypted text from os_output.txt, without adding line feeds or spaces. Paste the encrypted passwords into the silentinstall.config file for the osadmin.password and people.password parameters.

    The output has this format:

    osadmin:{V2.1}encrypted password==
people:{V2.1}encrypted password==

Creating a Configuration File and Running the Silent Mode Installation on Microsoft Windows

To install in silent mode:

  1. Create a configuration file.

    The OSK_INSTALL/setup directory includes a sample configuration file, silentinstall.config. If you want to use this file, it is a good idea to make a backup copy of the original file before you continue.

    Edit the configuration file with the required values. See the section Installing OpenSearch and OpenSearch Dashboards on Microsoft Windows Interactively for guidance on specifying the values.

  2. Enter y (yes) if you want to install OpenSearch, or n (no) if you want to skip the OpenSearch installation.

    You must enter a value for this field. If you enter yes, you must specify values for the items labelled mandatory. If you enter no, you can leave them blank. Enter encrypted text for the passwords as described in the previous section.

    #Silent Install Configuration Values for installing opensearch and opensearch-dashboards

#Install opensearch Y/N is mandatory field
Install opensearch?[Y/N]= 

#Opensearch cluster name (mandatory)
cluster.name= OSCLUSTER

#Opensearch host name (mandatory)
network.host=

#Opensearch port number (optional-default 9200)
#If its upgrade from ES to Opensarch and if you want to use the 
same port number as ES. Please make sure ES is down else 
please enter a different port number for OS.

http.port=

#Opensearch data directory (optional-default OS_HOME/data)
#If its upgrade from ES to Opensarch and if you want to use the 
same data path as ES. Please make sure ES is down else please 
enter a different data path for OS.
path.data= 

#Opensearch log directory (optional-default OS_HOME/logs)
path.logs= 

#Opensearch discovery hosts (optional)
discovery.hosts= 

#Master eligible nodes (optional)
master_eligible.hosts=

#Opensearch heap size (optional-default 2)
OS_HEAP_SIZE= 

#Opensearch admin username (optional - default osadmin)
admin.user= 

#Opensearch encrypted password for osadmin (mandatory)
admin.password=encrypted password

#Opensearch proxy username (optional - default people)
people.user= 

#Opensearch encrypted password for people (mandatory)
people.password=encrypted password

  3. Specify N to skip the Logstash installation.

    When you enter no, you can leave the other parameters in the Logstash section blank. 

    Install Logstash?[Y/N]=N

    #Install Logstash Y/N is mandatory field
Install Logstash?[Y/N]=

#Logstash port number (optional-default 9800)
LS_port= 

#Logstash host name (mandatory)
LS_host = 

#The Opensearch username (mandatory)
OS_user = 

#The encrypted Opensearch password [encrypted using PSLSCipher.bat/PSLSCipher.sh] (mandatory)
OS_pwd = 

#Configure Logstash Y/N (for PeopleSoft Health Centre) is mandatory field 
Configure Logstash(for PHC)?[Y/N]= 

#IB REST service URL (mandatory)
IB_REST_URL= 

#Enter the encrypted IB user [encrypted using PSLSCipher.bat/PSLSCipher.sh] (mandatory)
IB_USER= 

#Enter the encrypted IB password [encrypted using PSLSCipher.bat/PSLSCipher.sh](mandatory) 
IB_PWD=

#location where JSON files need to be created(optional-default LS_HOME/pt/jmxmonitor)
JSON_LOC= 

#The polling frequency for JMX metrics (mandatory)
polling_freq = 

#The number of threads (mandatory)
no_of_threads =

#The Opensearch host name (mandatory)
OS_host =

#The Opensearch port (mandatory)
OS_port = 

#Do you want to create JSON files(Y/N) (mandatory)
JSON_files?[Y/N] =

#To fetch the alert configuration, alerts must be configured in 
Peopletools>Health Centre>Alert Configuration. Do you want to 
fetch the alert configuration parameters?(Y/N) (mandatory)
alert_conf?[Y/N] =

  4. Specify y if you want to install OpenSearch Dashboards, or n if you do not.

    You must enter a value for this field. If you enter yes, you must specify values for the items labelled mandatory in this section. If you enter no, you can leave them blank. 

    #Install Opensearch-dashboards Y/N is mandatory field
Install opensearch-dashboards?[Y/N]= y

#Opensearch-dashboards host name (mandatory)
opensearch-dashboards.host= 

#Opensearch-dashboards port number (optional-default 5601)
opensearch-dashboards.port=

  5. If you want to install OpenSearch Dashboards and connect to the currently-installed OpenSearch server, specify y (yes) for the following.

    If you want to install OpenSearch Dashboards and connect to a previously-installed OpenSearch server, specify n (no). 

    #Set the value to Y if Install Opensearch(Y) and Install Opensearch-dashboards(Y)
Use same OS?[Y/N]= n

  6. Specify the host name, port, OpenSearch administrative user, and encrypted password for the OpenSearch server.

    #Provide the Opensearch instance details mapped to Opensearch-dashboards
OS.host[http(s)://hostname]= 
OS.user= 
OS.port= 
OS.password=

  7. If the OpenSearch is SSL enabled, enter the path to the certificate.

    #Provide SSL certificate path if Opensearch is SSL enabled.
OS.cacert.path=
  8. If OpenSearch is SSL enabled, provide SSL values for OpenSearch Dashboards.
    #Provide SSL required values for OSD if Opensearch is SSL enabled.
#Provide the absolute signed certificate path (Ex: /dir1/pt/osd_home/config/****.cer)
OSD.cert.path=
#Provide the absolute key file path(Ex: /dir1/pt/osd_home/config/****.key)
OSD.cert.key=
#Provide the absolute pem file path(Ex: /dir1/pt/osd_home/config/****.pem)
OSD.cert.pem=
  9. If you want to install Data Prepper, enter Y, and provide the full path to the configuration file.

    The installation is optional, and the default is n. 

    #Install data-prepper Y/N is optional field ( N - by default)

Install data-prepper?[Y/N]= 
#Provide the configuration files path for data-prepper
dp_config_path=
  10. If you want to install Fluent Bit, enter Y, and provide the full path to the configuration file.

    The installation is optional, and the default is n. 

    #Install fluent-bit Y/N is optional field (N - by default)

Install fluent-bit?[Y/N]= 
#Provide the configuration files path for fluent-bit
fb_config_path=

  11. In a command prompt window, run the DPK setup script from OSK_INSTALL\setup as follows:

    Note:

    The command here includes line feeds for readability. Do not include the line feeds when you run.

    psft-dpk-setup.bat –-install_silent 
--install_base_dir BASE_DIR
--config_file full_path_configuration_file

    • Use double-dashes when specifying the script options; for example, --install_silent.

    • For the install_base_dir option, specify the full path where you want OpenSearch installed. The installation directory is referred to in this documentation as BASE_DIR.

    • For the config option, specify the full path to the prepared configuration file. For example:

      Note:

      The command includes line feeds for readability. Do not include the line feeds when you run.

      psft-dpk-setup.bat –-install_silent 
--install_base_dir C:/opensearch
--config C:/tmp_install/silentinstall.config

  12. When the script completes, you see a message such as: 

    Opensearch Installation Completed.
Silent mode installation of opensearch-dashboards

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

    See "Integrating OpenSearch with the PeopleSoft Environment."

  14. To start and use OpenSearch Dashboards, see the Search Technology product documentation.

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