JS7 - PowerShell Installation Script - Install-JS7Controller.ps1

Name

Install-JS7Controller.ps1

SYNOPSIS

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

SYNTAX

Install-JS7Controller.ps1 [-HomeDir] <String> [[-Data] <String>] [[-Config] <String>] [[-Logs] <String>] [[-User] <String>] [[-ControllerId] <String>] [[-Release] <String>] [[-Tarball] <String>] [[-Patch] <String>] [[-PatchJar] <String>] [[-LicenseKey] <String>] [[-LicenseBin] <String>] [[-InstanceScript] <String>] [[-BackupDir] <String>] [[-LogDir] <String>] [[-ExecStart] <String>] [[-ExecStop] <String>] [[-ReturnValues] <String>] [[-DeployDir] <String[]>] [[-ControllerConf] <String>] [[-PrivateConf] <String>] [[-HttpPort] <String>] [[-HttpsPort] <String>] [[-PidFileDir] <String>] [[-PidFileName] <String>] [[-ControllerPrimaryCert] <String>] [[-ControllerSecondaryCert] <String>] [[-JocPrimaryCert] <String>] [[-JocSecondaryCert] <String>] [[-Keystore] <String>] [[-KeystorePassword] <SecureString>] [[-KeyAlias] <String>] [[-Truststore] <String>] [[-TruststorePassword] <SecureString>] [[-JavaHome] <String>] [[-JavaOptions] <String>] [[-StopTimeout] <Int32>] [[-ServiceDir] <String>] [[-ServiceFile] <String>] [[-ServiceName] <String>] [[-ServiceCredentials] <PSCredential>] [[-ServiceStartMode] <String>] [[-ServiceDisplayName] <String>] [-Active] [-Standby] [-NoInstall] [-Uninstall] [-ShowLogs] [-MakeDirs] [-MakeService] [-MoveLibs] [-RemoveJournal] [-Restart] [-Abort] [-Kill] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Controller Installation Script can be used to automate installing, updating, patching and uninstalling Controller instances.

The script offers the installation options and configuration options available from the Controller'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 Controller should be installed.

Data

-Data <String>
Specifies the directory in which Controller data such as configuration files should be stored.
By default the <home>/var_<http-port> directory is used, see -HomeDir and -HttpPort parameters.

Config

-Config <String>
Specifies the directory from which the Controller reads configuration files.

By default the <data>/config directory is used, see -Data parameter.

Logs

-Logs <String>
Specifies the directory to which the Controller stores log files.
By default the <data>/logs directory is used, see -Data parameter.

User

-User <String>
Specifies the user account for the Controller daemon.
By default the account of the user running the Installation Script is used.

ControllerId

-ControllerId <String>
Specifies the Controller ID, a unique identifier of the Controller installation. If a Controller Cluster is operated than all cluster members use the same Controller ID.
The Controller ID is used in the Controller's private.conf file to specify which Controller instance can access a given Controller.

Release

-Release <String>
Specifies a release number for the JS7 Controller 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 Controller 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 and a specific release in the SOS Change Management System.

For example the -Patch JS-1984 -Release 2.2.3 parameters will download an (empty) sample patch from the SOS web site
for the respective operating system that the the cmdlet is operated for:

For Unix and Windows the download file is https://download.sos-berlin.com/patches/2.2.3-patch/js7_controller.2.2.3-PATCH.JS-1984.tar.gz

Patches can be individually downloaded and can be made available from the -Tarball parameter.

For example the -Patch JS-1984 -Tarball /tmp/js7_controller.2.2.3-PATCH.JS-1984.tar.gz parameters will apply the patch from the downloaded file.

Patches are added to the Controller's <home>/lib/patches directory.
Note that patches will be removed when updating the Controller installation later on.

To apply patches the Controller has to be restarted. The -Restart or -ExecStart, -ExecStop parameters can be used for automated restart.

PatchJar

-PatchJar <String>
Opetionally specifies the path to a .jar file that holds a patch.

The patch .jar file has to be downloaded individually and will be copied to the Controller's <home>/lib/patches directory.

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.

InstanceScript

-InstanceScript <String>
Specifies the path to an Instance Start Script that acts as a template and that is copied to the 'bin' directory.
Users are free to choose any name for the Instance Start Script template. In the target directory the file name controller_instance.sh|.cmd will be used.

