JS7 - PowerShell Installation Script - Install-JS7Joc.ps1

Name

Install-JS7Joc.ps1

SYNOPSIS

Installs, updates or patches a JS7 JOC Cockpit on Windows and Unix platforms supporting PowerShell 5.1, 6, 7

SYNTAX

Install-JS7Joc.ps1 [[-HomeDir] <String>] [[-Data] <String>] [[-ClusterId] <String>] [[-InstanceId] <Int32>] [[-Release] <String>] [[-Tarball] <String>] [[-Patch] <String>] [[-User] <String>] [[-SetupDir] <String>] [[-ResponseDir] <String>] [[-LicenseKey] <String>] [[-LicenseBin] <String>] [[-BackupDir] <String>] [[-LogDir] <String>] [[-ExecStart] <String>] [[-ExecStop] <String>] [[-ReturnValues] <String>] [[-DeployDir] <String[]>] [[-Ini] <String[]>] [[-Properties] <String>] [[-Title] <String>] [[-SecurityLevel] <String>] [[-DBMSConfig] <String[]>] [[-DBMSDriver] <String[]>] [[-DBMSInit] <String[]>] [[-HttpPort] <String>] [[-HttpsPort] <String>] [[-Keystore] <String>] [[-KeystorePassword] <SecureString>] [[-KeyAlias] <String>] [[-Truststore] <String>] [[-TruststorePassword] <SecureString>] [[-JavaHome] <String>] [[-JavaOptions] <String>] [[-ServiceDir] <String>] [[-ServiceFile] <String>] [[-ServiceName] <String>] [[-ServiceCredentials] <PSCredential>] [[-ServiceStartMode] <String>] [-AsUser] [-PreserveEnv] [-NoInstall] [-NoJetty] [-ShowLogs] [-MakeDirs] [-MakeService] [-Restart] [-Kill] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The JOC Cockpit installation script can be used to automate installing, updating and patching JOC Cockpit.

The script offers the installation options and configuration options available from the JOC Cockpit's graphical installer.

For download see https://kb.sos-berlin.com/display/JS7/JS7+-+Download

PARAMETERS

HomeDir

-HomeDir <String>
Specifies the directory in which the JOC Cockpit should be installed.

Data

-Data <String>
Specifies the directory in which JOC Cockpit data such as configuration files should be stored.
By default the <home>/jetty_base directory is used, see -HomeDir and -Data parameters.

ClusterId

-ClusterId <String>
Specifies the unique identifier of a JOC Cockpit cluster. A number of JOC Cockpit instances can be operated as a cluster using the same Cluster ID.

InstanceId

-InstanceId <Int32>
Specifies a unique number between 0 and 99 that identifies the JOC Cockpit instance.

The ordering of numbers determines appearence of JOC Cockpit instances in the JOC Cockpit dashboard.

Release

-Release <String>
Specifies a release number of the JS7 JOC Cockpit such as 2.3.1 to be used.

The release will be downloaded from the SOS web site if the -Tarball parameter is not used.

Tarball

-Tarball <String>
Optionally specifies the path to a .zip or .tar.gz file that holds the JOC Cockpit installation files.
If this parameter is not used the installer tarball will be downloaded from the SOS web site for the release indicated with the -Release parameter.

Users can check if the connection to a specific URL is bypassed or is using a proxy with a command such as:
([System.Net.WebRequest]::GetSystemWebproxy()).IsBypassed("https://download.sos-berlin.com")

For use with PowerShell 7 users can specify environment variables to perform download using a proxy:

* HTTP_PROXY - proxy for HTTP requests
* HTTPS_PROXY - proxy for HTTPS requests
* ALL_PROXY - proxy for both HTTP and HTTPS
* NO_PROXY - proxy exclusion address list

Patch

-Patch <String>
A patch is identified by an issue key in the Change Management System, for example JS-1984.
Patches are downloaded from the SOS web site if the -Tarball parameter is not used.

Patches are added to the JOC Cockpit's <home>/lib/patches directory. Note that the patches sub-directory will be emptied when updating a Controller installation later on.

If a backup directory is specified then an JOC Cockpit's existing installation directory will be added to the backup file in this directory.

