Versions Compared

Key

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

...

After pulling the Controller image you can run the container with a number of options like thissuch as:


Code Block
languagebash
titleRunning the Controller Container for HTTP Connections
linenumberstrue
#!/bin/sh

docker run -dit --rm \
      --hostname=js7-controller-primary \
      --network=js7 \
      --publish=15444:4444 \
      --env="RUN_JS_JAVA_OPTIONS=-Xmx256m" \
      --env="RUN_JS_ID=jobscheduler" \
      --env="RUN_JS_USER_ID=$(id -u $USER):$(id -g $USER)" \
      --mount="type=volume,src=js7-controller-primary-var,dst=/var/sos-berlin.com/js7/controller/var" \
      --name js7-controller-primary \
      sosberlin/js7:controller-2-0-0-SNAPSHOT

...

  • --network The above example makes use of a Docker network - created e.g. with the command docker network create js7  command - to allow network sharing between containers. Note that any inside ports used by Docker containers are visible within a Docker network. Therefore a Controller instance running for the inside port 4444 is accessible with can be accessed using the container's hostname and the same port within the Docker network.
  • --publish The Controller is prepared to listen to the HTTP port 4444. An outside port of the Docker host can be mapped to the Controller's inside HTTP port. This is not required for use with a Docker network, see --network, however, it will allow direct access to the Controller from the Docker host by through its outside port .
  • --env=RUN_JS_JAVA_OPTIONS This allows to inject any Java options to be injected into the Controller's container. Preferably this is used to specify memory requirements of a Controller, e.g. with -Xmx256m.
  • --env=RUN_JS_ID This setting specifies the Controller ID that is a unique identifier for either a standalone Controller instance or for both the primary Controller instance and secondary Controller instance instances in a cluster that use the same a common Controller ID.
  • --env=RUN_JS_USER_ID Inside the container the Controller is operated for with the jobscheduler user account jobscheduler. In order to access e.g. , for example, log files created by the Controller that are and mounted to the Docker host it is recommended that you map the account that is starting the container to the jobscheduler account inside the container. The RUN_JS_USER_ID environment variable accepts the user ID and group ID of the account that will be mapped. The above example makes use of example listed above uses the current user.
  • --mount The following volume mounts are suggested:
    • var: This folder works as an entry point to the following sub-folders:
      • config: The configuration folder allows specification of  individual settings for Controller operation, see below the chapters lsited and the JS7 - Controller Configuration Items article. Default settings are available from initial operation..
      • logs: In order to have persistent Controller log files persisted they have to be written to a volume that is mounted for the container. Feel free to adjust the volume name from the src attribute, however, the value of the dst attribute should not be changed as it reflects the directory hierarchy inside the container.
      • state: The Controller requires a directory for journal information that should be persistedpersistent. The journal is required to restore the state of orders when restarting the Controller.
    • Docker offers a number of ways of mounting volumes to containers that include e.g. , which include, for example, creating a local folder and mapping the folder to a volume before executing the above  docker run command listed above:

      Code Block
      languagebash
      titleExample how to create Docker volumes
      linenumberstrue
      # example to map volumes to directories on the Docker host prior to running the Controller container
      mkdir -p /home/sos/js7/js7-controller-primary/var
      docker volume create --driver local --opt o=bind --opt type=none --opt device="/home/sos/js7/js7-controller-primary/var" js7-controller-primary-var

...

Access to log files is essential to identify for identifying problems during installation and operation of containers.

When mounting a volume for log files as explained above you should have access to the files indicated with in the JS7 - Log Files and Locations article.

  • The controller.log file reports general information, warnings and errors.
  • The watchdog.log file includes information about automated restarts of the Controller.

Initial Operation

Consider Note the following information about initial operation:

...

Note that it is not necessary to configure the Controller - it runs out-of-the-box. The default configuration specifies that

  • deployment of objects , e.g. such as workflows and jobs , is not subject to compliance requirements such as non-repudiation.
  • HTTP connections are used that expose unencrypted communication between JOC Cockpit and Controller. Authentication is performed by hashed passwords.

...