Versions Compared

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

...

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.

  • Navigate In your browser navigate to the JOC Cockpit login window 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.

  • Note that the JOC Cockpit web service might take a minute to start and to display the login window.

    Image Modified


Register Controller and Agents

Once the After successful login to JOC Cockpit is login 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

Registering a Standalone

...

Controller is a straightforward task:

Image Modified

Explanation

  • The title added to for the Controller will be visible on in the JS7 - Dashboard Viewview.
  • The URL for JOC Cockpit is the URL for hostname and port of the Controller as seen by JOC Cockpit i. e URL of the COntroller by which the This URL is used by JOC Cockpit can to connect to the controller. 

Register Controller Cluster

...

  • 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 Note that the high availability feature of clustering is subject to JS7 - Licensing. Without a license fail-over/switch-over will not take place between Controller cluster members.


Explanation

  • This dialog allows specifying of to specify the Primary Controller instance,  Secondary the Secondary Controller instance and an Agent Cluster Watcher.
  • The title added to the for each Controller instance will be visible on in the JS7 - Dashboard Viewview.
  • 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 instance has to match typically includes the hostname and port that the Controller instance is operated for.
  • The Agent Cluster Watcher is required for the operation of a Controller clusterCluster. The Agent is contacted by both Controller cluster Cluster members to verify the cluster status should no direct connection between Controller cluster Cluster members be available.

      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 Profile. Click on the Action Menu of the Controller for which the agent needs to be added 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 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 Added

      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.

      ...