Job Forking - Revision history

Craig: /* Database Configuration Parameters */

2024-12-27T22:07:10Z

Database Configuration Parameters

← Older revision		Revision as of 22:07, 27 December 2024
Line 59:		Line 59:

	=== Database Configuration Parameters ===		=== Database Configuration Parameters ===
	If your environment does not have database configuration ~~properties~~ in the properties file accessible to the forked job (e.g. config is done via System properties and/or programmatically), you will want to enable the following option for forked jobs. When enabled, database configuration will be passed into the scripts instead of relying on locating a properties file with the same information.		If your environment does not have database configuration entries in the properties/yaml file accessible to the forked job (e.g. config is done via System properties and/or programmatically), you will want to enable the following option for forked jobs. When enabled, database configuration will be passed into the scripts instead of relying on locating a properties file with the same information.

	<code>com.carfey.obsidian.jvmJobForkingIncludeDbSysParms=true</code>		<code>com.carfey.obsidian.jvmJobForkingIncludeDbSysParms=true</code>

Craig at 19:56, 23 May 2023

2023-05-23T19:56:18Z

← Older revision		Revision as of 19:56, 23 May 2023
Line 3:		Line 3:
	JVM job forking is disabled by default. Standalone deployments support forking out-of-the-box, but it is not active until you enable it as defined in [[#Configuring_Job_Forking\|Configuring Job Forking]].		JVM job forking is disabled by default. Standalone deployments support forking out-of-the-box, but it is not active until you enable it as defined in [[#Configuring_Job_Forking\|Configuring Job Forking]].

	'''Note:''' In order to support hot-swapping of JARs that contain compiled jobs, Obsidian expects you to ensure JAR consistency between nodes. If you plan on deploying new jobs or changing the configurability (e.g. supported parameter changes), you will want to deploy these to all Obsidian nodes that have job forking enabled and either restrict these from executing on nodes with forking disabled (see [[Admin_Jobs#~~Execution_.26_Pickup~~\|Fixed Hosts]]) or deploy the changes to these nodes with appropriate restarts of Obsidian.		'''Note:''' In order to support hot-swapping of JARs that contain compiled jobs, Obsidian expects you to ensure JAR consistency between nodes. If you plan on deploying new jobs or changing the configurability (e.g. supported parameter changes), you will want to deploy these to all Obsidian nodes that have job forking enabled and either restrict these from executing on nodes with forking disabled (see [[Admin_Jobs#Advanced_Options\|Fixed Hosts]]) or deploy the changes to these nodes with appropriate restarts of Obsidian.

	= How Does Job Forking Work? =		= How Does Job Forking Work? =

Craig: /* Enabling Job Forking - Cluster */

2019-01-09T15:40:37Z

Enabling Job Forking - Cluster

← Older revision		Revision as of 15:40, 9 January 2019
Line 22:		Line 22:
	To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[Admin Scheduler Settings\|scheduler setting]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.		To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[Admin Scheduler Settings\|scheduler setting]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.

	If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category~~. This support was~~ introduced as of Obsidian 3.6.0.		If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category, introduced as of Obsidian 3.6.0.

Carfey at 17:50, 1 July 2016

2016-07-01T17:50:38Z

← Older revision		Revision as of 17:50, 1 July 2016
Line 20:		Line 20:
	=== Enabling Job Forking - Cluster ===		=== Enabling Job Forking - Cluster ===

	To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[Admin Scheduler Settings ~~4.0~~\|scheduler setting]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.		To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[Admin Scheduler Settings\|scheduler setting]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.

	If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category. This support was introduced as of Obsidian 3.6.0.		If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category. This support was introduced as of Obsidian 3.6.0.

Carfey: /* Enabling Job Forking - Cluster */

2016-07-01T16:36:11Z

Enabling Job Forking - Cluster

← Older revision		Revision as of 16:36, 1 July 2016
Line 20:		Line 20:
	=== Enabling Job Forking - Cluster ===		=== Enabling Job Forking - Cluster ===

	To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[~~Admin_System~~\|~~system parameter~~]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.		To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[Admin Scheduler Settings 4.0\|scheduler setting]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.

	If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category. This support was introduced as of Obsidian 3.6.0.		If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category. This support was introduced as of Obsidian 3.6.0.


	[[File:~~3.6~~.0.~~JobSpawner.ForkingConfiguration.PNG~~]]		[[File:JobForking_4.0.png]]

	=== Enabling Job Forking - Node ===		=== Enabling Job Forking - Node ===

Craig: /* How Does Job Forking Work? */

2016-01-15T20:19:59Z

How Does Job Forking Work?

← Older revision		Revision as of 20:19, 15 January 2016
Line 8:		Line 8:
	When job forking is enabled, Obsidian will run a shell script (or batch file on Windows) for each job execution to be forked. This script in turn starts a new JVM which invokes an Obsidian class with the appropriate arguments to start the single-job execution. Forking can be [[#Script_Customization\|customized]] easily by using alternate scripts from the provided defaults. To support new jobs or configurability changes to existing jobs, [[Implementing_Jobs#Classpath_Scanning\|Classpath Scanning]] also runs as a forked process using the same scripts.		When job forking is enabled, Obsidian will run a shell script (or batch file on Windows) for each job execution to be forked. This script in turn starts a new JVM which invokes an Obsidian class with the appropriate arguments to start the single-job execution. Forking can be [[#Script_Customization\|customized]] easily by using alternate scripts from the provided defaults. To support new jobs or configurability changes to existing jobs, [[Implementing_Jobs#Classpath_Scanning\|Classpath Scanning]] also runs as a forked process using the same scripts.

	'''~~A note about~~ Forked Jobs'''		'''Forked Jobs and the Obsidian Database'''

	Each occurrence of a Forked Job will require a few connections to the database. Make sure you plan accordingly in your connection allocations on the database and sizing for the JNDI datasource, if applicable.		Each occurrence of a Forked Job will require a few connections to the database. Make sure you plan accordingly in your connection allocations on the database and sizing for the JNDI datasource, if applicable.

Craig: /* How Does Job Forking Work? */

2016-01-15T20:18:59Z

How Does Job Forking Work?

← Older revision		Revision as of 20:18, 15 January 2016
Line 9:		Line 9:

	'''A note about Forked Jobs'''		'''A note about Forked Jobs'''

	Each occurrence of a Forked Job will require a few connections to the database. Make sure you plan accordingly in your connection allocations on the database and sizing for the JNDI datasource, if applicable.		Each occurrence of a Forked Job will require a few connections to the database. Make sure you plan accordingly in your connection allocations on the database and sizing for the JNDI datasource, if applicable.

Craig: /* How Does Job Forking Work? */

2016-01-15T20:18:50Z

How Does Job Forking Work?

← Older revision		Revision as of 20:18, 15 January 2016
Line 7:		Line 7:
	= How Does Job Forking Work? =		= How Does Job Forking Work? =
	When job forking is enabled, Obsidian will run a shell script (or batch file on Windows) for each job execution to be forked. This script in turn starts a new JVM which invokes an Obsidian class with the appropriate arguments to start the single-job execution. Forking can be [[#Script_Customization\|customized]] easily by using alternate scripts from the provided defaults. To support new jobs or configurability changes to existing jobs, [[Implementing_Jobs#Classpath_Scanning\|Classpath Scanning]] also runs as a forked process using the same scripts.		When job forking is enabled, Obsidian will run a shell script (or batch file on Windows) for each job execution to be forked. This script in turn starts a new JVM which invokes an Obsidian class with the appropriate arguments to start the single-job execution. Forking can be [[#Script_Customization\|customized]] easily by using alternate scripts from the provided defaults. To support new jobs or configurability changes to existing jobs, [[Implementing_Jobs#Classpath_Scanning\|Classpath Scanning]] also runs as a forked process using the same scripts.

			'''A note about Forked Jobs'''
			Each occurrence of a Forked Job will require a few connections to the database. Make sure you plan accordingly in your connection allocations on the database and sizing for the JNDI datasource, if applicable.

	== Interrupt Support ==		== Interrupt Support ==

Craig: /* Interrupt Support */

2016-01-15T20:11:04Z

Interrupt Support

← Older revision		Revision as of 20:11, 15 January 2016
Line 10:		Line 10:
	== Interrupt Support ==		== Interrupt Support ==

	~~Currently~~, forked ~~execution does not support~~ [[~~Implementing_Jobs~~#~~Interruptable_Jobs~~\|~~job interrupts~~]].		As of Obsidian 3.6.0, forked jobs can be interrupted. See [[Job_Forking#Configuring_Job_Forking \| Configuring Job Forking]] below.

	= Configuring Job Forking =		= Configuring Job Forking =

Craig: /* Enabling Job Forking - Cluster */

2016-01-15T20:09:04Z

Enabling Job Forking - Cluster

← Older revision		Revision as of 20:09, 15 January 2016
Line 18:		Line 18:
	To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[Admin_System\|system parameter]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.		To use forking, first you must enable a setting (''jvmJobForkingEnabled'') that will apply across the cluster. This is a [[Admin_System\|system parameter]] found in the ''Job Spawner'' category. You may enable it through the admin web application, the [[Embedded API]], [[REST API]], or Obsidian's [[Initializing and Restoring\|initialization & restore]] support.

	If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category.		If you wish to enable interruption of forked jobs that implement the necessary [[Implementing_Jobs#Interruptable_Jobs\|Interruptable]] interface, you must also enable the setting ''jvmForkedJobsCanBeInterrupted'' also found in the ''Job Spawner'' category. This support was introduced as of Obsidian 3.6.0.