JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 22

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 23

changes.mady.by.user Andreas Püschel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagepowershell
titleExample for use of Installation Script
./Install-JS7Agent.ps1 `
    -HomeDir /home/sos/agent `
    -ControllerId controller `
    -HttpPort localhost:4445 `
    -HttpsPort batch.example.com:4445 `
    -PrivateConf /home/sos/agent-deployment/private.conf `
    -ControllerPrimaryCert /home/sos/agent-deployment/centostest-primary.crt `
    -ControllerSecondaryCert /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 `
    -NoInstall

# performs no installation but certificate renewal only
# specifies the Controller ID of the Controller to which the Agent is dedicated
# addresses an existing Agent operated for 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
# deploys the Agent private configuration file that holds references to keystore and truststore
# deploys keystore and truststore files
# stops and starts the Agent's systemd service

...

Start Agent

...

Service

Install or Update from Download

Code Block
languagepowershell
titleExample for use of Installation Script
./Install-JS7Agent.ps1 `
    -Release 2.5.2HomeDir /home/sos/agent `
      -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" HttpPort 4445 `
      -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445"ExecStart StartService `
    -HttpPortExecStop 4445StopService `
    -MakeDirsNoInstall

# downloadsstops the Agent's releasesystemd tarballservice fromshould the SOSAgent Webbe Siterunning
# createsstarts the home and data directories if they doe not exist
# extracts the tarball to the AgentAgent's home directory
# operates the Agent for HTTP port 4445

Install or Update from .zip Archive

systemd service

Stop Agent Service

Code Block
languagepowershell
titleExample for use of Installation Script
Invoke-WebRequest./Install-JS7Agent.ps1 `
    -UriHomeDir 'https:/home/download.sos-berlin.com/JobScheduler.2.5/js7_agent_windows.2.5.2.zip'agent `
    -HttpPort 4445 `
    -ExecStart StartService `
    -NoInstall

# stops the Agent's systemd service should the Agent be running

Install Agent for Windows

Install or Update from Download

Code Block
languagepowershell
titleExample for use of Installation Script
Outfile C:\tmp\js7_agent_windows.2.5.2.zip

./Install-JS7Agent.ps1 `
    -Tarball C:\tmp\js7_agent_windows.2.5.2.zipRelease 2.5.2 `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# creates the home and data directorydirectories if itthey doesdoe not exist
# extracts the tarball to the Agent's home directory
# operates the Agent for HTTP port 4445

Install or Update

...

from .zip Archive

Code Block
languagepowershell
titleExample for use of Installation Script
./Install-JS7Agent.ps1Invoke-WebRequest `
    -HomeDirUri "C:\Program Files\'https://download.sos-berlin.com\js7\agent"/JobScheduler.2.5/js7_agent_windows.2.5.2.zip' `
    -DataOutfile "C:\ProgramData\sos-berlin.comtmp\js7\agent_44445"_agent_windows.2.5.2.zip

./Install-JS7Agent.ps1 `
    -HttpPort 44445Tarball C:\tmp\js7_agent_windows.2.5.2.zip `
      -MakeDirs -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -UseInstall

# makes use of an existing Agent installation in the home directoryData "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# creates the datahome directory if it does not exist
# populatesextracts the datatarball directoryto fromthe initialAgent's configurationhome filesdirectory
# operates the Agent for HTTP port 444454445

Install or Update

...

side-by-side Agent

Code Block
languagepowershell
titleExample for use of Installation Script
Invoke-WebRequest./Install-JS7Agent.ps1 `
    -UriHomeDir 'https://download."C:\Program Files\sos-berlin.com/JobScheduler.2.5/js7_agent_windows.2.5.2.zip'\js7\agent" `
    -OutfileData "C:\tmp\ProgramData\sos-berlin.com\js7_agent_windows.2.5.2.zip

