You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Introduction

  • Initial Operation is performed after installation of the JS7 components.
  • Operation of a Controller Cluster and of a JOC Cockpit Cluster requires a commercial license, see JS7 - Licensing.
  • Tasks include to apply the license key and licensed binary code.
  • Tasks include to register the Controller Cluster and Agents.
  • This optionally includes to adjust global settings to your needs.

Prerequisites

Initial Operation requires that a Controller, Agent and JOC Cockpit are successfully installed and are up and running.

Controller Cluster

xxxx

Check Controller ID

  • Both Controller instances for a Cluster are installed with the same Controller ID that is a unique identifier for a Controller Cluster.
    • Changing the Controller ID requires to reinstall the Controller instances by applying the following steps to each instance:
      • Stop the Controller service, see JS7 - Controller - Command Line Operation.
      • Remove Controller journal files
        • The journal files have to be removed from the configuration directory with the state folder which implies that any submitted orders for workflows will be removed and that workflows have to be redeployed:
          • Unix: rm -f /var/sos-berlin.com/js7/controller/state/*
          • Windows: del C:\ProgramData\sos-berlin.com\js7\controller\state\*
        • Consider that a different configuration directory can be specified during installation.
      • Modify Controller ID
      • Restart the Controller instance.

x

  • The secondary Controller is using the following configuration from its config/controller.conf file, see JS7 - Controller Configuration Items:
    • Apply the following line to this file:
      • js7.journal.cluster.nodes.is-backup=yes
    • If changes to the above configuration are required then the
      • its config/controller.conf file
      • The journal files have to be removed from the configuration directory with the state folder which implies that any submitted orders for workflows will be removed and that workflows have to be redeployed:
      • Consider that a different configuration directory can be specified during installation.
      • x

JOC Cockpit Cluster

License Key and Licensed Binary Code

Customers equipped with a commercial license receive both a license key from SOS and the binary code that allows clustering of JS7 components.

Find below the summary information, for details see JS7 - FAQ - How to apply a JS7 License Key

Adding a License Key

  • The license key can be added during installation of each Controller instance and of each JOC Cockpit instance.
  • The license key can be added later on by storing the license certificate file to the following locations:
    • Unix
      • Controller Configuration Directory with license sub-folder
        • Default: /var/sos-berlin.com/js7/controller/config/license
        • A different configuration directory can be specified during installation.
      • JOC Cockpit Configuration Directory with license sub-folder
        • Default: /var/sos-berlin.com/js7/joc/resources/joc/license
        • A different configuration directory can be specified during installation.
    • Windows
      • Controller Configuration Directory with license sub-folder
        • Default: C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>\config\license
          • where <controller-id> is the unique identifier for the Controller that is specified during installation.
        • A different configuration directory can be specified during installation.
      • JOC Cockpit Configuration Directory with license sub-folder
        • Default: C:\ProgramData\sos-berlin.com\js7\joc\resources\joc\license
        • A different configuration directory can be specified during installation.

Applying Licensed Binary Code

  • Binary code for clustering is available from the js7-license.jar file that is offered from JS7 - Download.
  • By downloading the binary code for clustering you consent with the license terms for a commercial license of JS7.
  • The js7-license.jar file has to be stored to the following locations:
    • Unix
      • Controller Installation Directory with lib/user_lib sub-folders
        • Default: /opt/sos-berlin.com/js7/controller/lib/user_lib
        • A different installation directory can be specified during installation.
      • JOC Cockpit Installation Directory with lib/ext/joc sub-folders
        • Default: /opt/sos-berlin.com/js7/joc/lib/ext/joc
        • A different installation directory can be specified during installation.
    • Windows
      • Controller Installation Directory with lib\user_lib sub-folders
        • Default: C:\Program Files\sos-berlin.com\js7\controller\lib\user_lib
        • A different installation directory can be specified during installation.
      • JOC Cockpit Installation Directory with lib\ext\joc sub-folders
        • Default: C:\Program Files\sos-berlin.com\js7\joc\lib\ext\joc
        • A different installation directory can be specified during installation.

Login to JOC Cockpit User Interface

  • 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.

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

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

Registering a Standalone Controller is a straightforward task:



Explanation

  • 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.


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.

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.


  • No labels