Product Knowledge Base

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 25 Next »

Installation Requirements

The following requirements must be met before the JOC Cockpit can be installed:

  • The JOC Cockpit can only be used to operate JobScheduler Masters in versions 1.11 and newer. These JobSchedulers have to use a separate schema, user and database to any other JobSchedulers that use the same DBMS because of changes made to the database tables for version 1.11.
  • The JOC Cockpit can only be installed alongside a JobScheduler Master version 1.11 and newer. < CONFIRM DBMS CAN BE ON DIFFERENT COMPUTER
  • An Oracle Java 8 JRE has to be installed if not already installed for the JobScheduler. Note that Oracle Java 9 has not yet (December 2016) been tested with the JOC Cockpit. The JAVA_HOME variable should be set to point to the JRE. < CONFIRM DBMS CAN BE ON DIFFERENT COMPUTER
  • A web server such as Jetty or Tomcat, which is capable of handling Java web applications is required. This can be the Jetty provided with the JOC Cockpit installation. < DOES JETTY INSTANCE HAVE TO INSTALLED ON SAME COMPUTER?

Operating Systems

The JOC Cockpit is available for Linux and Windows operating systems in 64-bit and 32-bit. See the Which platforms is JobScheduler available for and what platform support is provided? article for more information. IS ARTICLE CORRECT TARGET?

Download the JOC Cockpit Archive

The following archive files including installer are available:

  • joc_linux.[release].tar.gz < DEFINITION TO BE ADDED
  • joc_windows.[release].zip

These archives can be downloaded from:

  • the SOS Web Site Download page < LINKS TO BE ADDED
  • the JobScheduler Source Forge

Installation Procedure

Preparation

  • Unpack the archive JOC Cockpit archive to a suitable directory such as /tmp on Linux systems or C:\temp on Windows.
The installer can be started as a dialog or in batch mode. 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 batch installation should be used.

Start Installation

Dialog installation is started by clicking on the setup.sh or setup.cmd files.

Batch installation is started by opening a terminal or command window in the folder containing the setup.* file and typing:

  • Starting the JOC Cockpit installer on Linux systems
    /tmp/jobscheduler.[release]> ./setup.sh
  • Starting the JOC Cockpit installer on Windows systems
    C:\temp\jobscheduler.[release]> setup.cmd

Configuration Forms

  • 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 shown in Step 2 of the installation has to be accepted before installation can take place.



  • Step 3 - Target Path for the Installation

    • The installation path for the JOC Cockpit is set in the Step 3 form.

    • The default installation paths for the JOC Cockpit are alongside the default installation path for the JobScheduler program files:

      • /home/[user]/sos-berlin.com/joc on Linux systems and

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



  • Step 4 - User Data / Install Jetty

    • The JOC Cockpit requires a Java-capable web server and comes with a Jetty server.
    • The Step 4 installation form allows system administrators to specify whether the Jetty Web Server delivered with the JOC Cockpit should be installed and if this is the case, to specify its configuration and installation path.
    • The default installation directory for the Jetty Web Server delivered with the JOC Cockpit - the jetty_base - lies alongside the default JobScheduler configuration and log files (referred to as the $SCHEDULER_DATA directory in the JobScheduler installation manual):

      • /home/[user]/sos-berlin.com/joc on Linux systems and

      • C:\ProgramData\sos-berlin.com\joc on Windows.
    • The Jetty Base field in the form shown below can be used to change the installation path of the Jetty delivered with the JOC Cockpit.

    • If the Jetty delivered with the JOC Cockpit is not to be used then all JOC Cockpit files will be installed in the following directories:
      • ??? on Linux systems and < FILE LOCATION TO BE ADDED
      • C:\Program Files\sos-berlin.com\joc on Windows
    • Note that if a different web server to that delivered with the JOC Cockpit is to be used, the relevant configuration files required for such a server such as the shiro.ini and joc.properties files will still be written to the file system. These files can then be moved by the system administrator to the desired location. See the Configuration with Alternative Web Servers section below for more information.

  • Step 5 - Choose the DBMS

    • The type of DBMS used by the JobSchedulers operated by the JOC Cockpit is specified in the Step 5 form.

      • The DBMS type can be found in the database configuration for job history section of the $JOBSCHEDULER_DATA\factory.ini file of one of the JobSchedulers, where $JOBSCHEDULER_DATA is defined in the JobScheduler - Installation Guide (Section 1.2).
    • The database configuration for the JOC Cockpit is written to an XML file during installation.
    • The name and location of the database configuration file is specified in the joc.properties file, which can be found in the JOC Cockpit resources folder.
      The default name and location of the database configuration file are:
      • resources/hibernate.cfg.xml



  • Step 6 - Configure the Database Connection

    • The access parameters for the DBMS used by the JobSchedulers operated by the JOC Cockpit are specified in the 6th form.

      • The DBMS access parameters used can be found in the database configuration for job history section of the $JOBSCHEDULER_DATA\factory.ini file of one of the JobSchedulers, where $JOBSCHEDULER_DATA is defined in the JobScheduler - Installation Guide (Section 1.2).



  • Step 7 - No longer required

  • Step 8 - Installation

    • The installation form shows the progress of the first part of the installation procedure.



  • Step 9 - Processing

    • The installation form shows the progress of the second part of the installation procedure.



  • Step 10 - Completion



  • Initial Testing with the JOC Cockpit Login Form

    This test is only available after installation of the JOC Cockpit if the Jetty web server provided with the JOC Cockpit has been installed (see Step 4 of the installation procedure above):

    • Call the JOC Cockpit login form in a web browser and enter the username and password.

      After a first installation of the JOC Cockpit the default User Name and Password will be root:root and Shiro Authentication will be active.

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

    • Note that it usually takes one or two minutes for the web service to start (only on Win ?) and the login form shown below to appear.

