JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 18

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 19

changes.mady.by.user Andreas Püschel

Saved on

Key

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

...

  • the shiro.ini and joc.properties files from an earlier installation will not be overwritten.
  • an existing hibernate.cfg.xml database configuration file will be considered during update and the settings will be suggested as default values. This file will be deleted and a new version of the file will be stored to the joc_home directory.
  • an update of JOC Cockpit will not overwrite any existing configuration files. However new versions of the joc.properties and shiro.ini files with the names joc.properties-example and shiro.ini-example will be stored to the resources\joc folder, alongside the original files.

Initial Operation

Operation

Having completed the installation or update of the JS7 JOC Cockpit you can start the JOC Cockpit either manually or from its Unix daemon/Windows Service, see JS7 - JOC Cockpit Command Line Operation.

Login to JOC Cockpit User Interface

Note that a working servlet container - either the Jetty provided with the JOC Cockpit or some other product - is required before the JOC Cockpit can be operated.

...

In your browser navigate to the JOC Cockpit URL and enter the User Account and Password. Typically the URL includes the hostname and port that JOC Cockpit has been installed for:

  • For example, http://myhost:4446. Please check that the JOC Cockpit port is accessible which might include to add firewall rules to allow access to this port from the computer that you operate the browser for.

  • After initial installation of JOC Cockpit the default User Account and Password of root:root will be available if no changes have been made to the shiro.ini configuration file.

...

Note that the root user is assigned the all role in the default configuration that includes any available permissions.
See the Authentication and Authorization - Configuration article for information about the configuration of other user profiles and authentication methods.

A number of JOC Cockpit instances can be operated as a passive cluster with the first JOC Cockpit instance started acting as the primary cluster member and any additional JOC Cockpit instances acting as standby cluster members. The role of the primary cluster member is decided by the order by which JOC Cockpit instances are started.

  • Consider that operating a JOC Cockpit cluster for high availability requires a commercial license, see JS7 - Licensing.
  • The installation of JOC Cockpit Cluster instances follows the standard operating procedures explained above, there is no difference in installation considering the roles of primary cluster member and standby cluster members. 
  • Consider the following information about initial cluster operation:

Deinstallation

The JOC Cockpit can be uninstalled using the uninstall.cmd

...

Register Controller and Agents

After successful login to JOC Cockpit a dialog window appears. This window asks to register a Controller. You will find the same dialog later on from the User -> Manage Controllers/Agents menu item.

You have a choice to register a Standalone Controller (n scope of the JS7 Open Source License) or a Controller Cluster for high availability (requires a JS7 Commercial License, see JS7 - Licensing).

Register Standalone Controller

...

  • The title added for the Controller will be visible in the JS7 - Dashboard view.
  • The URL for JOC Cockpit is the hostname and port of the Controller as seen by JOC Cockpit. This URL is used by JOC Cockpit to connect to a Controller.
  • Consider that the Controller's port is accessible which might include to add firewall rules to allow access to this port from the server that JOC Cockpit is operated for.

Register Controller Cluster

A Controller Cluster implements high availability for automated fail-over should a Controller instance be terminated or become unavailable.

Note that high availability by clustering is subject to JS7 - Licensing. Without a license fail-over/switch-over will not take place between Controller cluster members.

Image Removed

Explanation

  • This dialog allows to specify the Primary Controller instance, the Secondary Controller instance and an Agent Cluster Watcher.
  • The title added for each Controller instance will be visible in the JS7 - Dashboard view.
  • Primary and Secondary Controller instances require a URL as seen from JOC Cockpit. This URL is used by JOC Cockpit to connect to the Controller instances respectively.
  • The URL of the Controller typically includes the hostname and port that the Controller instance is operated for.
  • The Agent Cluster Watcher is required for operation of a Controller Cluster. The Agent is contacted by both Controller Cluster members to verify the cluster status should no direct connection between Controller Cluster members be available.
    • The Agent is assigned an Agent ID which is a unique identifier for this Agent that cannot be modified during lifetime of an Agent. Change of the Agent ID requires to remove and to add the Agent with JOC Cockpit, it is not required to uninstall/reinstall an Agent.
    • The Agent Name is a unique identifier that is used for example in the Configuration view to assign Agents to jobs. The Agent Name can be modified later on.
    • The Agent URL is the hostname and port for which the Agent is operated.
  • Consider that the following connections should be accessible which might include to add firewall rules to allow access to the ports:
    • JOC Cockpit connection to the Primary Controller host and port.
    • JOC Cockpit connection to the Secondary Controller host and port.
    • Primary Controller connection to the Secondary Controller host and port.
    • Secondary Controller connection to the Primary Controller host and port.
    • Primary Controller connection to the Cluster Watcher Agent host and port.
    • Secondary Controller connection to the Cluster Watcher Agent host and port.

