Skip to end of metadata
Go to start of metadata

Pulling the Controller Image

Pull the version of the Controller image that corresponds to the JS7 release in use:

Pulling the Controller Image
docker image pull sosberlin/js7:controller-2-0-0-SNAPSHOT

Running the Controller Container

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


Running the Controller Container for HTTP Connections
#!/bin/sh

docker run -dit --rm \
      --user="$(id -u $USER):$(id -g $USER)" \
      --hostname=js7-controller-primary \
      --network=js7 \
      --publish=15444:4444 \
      --env="RUN_JS_JAVA_OPTIONS=-Xmx256m" \
      --env="RUN_JS_ID=jobscheduler" \
      --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

Explanations:

  • --user Inside the container the Controller instance is operated for the user account jobscheduler. In order to access e.g. log files created by the Controller instance that are 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 --user option accepts the user ID and group ID of the account that will be mapped. The above example makes use of the current user.
  • --network The above example makes use of a Docker network - created e.g. with the command docker network create js7 - to allow network sharing between containers. Consider 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 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 its outside port .
  • --env=RUN_JS_JAVA_OPTIONS This allows to inject any Java options to 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 in a cluster that use the same Controller ID.
  • --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 to specify individual settings for Controller operation, see below chapters and the JS7 - Controller Configuration Items article. Default settings are available from initial operation..
      • logs: In order to have 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 persisted. The journal is required to restore the state of orders when restarting the Controller.
    • Docker offers a number of ways how to mount volumes to containers that include e.g. to create a local folder and to map the folder to a volume before executing the above docker run command:


      Example how to create Docker volumes
      # 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

Further Resources

Configure the Controller

Consider that it is not required to configure the Controller - it runs out-of-the-box. The default configuration includes that

  • deployment of objects, e.g. 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.

Users who intend to operate a compliant and secure job scheduling environment or who wish to operate the Controller as a cluster for high availability are suggested the JS7 - Controller Configuration for Docker Containers article series.

Build the Controller Image

User who wish to create individual images of the Controller find instructions with the JS7 - Controller Build for Docker Image article.



  • No labels
Write a comment…