Page History

...

Usage: controller.sh command [options]
  command:
    start           [options]
    start-container [options]
    stop            [options]
    restart         [options]
    status          [options]
    cancel |      kill   [options]
    switch-over     [options]
    revert          [options] 
    cert            [cert-options]                    | see https://kb.sos-berlin.com/x/jLbAAw
  options:
    --id=<identifier>                                 | Controller ID, default: controller
    --http-port=<[interface:]port>                    | http network interface and port, default: 4444
    --https-port=<[interface:]port>                   | https network interface and port, default:
    --data-directory=<directory>                      | default: /var/sos-berlin.com/js7/controller/var
    --config-directory=<directory>                    | default: /var/sos-berlin.com/js7/controller/var/config
    --timeout=<seconds>                    | timeout          | timeout for for terminating Controller instance
    --java-options=<java options>                     | default: -Xmx500m -Dfile.encoding=UTF-8; see https://kb.sos-berlin.com/x/aIC9uYo7B
  switches: 
    -c | --curl                                       | use curl instead of Java http client
    -f | --fail-forceover                       | fail-over              | force termination active role on stop and restart
  
see https://kb.sos-berlin.com/x/CKrAAw for more information.

...

Usage: controller.cmd command [options]
  command:
    start           [options]
    start-container [options]
    stop            [options]
    restart         [options]
    status          [options]
    cancel |      kill   [options]
    switch-over     [options]
    revert          [options]
    cert            [cert-options]         |           | see httpssee https://kb.sos-berlin.com/x/jLbAAw
  options:
    --id=<identifier>                                 | Controller ID, default: controller
    --http-port=<[interface:]port>                    | http network interface and port, default: 4444
    --https-port=<[interface:]port>                   | https network interface and port, default:
    --data-directory=<directory>                      | default: C:\ProgramData\sos-berlin.com\js7\controller\controller
    --config-directory=<directory>                    | default: C:\ProgramData\sos-berlin.com\js7\controller\controller\config
    --timeout=<seconds>                    | timeout for terminating Controller instance
      | timeout for terminating Controller instance
    ---java-options=<java options>                     | default: -Xmx500m -Dfile.encoding=UTF-8; see https://kb.sos-berlin.com/x/aIC9uYo7B
  switches switches: 
    -f | --fail-forceover                       | fail-over              | force terminationactive role on stop and restart
  
see https://kb.sos-berlin.com/x/CKrAAw for more information.

...

• -c ,  --curl
  • Specifies that the curl utility should be used instead of the built-in HTTP client when sending commands to the Controller.
• -f, --fail-forceover

  • With the stop and restart commands this option forcibly terminates the Controller instancewill fail-over the active role to the Standby Controller instance.

Watchdog Script: controller_watchdog.sh, controller_watchdog.cmd

...

• 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
#stopping_controller #stopping_controller

Stopping the Controller Instance

# stop Controller instance
controller_instance.sh|.cmd stop [options]

This command will safely terminate the Controller (recommended).

• If a Controller Cluster is operated then fail-over will not occur.
• Using the --timeout command line option will terminate the Controller when the number of seconds specified for the timeout is exceeded.

# wait up to 60s and stop Controller instance
controller_instance.sh|.cmd stop --timeout=60

# fail-over active role and stop Controller instance
controller_instance.sh|.cmd abort [options]stop --fail-over

The command will terminate the ControllerThe Controller process is aborted immediately.

• If a Controller

...

• instance will take more time to terminate then the command will wait accordingly.
• If a Controller Cluster is operated then fail-over will not occur. 
• Using the --fail-over switch will fail-over the active role to the Standby Controller instance.
• Using the --timeout option will terminate the Controller instance when the number of seconds specified for the timeout is exceeded.
  • No fail-over will occur if the Controller terminates within the given timeout.
  • Fail-over will occur if the Controller does not terminate within the given timeout.
• Only one of the --timeout option and --fail-over switch can be used.

controller_instance.sh|.cmd abort [options]

The Controller process is aborted immediately

The command is deprecated and is replaced by the stop command using the --force switch or --timeout option..

controller_instance.sh|.cmd cancel | kill [options]

The Controller process is forcibly terminated. The command kill can be used as an alternative to cancel.

The behavior corresponds to sending a SIGKILL signal with a command such as kill -9 (Unix) or taskkill (Windows).

If a Controller Cluster is being operated then the command will cause fail-over.

Restarting the Controller Instance

-over.

The command is deprecated and is replaced by the stop command using the --fail-over switch.

controller_instance.sh|.cmd cancel | kill [options]

The Controller process is forcibly terminated. The command kill can be used as an alternative to cancel.

The behavior corresponds to sending a SIGKILL signal with a command such as kill -9 (Unix) or taskkill (Windows).

If a Controller Cluster is being operated then the command will cause fail-over.

Restarting the Controller Instance

# restart Controller instance
controller_instance.sh|.cmd restart [options]

# wait up to 60s and restart Controller instance
controller_instance.sh|.cmd restart --timeout=60

# fail-over active role and restart Controller instance

controller_instance.sh|.cmd restart [options]--fail-over

The Controller process is stopped and started:

• The Controller is stopped as explained in chapter Stopping the Controller Instance. This includes handling of switch-over and fail-over.
• After termination the Controller instance is started.

Only one of the --timeout option and --fail-over switch can be usedIf a Controller Cluster is operated then the command will not cause switch-over.

Checking the Controller Instance Status

...

ERROR: java.nio.file.NoSuchFileException: C:\ProgramData\sos-berlin.com\js7\controller\controller\state\session-token
...JS7 Controller(controller) not started!

Switching-over

...

the

...

Active Controller Instance

...

Code Block
language bash
controller_instance.sh|.cmd switch-over [options]

If a Controller Cluster is operated then this the command can 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.This command is applicable from the Active Controller Instance onlyfrom this Controller instance to the Standby Controller instance. The command can be executed for the active Controller instance only.

After switch-over the Controller instance is restarted.

Reverting a Controller Cluster to a Standalone Controller

...

If a Controller Cluster is operated then this the command can be executed after the Controller is stopped. The command will revert the Controller Cluster to a Standalone Controller instance.

...