Register Agents

After the connection between JOC Cockpit and the Controller is established you can add Agents. To register an Agent switch to the Manage Controller/Agents view from the user menu. Click on the Action Menu of the Controller for which an Agent should be registered and select Add Agent.

Image Removed

Explanation: 

  • The Agent is assigned an Agent ID which is a unique identifier for this Agent that cannot be modified during the lifetime of an Agent. Change of the Agent ID requires to remove and to add the Agent with JOC Cockpit, it is not required to uninstall/reinstall an Agent.
  • The Agent Name is a unique identifier that is used for example in the Configuration view to assign Agents to jobs. The Agent Name can be modified later on
  • In addition, you can add Agent Alias Names to make the same Agent available by different names.
  • The Agent URL is the hostname and port for which the Agent is operated.

Configuration

The JOC Cockpit offers a number of configuration items that can be used to configure JOC Cockpit. Find details from the JS7 - JOC Cockpit Configuration Items article.

Deinstallation

The JOC Cockpit can be uninstalled using the uninstall.cmd and uninstall.sh scripts available from the following locations:

  • For Unix systems:
    • /opt/sos-berlin.com/js7/joc/Uninstaller
  • For Windows systems:
    • C:\Program Files\sos-berlin.com\js7\joc\Uninstaller

Windows systems

...

    • /Uninstaller
  • For Windows systems:

...

    • ...

        • C:\Program Files\

      ...

        • sos-berlin.com\js7\joc\Uninstaller

      Unix Systems

      If the checkbox is not selected, configuration files will be left in both the JOC Cockpit installation folder and the Jetty servlet container installation folder (if installed with the JOC Cockpit).

      ...

      The uninstall script on Unix systems runs in headless mode. The uninstall script will start the Uninstaller and remove both the program filesinstallation directory, configuration files directory and respective sub-folders. 

      Cluster Operation

      Please consider that operating a JOC Cockpit cluster for high availability requires a commercial license, see JS7 - Licensing.

      A number of JOC Cockpit instances can be operated as a passive cluster with the first JOC Cockpit instance started acting as the primary cluster member and any additional JOC Cockpit instances acting as standby cluster members. The role of the primary cluster member is decided by the order by which JOC Cockpit instances are started.

      The installation of JOC Cockpit instances follows the standard operating procedures explained above, there is no difference in installation considering the roles of primary cluster member and standby cluster members. 

      ...

      Windows Systems

      Starting the uninstaller will display the following window on Windows systems:

      Image Added

      Selecting the "Force the deletion of C:\Program Files\ ...." checkbox will cause the uninstall script to remove boththe program and configuration files and folders.

      If the checkbox is not selected, configuration files will be left in both the JOC Cockpit installation folder and the Jetty servlet container installation folder (if installed with the JOC Cockpit).

      Automated Startup and Shutdown

      For Unix systems , the start-up startup and shutdown configurations apply that are executed by root, the root account e.g. in from /etc/init.d or corresponding locations scripts and by use of systemd.

      • The JOC Cockpit will start for the user account that is specified during installation. The JOC Cockpit start script jetty.sh|cmd will switch to this account independently from the fact that the start script is executed e.g.  by the root account.
      • For use with systemd find a sample service file from ./bin/joc.service-example file.

      For Windows systems operation of the JOC Cockpit by a Windows Service is recommended as such services can be configured to start/stop automatically on server start-up and shutdownstartup and shutdown.

      • Consider to assign a service account to the JOC Cockpit service with the Windows Service Panel.
      • Consider to allow the JOC Cockpit service to be automatically started on server startup.

      Further References

      Installation with other servlet containers: