Versions Compared

Key

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

Table of Contents

Introduction

  • Initial Operation is performed after installation of the JS7 Agent, Controller and JOC Cockpit.
  • Operation of a JOC Cockpit Cluster requires a commercial license, see JS7 - Licensing.
  • Tasks include to apply the license key and licensed binary code.

Prerequisites

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

JOC Cockpit Cluster Checks

Check Security Level

Any JOC Cockpit cluster members have to use the same security level (low, medium, high).

To apply changes to the security level JOC Cockpit has to be reinstalled.

Check Database Connection

Any JOC Cockpit cluster members have to use the same database connection.

To apply changes modify the Hibernate configuration file hibernate.cfg.xml:

  • Unix
    • Default Location: /var/sos-berlin.com/js7/joc/resources/joc
    • A different location for the configuration directory can be specified during installation.
  • Windows
    • Default Location: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 location for the configuration directory can be specified during installation.
  • Find examples for Hibernate configuration from the JS7 - Database article.

Check Instance Settings

When installing JOC Cockpit then for each instance a title and ordering can be specified that become visible with the JS7 - Dashboard:

  • Use a different title for each JOC Cockpit instance to better distinguish instances in the dashboard.
  • Use an ordering of your choice that determines the sequence by which JOC Cockpit instances are displayed with the dashboard.

Both settings are used from the joc.properties file, find the following example:

Code Block
titleTitle and Ordering from joc.properties
collapsetrue
################################################################################
### If JOC Cockpit is used in a cluster then specify a title to identify which node
### is currently used. Further specify the ordering (Primary <= 0, Standby > 0) for
### display of JOC Cockpit instances with the Dashboard view.

title                        = PRIMARY JOC COCKPIT
ordering                     = 0

Find the joc.properties file from the following location:

  • Unix
    • Default Location: /var/sos-berlin.com/js7/joc/resources/joc
    • A different location for the configuration directory can be specified during installation.
  • Windows
    • Default Location: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 location for the configuration directory can be specified during installation.

Adding License Key and Licensed Binary Code

Customers equipped with a commercial license receive a license key from SOS and can download the binary code that allows clustering of JS7 components, see JS7 - Download.

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

Handling for Installation on premises

The following chapters can be skipped if a license key was added during installation of JOC Cockpit. The explanations apply to a situation when a license key should be added or replaced for an existing installation without updating JOC Cockpit.

Adding a License Key

  • The license key can be added during installation of each of each JOC Cockpit instance.
  • The license key can be added later on by storing the license certificate file to the following locations:
    • Unix: JOC Cockpit Configuration Directory with license sub-folder
      • Default: Location /var/sos-berlin.com/js7/joc/resources/joc/license
      • A different location for the configuration directory can be specified during installation.
    • Windows: JOC Cockpit Configuration Directory with license sub-folder
      • Default Location:C:\ProgramData\sos-berlin.com\js7\joc\resources\joc\license
      • A different location for the configuration directory can be specified during installation.

Adding 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: JOC Cockpit Installation Directory with lib/ext/joc sub-folders
      • Default Location/opt/sos-berlin.com/js7/joc/lib/ext/joc
      • A different location for the installation directory can be specified during installation.
    • Windows: JOC Cockpit Installation Directory with lib\ext\joc sub-folders
      • Default Location:C:\Program Files\sos-berlin.com\js7\joc\lib\ext\joc
      • A different location for the installation directory can be specified during installation.

Handling for Docker® Installation

Basically the same locations for license key and licensed binary code apply as explained for Unix operating systems with the previous chapters.

However, there is no access to the container's file system before running the container which makes it impossible to add or replace licensed binary code before JOC Cockpit is started.

Adding a License Key

  • The license key can be added by storing the license certificate file to the following location:

Adding 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:
    • /var/sos-berlin.com/js7/joc/jetty_base/resources/joc/lib
    • The directory /var/sos-berlin.com/js7/joc/jetty_base/resources/joc typically is mounted to a Docker config volume when running the container, for details see JS7 - JOC Cockpit Installation for Docker Containers. If the sub-directory lib does not exist then you can create it to store the js7-license.jar file.

On startup JOC Cockpit checks the above directory for existence of the js7-license.jar file. If the file is found then

  • the file will be copied to ./jetty_base/lib/ext/joc 
  • any existing version of the file in this directory is overwritten.

Initial Operation

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 root and Password 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.

Further References