./Install-JS7Agent.ps1\agent_44445" `
    -Tarball C:\tmp\js7_agent_windows.2.5.2.tar.gzHttpPort 44445 `
     -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" MakeDirs `
    -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -ExecStart StartService `
    -ExecStop StopService `
    -MakeService `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the Agent's home directory
# creates the Agent's Windows service
# stops and starts the Agent's Windows service
# operates the Agent for HTTP port 4445UseInstall

# makes use of an existing Agent installation in the home directory
# creates the data directory if it does not exist
# populates the data directory from initial configuration files
# operates the Agent for HTTP port 44445

Install or Update and Stop/Start using Windows Service

...

Code Block
languagepowershell
titleExample 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.tar.gz `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -ServiceCredentials ( New-Object -typename System.Management.Automation.PSCredentialExecStart StartService `
    -ExecStop StopService `
    -MakeService `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the -ArgumentList '.\sos', ( 'secret' | ConvertTo-SecureString -AsPlainText -Force) ) `
    -MakeService `
    -ExecStart StartService `
    -ExecStop StopService `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the Agent's home directory
# creates the Agent's Windows service  that is running in the local account '.\sos' using the password 'secret' 
#    credentials can be specified in a number of ways
# stops and starts the Agent's Windows service
# operates the Agent for HTTP port 4445

Install or Update and Stop/Start using Instance Start Script

Agent's home directory
# creates the Agent's Windows service
# stops and starts the Agent's Windows service
# operates the Agent for HTTP port 4445

Install or Update and Stop/Start using Windows Service for specific Account

Code Block
languagepowershell
titleExample 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.tar.gz `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -ServiceCredentials ( New-Object -typename System.Management.Automation.PSCredential `
                          -ArgumentList '.\sos', ( 'secret' | ConvertTo-SecureString -AsPlainText -Force) ) `
    -MakeService `
    -ExecStart StartService
Code Block
languagepowershell
titleExample 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.tar.gz `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -Data "C:\ProgramData\sos-berlin.com\js7\agent_4445" `
    -HttpPort 4445 `
    -RestartExecStop StopService `
     -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the Agent's home directory
# stops and startscreates the Agent's fromWindows itsservice instance startthat script <home>\bin\agent_4445.cmd
# operates the Agent is running in the local account '.\sos' using the password 'secret' 
#    credentials can be specified in a number of ways
# stops and starts the Agent's Windows service
# operates the Agent for HTTP port 4445

Install or Update

...

and Stop/Start using Instance Start Script

Code Block
languagepowershell
titleExample 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.tar.zipgz `
    -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-11.0.2+9" `
    -JavaOptions "-Xmx512m -Xms256m" `
    -Restart `
    -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

Install or Update

...

using Java Home and Java Options

Code Block
languagepowershell
titleExample 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" `
      -ControllerIdHttpPort controller4445 `
    -HttpPortJavaHome localhost"C:4445 `
    -HttpsPort batch.example.com:4445\Program Files\Java\jdk-11.0.2+9" `
    -PrivateConfJavaOptions "C:\js7\agent-deployment\private.conf-Xmx512m -Xms256m" `
    -ControllerPrimaryCert "C:\js7\agent-deployment\wintest-primary.crt" 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

Install or Update and Apply Certificates for HTTPS Connections

Code Block
languagepowershell
titleExample for use of Installation Script
Invoke-WebRequestControllerSecondaryCert "C:\js7\agent-deployment\wintest-secondary.crt" `
    -Keystore "C:\js7\agent-deployment\https-keystore.pfx" `
    -KeystorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) `
    -Truststore "C:\js7\agent-deployment\https-truststore.pfx" `
    -TruststorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) ` 
    -ExecStart StartService `
    -ExecStop StopService `
    -MakeServiceUri 'https://download.sos-berlin.com/JobScheduler.2.5/js7_agent_windows.2.5.2.zip' `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the Agent's home directory
# specifies the Controller ID of the Controller to which the Agent is dedicated
# 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 -ControllerSecondaryCert argument is omitted
# deploys the Agent private configuration file which holds references to keystore and truststore
# deploys keystore and truststore files in PKCS12 format 
# stops and starts the Agent's Windows service

Note:

  • For details about certificates and HTTPS connections see JS7 - Agent HTTPS Connections.
  • The private.conf configuration file holds references to the Controller's certificate in order to verify the connection from the Controller using HTTPS mutual authentication.
  • Users have a choice how to provide the required configuration:
    • The Agent Installation Script performs replacements of placeholders in the private.conf configuration file from option values, for details see chapter Replacements.
    • Users can manually adjust configuration items in the private.conf file that they specify for the Agent Installation Script., see JS7 - Agent Configuration Items.

Renew Certificates for HTTPS Connections

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" `
    -ControllerId controller `
    -HttpPort localhost:4445 `
    -HttpsPort batch.example.com:4445 `
    -PrivateConf "C:\js7\agent-deployment\private.conf" `
    -ControllerPrimaryCert "C:\js7\agent-deployment\wintest-primary.crt" `
    -ControllerSecondaryCert "C:\js7\agent-deployment\wintest-secondary.crt" `
    -Keystore "C:\js7\agent-deployment\https-keystore.pfx" `
    -KeystorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) `
    -Truststore "C:\js7\agent-deployment\https-truststore.pfx" `
    -TruststorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) ` 
    -ExecStart StartService `
    -ExecStop StopService `
    -MakeService `
    -MakeDirs

# downloads the release tarball from the SOS Web Site using Invoke-WebRequest
# extracts the tarball to the Agent's home directory
# specifies the Controller ID of the Controller to which the Agent is dedicated
# 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 -ControllerSecondaryCert argument is omitted
# deploys the Agent private configuration file which holds references to keystore and truststore
# deploys keystore and truststore files in PKCS12 format 
# stops and starts the Agent's Windows service

Note:

  • For details about certificates and HTTPS connections see JS7 - Agent HTTPS Connections.
  • The private.conf configuration file holds references to the Controller's certificate in order to verify the connection from the Controller using HTTPS mutual authentication.
  • Users have a choice how to provide the required configuration:
    • The Agent Installation Script performs replacements of placeholders in the private.conf configuration file from option values, for details see chapter Replacements.
    • Users can manually adjust configuration items in the private.conf file that they specify for the Agent Installation Script., see JS7 - Agent Configuration Items.

Renew Certificates for HTTPS Connections

Code Block
languagepowershell
titleExample 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" `
    -ControllerId controller `
    -HttpPort localhost:4445 `
    -HttpsPort batch.example.com:4445 `
    -PrivateConf "C:\js7\agent-deployment\private.conf" `
    -ControllerPrimaryCert "C:\js7\agent-deployment\wintest-primary.crt" `
    -ControllerSecondaryCert "C:\js7\agent-deployment\wintest-secondary.crt" ` 
    -Keystore "C:\js7\agent-deployment\https-keystore.pfx" `
    -KeystorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) `
    -Truststore "C:\js7\agent-deployment\https-truststore.pfx" `
    -TruststorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) ` 
    -ExecStart StartService `
    -ExecStop StopService `
    -NoInstall

# performs no installation but certificate renewal only
# specifies the Controller ID of the Controller to which the Agent is dedicated
# addresses an existing Agent operated for 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 -ControllerSecondaryCert argument is omitted
# deploys the Agent private configuration file that holds references to keystore and truststore
# deploys keystore and truststore files in PKCS12 format
# stops and starts the Agent's Windows service

Start Agent Service

Code Block
languagepowershell
titleExample for use of Installation Script
./Install-JS7Agent.ps1 `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -HttpPort 4445 `
    -ExecStart StartService `
    -ExecStop StopService `
    -NoInstall

# stops the Agent's Windows service should the Agent be running
# starts the Agent's Windows service

Stop Agent Service

Code Block
languagepowershell
titleExample for use of Installation Script
./Install-JS7Agent.ps1 `
    -HomeDir "C:\Program Files\sos-berlin.com\js7\agent" `
    -HttpPort 4445 `
    -ExecStart StartService `
    -NoInstall

# stops
Code Block
languagepowershell
titleExample 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" `
    -ControllerId controller `
    -HttpPort localhost:4445 `
    -HttpsPort batch.example.com:4445 `
    -PrivateConf "C:\js7\agent-deployment\private.conf" `
    -ControllerPrimaryCert "C:\js7\agent-deployment\wintest-primary.crt" `
    -ControllerSecondaryCert "C:\js7\agent-deployment\wintest-secondary.crt" ` 
    -Keystore "C:\js7\agent-deployment\https-keystore.pfx" `
    -KeystorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) `
    -Truststore "C:\js7\agent-deployment\https-truststore.pfx" `
    -TruststorePassword ('jobscheduler' | ConvertTo-SecureString -AsPlainText -Force) ` 
    -ExecStart StartService `
    -ExecStop StopService `
    -NoInstall

# performs no installation but certificate renewal only
# specifies the Controller ID of the Controller to which the Agent is dedicated
# addresses an existing Agent operated for 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 -ControllerSecondaryCert argument is omitted
# deploys the Agent private configuration file that holds references to keystore and truststore
# deploys keystore and truststore files in PKCS12 format
# stops and starts the Agent's Windows service should the Agent be running

Patch

Patch Agent for Unix

...