...

The documentation of the Agent Installation Script is available from JS7 - PowerShell Installation Script - Install-JS7Agent.ps1.
Installation Scripts are available for download from from (verify signed scripts) JS7 - Download.
Considering the fact that PowerShell for Unix based environments misses support for sudo the Agent Installation Script does not own directories to other user accounts. Therefore below examples do not make use of --home-owner and --data-owner arguments that are available from the Unix Shell version of the Installation Script with JS7 - Agent - Unix Shell Installation Script - js7_install_agent.sh.

...

Code Block

language	powershell
title	Example for use of Installation Script

Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/JobScheduler.2.5/js7_agent_unix.2.5.2.tar.gz' `
    -Outfile /tmp/js7_agent_unix.2.5.2.tar.gz

./Install-JS7Agent.ps1 `
    -Tarball /tmp/js7_agent_unix.2.5.2.tar.gz `
    -HomeDir /home/sos/agent `
    -HttpPort 4445 `
    -JavaHome /opt/java/jdk-1117.0.2+9 `
    -JavaOptions "-Xmx512m -Xms256m" `
    -Restart `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the Agent's home directory
# specifies the Java version and Java options to be used
# stops and starts the Agent from its instance start script <home>/bin/agent_4445.sh
# operates the Agent for HTTP port 4445

...

Code Block

language	powershell
title	Example for use of Installation Script

Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/JobScheduler.2.6/js7_agent_unix.2.6.0.tar.gz' `
    -Outfile /tmp/js7_agent_unix.2.6.0.tar.gz
 Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/JobScheduler.2.6/js7-license.jar' `
    -Outfile /tmp/js7-license.jar
 
./Install-JS7Agent.ps1 `
    -Tarball /tmp/js7_agent_unix.2.6.0.tar.gz `
    -HomeDir /home/sos/agent `
    -ControllerId controller `
    -AgentClusterId agent-cluster `
    -HttpPort localhost:4445 `
    -HttpsPort batch.example.com:4445 `
    -LicenseKey /home/sos/agent-deployment/example.pem `
    -License-bin /tmp/js7-license.jar `
    -PrivateConf /home/sos/agent-deployment/private.conf-template-agent `
    -ControllerPrimaryCert /home/sos/agent-deployment/centostest-primary.crt `
    -ControllerSecondaryCert /home/sos/agent-deployment/centostest-secondary.crt `
    -DirectorPrimaryCert /home/sos/agent-deployment/centostest-primary.crt `
    -DirectorSecondaryCert /home/sos/agent-deployment/centostest-secondary.crt `
    -Keystore /home/sos/agent-deployment/https-keystore.p12 `
    -KeystorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) `
    -Truststore /home/sos/agent-deployment/https-truststore.p12 `
    -TruststorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) ` 
    -ExecStart StartService `
    -ExecStop StopService `
    -MakeService `
    -Active `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using curlInvoke-WebRequest
# downloads the binary file for licensed code to enable cluster operations
# extracts the release tarball to the Agent's home directory
# specifies the Controller ID of the Controller to which the Agent is dedicated
# specifies the Agent Cluster ID
# specifies HTTP port 4445 on the localhost network interface and the same HTTPS port on the server network interface
# specifies the paths to the Primary and Secondary Controller's server certificates if a Controller Cluster is used
#     for a Standalone Controller the --controller-secondary-cert argument is omitted
# specifies the paths to the Primary and Secondary Director Agent's server certificates if an Agent Cluster is used
#     for a Standalone Director Agent the -DirectorSecondaryCert argument is omitted
# deploys the Agent private configuration file which holds references to keystore and truststore
# deploys keystore and truststore files
# makes the Agent the active Director Agent in an Agent Cluster
# stops and starts the Agent's systemd service

...

Code Block

language	powershell
title	Example for use of Installation Script

Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/JobScheduler.2.5/js7_agent_windows.2.5.2.zip' `
    -Outfile C:\tmp\js7_agent_windows.2.5.2.zip

./Install-JS7Agent.ps1 `
    -Tarball C:\tmp\js7_agent_windows.2.5.2.zip `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -JavaHome "C:\Program Files\Java\jdk-1117.0.2+9" `
    -JavaOptions "-Xmx512m -Xms256m" `
    -Restart `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the Agent's home directory
# specifies the Java version and Java options to be used
# stops and starts the Agent from its instance start script <home>\bin\agent_4445.cmd
# operates the Agent for HTTP port 4445

...

Patch from Download

Code Block

language	powershellbash
title	Example for use of Agent Installation Script

./Install-JS7Agent.ps1 `
     -Release 2.2.3 `
    -Patch JS-1984 `
     -HomeDir /home/sos/agent `
    -HttpPort 4445 `
    -ExecStart StartService `
    -ExecStop StopService
 
# downloads the patch tarball from the SOS Web Site
# extracts the patch tarball to the Agent's home directory
# stores the patch files to the Agent's <home>/lib/patches sub-directory
# stops and starts the Agent's systemd Serviceservice

Patch from Tarball

Code Block

language	powershellbash
title	Example for use of Agent Installation Script

Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/patches/JobScheduler2.2.23-patch/js7_agent_unix.2.2.3-PATCH.JS-1984.tar.gz' `
    -Outfile /tmp/js7_agent_unix.2.2.3-PATCH.JS-1984.tar.gz

