Page History

...

• Extract the downloaded archive file to a directory.
• After extraction the resulting directory structure includes (only files and folders immediately relevant):
  • agent 
    • license.gpl (copy of  GPLv3 (General Public License) )
    • license.html, license.txt (copy of JS7 JobScheduler Commercial License Agreement)
    • ThirdParty.txt (list of 3rd party components and licenses included with the JS7 Agent)
    • bin
      • agent.cmd|sh
        • The Start Script for Windows/Unix platforms
      • agent_credential_value.cmd|sh
        • The script for access to a credential store on Windows/Unix platforms
      • agent_instance.sh-example
        • The template for the Agent Instance Start Script
      • agent_watchdog.cmd|sh
        • Restarts the Agent for Windows/Unix platforms
    • lib (directory for Java libraries)
    • service (directory for operation as a Windows Service)
    • var (configuration directory)
      
      • config (directory for configuration files)
        • agent.conf (general Agent configuration) 
        • private (directory for security related configuration files)
          • private.conf-example  (security related configuration)
            • For setting up HTTPS connections see JS7 - Agent Configuration Items
            • For setting up authentication and digital signature checks
          • trusted-pgp-keys (empty directory, can be used to add individual PGP public keys for signing, see JS7 - Secure Deployment)
          • trusted-x509-keys (directory to hold X.509 certificates for signing, see JS7 - Secure Deployment)
            • sos.intermediate-ca.pem (default certificate of SOS to allow deployment with JOC Cockpit)
      • logs (directory for log files)
      • state (directory for journal files, will be created on startup of the Agent)
      • work (directory for work files)
    • yade (directory for the YADE file transfer utility)
  • On Windows Systems:
    • You have to modify the directory permissions for the above .\logs and .\service directories if you extracted the Agent to, for example, C:\Program Files.
      • This step is not required if you extract the Agent e.g. to C:\ProgamData.

      • Start a command prompt with elevated administrative rights and execute, for example:

        Code Block
        language bash title Allow full acces for "Users" on .\service and .\logs directories
        cd "path\to\installation-directory" icacls "service" /L /grant *S-1-5-32-545:(OI)(CI)F icacls "logs" /L /grant *S-1-5-32-545:(OI)(CI)F

  • If more than one run-time instance of an Agent starting from the same Agent installation is used then every instance has to use its individual ./var_<http-port of the instance> data directory, e.g. ./var_4445, ./var_4447 etc. as each Agent instance has to use an individual port when operated on the same server.
  • To start the Agent you can use the commands explained in the JS7 - Agent - Command Line Operation article or your can automate startup from the instructions provided by the "Automated Startup and Shutdown" section below.

Update and Upgrade

Find detailed instructions from Detailed instructions are available in the JS7 - Update and Patch Management article.

Preparation

• Stop any running JS7 Agent instances. Note that more than one Agent instance can be launched from a single Agent installation.
• Prepare to rollback in case that the event of the update of the JS7 Agent is not being successful:
  • Make a backup of the Agent's installation directory and configuration directory, e.g. by creating a .tar.gz/.zip archive.
    • Installation Directory:
      • The default installation directory for the Agent is

        • /opt/sos-berlin.com/js7/agent for Unix systems,

        • C:\Program Files\sos-berlin.com\js7\agent for Windows systems.
    • Configuration Directory
      • The default configuration directory for the Agent is
        • /home/<user-account>/sos-berlin.com/js7/agent_<http-port> for Unix systems,
        • C:\ProgramData\sos-berlin.com\js7\agent_<http-port> for Windows systems.

...

# download archive (consider to useusing a current release that matches the Controller release)
curl  'https://download.sos-berlin.com/JobScheduler.2.1/js7_agent_unix.2.1.1.tar.gz' --output js7_agent_unix.2.1.1.tar.gz

# extract archive
tar xvzf js7_agent_unix.2.1.1.tar.gz

# find extracted files in the "agent" sub-directory
ls -la agent

# prepare an instance start script from the example
cd agent/bin
cp -p agent_instance.sh-example agent_4445.sh

# optionally activate/adjust environment variables in agent_4445.sh
# JS7_AGENT_HTTP_PORT=4445
# JAVA_HOME=...

# add the default certificate to verify signed workflows
cp ../var/config/private/trusted-x509-keys/* ../var_4445/config/private/trusted-x509-keys/

# run the Agent
./agent_4445.sh start

# find log output
tail -100 ../var_4445/logs/agent.log

...

• To run the Windows installer in graphical mode see see the JS7 - Agent - Installation Using the Windows Graphical Installer article.
• To Refer to the information below to run the Windows installer in headless mode consider the information below..

Installation

After extraction of the installer .zip archive the directory structure will include:

...

Running the Installer

• Running the installer of for the JS7 Agent on Windows systems

  Code Block
  language text title Running the installer of JS7 Agent on Windows systems
  C:\temp\agent.[release]> setup.cmd agent_install.xml

...

After installation the resulting directory structure will be similar to that described in the Installation from .tar.gz/.zip Archive chapter above section above.

Directories for installation and configuration of the Agent might differ.

...

• The default location of the logs directory is:
  
  • C:\ProgramData\sos-berlin.com\js7\agent_<http-port>
• Installation log files are named according to the pattern Install_V<release>_<date-time>_....log where <release> is the release number and <date-time> refers to the point in time of installation.
• For further information about logging see see the JS7 - Logging article.

Update

Preparation

• Stop any running JS7 Agent instances. Note that more than one Agent instance can be launched from a single Agent installation.
• Prepare to rollback in case the update of the JS7 Agent is not successful.
  • Make a backup of the Agent's installation and configuration directories, e.g. by creating a .zip archive.
    • Installation Directory:
      • The default installation directory for the Agent is:
        
        • C:\Program Files\sos-berlin.com\js7\agent
    • Configuration Directory
      • The default configuration directory for the Agent is:
        
        • C:\ProgramData\sos-berlin.com\js7\agent_<http-port>

...

Rolling back an Installation by the Windows Installer in Headless Mode

• To perform the a rollback of a JS7 Agent installation run the uninstaller from the command line.
  • The default location of the uninstall.cmd file is:
    
    • C:\Program Files\sos-berlin.com\js7\agent\Uninstaller
• Restore from a previous backup, e.g. by extracting the .tar.gz/.zip archive to the installation and configuration directories.
• Re-install the Windows Service from the command line:
  • Switch to the .\bin directory of the Agent installation.
    • The default location of the .\bin directory is:
      

      • C:\Program Files\sos-berlin.com\js7\agent\bin

  • Run the Agent Instance Start Script installs the Agent's Windows Service:

    agent_<http-port>.cmd install-service

...