Installation Log Files

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

Installation log files are named according to the pattern Install_V[release]_[date&time]_...log where release is the version release number and date and time refer to the installation.

Deinstallation

The JOC Cockpit can be uninstalled using the uninstall.cmd script saved in the folder:

  • C:\Program Files\sos-berlin.com\joc\Uninstaller

Starting the uninstaller will open the following form:

Ticking the "Force the deletion of C:\PRogram Files ...." checkbox will cause the uninstall script to remove all the files and folders in the Program Files folder.

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

These files contain the configuration information for 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 with the JOC Cockpit installation archive. This option was shown in the above series of screen shots (Step 4). An alternative web server, which is capable of handling Java web applications, such as Tomcat or an own Jetty server, can also be used. < DOES JETTY INSTANCE HAVE TO INSTALLED ON SAME COMPUTER?

If the Jetty provided with the JOC Cockpit is not to be installed, a resources folder, containing files that will likely be relevant for system administrators - i.e. the shiro.ini file (containing default authentication and authorization information) and the joc.properties file (containing default database configuration information) - will still be written to the file system. The locations of these files will depend on whether or not a Jetty web server was previously be written to locations described in Step 4 of the installation procedure above. The exact locations will depend on whether the installation program finds an older Jetty installation within the JOC Cockpit installation path specified in Step 3 of the installation procedure. System administrators can then move the shiro.ini file and other resources to the appropriate application directory as required.

Location of the resources 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:

  • on Linux systems:
    • ...   < PATH TO BE COMPLETED
  • on Windows systems:
    • C:\Program Files\sos-berlin.com\joc\resources

Location of the resources folder with an installation on top of an installation with Jetty < TITLE IST SCHLECHT

If the JOC Cockpit is being installed without the included Jetty but on top of an installation that had included the JOC Cockpit Jetty then the resources folder will not be moved from its current location. This means that the resources folder will be found after the new installation as follows:

  • on Linux systems:
    • ...   < PATH TO BE COMPLETED
  • on Windows systems:
    • C:\ProgramData\sos-berlin.com\joc\resources

In this situation the shiro.ini and joc.properties file from the earlier installation will not be overwritten. However new versions of the hibernate.cfg.xml , joc.properties-example and shiro.ini-example files will be written to the resources folder, overwriting any existing versions.

File Structure SECTION FOR REFERENCE ONLY

Windows

  • If JETTY IS INSTALLED:
    • File Structure is:
      • ProgramData\sos-berlin.com\joc
        • > joc_home < bleibt after uninstall
        • logs < bleibt after uninstall
        • resources < bleibt after uninstall
          • hibernate.cfg.xml
          • joc.properties < bleibt after uninstall
          • joc.properties-example < only added if joc.properties file found
          • shiro.ini < bleibt after uninstall
          • shiro.ini-example < only added if shiro.ini file found
        • temp < bleibt after uninstall
        • webapps
        • start.ini < bleibt after uninstall
      • Program Files\sos-berlin.com\joc
        • install
          • see below
        • jetty
        • > jetty_base
        • service
          • as below plus:
            • sos_joc.exe
            • sos_jocw.exe
        • Uninstaller < bleibt after uninstall (empty)
          • jobscheduler.ico
          • uninstall.cmd
          • uninstaller.jar
        • .jocinstallinformation < bleibt after uninstall
        • joc_install.xml < bleibt after uninstall
  • If JETTY NOT INSTALLED:
    • File Structure is:
      • Program Files\sos-berlin.com\joc
        • install
          • see below
        • logs
          • Install_ ... .log < bleibt after uninstall
        • resources
          • hibernate.cfg.xml
          • joc.properties < bleibt after uninstall
          • shiro.ini < bleibt after uninstall
        • service
          • amd64
          • ia64
          • manager
          • x86
          • 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 < bleibt after uninstall (empty)
          • jobscheduler.ico
          • uninstall.cmd
          • uninstaller.jar
        • webapps
          • joc.war
        • .jocinstallinformation < bleibt after uninstall
        • joc_install.xml < bleibt after uninstall
    • Contents of C:\Program Files\sos-berlin.com\joc\install folder are: < FILE FUNCTIONS TO BE DESCRIBED .....
      • install_jetty_base.cmd
      • shortcut.vbs
      • sleep.exe
      • update_jetty_base.cmd
    • Contents of C:\Program Files\sos-berlin.com\joc\webapps folder are: < FILE FUNCTIONS TO BE DESCRIBED .....
      • joc.war

 

  • No labels