JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 5

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 6

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

Expand
titleagents.<agent-id>.target

agents.<agent-id>.target: optional

  • target: object, optional
    • connection: object, required
      • host: string, required
        • The hostname or FQDN to which the Agent should be deployed.
      • port: number, optional
        • The port number used for SSH connections, default: 22
    • authentication
      • method: string, required
        • Supported authentication methods include public/private key. The value publickey has to be specified.
      • user: string, required
        • The user account for SSH connection sto the target host.
      • keyFile: string, optional
        • The path to the private key file of the user account, for example /home/sos/.ssh/id_rsa.
    • packagingLocation: string, required
      • The path to a directory on the target host to which the deployment tarballs will be stored after transfer.
    • execPre: string, optional
      • Holds  a command that will be executed on the target host before extraction of deployment tarballs is performed.
      • Deployment scripts provide shell functions to start and to stop the systemd service for the Agent.
      • Specifying the command StopService will stop the Agent's systemd service.
    • execPost: string, optional
      • Holds  a command that will be executed on the target host after extraction of deployment tarballs is performed.
      • Deployment scripts provide shell functions to start and to stop the systemd service for the Agent.
      • Specifying the command StartService will start the Agent's systemd service.
    • makeService: boolean, optional
      • Specifies that a systemd service should be created or renewed for JS7 components such as the Agent. This includes that a service file is created and stored to the relevant systemd service file directory and it includes that the service will be enabled for automated start-up and shutdown.
    • serviceName: string, optional
      • Specifies the name of the systemd service and corresponding service file that will be created if the makeService setting is active.
      • The Agent's systemd service file is created in the Agent's <home>/bin directory with the file name agent_<http-port>.service. By default the file will be copied to the systemd's /usr/lib/systemd/system directory with the file name js7_agent_<http-port>.service which results in the corresponding systemd service name. Users who wish to use a different service name can use this setting. If the indicated service name does not include the .service extension then it will be added.
    • serviceDir: string, optional
      • Specifies the location of the systemd directory for service files. By default the /usr/lib/systemd/system directory will be used. An alternative location is the /etc/systemd/system directory. Users are free to specify the systemd directory that is in place on the target host.
Expand
titleagents.<agent-id>.media

agents.<agent-id>.media: required

  • media: object, required
    • release: object, required
      • The JS7 release number, for example 2.5.0
    • tarball: string, required
      • Path to the .tar.gz installation file as downloaded from the SOS Web Site.

...

Expand
titlecontrollers

controllers: optional

An array of Controller configuration objects is specified. Relevant settings correspond to the agents.<agent-id> sections.

  • <controller-id>: object, required
    • The unique identifier of a Controller is specified. If a Controller Cluster is operated then both Primary and Secondary Controller instances use the same Controller ID.
    • Any number of Controller configurations using unique Controller IDs can be specified.
    • <instance-type>: object, required
      • If a Controller Cluster is operated then separate nodes are added to the Deployment Descriptor indicating the primary and secondary instance type.
      • For a Standalone Controller a single instance type primary is specified.
      • target: see agents
      • media: see agents
      • installation: see agents
      • configuration: see agents
Expand
titlejoc

joc: optional

An array of JOC Cockpit configuration objects is specified. Relevant settings correspond to the agents.<agent-id> sections.

  • <joc-id>: object, required
    • The unique identifier of JOC Cockpit is specified. If a JOC Cockpit Cluster is operated then both Primary and Secondary JOC Cockpit instances use the same JOC Cockpit ID.
    • Any number of JOC Cockpit configurations using unique JOC Cockpit IDs can be specified.
    • <instance-type>: object, required
      • If a JOC Cockpit Cluster is operated then two separate nodes are added to the Deployment Descriptor indicating the primary and secondary instance type.
      • For a Standalone JOC Cockpit the instance type primary is specified.
      • target: see agents
      • media: see agents
      • installation: see agents
      • configuration: see agents
Expand
titlejoc.<joc-id>.installation

joc.<joc-id>.installation: required

The following settings are available in addition to what is stated with the agents.<agent-id>.installation section.

  • installation: object, required
    • setupDir: object, optional
      • Path to the directory to which the JOC Cockpit .tar.gz installation file is extracted. The directory is required to extract the installation file and to run the JOC Cockpit installer.
      • If this setting is omitted then a temporary directory will be used.
    • isUser: boolean, optional
      • Specifies that the JOC Cockpit installation will be performed for a user account, not for the root account. This setting corresponds to the -u switch that can be used when manually installing JOC Cockpit, for example using ./setup.sh -u joc_install.xml.
    • isPreserveEnv: boolean, optional
      • Specifies that during JOC Cockpit installation environment variables of the user account performing installation are passed to sudo. 
      • This corresponds to use of the sudo -E switch, for example using ./setup.sh -u -E joc_install.xml.
Expand
titlejoc.<joc-id>.configuration

joc.<joc-id>.configuration: optional

The following settings are available in addition to what is stated with the agents.<agent-id>.configuration section.

  • configuration: object, optional
    • startFiles: object, optional
      • The Jetty Servlet Container used with JOC Cockpit by default ships for HTTP connections. For use with HTTPS connections a number of configuration files are used that hold SSL related settings. All files are stored to the JETTY_BASE/start.d directory:
        • http.ini: enables/disables the Jetty HTTP module, specifies the port and optionally the network interface for HTTP connections.
        • https.ini: enables/disables the Jetty HTTPS module.
        • ssl.ini: specifies the port and optionally the network interface for HTTPS connections. In addition settings related to keystores and truststores are available.
      • httpIni: string, optional
        • Specifies the path to the http.ini file that should be copied to JOC Cockpit's JETTY_BASE/start.d directory.
        • When using HTTPS connections it is recommended to deploy a copy of the file that disables the HTTP module as HTTPS is not an invite to users to fall back to use of a less secure protocol.
        • Settings for port and network interface in this file will be updated from corresponding elements in the joc.<joc-id>.installation section.
      • httpsIni: string, optional
        • Specifies the path to the https.ini file that should be copied to JOC Cockpit's JETTY_BASE/start.d directory.
        • When using HTTPS connections it is recommended to deploy a copy of the file that enables the HTTPS module.
      • sslIni: string, optional
        • Specifies the path to the ssl.ini file that should be copied to JOC Cockpit's JETTY_BASE/start.d directory.
        • When using HTTPS connections it is recommended to deploy a copy of the file that specifies the SSL port and optionally the network interface. In addition, the file holds settings for the keystore and truststore used by Jetty.
        • Settings for port, network interface, keystore and truststore in this file will be updated from corresponding elements in the joc.<joc-id>.installation section.
    • files: object, optional
      • jocProperties: string, optional
        • Specifies the path to the joc.properties file that should be copied to JOC Cockpit's JETTY_BASE/resources/joc directory.
        • Settings for keystore and truststore in this file will be updated from corresponding elements in the joc.<joc-id>.installation section.

Resources

...