./Install-JS7Agent.ps1 `
    -Tarball /tmp/js7_agent_unix.2.2.3-PATCH.JS-1984.tar.gz `
     -Patch JS-1984 `
     -HomeDir /home/sos/agent `
     -HttpPort 4445 `
    -ExecStart StartService `
    -ExecStop StopService

# downloads the patch tarball from the SOS Web Site using Invoke-WebRequest
# extracts the patch tarball to the Agent's home directory
# stores patch files to the Agent's <home>/lib/patches sub-directory
# stops and starts the Agent's systemd Serviceservice

Patch from .jar File

Code Block

language	powershellbash
title	Example for use of Agent Installation Script

Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/patches/JobScheduler2.2.2/patch-20220331-JS-1984-3-patch/js7_agent.2.2.3-PATCH.JS-1984.jar' `
    -Outfile /tmp/patch-20220331-JS-1984-js7_agent.2.2.3-PATCH.JS-1984.jar

./Install-JS7Agent.ps1 `
    -JarPatchJar /tmp/patch-20220331-JS-1984-js7_agent.2.2.3-PATCH.JS-1984.jar `
     -Patch JS-1984 `
     -HomeDir /home/sos/agent `
     -HttpPort 4445 ` 
     -ExecStart StartService `
    -ExecStop StopService

# downloads the patch .jar file from the SOS Web Site using Invoke-WebRequest
# stores the patch .jar filefiles to the Agent's <home>/lib/patches sub-directory
# stops and starts the Agent's systemd Serviceservice

Patch Agent for Windows

Patch from Download

Code Block

language	powershell
title	Example for use of Installation Script

./Install-JS7Agent.ps1 `
    -Release 2.2.3 `
    -Patch JS-1984 `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -HttpPort 4445 `
    -ExecStart StartService `
    -ExecStop StopService

# downloads the patch tarball from the SOS Web Site
# extracts the patch files to the Agent's <home>\lib\patches sub-directory
# stops and starts the Agent's Windows service

Patch from

...

Tarball

Code Block

language	powershell
title	Example for use of Installation Script

Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/patches/JobScheduler2.2.23-patch/js7_agent_windows.2.2.3-PATCH.JS-1984.tar.zipgz' `
      -Outfile C:\tmp\js7_agent_windows.2.2.3-PATCH.JS-1984.ziptar.gz

./Install-JS7Agent.ps1 `
    -Tarball "C:\tmp\js7_agent_windows.2.2.3-PATCH.JS-1984.ziptar.gz" `
    -Patch JS-1984 `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -HttpPort 4445 `
    -ExecStart StartService `
    -ExecStop StopService 

# downloads the patch tarball from the SOS Web Site using Invoke-WebRequest
# extracts patch files to the Agent's <home>\lib\patches sub-directory
# stops and starts the Agent's Windows service

...

Code Block

language	powershell
title	Example for use of Installation Script

Invoke-WebRequest `
    -Uri 'https://download.sos-berlin.com/patches/JobScheduler2.2.2/patch-20220331-JS-1984-3-patch/js7_agent.2.2.3-PATCH.JS-1984.jar' `
      -Outfile C:\tmp\patch-20220331-JS-1984-js7_agent.2.2.3-PATCH.JS-1984.jar 

./Install-JS7Agent.ps1 `
    -JarPatchJar "C:\tmp\patch-20220331-JS-1984-js7_agent.2.2.3-PATCH.JS-1984.jar" `
    -Patch JS-1984 `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -HttpPort 4445 `
    -ExecStart StartService `
    -ExecStop StopService 

# downloads the patch .jar file from the SOS Web Site using Invoke-WebRequest
# stores the patch .jar file to the Agent's <home>\lib\patches sub-directory
# stops and starts the Agent's Windows service

...

Code Block

language	powershell
title	Example for use of Installation Script

./Install-JS7Agent.ps1 `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -ExecStop StopService ` 
    -UninstallHome

# stops the Agent's Windows service
# removes the Agent's Windows service
# removes the Agent's home directory
# preserves the Agent's data directory

Anchor
replacements
replacements
Replacements

