Page History

...

• --http-port=<[hostname or ip address:]number>
  • Specifies the HTTP port that the Agent is listening to in order to receive requests from a JS7 Controller:

    • agent.sh|.cmd --http-port=####

    • where #### is the port number.
    • This option can be used to indicate which network interface the JS7 Agent should listen to if a hostname or IP address is specified, for example with --http-port=myhost:4445.
  • Without this option being used the port defaults to 4445 and the Agent listens to all available network interfaces.
  • If a port is specified then the following order of precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_AGENT_HTTP_PORT (see below)
    • Third precedence: use of default value
• --https-port=<[hostname or ip address:]number>
  • Specifies the HTTPS port that the Agent is listening to in order to receive requests from a Controller:

    • agent.sh|.cmd command --https-port=####

    • where #### is the port number.
    • This option can be used to indicate which network interfaces the Agent should listen to if a hostname or IP address is specified, for example, with --https-port=myhost:4445.
  • When using the HTTPS protocol for connections from a Controller instance consider additionally allowing the HTTP protocol for local connections as with --http-port=localhost:4445. As the Agent Start Script makes use of an HTTP connection this protocol has to be in place to allow the Agent to be started, stopped, etc. by its Start Script.
  • Without this option being used the port defaults to 4445 and the Agent listens to all available network interfaces.
  • If a port is specified then the following order of precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable SJS7_AGENT_HTTPS_PORT (see below)
    • Third precedence: use of default value
• --data-directory=<location of data directory>
  • Specifies the location of the data directory that usually includes the config, logs, tmp and state directories.
  • This location has to be unique for any Agent instance.
  • If a data directory is specified then the following order of precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_AGENT_DATA (see below)
    • Third precedence: use of default value JS7_AGENT_HOME/var_<JS7_AGENT_PORT>
• --config-directory=<location of config directory>
  • Specifies the location of the config directory for configuration data.
  • This location has to be unique for any Agent instance.
  • Should a configuration directory be specified then the following order of precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_AGENT_CONFIG_DIR (see below)
    • Third precedence: use of default value JS7_AGENT_HOME/var_<JS7_AGENT_PORT>
• --sigkill

  • With the stop and restart commands this option kills terminates any running processes of jobs by use of a SIGKILL signal. See explanations to the --sigkill-delay option.

  • The option is available for Agents running on Unix.
• --sigkill-delay
  • Specifies the delay for killing job processes in case the Agent is killedterminated. A value --sigkill-delay=3s5 will specify 5 seconds. Default: 3 seconds.
  • In a situation when the Agent is crashed or is terminated using the --sigkill switch, the Agent's Watchdog Script will terminate remaining job processes and child processes of jobs..
    • if the --sigkill-delay option specifies a positive, non-zero value
      • send all processes and child processes created by the Agent the SIGTERM signal,
      • wait for the period specified with the --sigkill-delay option,
    • send remaining job processes and child processes the SIGKILL signal.
  • The option is available for Agents running on Unix.
  • This option is available starting from release 2.7.2, see

    Jira
    server SOS JIRA columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-2148

• --timeout

  • With the stop command this option waits for the indicated number of seconds and kills the Agent including any running processes of jobs if the timeout is exceeded.

• --kill-script=<location of kill script>

  • The kill script provides the functionality to kill tasks and any child processes of jobs.

  • Kill scripts are by default provided from the following locations:
    

    • JS7_AGENT_DATA/work/kill_task.sh for Unix.

    • JS7_AGENT_DATA\work\kill_task.cmd for Windows.

  • This option can be used to specify the location of an individual kill script if required.

  • Should an individual kill script be specified then the following order of precedence applies:

    • First precedence: command line option
    • Second precedence: environment variable JS7_AGENT_KILL_SCRIPT (see below)
    • Third precedence: use of default value
  • Starting from release 2.7.2 this option is ignored, see 

    Jira
    server SOS JIRA columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-2148