The script has to be executable for the Controller daemon or Windows Service, see -User parameter.
Permissions of the script are not changed by the Installation Script.
The Installation Script will perform replacements in the Instance Start Script template for known placeholders such as <JS7_CONTROLLER_USER>,
for details see ./bin/controller_instance.sh-example and .\bin\controller_instance.cmd-example.

BackupDir

-BackupDir <String>
If a backup directory is specified then a Controller's existing home and data directories will be added to backup files in this directory.
The backup file type is .tar.gz for Unix and Windows.

File names are created according to the pattern:

* backup_js7_controller.<hostname>.<release>.home.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.tar.gz
* backup_js7_controller.<hostname>.<release>.data.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.tar.gz

For example: backup_js7_controller.centostest_primary.2.3.1.home.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_controller.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
For example: install_js7_controller.centostest_primary.2022-03-19T20-50-45.log

ExecStart

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

For Unix users can specify individual commands, for example -ExecStart "sudo systemctl start js7_controller".

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

ExecStop

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

For Unix users can specify individual commands, for example -ExecStop "sudo systemctl stop js7_controller".
This parameter is an alternative to use of the -Restart switch which stops the Controller 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_controller.centostest_primary.2022-03-20T04-54-31.log
backup_file=backup_js7_controller.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 <config> directory.
A deployment directory allows to manage central copies of configuration files such as controller.conf, private.conf, log4j2.xml etc.

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

ControllerConf

-ControllerConf <String>
Specifies the path to a configuration file for global Controller configuration items. The file will be copied to the <config>/controller.conf file.

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

PrivateConf

-PrivateConf <String>
Specifies the path to a configuration file for private Controller configuration items. The file will be copied to the <config>/private/private.conf file.

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

HttpPort

-HttpPort <String>
Specifies the HTTP port that the Controller is operated for. The default value is 4444.

The HTTP port is used to specify the value of the JS7_CONTROLLER_HTTP_PORT environment variable in the instance start script.

The port can be prefixed by the network interface, for example localhost:4444.
When used with the -Restart switch the HTTP port is used to identify if the Controller is running.

HttpsPort

-HttpsPort <String>
Specifies the HTTPS port that the Controller is operated for. The HTTPS port is specified in the Controller Instance Start Script typically available
from the ./bin/controller_instance.sh|.cmd script with the environment variable JS7_CONTROLLER_HTTPS_PORT.

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 batch.example.com:4444.

PidFileDir

-PidFileDir <String>
Specifies the directory to which the Controller stores its PID file. By default the <data>/logs directory is used.
When using SELinux then it is recommended to specify the /var/run directory, see the 'JS7 - How to install for SELinux' article.

PidFileName

-PidFileName <String>
Specifies the name of the PID file in Unix environments. By default the file name controller.pid is used.
The PID file is created in the directory specified by the -PidFileDir parameter.

ControllerPrimaryCert

-ControllerPrimaryCert <String>
Specifies the path to the SSL/TLS certificate of the Primary Controller Instance.
The Installation Script extracts the distinguished name from the given certificate and adds it to the Controller's private.conf file
to allow HTTPS connections from the given Controller using mutual authentication without the need for passwords.

ControllerSecondaryCert

-ControllerSecondaryCert <String>
Corresponds to the -ControllerPrimaryCert parameter and is used for the Secondary Controller Instance.

JocPrimaryCert

-JocPrimaryCert <String>

JocSecondaryCert

-JocSecondaryCert <String>

Keystore

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

If a keystore file is made available then the Controller's <config>/private/private.conf file has to hold a reference to the keystore location and optionally 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 the 'JS7 - How to add SSL TLS Certificates to Keystore and Truststore' article.

KeystorePassword

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

The 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 Controller 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 <config>/private directory.

If a truststore file is made available then the Controller's <config>/private/private.conf file has to hold a reference to the truststore location and optionally 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 the 'JS7 - How to add SSL TLS Certificates to Keystore and Truststore' article.

TruststorePassword

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

The 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 Controller from the JAVA_HOME environment variable
specified with the Controller Instance Start Script typically available from the ./bin/controller_instance.sh|.cmd script.