The Agent Installation Script performs replacements of placeholders in installation files and configuration files by option values.

Installation files

<home>\bin\agent_<http-port>.cmd

Replacements are performed for the following placeholders used for environment variables by respective option values:

Placeholder	Option Value
`JS7_AGENT_HOME`	`-HomeDir`
`JS7_AGENT_DATA`	`-Data`
`JS7_AGENT_USER`	`-User`
`JS7_AGENT_HTTP_PORT`	`-HttpPort`
`JS7_AGENT_HTTPS_PORT`	`-HttpsPort`
`JS7_AGENT_CONFIG_DIR`	`-Config`
`JS7_AGENT_LOGS`	`-Logs`
`JS7_AGENT_WORK_DIR`	`-Work`
`JS7_AGENT_PID_FILE_DIR`	`-PidFileDir`
`JS7_AGENT_PID_FILE_NAME`	`-PidFileName`
`JAVA_HOME`	`-JavaHome`
`JAVA_OPTIONS`	`-JavaOptions`

Configuration files

<config>\private\private.conf

Replacements are performed for the following placeholders by respective option values:

Placeholder	Option Value
`{{controller-id}}`	`-ControllerId`
`{{controller-primary-distinguished-name}}`	`-ControllerPrimaryCert`
`{{controller-secondary-distinguished-name}}`	`-ControllerSecondaryCert`
`{{agent-cluster-id}}`	`-AgentClusterId`
`{{director-primary-distinguished-name}}`	`-DirectorPrimaryCert`
`{{director-secondary-distinguished-name}}`	`-DirectorSecondaryCert`
`{{keystore-file}}`	`-Keystore`
`{{keystore-password}}`	`-KeystorePassword`
`{{keystore-alias}}`	`-KeystoreAlias`
`{{client-keystore-file}}`	`-ClientKeystore`
`{{client-keystore-password}}`	`-ClientKeystorePassword`
`{{client-keystore-alias}}`	`-ClientKeystoreAlias`
`{{truststore-file}}`	`-Truststore`
`{{truststore-password}}`	`-TruststorePassword`

Find a template for a private.conf file using placeholders for HTTPS mutual authentication:

Code Block

language	yml
title	private.conf template file with placeholders
collapse	true

js7 {
    auth {
        users {
            # Controller ID for connections by primary/secondary Controller instance
            {{controller-id}} {
                distinguished-names=[
                    "{{controller-primary-distinguished-name}}",
                    "{{controller-secondary-distinguished-name}}"
                ]
            }

            # Agent Cluster ID for connections by primary/secondary Director Agent instance
            {{agent-cluster-id}} {
                permissions = [ AgentDirector ]
                distinguished-names=[
                    "{{director-primary-distinguished-name}}",
                    "{{director-secondary-distinguished-name}}"
                ]
            }
        }
    }

    configuration {
        # Locations of certificates and public keys used for signature verification
        trusted-signature-keys {
            # PGP=${js7.config-directory}"/private/trusted-pgp-keys"
            X509=${js7.config-directory}"/private/trusted-x509-keys"
        }
    }

    job {
        # Enable script execution from signed workflows^M
        execution {
            signed-script-injection-allowed=yes
        }
    }

    web {
        # Locations of keystore and truststore files for HTTPS connections
        https {
            keystore {
                # Default: ${js7.config-directory}"/private/https-keystore.p12"
                file=${js7.config-directory}"/private/{{keystore-file}}"
                key-password="{{keystore-password}}"
                store-password="{{keystore-password}}"
                # alias="{{keystore-alias}}"
            }

            client-keystore {
                # Default: ${js7.config-directory}"/private/https-client-keystore.p12"
                file=${js7.config-directory}"/private/{{client-keystore-file}}"
                key-password="{{client-keystore-password}}"
                store-password="{{client-keystore-password}}"
                # alias="{{client-keystore-alias}}"
            }

            truststores=[
                {
                    # Default: ${js7.config-directory}"/private//https-truststore.p12"
                    file=${js7.config-directory}"/private/{{truststore-file}}"
                    store-password="{{truststore-password}}"
                }
            ]
        }
    }
}

...

Space shortcuts

Page tree

Versions Compared

Old Version 30

New Version Current

Key

Patch from Download

Patch from Tarball

Patch from .jar File

Patch Agent for Windows

Patch from Download

Patch from

Tarball

Anchor
replacements
replacements
Replacements

Installation files

Configuration files

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 30

New Version Current

Key

Patch from Download

Patch from Tarball

Patch from .jar File

Patch Agent for Windows

Patch from Download

Patch from

Tarball

AnchorreplacementsreplacementsReplacements

Installation files

Configuration files

Anchor
replacements
replacements
Replacements