JS7 JobScheduler

Space shortcuts

Page tree

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

Compare with Current View Page History

« Previous Version 10 Next »

Installing the JS7 JOC Cockpit

Prerequisites

  • Ensure that the Installation Requirements have been met.
  • Unpack the JOC Cockpit archive to a suitable directory such as /tmp on Linux systems or C:\temp on Windows.

Note that an X-Server is required if the installer is to be run on Linux systems as a dialog. If an X-Server is not installed, then headless installation should be used.

Administrative Permissions

  • On Windows systems:
    • The setup asks for elevated permissions.
  • On Linux systems:
    • Root permissions are required when the JOC Cockpit is to be installed together with Jetty if the Jetty server is to run as a demon, i.e. the Jetty Servlet Container and JOC Cockpit are to be started automatically after reboot of the machine.
    • To install JOC Cockpit without root permissions, the start script should be called with the -u argument, otherwise the sudo prompt will ask for a password.   

Graphical Installer

Dialog installation is started by running the setup.sh or setup.cmd files from the unpacked download archive.

  • Language Selection

    • Select the language to be used for the setup: English and German are available.




  • Step 1 - Welcome Screen



  • Step 2 - Licensing Agreement

    • The License Agreement displayed in Step 2 of the installation has to be accepted before installation can take place.



  • Step 3 - Target Path for Installation

    • The path to the installation directory for the JOC Cockpit program files - referred to later in this page as the joc_installation_directory - is set in this step.

    • The default installation paths for the JOC Cockpit are:

      • /opt/sos-berlin.com/js7/joc on Linux systems and

      • C:\Program Files\sos-berlin.com\js7\joc on Windows.
    • Users can use the Step 3 installation form to specify their individual installation path for the JOC Cockpit if required.




  • Step 4 - Jetty Installation & Configuration

    • The JOC Cockpit ships with the Jetty Servlet Container. Step 4 allows system administrators to specify whether the Servlet Container is to be installed and if so, to specify its configuration, i.e. the ports to be used, installation path, memory pool, etc.
    • While the Jetty Servlet Container provided with the JOC Cockpit is installed in the joc_installation_directory that was configured in the previous step - the Jetty configuration files are installed in the jetty_base directory. The Jetty Base input field in the installer form can be used to set the jetty_base directory. 
      • The default path to the jetty_base directory on Linux systems points to the user's home directory:
        • e.g. /home/sos/sos-berlin.com/js7/joc
      • By default log files are stored in:

        • /var/log/sos-berlin.com/js7/logs on Linux systems.

      • The default path to the jetty_base directory and log files on Windows systems is: 
        • C:\ProgramData\sos-berlin.com\js7\joc



    • Note that if If the Jetty provided with JOC Cockpit is not to be installed and either an alternative Jetty installation or another Servlet Container is to be used then relevant configuration files such as shiro.ini and joc.properties will still be written to the file system. These files can then be moved to a suitable location for the Servlet Container as required. See the Configuration with Alternative Web Servers section below for more information.

  • Step 5 - JOC Configuration

    • The JOC Cockpit can be installed in a cluster. if JOC Cockpit is installed as a cluster, then it is required to provide a title to the JOC. By default the title is joc.



    • The security level for the signing mechanism has to be specified at the time of JOC Cockpit installation.  A security level is required for the signing of deployment objects such as workflows. See the Secure Configuration Article for more information. The JOC Cockpit provides three types of security levels:
      • Low: This mechanism is easy to use as it does not require any user interaction for the signing operation to be performed. 
      • Medium: This mechanism is similar to the low signing mechanism except for the fact that the private key stored with the current user's profile is used for the signing of configuration objects.
      • High: This mechanism is the highest security level and requires any configuration objects to be exported and to be signed individually outside of JOC Cockpit.

  • Step 6 - Database Management System

    • Choose the DBMS to be used by the JOC Cockpit for the database.

    • The database connection settings either can be specified directly or can be provided by a hibernate configuration file. If the settings are specified directly then it is required to choose the DBMS otherwise the hibernate configuration file path can be specified after checking the option with hibernate configuration file.



    • The DBMS is specified in the upper selection on this form. It is recommended that the checkbox in the center of the form remains checked so that the script is executed that creates and populates the required database objects. 

  • Step 7 - Database connection Configuration

    • Specify the parameters for the connection to the database.



    • The database connection settings from the above screenshot should be evident.

    • The database configuration for the JOC Cockpit is written to an XML file during installation and stored in the jetty_base/resources/joc folder. The default name of the database configuration file is hibernate.cfg.xml. This file can be modified later on if required. Any text editor can be used. The JOC Cockpit service has to be restarted to apply changes to the hibernate configuration file.

    • The name and location of the hibernate configuration file is specified with the joc.properties the file that can be found in the jetty_base/resources/joc folder.

  • Step 8 - Specify the JDBC Driver for the Database Connection

    • Specify if a JDBC Driver provided with the installer should be used for the Database Connection or whether an external JDBC Driver should be used.
      The information shown in this form depends on the DBMS previously selected:
      • The jTDS JDBC® the driver delivered with the JOC Cockpit is only shown as an option when Sybase® or Microsoft SQL Server® DBMSs have been specified.
      • If you have specified a MySql® DBMS then you will get a checkbox for specifying whether you want to use the MariaDB® JDBC® driver provided with the JobScheduler. 
      • If you do not check the jTDS JDBC® or the MariaDB JDBC drivers then you must enter your own JDBC® Driver in the form shown below.



    • Configuring the JDBC Driver URL for Oracle® RAC databases

      The JDBC Driver URL for Oracle® RAC databases should be entered in the Host field of the database connection form. For example:

      jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(LOAD_BALANCE=OFF)(FAILOVER=ON) 
