Page History

...

Usage: controller.sh command [options]
  command:
    start         [options]
    start_docker  [options]
    stop          [options]
    abort         [options]
    restart       [options]
    status revoke        [options]
     kill  status        [options]
    killswitch-over   [options]
    revert   [options]
    switch-over   [options] 
    cert          [cert-options]                      | see https://kb.sos-berlin.com/x/jLbAAw
  options:
    --id=<JS7 Controller Id>                          | default: controller
    --http-port=<[hostname or ip address:]number>     | default: 4444
    --https-port=<[hostname or ip address:]number>    | default:
    --data-directory=<location of data directory>     | default: /var/sos-berlin.com/js7/controller/var
    --config-directory=<location of config directory> | default: /var/sos-berlin.com/js7/controller/var/config
    --revoketimeout=<timeout > 0, in seconds>               | only for stop; if timeout is reached then SIGKILL              | default: falseis sent
    --java-options=<java options>                     | default: -Dfile.encoding=UTF-8  -Xmx500m -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector -Dlog4j2.asyncLoggerWaitStrategy=Block; see also https://kb.sos-berlin.com/x/aIC9
see also https://kb.sos-berlin.com/x/CKrAAw for more information.

...

Usage: controller.cmd command [options]
  command:
    start           [options]
    stop       start-docker     [options]
    abort stop          [options]
    restartabort         [options]
    revokerestart          [options] 
    status          [options]
    kill            [options]
    switch-over     [options]
    install-service [options]
    remove-servicerevert  [options]
    start-service   [options]
    cert            [cert-options]                              | see https://kb.sos-berlin.com/x/jLbAAw
  options:
    --id=<JS7 Controller ID>                          | default: controller
        | default: controller
    ----http-port=<[hostname or ip address:]number>               | default: 4444
    --https-port=<[hostname or ip address:]number>              | default:
    --data-directory=<location of data directory>               | default: C:\ProgramData\sos-berlin.com\js7\controller\controller
    --config-directory=<location of config directory>           | default: C:\ProgramData\sos-berlin.com\js7\controller\controller\config
    --revoketimeout=<timeout > 0, in seconds>               | only for stop; if timeout is reached then KILL                        | default: falseis sent
    --java-options=<java options>                               | default: -Dfile.encoding=UTF-8  -Xmx500m -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector -Dlog4j2.asyncLoggerWaitStrategy=Block; see also https://kb.sos-berlin.com/x/aIC9
see also https://kb.sos-berlin.com/x/CKrAAw for more information.

...

• --id=<JS7 Controller ID>
  • Specifies a unique identifier for a Controller. Identifiers such as "controller-test", "controller-production" etc. can be used. Upper case and lower case characters are considered, the characters a-z, A-Z, 0-9, underscore and hyphen are allowed. Spaces are not allowed in a Controller ID.
  • If users intend to operate a Controller Cluster with two Controller instances for the active and for the standby cluster member, then the same Controller ID must be specified for both Controller instances as otherwise the instances will not be considered to be members of the same cluster.
• --http-port=<[hostname or ip address:]number>
  • Specifies the HTTP port which the Controller instance is listening to in order to receive requests from JOC Cockpit or a partnering Controller instance in a cluster.

    • controller.sh|.cmd command --http-port=####

    • where #### is the port number.
    • This option can be also used to indicate which network interface the JS7 Controller should listen to if a hostname or IP address is specified - for example with --http-port=myhost:4444.
  • When this option is not used the port defaults to 4444 and the Controller 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_CONTROLLER_HTTP_PORT (see below)
    • Third precedence: use of default value
• --https-port=<[hostname or ip address:]number>
  • Specifies the HTTPS port that the Controller is listening to in order to receive requests from JOC Cockpit or a pairing Controller instance in a cluster:

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

    • where #### is the port number.
    • This option can be used to indicate which network interface the Controller should listen to if a hostname or IP address is specified - for example with --https-port=myhost:4443.
    • When using the HTTPS protocol for connections from JOC Cockpit and from a pairing Controller instance the the HTTP protocol has to be allowed for local connections such as --http-port=localhost:4444. As the Controller Start Script uses a HTTP connection this protocol has to be in place to allow the Controller instance to be started, stopped etc. by its Start Script.
  • If a port is specified then the following order of precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_CONTROLLER_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 and state directories.
  • If a data directory is specified then the following order of precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_CONTROLLER_DATA (see below)
    • Third precedence: use of default value JS7_CONTROLLER_HOME\var
• --config-directory=<location of config directory>
  • Specifies the location of the config directory for configuration data.
  • If a configuration directory is specified then the following order of precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_CONTROLLER_CONFIG_DIR (see below)
    • Third precedence: use of default value JS7_CONTROLLER_DATA/config
• --timeout

  • With the stop command this option waits for the indicated number of seconds and kills the Controller if the timeout is exceeded.

• --revoke
  • Specifies that a Controller Cluster should be revoked and that the current Controller instance should be reverted to a Standalone Controller.
  • For details see JS7 - How to revert a Controller Cluster to a Standalone Controller
• --java-options=<java options>
  • This option can be used to apply Java options for the Controller, e.g. for memory settings.

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

  • 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

...

This command is applicable from the Active Controller Instance only.

Reverting a Controller Cluster to a Standalone Controller

controller_instance.sh|.cmd switch-over [options]

If a Controller Cluster is operated then this command will switch-over the active role in the Controller Cluster, more precisely the currently Active Controller Instance takes the standby role and the previous Standby Controller Instance takes the active role.

For details see JS7 - How to revert a Controller Cluster to a Standalone Controller.

Performing Certificate Rollout

...