• --java-options=<java options>

  • This option can be used to apply Java options for the Agent, e.g. for memory settings.

  • Without this option being used the Java options default to -Xms100m.

  • In order to specify a number of Java options quotes have to be used like this:
    • --java-options="-Xms100m -Xmx1g"

  • When specifying Java options then the following order of precedence applies:

    • First precedence: command line option
    • Second precedence: environment variable JAVA_OPTIONS (see below)
    • Third precedence: use of default value
• --job-java-options=<java options>
  • This option can be used to specify Java options for Shell jobs that load a JVM. This option does not apply to jobs derived from JS7 - Job Templates that are executed in the Agent's JVM.
  • In order to specify a number of Java options quotes have to be used like this:
    • --job-java-options="-Xms100m -Xmx1g"

  • When specifying Java options for execution with Shell jobs then the following order of precedence applies:

    • First precedence: command line option
    • Second precedence: environment variable JS7_AGENT_JOB_JAVA_OPTIONS (see below)

...

• The command will keep the start script running as PID 1 in order to receive later stop/kill signals (SIGTERM, SIGKILL) from the container management software.
• The command start-docker is an alias for start-container.

• Jira
  server SOS JIRA columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key SET-223

Anchor
#stop_agent #stop_agent

Stopping the Agent

agent_4445.sh|.cmd stop [options]

...

• The Agent waits for running processes of any jobs to be completed.
• Using the --sigkill command line option in a Unix environment will immediately terminate any running job processes and will terminate the Agent normally and will kill any running processes.
• Using the --timeout command line option will terminate the Agent and will kill any running processes when the timeout is exceededwait for the indicated timeout that the Agent terminates. If the timeout is exceeded and if the Agent is still running then jobs are focibly terminated.
• Termination of jobs and of the Agent are performed by the Watchdog Script using the following actions:
  
  • collect PIDs of job processes,
  • if the --sigkill-delay option is used
    • send SIGTERM signal to remaining job processes for which PIDs have been collected,
    • wait for the indicated delay,
  • send SIGKILL signal to remaining job processes and child processes.
  • terminate the Agent.

agent_4445.sh|.cmd abort [options]

...

• Any running tasks and child processes of jobs are killed terminated immediately with a SIGKILL signal.
• Should tasks use resources such as database connections then they will not be properly closed.

...

agent_4445.sh|.cmd kill [options]

The Agent process is killedterminated.

• This corresponds to sending a SIGKILL signal with a kill -9  command (Unix) or taskkill command (Windows).
• Should jobs be running that start detached child processes then it is not guaranteed that child processes will be killed.

Anchor
#restart_agent #restart_agent

Restarting the Agent

agent_4445.sh|.cmd restart [options]

This The command will safely restart the Agent (recommended).

• The Agent waits for running processes of any jobs to be completed.
• Using the --sigkill  or --timeout command line option options will terminate the Agent normally, kill any running job processes and restart will terminate the Agent as explained in chapter Stopping the Agent.
• After termination the Agent will be restarted.

Anchor
#status_agent #status_agent

Checking the Agent Status

agent_4445.sh|.cmd status [options]

The command reports the status of an Agent being started. Use of the -c or --curl option prefereably will use the curl utility, otherwise the built-in Java HTTP Client is used.

If the Agent is up and running then this command results in output such as:

version: 2.0.0-alpha.20210722.2 (2021-07-22)
buildId: QQqWYNiJRbqcYqx4iiFWww
startedAt: 1626981330629
isTerminating: false
system:
  hostname: agent-2-0-primary
  distribution: Alpine Linux v3.13
  cpuModel: Intel(R) Xeon(R) CPU E5-2630 v4 @ 2.20GHz
  mxBeans:
    operatingSystem:
      availableProcessors: 8
      systemLoadAverage: 0.0107421875
java:
  version: 1.8.0_292
  memory:
    maximum: 954728448
    total: 289931264
    free: 87118936
  systemProperties:
    java.vendor: IcedTea
    os.arch: amd64
    java.runtime.name: OpenJDK Runtime Environment
    os.version: 3.10.0-957.1.3.el7.x86_64
    os.name: Linux
    java.vm.name: OpenJDK 64-Bit Server VM
    java.version: 1.8.0_292

Anchor
#cert_agent #cert_agent

Performing Certificate Rollout

agent_4445.sh|.cmd cert [cert-options]

...