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, for example, using the 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 JOC Cockpit instance running for the inside port 4446 can be accessed with the container's hostname and the same port within the Docker network.
  • --publish The JOC Cockpit has been configured to listen to the HTTP port 4446. An outside port of the Docker host can be mapped to the JOC Cockpit inside HTTP port. This is not required for use with a Docker network, see --network, however. However, it will allow direct access to the JOC Cockpit from the Docker host via its outside port .
  • --env=RUN_JS_JAVA_OPTIONS This allows any Java options to be injected into the JOC Cockpit container. Preferably this is used to specify memory requirements of the JOC Cockpit, for example,  with -Xmx256m.
  • --env=RUN_JS_USER_ID Inside the container the JOC Cockpit is operated by the jobscheduler user account. In order to access, for example, log files created by the JOC Cockpit, which are mounted to the Docker host, it is recommended that you map the account that is starting starts 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 example above makes use of the current user.
  • --mount The following volume mounts are suggested:
    • config: The optional configuration folder allows specification of individual settings for JOC Cockpit operation , - see the chapters sections below and the JS7 - JOC Cockpit Configuration Items article. Without this folder the default settings are used.
    • logs: In order to make JOC Cockpit log files persistent 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.
    • Docker offers a number of ways of mounting or binding volumes to containers including, for example, creation of local directories and binding them to volumes like this:

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

      There are alternative ways how to achieve of achieving this. As a result you should have a access to the directories /var/sos-berlin.com/js7/joc/resources/joc and /var/log/sos-berlin.com/js7/joc inside the container and data in both locations should be persistent. If volumes are not created before running the container then they will be mounted automatically. However, you should have access to data in the volumes, e.g. by access to /var/lib/docker/volumes/js7-joc-primary-config etc.

...

JOC Cockpit requires a database connection, see JS7 - Database.

The database connection is should be configured before the initial start of the JOC Cockpit container.

The following chapterssections can be skipped when using the H2® embedded database to evaluate JS7. Here it is sufficient to have the Hibernate configuration ready as this database runs in pre-configured mode inside the container.

...

  • JDBC Drivers for use with H2®, MariaDB®, MySQL®, Oracle®, PostgreSQL® are included with JS7.
    • For details about JDBC Driver versions see the JS7 - Database article.
    • Should you have a good reason to use a different version of a JDBC Driver then you can apply the JDBC Driver version of your choice.
  • For use with Microsoft SQL Server®
    • the JDBC Driver has to be downloaded by the user as it cannot be bundled with open source software due to license conflicts.
  • You can download JDBC Drivers from vendor's sites and store the resulting *.jar file(s) in the following location:
    • Location in the container: /var/sos-berlin.com/js7/joc/resources/joc/lib
    • Consider accessing this directory from the volume that is mounted when running the container, e.g. , for example, from a local folder /home/sos/js7/js7-joc-primary/config/lib.
    • Refer to the JS7 - Database article for details about the proceedingprocedure.

Configure the Database Connection

...

  • For examples how to set up the database see see the JS7 - Database article.

In a second step the database connection has to be specified from a Hibernate configuration file:

...

During installation JOC Cockpit can be configured:

  • not to create database objects by the installer,
  • to create database objects by the installer,
  • on start-up.to check if database objects exist and otherwise to create them on-the-fly.

...

  • docker exec -ti is the command that connects to the JOC Cockpit container js7-joc-primary.
  • js7-joc-primary is the name of the JOC Cockpit container as specified in the docker run command mentioned above.
  • /bin/sh -c runs a shell inside the container and executes a script to install and to populate the database objects required for operation of the JOC Cockpit.
  • Note that there is no harm in re-running the script a number of times as it will not remove existing data from the database.

Time Service

It is required to operate necessary that a time service is operated on the docker host that which runs the JOC Cockpit in order to synchronize the system clock's time.

...

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.

...

Accessing JOC Cockpit from your Browser

ExplanatiosExplanations:

  • For the JOC Cockpit URL: in most situations you can use the host name of the Docker host and the port that was specified when starting the container.  
    • From the example above this could be http://centostest_primary.sos17446 if centostest_primary.sos were is your Docker host and 17446 were the outside HTTP port of the container.
    • Note that the Docker host has to allow incoming traffic to the port specified. This might require adjustment of the port or the creation of firewall rules.
  • By default JOC Cockpit ships with the following credentials:
    • User Account: root
    • Password: root

Register Controller and Agents

After login logging in a dialog window pops up that asks for the registration of a Controller. You will find the same dialog later on in the User -> Manage Controllers/Agents menu.

You have a choice of registering a Standalone Controller or registering a Controller Cluster for high availability (requires JS7 - License).

Register Standalone Controller

...

  • This Primary Controller instance, Secondary Controller instance and Agent Cluster Watcher are specified in this dialog.
    • You can add a title for each Controller instance that which will be shown in the JS7 - Dashboard View view.
    • Primary and Secondary Controller instances require a URL as seen from the JOC Cockpit.
    • In addition, a URL can be specified for each Controller instance to allow it to be accessed by its partner cluster member.
      • Typically the URL used between Controller instances is the same as the URL used by the JOC Cockpit.
      • Should you operate e.g. a proxy server between Primary and Secondary Controller instances then the URL for a given Controller instance to access its partner cluster member might be different from the URL used by the JOC Cockpit.
  • The URL of the Controller instance has to match the hostname and port that the Controller instance is operated on.
    • Should you use a Docker network then all containers will "see" each other and all inside container ports are accessible within the network.
      • In the above example a Docker network js7 was used and the Primary Controller container was started with the hostname js7-controller-primary. The Secondary Controller was started with the hostname js7-controller-secondary.
      • The port 4444 is the inside HTTP port of the Controller instance that is visible in the Docker network.
    • IF If you are not using a Docker network then you are free to how decide how to map hostnames:
      • The Controller container could be accessible from the Docker host, i.e. you would specify the hostname of the Docker host. 
      • The outside HTTP port of the Controller instance has to be used that was specified with the --publish option when starting the Controller container.
  • The Agent Cluster Watcher is required for operation of a Controller cluster. The Agent is contacted by Controller cluster members to verify the cluster status should no if direct connection between Controller cluster members be is not available.
    • Note that the example above makes use of an Agent that by default is configured for use with HTTP connections. 
    • For use of the Agent's hostname and port the same applies as for Controller instances.

...

Users who intend to operate a compliant and secure job scheduling environment or who wish to operate JOC Cockpit as a cluster for high availability are recommended to familiarize themselves with the JS7 - JOC Cockpit Configuration for Docker Containers article series.

...