(ADDRESS=(PROTOCOL=TCP)(HOST=tst-db1.myco.com)(PORT=1604)) 
(ADDRESS=(PROTOCOL=TCP)(HOST=tst-db2.myco.com)(PORT=1604))) 
(CONNECT_DATA=(SERVICE_NAME=mydb1.myco.com)(SERVER=DEDICATED)))

      In addition, the Schema and Port fields should be left empty.

  • Step 9 - Performing the Installation

    • This step displays a progress bar for the first part of the installation procedure.

    • Changes to the configuration can no longer be made once this step has started.
      Instead, configuration files can be manually modified. To apply changes the JOC Cockpit should be restarted.



  • Step 10 - External Processes

    • This step displays the progress of the second part of the installation procedure.



    • The information displayed with this step is written to the installation log file that can be found in the jetty_base/logs folder.

  • Step 11 - Completion

    • The last step of the installation displays summary information about the installation (success/error) and paths to relevant information.



    • Note that if a problem occurs during installation a warning message will be shown here and a link to the installation log file will be provided.

  • Operation

    • Go to the Initial Operation section of this article for information about opening the JOC Cockpit Interface.


Update

The update using the GUI can be done by rerunning the installer setup.cmd file from the .zip archive and by providing the same parameters such as installation paths, ports etc.

Initial Operation with the JOC Cockpit Login Form

Note that a working Servlet Container - either the Jetty provided with the JOC Cockpit or some other product - is required before the JOC Cockpit installation can be operated.

  • Call the JOC Cockpit login form in a web browser and enter the User Name and Password.

    After a first installation of the JOC Cockpit the default User Name and Password of root:root and Shiro Authentication will be active if changes have not been made to the shiro.ini configuration file. Note that the root user is assigned all role in the default configuration, which has all permissions available.

    See the Authentication and Authorization - Configuration article for information about the configuration of other user profiles and authentication methods.

  • Note that the web service may take a minute to start and display the login form on some systems as explained below.

Updating

Empty the Browser Cache after updating the JOC Cockpit

You should use Ctrl & F5 as well as empty the browser cache before starting the JOC Cockpit after an update.

Installation Log Files

The JOC Cockpit configuration and installation log information are written to a new log file each time an installation or update is carried out. These log files can be found in the logs folder in the jetty_base directory.

  • Installation log files are named according to the pattern Install_V<release>_<date-time>_....log where <release> is the release number and <date-time> refers to the point in time of installation.

Deinstallation

The JOC Cockpit can be uninstalled using the uninstall.cmd and uninstall.sh scripts saved in the folders:

Windows systems

Starting the uninstaller will open the following form on Windows systems:


Ticking the "Force the deletion of C:\Program Files\ ...." checkbox will cause the uninstall script to remove both the program and configuration files and folders.

If the checkbox is not selected, configuration files will be left in both the JOC Cockpit installation folder and the Jetty web server installation folder (if installed with the JOC Cockpit).

On Linux systems

Make a Backup!

The uninstall script on Linux systems will not open a dialog box. Instead, an uninstall script will start the Uninstaller and remove both the program and configuration files and folders. 

These files contain the configuration information from the last JOC Cockpit and Jetty web server installations.

Configuration with Alternative Web Servers

The JOC Cockpit installation procedure contains the option of installing and using the Jetty Web Server that is included in the JOC Cockpit installation archive. This option was configured in Step 4 of the installation procedure described above. An alternative web server that is capable of handling Java web applications, such as Tomcat or another web server, can also be used.

If the Jetty provided with the JOC Cockpit is not to be installed, the installation program will look and see if a jetty_base shortcut from a previous installation is to be found in the jetty_home directory. Particularly relevant for system administrators would be the shiro.ini file (containing authentication and authorization information) and the joc.properties file (containing database configuration information).

  • If configuration files are found then these will not be overwritten or removed.
  • Default configuration files will be written to the file system in the joc_home directory.
  • System administrators can then move the configuration files to the appropriate application directory as required.

See also links in the References section below.

Location of the resources/joc folder with a fresh installation

With a fresh installation, the installer will not find an existing Jetty and will save the resources directory by default as follows:

Location of the resources/joc folder after an installation on top of a JOC Cockpit installation with Jetty 

If the JOC Cockpit is being installed without the included Jetty but on top of an installation that has included the JOC Cockpit Jetty then the resources\joc the folder will not be moved from its location. This means that the "new" resources the folder will be found after the new installation as follows (if the original installation was carried out in the default directory):

In this situation the shiro.ini and joc.properties file from the earlier installation will not be overwritten.

The "old" hibernate.cfg.xml the database configuration file will be read during the installation and the settings suggested as default values. The file itself will be deleted and a new one saved in the joc_home directory.

An update of the JOC Cockpit will neither overwrite the new or old configuration files. However new versions of the joc.properties and shiro.ini files named joc.properties-example and shiro.ini-example will be written to the resources\joc folder, alongside the originals.

File Structure

The following listings should make clear the changes that occur in the JOC Cockpit file structure during installation and de-installation.

Windows Systems

Default File Structure if Jetty is Installed

If the Jetty web server provided with the JOC Cockpit is installed then files will be added by default in the ProgramData\sos-berlin.com\joc and Program Files\sos-berlin.com\joc directories.

  • ProgramData
    • sos-berlin.com
      • js7
        • joc
          • jetty_base
            • archive (directory with files, remains after uninstall)
            • lib (directory with files, remains after uninstall)
            • logs (directory with files, remains after uninstall)
            • patches (directory with files, remains after uninstall)
            • resources (remains after uninstall and (empty) after full uninstall)
              • joc (directory with files, remains after uninstall)
                • license (directory with files, remains after uninstall)
                • xsd (directory with files, remains after uninstall)
                • hibernate.cfg.xml (remains after uninstall if modified)
                • joc.properties (remains after uninstall)
                • log4j2.xml (remains after uninstall if modified)
                • shiro.ini.active (remains after uninstall)
                • shiro.ini-example (only added if shiro.ini file is found)
          • temp (directory with files, remains after uninstall)
          • webapps
          • start.ini (file, remains after uninstall)


  • Program Files
    • sos-berlin.com
      • js7
        • joc
          • install (directory with files)
            • install_jetty_base.cmd
            • update_jetty_base.cmd
          • jetty (directory with files)
          • jetty_base (symlink)
          • service
          • Uninstaller (directory, the empty remains after uninstall and full uninstall)
            • uninstall.cmd
            • uninstaller.jar
          • .jocinstallinformation (file, remains after uninstall)
          • joc_install.xml (file, remains after uninstall)
Default File Structure if Jetty is not Installed

If the Jetty web server provided with the JOC Cockpit is not installed and no previous configuration files are found in the Program Files\sos-berlin.com\joc the directory then files will be added by default only in the Program Files\sos-berlin.com\joc directories.

If configuration files are found in Program Files\sos-berlin.com\joc the directory then files will be added in the ProgramData\sos-berlin.com\joc and Program Files\sos-berlin.com\joc directories as described above.

  • Program Files
    • sos-berlin.com
      • js7
        • joc
          • install
            • install_jetty_base.cmd
            • shortcut.vbs
            • joc_install_tables.cmd
            • update_jetty_base.cmd
          • logs
            • Install_ ... .log (files will remain after uninstall)
          • resources
            • joc
              • hibernate.cfg.xml (remains after uninstall if modified)
              • joc.properties (remains after uninstall)
              • joc.properties-example (only added if joc.properties file is found at installation start)
              • log4j2.xml (remains after uninstall if modified)
              • shiro.ini (remains after uninstall)
              • shiro.ini-example (only added if shiro.ini file is found at installation start)
          • service
            • amd64 (directory)
            • manager (directory)
            • x86 (directory)
            • install_jetty_windows_service.cmd
            • LICENSE.txt
            • NOTICE.txt
            • RELEASE-NOTES.txt
            • set_java_home_for_jetty_windows_service.cmd
            • start_jetty_windows_service.cmd
            • uninstall_jetty_windows_service.cmd
          • Uninstaller (the empty directory remains after uninstall)
            • js7.ico
            • uninstall.cmd
            • uninstaller.jar
          • webapps
            • joc.war
          • .jocinstallinformation (file, remains after uninstall)
          • joc_install.xml (file, remains after uninstall)

Clustering and Redundancy

With each instance running on its own server, multiple instances of the JOC Cockpit can either be installed as an active cluster or redundantly. In both cases, installation of the JOC Cockpit instances follows the standard procedure described above. The configuration of the JOC Cockpit instances then follows the instructions provided in the Authentication and Authorization - Configuration article. 

 The JOC Cockpit - Clustering article provides more general information about installing and configuring multiple instances of the JOC Cockpit.

JOC Cockpit Configuration

The JOC Cockpit includes certain configuration items which can be used to configure JOC Cockpit. Details about how to configure JOC Cockpit the article JS7 - JOC Cockpit Configuration Items can be followed. 

Further Resources

Installation with Other Application Servers


  • No labels