Skip to end of metadata
Go to start of metadata

Introduction

  • JOC Cockpit makes use of the joc.properties configuration file populated by installation options that can be found from the following locations:
  • Restart the JOC Cockpit instance to apply changes to its configuration file.

Installation Options


Example for installation options: joc.properties
################################################################################
### If JOC Cockpit is used in a cluster then type a title to identify which node
### is currently used. Further type an ordering (Primary <= 0, Backup > 0) for
### the display order in JOC's dashboard

title = PRIMARY JOC COCKPIT
ordering = 0


################################################################################
### Path to log4j configuration file. Path can be absolute or relative
### to this file.

log4j.configuration = log4j2.xml


################################################################################
### Path to hibernate configuration file of JOC's database.
### Path can be absolute or relative to this file.

hibernate_configuration_file = hibernate.cfg.xml


################################################################################
### The time (in seconds) to establish the connection with the
### remote host. Default = 2

jobscheduler_connection_timeout = 2


################################################################################
### The time (in seconds) waiting for data after the connection
### was established; maximum time of inactivity between two data packets.
### Default = 5

jobscheduler_socket_timeout = 5


################################################################################
### Should hostname verification be carried out for https certificate.
### Default false

https_with_hostname_verification = true


################################################################################
### Location, type and password of the Java truststore which contains the
### certificates of each JobScheduler Controller for HTTPS connections. Path can be
### absolute or relative to this file.

keystore_path = ../../etc/https-keystore.p12
keystore_type = PKCS12
keystore_password = jobscheduler
key_password = jobscheduler

truststore_path = ../../etc/https-truststore.p12
truststore_type = PKCS12
truststore_password = jobscheduler


################################################################################
### JOC Cockpit requires to configure a security level for the
### signing mechanism, options "high", "medium" and "low".
### high:
###      public PGP/X.509 keys are stored for verification only
###      all signing will be done externally outside of JOC Cockpit
### medium:
###      a private PGP/X.509 key will be stored for signing
###      signing will be done automatically with the provided key
### low:
###      no keys will be stored
###      signing will be done internally with default keys
###
### This flag controls the security level used. Default low

security_level = low


################################################################################
### Settings for a custom logo file on the login page
### The logo file has to be located in ./jetty_base/webapps/root/ext/images
### Possible units for height are according to
### https://www.w3schools.com/cssref/css_units.asp (default px)
### Possible values for the position are "top" or "bottom" (default=bottom).

custom_logo_name =
custom_logo_height =
custom_logo_position =


################################################################################
### Normally, the user permissions control if a view such as dashboard,
### workflows, etc. are shown or hidden. Here you can force to show (=true) or
### hide (=false) a view independent of the permissions. If the value is unequal
### true or false then the permissions win.

show_view_dashboard =
show_view_dailyplan =
show_view_workflows =
show_view_filetransfers =
show_view_resources =
show_view_history =
show_view_auditlog =
show_view_configuration =

Logger Settings

SettingDefault ValueExplanation
log4j.configurationlog4j2.xml

Specifies the file name of the log4j2 configuration file to be used. This file is expected with the configuration folder ./resources/joc

Database Connection Settings

SettingDefault ValueExplanation
hibernate_configuration_filehibernate.cfg.xml

Specifies the connection URL, account and authentication for the connection to the database.

Controller Connection Settings

SettingDefault ValueExplanation
jobscheduler_connection_timeout2

Specifies the time (in seconds) to establish a connection to a Controller.

jobscheduler_socket_timeout5The time (in seconds) waiting for data after the connection to a Controller is established. Technically the setting specifies the maximum duration for inactivity between two data packets.

HTTPS Connection Settings

SettingDefault ValueExplanation
https_with_hostname_verificationfalse

Specifies if hostname verification should be performed for HTTPS connections.

keystore_path../../etc/https-keystore.p12The keystore includes the private key and certificate for incoming HTTPS connections (Server Authentication) and for outgoing connections that request mutual authentication (Client Authentication).

keystore_type

PKCS12The keystore types PKCS12 and JKS are supported.
keystore_password
The keystore is protected by a password.
key_password
The private keys in the keystore are protected by a password. Consider that for PKCS12 keystores the same password applies to all keys.
truststore_path../../etc/https-truststore.p12The truststore includes the public key and/or certificates for outgoing HTTPS connections (Server Authentication).
truststore_typePKCS12The truststore types PKCS12 and JKS are supported.
truststore_password
The truststore is protected by a password.

Custom Logo Settings

SettingDefault ValueExplanation
custom_logo_name
The logo file indicated by this name has to be located in ./jetty_base/webapps/root/ext/images
custom_logo_height
The logo height in pixel. Possible units are specified according to: https://www.w3schools.com/cssref/css_units.asp (default px).
custom_logo_positionbottomPossible values for the position are top and bottom

Dashboard Settings

SettingDefault ValueExplanation
titlePRIMARY JOC COCKPIT
SECONDARY JOC COCKPIT
Title of the JOC Cockpit Cluster Status widget in the Dashboard view. The default value depends on the installer option for a Primary or Secondary JOC Cockpit instance.
ordering0
1
Order of appearance in JOC Cockpit Cluster Status widget in Dashboard view. The default value depends on the installer option for a Primary or Secondary JOC Cockpit instance.
  • title: The title of the respective JOC Cockpit instance as visible from the Cluster Status widget of the JS7 Dashboard view.
  • ordering: The order of appearance of the respective JOC Cockpit instance with the Cluster Status widget of the JS7 Dashboard view. An ordering 0 indicates the leftmost occurrence.

Installation Options

SettingDefault ValueExplanation
security_levellow

JOC Cockpit is installed for a security level used for signing of deployment objects such as workflows: 

  • high
    • certificates / public keys are stored for verification purposes
    • signing is performed externally outside of JOC Cockpit
  • medium
    • an individual private key per account is stored for signing purposes
    • signing is performed automatically with the provided key
  • low
    • a single private keys is stored for signing purposes with any accounts
    • signing is performed automatically with keys of the default profile account being applied
  • Changes to the above setting are ignored. Instead, the above setting is applied by the installer for informational purposes only.
  • To modify the security level of JOC Cockpit re-run the installer and select the respective installation option.





  • No labels
Write a comment…