JS7 - PowerShell Installation Script - Install-JS7Agent.ps1

Name

Install-JS7Agent.ps1

SYNOPSIS

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

SYNTAX

Install-JS7Agent.ps1 [-HomeDir] <String> [[-Data] <String>] [[-Config] <String>] [[-Logs] <String>] [[-Work] <String>] [[-User] <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[]>] [[-AgentConf] <String>] [[-PrivateConf] <String>] [[-ControllerId] <String>] [[-AgentClusterId] <String>] [[-HttpPort] <String>] [[-HttpsPort] <String>] [[-PidFileDir] <String>] [[-PidFileName] <String>] [[-ControllerPrimaryCert] <String>] [[-ControllerSecondaryCert] <String>] [[-DirectorPrimaryCert] <String>] [[-DirectorSecondaryCert] <String>] [[-Keystore] <String>] [[-KeystorePassword] <SecureString>] [[-KeyAlias] <String>] [[-ClientKeystore] <String>] [[-ClientKeystorePassword] <SecureString>] [[-ClientKeyAlias] <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] [-NoYade] [-NoInstall] [-UseInstall] [-Uninstall] [-UninstallHome] [-UninstallData] [-ShowLogs] [-MakeDirs] [-MakeService] [-MoveLibs] [-RemoveJournal] [-Restart] [-Abort] [-Kill] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Agent Installation Script can be used to automate installing, updating, patching and uninstalling Agents.

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

Data

-Data <String>
Specifies the directory in which Agent 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 Agent reads configuration files.

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

Logs

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

Work

-Work <String>
Specifies the working directory of the Agent.
By default the <data>/work directory is used, see -Data parameter.

User

-User <String>
Specifies the user account for the Agent daemon in Unix environments.
By default the account of the user running the Agent 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 Agent is operated for.

Release

-Release <String>
Specifies a release number of the JS7 Agent 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 Agent 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 Unix and Windows the download file is https://download.sos-berlin.com/patches/2.2.3-patch/js7_agent.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_agent.2.2.3-PATCH.JS-1984.tar.gz parameters will apply the patch from the downloaded file.

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

To apply patches the Agent 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 Agent'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 agent_<http-port>.sh|.cmd will be used.

The script has to be executable for the Agent 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_AGENT_USER>,
for details see ./bin/agent_instance.sh-example and .\bin\agent_instance.cmd-example.

BackupDir

-BackupDir <String>
If a backup directory is specified then an Agent'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_agent.<hostname>.<release>.home.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.tar.gz
* backup_js7_agent.<hostname>.<release>.data.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.tar.gz

For example: backup_js7_agent.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_agent.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
For example: install_js7_agent.centostest_primary.2022-03-19T20-50-45.log

ExecStart

-ExecStart <String>
This parameter can be used should the Agent be started after installation.
For example, when using systemd for Unix or using Windows Services then the -ExecStart "StartService" parameter value
will start the Agent 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_agent_4445".

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 Agent from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

ExecStop

-ExecStop <String>
This parameter can be used should the Agent be stopped before installation.
For example, when using Unix systemd or Windows Services then
the -ExecStop "StopService" parameter value will stop the Agent 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_agent_4445".
This parameter is an alternative to use of the -Restart switch which stops the Agent 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_agent.centostest_primary.2022-03-20T04-54-31.log
backup_file=backup_js7_agent.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 agent.conf, private.conf, log4j2.xml etc.

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

AgentConf

-AgentConf <String>
Specifies the path to a configuration file for global Agent configuration items. The file will be copied to the <config>/agent.conf file.

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

PrivateConf

-PrivateConf <String>
Specifies the path to a configuration file for private Agent 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.

ControllerId

-ControllerId <String>
Specifies the Controller ID, a unique identifier of the Controller installation. Agents will be dedicated to the Controller with the given Controller ID.
The Controller ID is used in the Agent's private.conf file to specify which Controller can access a given Agent.

AgentClusterId

-AgentClusterId <String>
Specifies the Agent Cluster ID, a unique identifier of the Agent Cluster. This is not the Primary/Secondary Director Agent ID.

Subagents will be dedicated to the Agent Cluster with the given Agent Cluster ID.
The Agent Cluster ID is used in the Agent's private.conf file to specify which pairing Director Agent instance in can access the given Director Agent instance.

HttpPort

-HttpPort <String>
Specifies the HTTP port that the Agent is operated for. The default value is 4445.
The Agent by default makes use of a configuration directory ./var_<http-port> that will be excluded from a backup taken with the -BackupDir parameter.