User

-User <String>
Specifies the user account for the JOC Cockpit daemon in Unix environments.
By default the account of the user running the JOC Cockpit Installation Script is used.

For Windows the -User parameter is informative. The -ServiceCredentials parameter can be used to specify credentials for the Windows Service account
that the JOC Cockpit is operated for.

SetupDir

-SetupDir <String>
Specifies the directory to which the JOC Cockpit installation archive (*.tar.gz, *.zip) will be extracted.
Users can specify a directory, otherwise a temporary directory is created if the -MakeDirs switch is present.

ResponseDir

-ResponseDir <String>
Specifies a directory that holds files related to the installation of JOC Cockpit.
The files will be copied to the directory indicated with the -SetupDir parameter.

This option is preferably used if an individual version of the joc_install.xml response file should be applied.
In addition, DBMS JDBC Driver files (*.jar), DBMS Hibernate configuration file and license key file can be used from this directory
if indicated with the joc_install.xml response file.

LicenseKey

-LicenseKey <String>
Specifies the path to a license key file (*.pem, *.crt) for use with a commercial license.
A license key file is required should JS7 cluster operations for JOC Cockpit, Controller or Agents be used.

The license key file activates the licensed binary code that implements cluster operations, see -LicenseBin parameter.

LicenseBin

-LicenseBin <String>
Specifies the path to a license binary file (*.jar) that implements cluster operations.

Use of licensed binary code is activated by a license key file, see -LicenseKey.

BackupDir

-BackupDir <String>
If a backup directory is specified then an JOC Cockpit's existing installation directory will be added to a backup file in this directory.
The backup file type will be .tar.gz for Unix and .zip for Windows.

File names are created according to the pattern: backup_js7_joc.<hostname>.<release>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.zip
For example: backup_js7_joc.centostest_primary.2.3.1.2022-03-19T20-50-45.tar.gz

LogDir

-LogDir <String>
If a log directory is specified then the installation script will log information about processing steps to a log file in this directory.
File names are created according to the pattern: install_js7_joc.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
For example: install_js7_joc.centostest_primary.2022-03-19T20-50-45.log

ExecStart

-ExecStart <String>
This parameter can be used should the JOC Cockpit be started after installation. For example, when using systemd for Unix then the
-ExecStart "StartService" parameter value will start the JOC Cockpit service provided that the related systemd service has been created manually or by use of the -MakeService switch.
When using Windows then the -ExecStart "StartService" parameter value will start the Windows Service.

Alternatively users can specify individual commands, for example -ExecStart "sudo systemctl start js7_joc_joc-1".

For systemd service files see the JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems article.
This parameter is an alternative to the use of the -Restart switch which will start the JOC Cockpit from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

ExecStop

-ExecStop <String>
This parameter can be used should the JOC Cockpit be stopped before installation. For example, when using systemd then
the -ExecStop "StopService" will stop the JOC Cockpit service provided that the related systemd service has been created manually or by use of the -MakeService switch.
When using Windows then the -ExecStop "StopService" parameter value will stop the Windows Service.

Alternatively users can specify individual commands, for example -ExecStop "sudo systemctl stop js7_joc_joc#1".
This parameter is an alternative to the use of the -Restart switch which stops the JOC Cockpit from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

ReturnValues

-ReturnValues <String>
Optionally specifies the path to a file to which return values will be added in the format <name>=<key>. For example:

log_file=install_js7_joc.centostest_primary.2022-03-20T04-54-31.log
backup_file=backup_js7_joc.centostest_primary.2.3.1.2022-03-20T04-54-31.tar.gz

An existing file will be overwritten. It is recommended to use a unique file name such as /tmp/return.$PID.properties.
A value from the file can be retrieved like this:

* Unix
** backup=$(cat /tmp/return.$$.properties | grep "backup_file" | cut -d'=' -f2)
* Windows
** $backup = ( Get-Content /tmp/return.$PID.properties | Select-String "^backup_file[ ]*=[ ]*(.*)" ).Matches.Groups[1].value

DeployDir

-DeployDir <String[]>
Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the <data>/resources/joc folder.
A deployment directory allows to manage central copies of configuration files such as joc.properties, log4j2.xml etc.

