Installing Logstash on Linux in Silent Mode

Encrypting the Logstash Passwords on Linux

The passwords that you include in the silent mode text file must be encrypted. For the Integration Broker password for the Logstash installation, encrypt the password using the PSLSCipher script that is part of the OSK DPK.

  1. Open a terminal window, and change directory 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. Change directory to OSK_INSTALL/archives and extract pt-jdk21.0.yy.tgz into a directory with the same name.

    It may be necessary to extract the file twice.

  4. Change directory to OSK_INSTALL/archives and extract pt-logstash-9.1.3.tgz into a directory with the same name.

    It may be necessary to extract the file twice. The extraction creates several directories and text files.

  5. Set the following environment variables.

    Add JAVA_HOME to the PATH. Use the location where you extracted pt-jdk21.0.yy.tgz. Set LOGSTASH_HOME to the location where you extracted pt-logstash-9.1.3.tgz. 

    export PATH=JAVA_HOME/Bin;$PATH
export LOGSTASH_HOME=OSK_INSTALL/archives/pt-logstash-9.1.3

  6. Change directory to OSK_INSTALL/pt-logstash-9.1.3/pt/bin.

  7. Run the script, supplying the password:

    ./PSLSCipher.sh password

  8. Copy the encrypted password from the output on the screen, without adding line feeds or spaces, and paste it into the silentinstall.config file for the IB_PWD parameter.

    The output has this format:

    Encrypted text: {V2.1}encrypted password==

The OSK DPK installation includes a psvault key file, which is found in the directory LOGSTASH_HOME/pt/properties. The key in this psvault is not related to the keys available in OpenSearch or the PeopleSoft Web server (PIA) psvault. It is recommended that appropriate access be used to protect the Logstash psvault, as with other similar files.

To generate and use a new version of psvault:

  1. Change directory to OSK_INSTALL/pt-logstash-9.1.3/pt/bin.

  2. Run the script as follows to build a new key:

    ./PSLSCipher.sh -buildkey

  3. Regenerate the Integration Broker user ID and password, and the OpenSearch password with one of these commands:

    ./PSLSCipher.sh password

    Or

    ./PSLSCipher.sh user ID

  4. Edit the Logstash configuration files in the directory LOGSTASH_HOME\pt\config with the new encrypted text.

    • Update the values for the Integration Broker user ID and password in JsonLogstash.properties.

    • Update the values for the OpenSearch password in LogstashPipeLine.CONF.

See Reviewing the Logstash Configuration Files (Optional).

See PeopleTools: Security Administration, "Securing the External Key File."

Creating a Configuration File and Running the Silent Mode Installation on Linux

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 Interactively for guidance on specifying the values.

  2. Enter N (no) to skip the OpenSearch installation.

    You must enter a value for this field. You can leave the other fields in the OpenSearch section blank. This sample does not show all of the fields.

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

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

  3. Specify y (yes) to install Logstash.

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

    To install and configure Logstash for PeopleSoft Health Center, enter y for the field Install Logstash? and for the Configure Logstash(for PHC)? field. 

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

#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] = 

#Configure Logstash Y/N (for PeopleSoft Process Scheduler Metric) is mandatory field 
Configure Logstash(for Process Scheduler Metric)?[Y/N] = 

#IB REST service URL for Process Scheduler Metric (mandatory)
IB_REST_PRCS_URL= 

#Enter the encrypted IB user for Process Scheduler Metric [encrypted using PSLSCipher.bat/PSLSCipher.sh] (mandatory)
IB_USER_PRCS= 

#Enter the encrypted IB password for Process Scheduler Metric [encrypted using PSLSCipher.bat/PSLSCipher.sh](mandatory) 
IB_PWD_PRCS= 

#The Opensearch host name (mandatory)
OS_host = 

#The Opensearch port (mandatory)
OS_port =

  4. Specify n (no) to skip the OpenSearch Dashboards installation.

    You must enter a value for this field. You can leave the other fields in the OpenSearch Dashboards section blank. This sample does not show all of the fields.

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

  5. 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.sh –-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_path 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 feed when you run.

      ./psft-dpk-setup.sh –-install_silent 
--install_base_dir /home/opensearch 
--config_file /home/tmp_install/silentinstall.config

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

    Logstash Installation Completed.

  7. To use Logstash, see the Performance Monitor product documentation.

    Note:

    The OSK DPK installation creates JSON files if the required conditions are met.

    See PeopleTools: Performance Monitor, "Configuring PeopleSoft Health Center."

  8. To use OpenSearch, OpenSearch Dashboards, and Logstash for external data integration, see the Search Technology product documentation.

    See PeopleTools: Search Technology, "Integrating External Data with PeopleSoft."