Versions Compared

Key

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

...

Code Block
languagebash
titlePulling the Standard Agent Image
linenumberstrue
docker image pull sosberlin/js7:agent-2-35-20

Note: Current releases should be applied as available from https://hub.docker.com/r/sosberlin/js7

...

Code Block
languagebash
titlePulling the Plus Agent Image
linenumberstrue
docker image pull sosberlin/js7:agent-2-35-20-plus

Running the Agent Container

...

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

docker run -dit --rm \
      --hostname=js7-agent-primary \
      --network=js7 \
      --publish=16445:4445 \
      --env="RUN_JS_JAVA_OPTIONS=-Xmx256m" \
      --env="RUN_JS_USER_ID=$(id -u $USER):$(id -g $USER)" \
      --mount="type=volume,src=js7-agent-primary-var,dst=/var/sos-berlin.com/js7/agent/var_4445" \
      --name js7-agent-primary \
      sosberlin/js7:agent-2-35-20

Explanation:

  • --network The above example makes use of a Docker network - created, for example, using the command docker network create js7 - to allow network sharing between containers. Note that any inside ports used by Docker containers are visible within a Docker® network. Therefore an Agent running for the inside port 4445 is accessible in conjunction with the container's hostname and the same port within the Docker network.
  • --publish The Agent is configured to listen to HTTP port 4445 by default. An outside port of the Docker host can be mapped to the Agent's inside HTTP port. This is not required for use with a Docker network, see --network, however, it will allow direct access to the Agent from the Docker host via its outside port .
  • --env=RUN_JS_JAVA_OPTIONS This allows Java options to be injected into the Agent's container. Preferably this is used to specify memory requirements for the Agent, e.g. with -Xmx256m.
  • --env=RUN_JS_USER_ID Inside the container the Agent is operated with the jobscheduler user account. In order to access files created by the Agent such as log files, and which 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 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 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 the specification of individual settings for the operation of the Agent - see the sections below and the JS7 - Agent Configuration Items article. Default settings are available on initial operation.
      • logs: In order to have persistent Agent log files 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 Agent requires a directory for journal information that should also be persistent. The journal is required to restore the state of orders when restarting the Agent.
    • Docker offers a number of methods for mounting volumes to containers that include, for example, creating a local folder and mapping the folder to a volume before executing the 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 Agent container
      mkdir -p /home/sos/js7/js7-agent-primary/var
      docker volume create --driver local --opt o=bind --opt type=none --opt device="/home/sos/js7/js7-agent-primary/var" js7-agent-primary-var
  • sosberlin/js7:agent-2-5-0-1: The name of the base image is the same as that which was previously used with the docker pull command. Alternatively this could be sosberlin/js7:agent-2-5-0-1-plus for use of a "plus" image.

...