config/dist/jobagent.properties

Code
Comments
Other
Rev Date Author Line
5681 28 Jul 11 jari 1 #  $Id$
2959 27 Nov 06 nicklas 2 #
3675 16 Aug 07 jari 3 #  Copyright (C) 2006 Nicklas Nordborg
2959 27 Nov 06 nicklas 4 #
2959 27 Nov 06 nicklas 5 #  This file is part of BASE - BioArray Software Environment.
2959 27 Nov 06 nicklas 6 #  Available at http://base.thep.lu.se/
2959 27 Nov 06 nicklas 7 #
2959 27 Nov 06 nicklas 8 #  BASE is free software; you can redistribute it and/or
2959 27 Nov 06 nicklas 9 #  modify it under the terms of the GNU General Public License
4474 05 Sep 08 jari 10 #  as published by the Free Software Foundation; either version 3
2959 27 Nov 06 nicklas 11 #  of the License, or (at your option) any later version.
2959 27 Nov 06 nicklas 12 #
2959 27 Nov 06 nicklas 13 #  BASE is distributed in the hope that it will be useful,
2959 27 Nov 06 nicklas 14 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
2959 27 Nov 06 nicklas 15 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2959 27 Nov 06 nicklas 16 #  GNU General Public License for more details.
2959 27 Nov 06 nicklas 17 #
2959 27 Nov 06 nicklas 18 #  You should have received a copy of the GNU General Public License
4508 11 Sep 08 jari 19 #  along with BASE. If not, see <http://www.gnu.org/licenses/>.
2959 27 Nov 06 nicklas 20
2959 27 Nov 06 nicklas 21 # =======================
2959 27 Nov 06 nicklas 22 # BASE settings
2959 27 Nov 06 nicklas 23 # =======================
2959 27 Nov 06 nicklas 24
2959 27 Nov 06 nicklas 25 ## The login and password for a BASE user that the agent should run as
2959 27 Nov 06 nicklas 26 ## The use must have privileges corresponding to the predefined 'Job agent' role.
2959 27 Nov 06 nicklas 27 agent.user=jobagent
2959 27 Nov 06 nicklas 28 agent.password=
2959 27 Nov 06 nicklas 29
2959 27 Nov 06 nicklas 30 ## The ID of this job agent. This is the value used for the external ID property
2959 27 Nov 06 nicklas 31 ## in the database and used for automatic registration of the job agent
2959 27 Nov 06 nicklas 32 ## THE ID MUST BE UNIQUE AMONG ALL RUNNING JOB AGENTS
2959 27 Nov 06 nicklas 33 agent.id=local
2959 27 Nov 06 nicklas 34 agent.name=Local job agent
2959 27 Nov 06 nicklas 35 agent.description=This is the default job agent running on the same server as the web server
2959 27 Nov 06 nicklas 36
2959 27 Nov 06 nicklas 37 # =======================
2959 27 Nov 06 nicklas 38 # Job agent server settings
2959 27 Nov 06 nicklas 39 # =======================
2959 27 Nov 06 nicklas 40
2959 27 Nov 06 nicklas 41 ## The port the job agen should listen to for incoming control requests
2959 27 Nov 06 nicklas 42 ## such as the start, stop, pause and info command
2959 27 Nov 06 nicklas 43 agent.port=47822
2959 27 Nov 06 nicklas 44
2959 27 Nov 06 nicklas 45 ## Comma-separated list of computer ip-adresses or names that are allowed
2959 27 Nov 06 nicklas 46 ## to remotely control this job agent. If the web server is on another
2959 27 Nov 06 nicklas 47 ## computer this list should at least include that server. The local
2959 27 Nov 06 nicklas 48 ## host is always allowed remote control and doesn't have to be in the list
2959 27 Nov 06 nicklas 49 agent.remotecontrol=
2959 27 Nov 06 nicklas 50
2959 27 Nov 06 nicklas 51 ## If the computers listed above also should be allowed to stop, start and/or
2959 27 Nov 06 nicklas 52 ## pause the job agent or not
2959 27 Nov 06 nicklas 53 agent.allowremote.stop=false
2959 27 Nov 06 nicklas 54 agent.allowremote.start=true
2959 27 Nov 06 nicklas 55 agent.allowremote.pause=true
2959 27 Nov 06 nicklas 56
5446 15 Oct 10 nicklas 57 # ==============================
5446 15 Oct 10 nicklas 58 # Custom remote control handlers
5446 15 Oct 10 nicklas 59 # ==============================
2959 27 Nov 06 nicklas 60
5446 15 Oct 10 nicklas 61 ## Handlers for custom remote control can be registered with one or more
5446 15 Oct 10 nicklas 62 ## settings like the one below. Replace 'foo' with the actual name of the 
5446 15 Oct 10 nicklas 63 ## protocol. The class must implement the CustumRequestHandler
5446 15 Oct 10 nicklas 64 ## interface. Requests are sent to the handler on the agent's remote control
5446 15 Oct 10 nicklas 65 ## port: foo://more-custom-data .....
5446 15 Oct 10 nicklas 66 # agent.request-handler.foo = <class-name>
5446 15 Oct 10 nicklas 67
5446 15 Oct 10 nicklas 68
5447 19 Oct 10 nicklas 69 # ============================
2959 27 Nov 06 nicklas 70 # Job agent execution settings
5447 19 Oct 10 nicklas 71 # ============================
2959 27 Nov 06 nicklas 72
5447 19 Oct 10 nicklas 73 ## The name of the executor class that is responsible for starting the job
2959 27 Nov 06 nicklas 74 ## The default is ProcessJobExecutor which starts job in a separate process
2959 27 Nov 06 nicklas 75 ## The class must implement the net.sf.basedb.clients.JobExecutor interface
2959 27 Nov 06 nicklas 76
2959 27 Nov 06 nicklas 77 # -------------------------------------------------------------------
2959 27 Nov 06 nicklas 78 # Executor that executes the jobs in a separate process (recommended)
2959 27 Nov 06 nicklas 79 # Options: 
2959 27 Nov 06 nicklas 80 #  java = Path to the java executable
2959 27 Nov 06 nicklas 81 #  options = Extra command line options to pass to the java executable
2959 27 Nov 06 nicklas 82 # -------------------------------------------------------------------
2959 27 Nov 06 nicklas 83 agent.executor.class=net.sf.basedb.clients.jobagent.executors.ProcessJobExecutor
2959 27 Nov 06 nicklas 84 agent.executor.process.java=java
2959 27 Nov 06 nicklas 85 agent.executor.process.options=-server
2959 27 Nov 06 nicklas 86
2959 27 Nov 06 nicklas 87 # -------------------------------------------------------------------
2959 27 Nov 06 nicklas 88 # Executor that executes jobs in the same process as the job agent (not recommended)
2959 27 Nov 06 nicklas 89 # -------------------------------------------------------------------
2959 27 Nov 06 nicklas 90 # agent.executor.class=net.sf.basedb.clients.jobagent.executors.ThreadJobExecutor
2959 27 Nov 06 nicklas 91
2959 27 Nov 06 nicklas 92 # -------------------------------------------------------------------
2959 27 Nov 06 nicklas 93 # Executor useful for debugging purposes. It just marks the job as 
2959 27 Nov 06 nicklas 94 # executed without really executing it.
2959 27 Nov 06 nicklas 95 # Options:
2959 27 Nov 06 nicklas 96 #  wait = Number of seconds it takes to execute a job
2959 27 Nov 06 nicklas 97 # -------------------------------------------------------------------
2959 27 Nov 06 nicklas 98 # agent.executor.class=net.sf.basedb.clients.jobagent.executors.DummyJobExecutor
2959 27 Nov 06 nicklas 99 # agent.executor.dummy.wait=120
2959 27 Nov 06 nicklas 100
2959 27 Nov 06 nicklas 101
2959 27 Nov 06 nicklas 102 ## Number of seconds between checks to the job queue
2959 27 Nov 06 nicklas 103 agent.checkinterval=30
2959 27 Nov 06 nicklas 104
5447 19 Oct 10 nicklas 105
5447 19 Oct 10 nicklas 106 # ============================
5447 19 Oct 10 nicklas 107 # Slot manager settings
5447 19 Oct 10 nicklas 108 # ============================
5447 19 Oct 10 nicklas 109
5447 19 Oct 10 nicklas 110 ## The name of the slot manager class that is responsible for assigning a slot
5447 19 Oct 10 nicklas 111 ## to the job. The default is the InternalSlotManager which assign slots based
5447 19 Oct 10 nicklas 112 ## on the estimated execution time.
5447 19 Oct 10 nicklas 113 agent.slotmanager.class=net.sf.basedb.clients.jobagent.slotmanager.InternalSlotManager
5447 19 Oct 10 nicklas 114
5447 19 Oct 10 nicklas 115 # -------------------------------------------------------------------
5447 19 Oct 10 nicklas 116 # The master slot manager is like the internal slot manager but also
5447 19 Oct 10 nicklas 117 # accepts slot assignment on behalf of other job agents. The other
5447 19 Oct 10 nicklas 118 # job agents should use the ExternalSlotManager and connect to the
5447 19 Oct 10 nicklas 119 # remote control port of this job agent.
5447 19 Oct 10 nicklas 120 # -------------------------------------------------------------------
5447 19 Oct 10 nicklas 121 # agent.slotmanager.class=net.sf.basedb.clients.jobagent.slotmanager.MasterSlotManager
5447 19 Oct 10 nicklas 122
5447 19 Oct 10 nicklas 123 # -------------------------------------------------------------------
5447 19 Oct 10 nicklas 124 # The remote slot manager uses another jobagent to assign slots.
5447 19 Oct 10 nicklas 125 # The other job agent should use the MasterSlotManager
5447 19 Oct 10 nicklas 126 # Options
5447 19 Oct 10 nicklas 127 #  server=The name/ip of the other job agent
5447 19 Oct 10 nicklas 128 #  port=The remote control port of the job agent
5447 19 Oct 10 nicklas 129 # -------------------------------------------------------------------
5447 19 Oct 10 nicklas 130 # agent.slotmanager.class=net.sf.basedb.clients.jobagent.slotmanager.RemoteSlotManager
5447 19 Oct 10 nicklas 131 # agent.slotmanager.remote.server=
5447 19 Oct 10 nicklas 132 # agent.slotmanager.remote.port=
5447 19 Oct 10 nicklas 133
2959 27 Nov 06 nicklas 134 ## Note! A quick job may use a slot from any of the pools reserved for
2959 27 Nov 06 nicklas 135 ## slower jobs if there are unused slots. Priority values should be between
2959 27 Nov 06 nicklas 136 ## 1 and 10, with 10 as the maximum priority. 
2959 27 Nov 06 nicklas 137 ## See http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html
2959 27 Nov 06 nicklas 138
2959 27 Nov 06 nicklas 139 ## Number of slots to reserved for jobs that takes < 1 minute to execute
2959 27 Nov 06 nicklas 140 agent.shortest.slots=1
2959 27 Nov 06 nicklas 141 agent.shortest.priority=4
2959 27 Nov 06 nicklas 142
2959 27 Nov 06 nicklas 143 ## Number of slots to reserved for jobs that takes < 10 minutes to execute
2959 27 Nov 06 nicklas 144 agent.short.slots=1
2959 27 Nov 06 nicklas 145 agent.short.priority=4
2959 27 Nov 06 nicklas 146
2959 27 Nov 06 nicklas 147 #" Number of slots to reserved for jobs that takes < 1 hour to execute
2959 27 Nov 06 nicklas 148 agent.medium.slots=2
2959 27 Nov 06 nicklas 149 agent.medium.priority=3
2959 27 Nov 06 nicklas 150
2959 27 Nov 06 nicklas 151 # Number of slots to reserved for jobs that takes > 1 hour to execute
2959 27 Nov 06 nicklas 152 agent.long.slots=2
2959 27 Nov 06 nicklas 153 agent.long.priority=3
2959 27 Nov 06 nicklas 154