Versions Compared

Key

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

...

  • 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)
            • 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 e.g. 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 e.g.

          Code Block
          languagebash
          titleAllow 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 with the JS7 - Agent - Command Line Operation article or your can automate startup from the instructions provided by the below chapter "Automated Startup and Shutdown".

Update and Upgrade

Find detailed instructions from JS7 - Update and Upgrade.

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 update of the JS7 Agent is not 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-portfor Unix systems,
          • C:\ProgramData\sos-berlin.com\js7\agent_<http-portfor Windows systems.

...

  • 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 JS7 - Logging.

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>

...

...