Use of a deployment directory has lower precedence as files can be overwritten by individual parameters such as -Properties etc.

Ini

-Ini <String[]>

Properties

-Properties <String>
Specifies the path to a configuration file for global JOC Cockpit configuration items. The file will be copied to the <data>/resources/joc/joc.properties file.

Any path to a file can be used as a value of this parameter, however, the target file name joc.properties will be used.

Title

-Title <String>

SecurityLevel

-SecurityLevel <String>

DBMSConfig

-DBMSConfig <String[]>

DBMSDriver

-DBMSDriver <String[]>

DBMSInit

-DBMSInit <String[]>

HttpPort

-HttpPort <String>
Specifies the HTTP port that the JOC Cockpit is operated for. The default value is 4446.

The port can be prefixed by the network interface, for example joc.example.com:4446.
When used with the -Restart switch the HTTP port is used to identify if the JOC Cockpit is running.

HttpsPort

-HttpsPort <String>
Specifies the HTTPS port that the JOC Cockpit is operated for.

Use of HTTPS requires a keystore and truststore to be present, see -Keystore and -Truststore parameters.
The port can be prefixed by the network interface, for example joc.example.com:4446.

Keystore

-Keystore <String>
Specifies the path to a PKCS12 keystore file that holds the private key and certificate for HTTPS connections to the JOC Cockpit.
Users are free to specify any file name, typically the name https-keystore.p12 is used. The keystore file will be copied to the <data>/resources/joc directory.

If a keystore file is made available then the JOC Cockpit's <data>/resources/joc/joc.properties file has to hold a reference to the keystore location and the keystore password.
It is therefore recommended to use the -PrivateConf parameter to deploy an individual private.conf file that holds settings related to a keystore.
For automating the creation of keystores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.

KeystorePassword

-KeystorePassword <SecureString>
Specifies the password for access to the keystore from a secure string. Use of a keystore password is required.

There are a number of ways how to specify secure strings, for example:

-KeystorePassword ( 'secret' | ConvertTo-SecureString -AsPlainText -Force )

KeyAlias

-KeyAlias <String>
If a keystore holds more than one private key, for example if separate pairs of private keys/certificates for server authentication and client authentication
exist, then it is not determined which private key/certificate will be used. The alias name of a given private key/certificate is specified
when the entry is added to the keystore. The alias name allows to indicate a specific private key/certificate to be used.

Truststore

-Truststore <String>
Specifies the path to a PKCS12 truststore file that holds the certificate(s) for HTTPS connections to the JOC Cockpit using mutual authentication .
Users are free to specify any file name, typically the name https-truststore.p12 is used. The truststore file will be copied to the <data>/resources/joc directory.

If a truststore file is made available then the JOC Cockpit's <data>/resources/joc/joc.properties file has to hold a reference to the truststore location and the truststore password.
It is therefore recommended to use the -PrivateConf parameter to deploy an individual private.conf file that holds settings related to a truststore.
For automating the creation of truststores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.

TruststorePassword

-TruststorePassword <SecureString>
Specifies the password for access to the truststore from a secure string. Use of a password is recommended as it is not primarily intended to protect access to the truststore.
The password is intended to allow verification that truststore entries have been added using the same password.

There are a number of ways how to specify secure strings, for example:

-TruststorePassword ( 'secret' | ConvertTo-SecureString -AsPlainText -Force )

JavaHome

-JavaHome <String>
Specifies the Java home directory that will be made available to the JOC Cockpit from the JAVA_HOME environment variable
specified with the JOC Cockpit profile typically available from the $HOME/.jocrc script.

JavaOptions

-JavaOptions <String>
Specifies the Java options that will be made available to the JOC Cockpit from the JAVA_OPTIONS environment variable specified with the JOC Cockpit profile
typically available from the $HOME/.jocrc script.

Java options can be used for example to specify Java heap space settings for the JOC Cockpit.
If more than one Java option is used then the value has to be quoted, for example -JavaOptions "-Xms256m -Xmx512m".

ServiceDir