In addition the HTTP port is used to identify the Agent Instance Start Script typically available from the ./bin/agent_<http-port>.sh|.cmd script
and to specify the value of the JS7_AGENT_HTTP_PORT environment variable in the script.

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

HttpsPort

-HttpsPort <String>
Specifies the HTTPS port that the Agent is operated for. The HTTPS port is specified in the Agent Instance Start Script typically available
from the ./bin/agent_<http-port>.sh|.cmd script with the environment variable JS7_AGENT_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:4445.

PidFileDir

-PidFileDir <String>
Specifies the directory to which the Agent 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 agent.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 Agent'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.

DirectorPrimaryCert

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

DirectorSecondaryCert

-DirectorSecondaryCert <String>
Corresponds to the -DirectorPrimaryCert parameter and is used for the Secondary Director Agent instance.

Keystore

-Keystore <String>
Specifies the path to a PKCS12 keystore file that holds the private key and certificate for HTTPS connections to the Agent.
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 Agent'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.

ClientKeystore

-ClientKeystore <String>
Use of this parameter is optional. It can be used if separate certificates for Server Authentication and Client Authentication are used.

The Client Authentication private key and certificate can be added to a client keystore. The location and configuration of a client keystore correspond to the -Keystore parameter.

ClientKeystorePassword

-ClientKeystorePassword <SecureString>
Specifies the password for access to the client keystore. Use of a client keystore password is required if a client keystore is used.

Consider explanations for the -KeystorePassword parameter.

ClientKeyAlias

-ClientKeyAlias <String>

Truststore

-Truststore <String>
Specifies the path to a PKCS12 truststore file that holds the certificate(s) for HTTPS connections to the Agent 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 Agent'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 Agent from the JAVA_HOME environment variable
specified with the Agent Instance Start Script typically available from the ./bin/agent_<http-port>.sh|.cmd script.

JavaOptions

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

Java options can be used for example to specify Java heap space settings for the Agent.
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 Agent'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 Agent'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 agent_<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/agent.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_agent_<http-port> will be used.

For Windows the service name is not specified, instead the service name js7_agent_<http-port> will be used.

ServiceCredentials

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

Active

-Active <SwitchParameter>
This setting is used for Director Agents only. It specifies that the Director Agent instance should act as the active node in a Director Agent Cluster during initial operation.

This setting is not required for installation of a Primary Director Agent in an Agent Cluster. It can be used to revert a Secondary Director Agent to a Primary Director Agent.

Standby

-Standby <SwitchParameter>
This setting is used for Director Agents only. It specifies that the Director Agent instance should act as the standby node in a Director Agent Cluster during initial operation.

This setting is required when installing a Secondary Director Agent instance in an Agent Cluster.

NoYade

-NoYade <SwitchParameter>
Excludes the YADE file transfer utility from Agent installation.

YADE is available from the yade sub-directory of the Agent's <home> directory.
If this switch is used then an existing yade sub-directory will be removed and
YADE will not be copied from the installation tarball to the Agent's <home> directory.

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.

UseInstall

-UseInstall <SwitchParameter>
Resuses an existing Agent installation. No installation files are specified as with the -Release or -Tarball parameters.

Instead, the new Agent's data directory and the respective service will be created.

Uninstall

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

UninstallHome

-UninstallHome <SwitchParameter>
Uninstalls the Agent but preservers the Agent's <data> directory.

UninstallData

-UninstallData <SwitchParameter>
Uninstalls the Agent but preservers the Agent's <home> directory.

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

MoveLibs

-MoveLibs <SwitchParameter>
For an existing Agent 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 Agent'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 Agents have been installed for the wrong operating mode (standalone, clustered) then the Agent's journal in the <data>/state directory can be removed.
This operation removes any information such as orders submitted to an Agent and requires the Agent to be re-registered to a Controller.

Restart

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

Abort

-Abort <SwitchParameter>
Aborts a running Agent and kills any running tasks including child processes if used with the -Restart switch.
Aborting an Agent includes to terminate the Agent in an orderly manner which allows to close journal files consistently.

Kill

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

Killing an Agent prevents journal files from being closed in an orderly manner.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

EXAMPLES

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

PS C:\> Install-JS7Agent.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" -Release 2.5.1 -HttpPort 4445 -MakeDirs

Downloads and installs the Agent release to the indicated location.

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

PS C:\> Install-JS7Agent.ps1 -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" -Tarball /tmp/js7_agent_windows.2.5.1.zip -BackupDir /tmp/backups -LogDir /tmp/logs -HttpPort 4445 -MakeDirs

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

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

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

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