JavaOptions

-JavaOptions <String>
Specifies the Java options that will be made available to the Controller from the JAVA_OPTIONS environment variable specified with the Controller Instance Start Script typically available from the ./bin/controller_instancesh|.cmd script.

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

StopTimeout

-StopTimeout <Int32>
Specifies the timeout in seconds for which the Installation Script will wait for the Agent to terminates, for example if jobs are running.
If this timeout is exceeded then the Agent will be killed. A timeout is not applicable when used with the -Abort or -Kill parameters.

ServiceDir

-ServiceDir <String>
For Unix environments specifies the systemd service directory to which the Controller'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 Controller's <home>/bin directory.
Users are free to choose any file name as a template for the service file. The resulting service file name will be controller_<http-port>.service.
The Installation Script will perform replacements in the service file to update paths and the port to be used, for details see ./bin/controller.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 for Unix the service name js7_controller_<controller-id> will be used.

For Windows the service name is not specified. Instead, the service name js7_controller_<controller-id> will be used.
If the -Standby option for a Secondary Controller is used then the service name js7_controller_<controller-id>-backup will be used.

ServiceCredentials

-ServiceCredentials <PSCredential>
In Windows environments the credentials for the Windows service account can be specified for which the Controller 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.

ServiceDisplayName

-ServiceDisplayName <String>
For Windows environments allows to specify the display name of the Controller's Windows Service.

Active

-Active <SwitchParameter>
Specifies the Controller instance to initially take the role of the active Controller instance in a Controller Cluster.

Standby

-Standby <SwitchParameter>
Specifies the Controller instance to initially take the role of the standby Controller instance in a Controller Cluster.

NoInstall

-NoInstall <SwitchParameter>
Specifies if the Installation Script should be used to update configuration items without changes to the binary files of the installation.
In fact no installation is performed but configuration changes as for example specified with the -Keystore parameter will be applied.

Uninstall

-Uninstall <SwitchParameter>
Uninstalls the Controller instance including the steps to stop and remove a running Controller service and to remove the <home> and <data> directories.

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, -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 its default value.

MoveLibs

-MoveLibs <SwitchParameter>
For an existing Controller installation the lib sub-directory includes .jar files that carry the release number in their file names.
If replaced by a newer version the lib directory has to be moved or removed.
This switch tries to move the directory to a previous version number as indicated from the .version file in the Controller's home directory,
for example to rename lib to lib.2.3.1.

Files in the lib/user_lib sub-directory are preserved.

RemoveJournal

-RemoveJournal <SwitchParameter>
If Controllers have been installed for the wrong operating mode (standalone, clustered) then the Controller's journal in the <data>/state directory can be removed.
This operation removes any information such as orders submitted to an Controller and requires scheduling objects to be re-deployed to the Controller.

Restart

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

Abort

-Abort <SwitchParameter>
Aborts a running Controller if used with the -Restart switch.
Aborting an Controller includes to terminate the Controller in an orderly manner which allows to close journal files consistently.

Kill

-Kill <SwitchParameter>
Kills a running Controller if used with the -Restart switch.
Killing a Controller prevents journal files from being closed in an orderly manner.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

EXAMPLES

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

PS C:\> Install-JS7Controller.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\controller" -Data "C:\ProgramData\sos-berlin.com\js7\controller" -Tarball /tmp/js7_controller_windows.2.5.1.zip -HttpPort 4444 -MakeDirs

Downloads and installs the Controller release to the indicated location.

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

PS C:\> Install-JS7Controller.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\controller" -Data "C:\ProgramData\sos-berlin.com\js7\controller" -Tarball /tmp/js7_controller_windows.2.5.1.zip -BackupDir /tmp/backups -LogDir /tmp/logs -HttpPort 4444 -MakeDirs

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

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

PS C:\> Install-JS7Controller.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\controller" -Data "C:\ProgramData\sos-berlin.com\js7\controller" -Tarball /tmp/js7_controller_windows.2.5.1.zip -HttpPort localhost:4444 -HttpsPort apmacwin:4444 -JavaHome "C:\Program Files\Java\jdk-11.0.12+7-jre" -JavaOptions "-Xms100m -Xmx256m" -MakeDirs

Applies the Controller 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.