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 have been successfully installed and are up and running.
- Note that a JOC Cockpit Cluster requires that two or more JOC Cockpit instances have been installed.
- For details see JS7 - Installation
- The steps for initial operation are the same for all supported platforms:
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.
- Default Location:
- Windows
- Default Location:
C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>\config
- where
<controller-id>
is the unique identifier for the Controller that is specified during installation.
- where
- A different location for the configuration directory can be specified during installation.
- Default Location:
- Hibernate configuration examples can be found in the JS7 - Database article.
Check Instance Settings
When installing JOC Cockpit then for each instance a title and ordering can be specified, which will be shown in 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 in the dashboard.
Both settings are made in the joc.properties
file, as shown in the following example:
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.
- Default Location:
- 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.
- where
- A different location for the configuration directory can be specified during installation.
- Default Location:
Adding License Key and Licensed Binary Code
Customers possessing 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.
A short description for procedure required to add the licnese key is provided below - for a detailed description, 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 and binary code were added during installation of JOC Cockpit. The instructions provided here apply when a license key and code are to 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.
- Default: Location
- 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.
- Default Location:
- Unix: JOC Cockpit Configuration Directory with
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.
- Default Location:
- 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.
- Default Location:
- Unix: JOC Cockpit Installation Directory with
Handling for Docker® Installation
Basically the same locations for license key and licensed binary code apply as explained for Unix operating systems in previous chapters.
Note, that the container's file system cannor be accessed before the container is running, which makes it impossible to add or replace licensed binary code before JOC Cockpit has been started.
Adding a License Key
- The license key can be added by saving the license certificate file in the following location:
/var/sos-berlin.com/js7/joc/jetty_base/resources/joc
- The directory is typically mounted to a Docker
config
volume when running the container: for details see JS7 - JOC Cockpit Installation for Docker Containers.
Adding Licensed Binary Code
- Binary code for clustering is available from the
js7-license.jar
file, which is available 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 at the following location:/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 Dockerconfig
volume when running the container: for details see JS7 - JOC Cockpit Installation for Docker Containers. Thelib
sub-directory should be created if it does not already exist before saving thejs7-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
. Check that the JOC Cockpit port can be accessed. Note that this might include adding firewall rules to allow access to this port from the computer that you are operating the browser on.After initial installation of JOC Cockpit the default User Account
root
and Passwordroot
will be available if no changes have been made to theshiro.ini
configuration file.
Note that the
root
user is assigned theall
role in the default configuration that includes 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.
Command Line Operation
- Command line operations include to start and stop the JOC Cockpit service
- from the command line,
- from a Unix
systemd
service file, - from a Windows Service.
- For details see JS7 - JOC Cockpit - Command Line Operation
Log files
- JOC Cockpit makes use of a number of log files.
- For log file locations, log rotation and log levels see JS7 - Logging.
Further References
- Installation
- Operation
- Configuration