Versions Compared

Key

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

...

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

The steps to required are summarised below, for details see JS7 - FAQ - How to apply a JS7 License Key

...

The following chapters can be skipped if a license key was added when using the Windows installer for the Controller. However, the steps described are required when a license key for an existing installation is to be added or replaced for an existing installation without updating the Controller.

...

  • 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 in the following locations:
    • Unix: Controller Configuration Directory with license sub-folder
      • Default Location: /var/sos-berlin.com/js7/controller/config/license
      • A different location for the configuration directory can be specified during installation.
    • Windows: Controller Configuration Directory with license sub-folder
      • 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.

...

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

Note that there is no access to the container's file system before the container is running, which makes it impossible to add or replace licensed binary code before the Controller is has been started.

Adding a License Key

...

  • Binary code for clustering is available from the js7-license.jar file, which can be obtained 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 in the following locations:
    • /var/sos-berlin.com/js7/controller/config/lib
    • The directory /var/sos-berlin.com/js7/controller typically is mounted in a Docker var volume when running the container: for details see JS7 - Controller Installation for Docker Containers.
    • If the sub-directory config/lib does not exist then you can create it before storing the js7-license.jar file.

...

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

    • For example, http://myhost:4446. Check that the JOC Cockpit port is accessible. This might require adding firewall rules to allow access to this port from the computer that you operate the browser on.

    • 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 and posesses all 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.

...

Explanation

  • This dialog allows to specify the Primary Controller instance, the Secondary Controller instance and an Agent Cluster Watcher to be specified.
  • The title added for each Controller instance will be visible shown 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 relevant 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 a direct connection between Controller Cluster members not be available.
    • The Agent is assigned an Agent ID which is a unique identifier for this Agent that and cannot be modified during lifetime of an Agent. Change of the Agent ID requires to remove and to add the removal and readdition of the Agent with JOC Cockpit, it . It is not required necessary to uninstall/reinstall an the Agent.
    • The Agent Name is a unique identifier that is used for example in the JOC Cockpit 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 Note that the following connections should be accessible which might include to add accessible and that this might require the addition of 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.

...

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.

...

  • 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 removal of and readdion of the Agent with the JOC Cockpit, it . It is not required necessary to uninstall/reinstall an the 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 includes the protocol, the hostname and port for which the Agent is operated.

...