-ServiceDir <String>
For Unix environments specifies the systemd service directory to which the JOC Cockpit's service file will be copied if the -MakeService switch is used.
By default the /usr/lib/systemd/system directory will be used. Users can specify an alternative location.

ServiceFile

-ServiceFile <String>
For Unix environments specifies the path to a systemd service file that acts as a template and that will be copied to the JOC Cockpit's <home>/jetty/bin directory.
Users are free to choose any file name as a template for the service file. The resulting service file name will be joc.service.
The installation script will perform replacements in the service file to update paths and the port to be used, for details see ./bin/jetty.service-example.

ServiceName

-ServiceName <String>
For Unix environments specifies the name of the systemd service that will be created if the -MakeService switch is used.
By default the service name js7_joc_<joc-id> will be used.

ServiceCredentials

-ServiceCredentials <PSCredential>
In Windows environments the credentials for the Windows service account can be specified for which the JOC Cockpit should be operated.

A credentials object can be created in a number of ways, for example:

$cred = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList '.\sos', ( 'secret' | ConvertTo-SecureString -AsPlainText -Force) )

The first argument '.\sos' specifies the user account, the second argument 'secret' specifies the password of the Windows Service account.
Consider that the user account is specified from a local account using the .\ prefix or from a domain account using account@domain.

ServiceStartMode

-ServiceStartMode <String>
For Windows environemnts one of the following start modes can be set when used with the -ServiceCredentials parameter:

* System
* Automatic
* Manual
* Disabled

By default automatic start is used.

AsUser

-AsUser <SwitchParameter>

PreserveEnv

-PreserveEnv <SwitchParameter>

NoInstall

-NoInstall <SwitchParameter>

NoJetty

-NoJetty <SwitchParameter>

ShowLogs

-ShowLogs <SwitchParameter>
Displays the log output created by the installation script if the -LogDir parameter is used.

MakeDirs

-MakeDirs <SwitchParameter>
If directories are missing that are indicated with the -HomeDir, -SetupDir, -BackupDir or -LogDir parameters then they will be created.

MakeService

-MakeService <SwitchParameter>
Specifies that for Unix environments a systemd service should be created, for Windows environments a Windows Service should be created.
In Unix environments the service name will be created from the -ServiceName parameter value or from its default value.

Restart

-Restart <SwitchParameter>
Stops a running JOC Cockpit before installation and starts the JOC Cockpit after installation using the JOC Cockpit's Instance Start Script.
This switch can be used with the-Kill switch to control the way how the JOC Cockpit is terminated.
This switch is ignored if the -ExecStart or -ExecStop parameters are used.

Kill

-Kill <SwitchParameter>
Kills a running JOC Cockpit and any running tasks if used with the -Restart switch.
This includes killing child processes of running tasks.

Killing a JOC Cockpit prevents journal files from being closed in an orderly manner.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

EXAMPLES

-------------------------- BEISPIEL 1 --------------------------

PS C:\> Install-JS7Joc.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\joc" -Data "C:\ProgramData\sos-berlin.com\js7\joc" -Release 2.5.1 -HttpPort 4446 -MakeDirs

Downloads and installs the JOC Cockpit release to the indicated location.

-------------------------- BEISPIEL 2 --------------------------

PS C:\> Install-JS7Joc.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\joc" -Data "C:\ProgramData\sos-berlin.com\js7\joc" -Tarball /tmp/js7_joc_windows.2.5.1.zip -BackupDir /tmp/backups -LogDir /tmp/logs -HttpPort 4446 -MakeDirs

Applies the JOC Cockpit release from a tarball and installs to the indicated locations. A backup is taken and log files are created.

-------------------------- BEISPIEL 3 --------------------------

PS C:\> Install-JS7Joc.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\joc" -Data "C:\ProgramData\sos-berlin.com\js7\joc" -Tarball /tmp/js7_joc_windows.2.5.1.zip -HttpPort localhost:4446 -HttpsPort apmacwin:4446 -JavaHome "C:\Program Files\Java\jdk-11.0.12+7-jre" -JavaOptions "-Xmx512m" -MakeDirs

Applies the JOC Cockpit release from a tarball and installs to the indicated locations. HTTP and HTTP port are the same using different network interfaces. The location of Java and Java Options are indicated.