Versions Compared

Key

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

...

  • --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 an Agent running for the inside port 4445 is accessible with the container's hostname and the same port within the Docker network.
  • --publish The Agent is prepared to listen to the HTTP port 4445. 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 by its outside port .
  • --env=RUN_JS_JAVA_OPTIONS This allows to inject any Java options to the Agent's container. Preferably this is used to specify memory requirements of an Agent, e.g. with -Xmx256m.
  • --env=RUN_JS_USER_ID Inside the container the Agent is operated for the user account jobscheduler. In order to access e.g. log files created by the Agent 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 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 specification of individual settings for Agent operation, see the chapters below and the JS7 - Agent Configuration Items article. Default settings are available on initial operation.
      • logs: In order to have Agent 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 Agent requires a directory for journal information that should be persisted. The journal is required to restore the state of orders when restarting the Agent.
    • Docker offers a number of ways how to mount volumes to containers that include e.g. creating a local folder and mapping the folder to a volume before executing the above docker run command.:

      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-0-0-SNAPSHOT: The name of the base image is the same that was previously used with the docker pull command. Alternatively this could be sosberlin/js7:agent-2-0-0-SNAPSHOT-plus for use of a "plus" image.

Log Files

Access to log files is essential to identify 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 the JS7 - Log Files and Locations article.

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

Further Resources

Running the Agent Container from a "plus" Image

...