source: trunk/doc/admin/jobagent.properties.html @ 3675

Last change on this file since 3675 was 3675, checked in by Jari Häkkinen, 15 years ago

Fixing copyright statements. Fixing svn properties.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 9.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
3<!--
4    $Id: jobagent.properties.html 3675 2007-08-16 14:16:43Z jari $
5
6    Copyright (C) 2006 Nicklas Nordborg
7
8    This file is part of BASE - BioArray Software Environment.
9    Available at http://base.thep.lu.se/
10
11    BASE is free software; you can redistribute it and/or modify it
12    under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 2 of the License, or
14    (at your option) any later version.
15
16    BASE is distributed in the hope that it will be useful, but
17    WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19    General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with this program; if not, write to the Free Software
23    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24    02111-1307, USA.
25-->
26
27<html>
28  <head>
29    <title>BASE 2.0 - Administrator documentation: jobagent.properties reference</title>
30  <link rel=stylesheet type="text/css" href="../styles.css">
31  </head>
32<body>
33
34<div class="navigation">
35  <a href="../index.html">BASE</a>
36  <img src="../next.gif">
37  <a href="index.html">Administrator documentation</a>
38  <img src="../next.gif">
39  jobagent.properties reference
40</div>
41
42<h1>BASE 2.0 - Administrator documentation: jobagent.properties reference</h1>
43
44<div class="abstract">
45
46  <p>
47  This document describes all configuration options for job
48  agents.
49  </p>
50
51  <b>Contents</b><br>
52  <ol>
53  <li><a href="#base">BASE settings</a>
54  <li><a href="#server">Job agent server settings</a>
55  <li><a href="#execution">Job execution settings</a>
56  </ol>
57
58
59  <p class="authors">
60  <b>Last updated:</b> $Date: 2007-08-16 14:16:43 +0000 (Thu, 16 Aug 2007) $<br>
61  <b>Copyright &copy;</b> 2006 The respective authors. All rights reserved.
62  </p>
63
64</div>
65
66  <a name="base"></a>
67  <h2>1. BASE settings</h2>
68
69  <table border="1" cellspacing="0" cellpadding="2" width="100%"> 
70  <tr>
71    <th>Setting</th>
72    <th>Default value</th>
73    <th>Description</th>
74  </tr>
75 
76  <tr>
77    <td>agent.user</td>
78    <td>-</td>
79    <td>
80      Required. The BASE user account the job agent should use to login
81      to the BASE server. The user account must have sufficient privileges
82      to access jobs and job agents. The predefined system role <code>Job agent</code>
83      is intended to be used by job agents. There is also a predefined user account
84      with the login <code>jobagent</code>. This account has to be enabled and
85      given a password before it can be used.
86    </td>
87  </tr>
88
89  <tr>
90    <td>agent.password</td>
91    <td>-</td>
92    <td>Required. The password for the user account.</td>
93  </tr>
94 
95  <tr>
96    <td>agent.id</td>
97    <td>-</td>
98    <td>
99      Required. A unique ID that identifies this job agent among other job agent.
100      If multiple job agents are installed each job agent should have it's own
101      unique ID.
102    </td>
103  </tr>
104
105  <tr>
106    <td>agent.name</td>
107    <td>-</td>
108    <td>
109      The name of the job agent. If not specified the ID is used. The name is only
110      used when registering the job agent with the BASE server.
111    </td>
112  </tr>
113 
114  <tr>
115    <td>agent.description</td>
116    <td>-</td>
117    <td>A description of the job agent. Only used when registering the job agent.</td>
118  </tr>
119 
120  </table>
121
122
123  <a name="server"></a>
124  <h2>2. Job agent server settings</h2>
125 
126  <table border="1" cellspacing="0" cellpadding="2" width="100%"> 
127  <tr>
128    <th>Setting</th>
129    <th>Default value</th>
130    <th>Description</th>
131  </tr>
132
133  <tr>
134    <td>agent.port</td>
135    <td>47822</td>
136    <td>
137      The port the job agent listens to for control requests. The requests are only
138      used for starting, stopping, pausing and getting status information from the
139      job agent. It is also used by the <code>jobagent.sh</code> command line interface
140      to control the local job agent.
141    </td>
142  </tr>
143 
144  <tr>
145    <td>agent.remotecontrol</td>
146    <td>-</td>
147    <td>
148      A comma-separated list of ip addresses or name of computers that
149      are allowed to send control requests to the job agent. If empty
150      only the local host is allowed to connect. It is recommended that the
151      web server is added to the list if the job agent is running
152      on a different server.
153    </td>
154  </tr>
155
156  <tr>
157    <td>agent.allowremote.stop</td>
158    <td>false</td>
159    <td>
160      If the <code>stop</code> command should be accepted from remote hosts
161      specified in the <code>agent.remotecontrol</code> setting.
162      If false only the local host is allowed to stop the job agent.
163    </td>
164  </tr>
165 
166  <tr>
167    <td>agent.allowremote.start</td>
168    <td>true</td>
169    <td>
170      If the <code>start</code> command should be accepted from the remote hosts
171      specified in the <code>agent.remotecontrol</code> setting.
172      If false only the local host is allowed to start the job agent.
173    </td>
174  </tr>
175
176  <tr>
177    <td>agent.allowremote.pause</td>
178    <td>true</td>
179    <td>
180      If the <code>pause</code> command should be accepted from the remote hosts
181      specified in the <code>agent.remotecontrol</code> setting.
182      If false only the local host is allowed to pause the job agent.
183    </td>
184  </tr>
185
186  </table>
187
188  <a name="execution"></a>
189  <h2>3. Job execution settings</h2>
190 
191  <table border="1" cellspacing="0" cellpadding="2" width="100%"> 
192  <tr>
193    <th>Setting</th>
194    <th>Default value</th>
195    <th>Description</th>
196  </tr>
197
198  <tr>
199    <td>agent.executor.class</td>
200    <td>net.sf.basedb.clients. jobagent.executors. ProcessJobExecutor</td>
201    <td>
202      Specifies the class that handles the actual execution of the jobs.
203      The default implementation ships three implementations:
204     
205      <ul>
206      <li>ProcessJobExecutor: Executes the job in an external process. This
207        is the recommended executor, since a misbehaving plugin doesn't
208        affect the job agent or other jobs.
209      <li>ThreadJobExecutor: Executes the job in a separate thread. This is only
210        recommended for plugins that are trusted and safe. A misbehaving plugin
211        can affect the job agent and other jobs.
212      <li>DummyJobExecutor: Doesn't executes the job. It only marks the job
213        as beeing executed. Use it only for debugging the job agent.
214      </ul>
215     
216      It is possible to create your own implemetnation of a job executor.
217      Create a class that implements the <code>net.sf.basedb.clients.jobagent.JobExecutor</code>
218      interface.
219    </td>
220  </tr>
221
222  <tr>
223    <td>agent.executor.process.java</td>
224    <td>java</td>
225    <td>
226      The path to the java executable used by the <code>ProcessJobExecutor</code>
227      only. If not specified the <code>JAVA_HOME</code>
228      environment variable will be checked. As a last resort <code>java</code>
229      is used without path information to let the operating system find the default
230      installation.
231    </td>
232  </tr>
233
234  <tr>
235    <td>agent.executor.process.options</td>
236    <td>-server</td>
237    <td>
238      Additional command line options to the java executable. Do not add
239      memory options, it will be added automatically by the executor. Used
240      by the <code>ProcessJobExecutor</code> only.
241    </td>
242  </tr>
243
244  <tr>
245    <td>agent.executor.dummy.wait</td>
246    <td>-</td>
247    <td>
248      Number of seconds the dummy job executor should wait before
249      returning from the job execution. The executor first sets the progress
250      to 50% then waits the specified number of seconds before setting
251      the job to completed. If no value is specified it returns immediately.
252    </td>
253  </tr>
254
255  <tr>
256    <td>agent.checkinterval</td>
257    <td>30</td>
258    <td>
259      Number of seconds between checks to the database for jobs that
260      are waiting for execution.
261    </td>
262  </tr>
263
264  <tr>
265    <td>agent.shortest.slots</td>
266    <td>1</td>
267    <td>
268      Number of slots to reserve for jobs that have estimated that it
269      takes &lt; 1 minute to execute.
270    </td>
271  </tr>
272
273  <tr>
274    <td>agent.shortest.priority</td>
275    <td>4</td>
276    <td>
277      The priority to give to jobs that have estimated that it
278      takes &lt; 1 minute to execute. The priority is a value between 1
279      and 10. See <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html"
280      >http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html</a> for more information
281      about thread priorities.
282    </td>
283  </tr>
284
285  <tr>
286    <td>agent.short.slots</td>
287    <td>1</td>
288    <td>
289      Number of slots to reserve for jobs that have estimated that it
290      takes &lt; 10 minutes to execute.
291    </td>
292  </tr>
293
294  <tr>
295    <td>agent.short.priority</td>
296    <td>4</td>
297    <td>
298      The priority to give to jobs that have estimated that it
299      takes &lt; 10 minutes to execute. The priority is a value between 1
300      and 10. See <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html"
301      >http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html</a> for more information
302      about thread priorities.
303    </td>
304  </tr>
305
306  <tr>
307    <td>agent.medium.slots</td>
308    <td>2</td>
309    <td>
310      Number of slots to reserve for jobs that have estimated that it
311      takes &lt; 1 hour to execute.
312    </td>
313  </tr>
314
315  <tr>
316    <td>agent.medium.priority</td>
317    <td>3</td>
318    <td>
319      The priority to give to jobs that have estimated that it
320      takes &lt; 1 hour to execute. The priority is a value between 1
321      and 10. See <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html"
322      >http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html</a> for more information
323      about thread priorities.
324    </td>
325  </tr>
326 
327  <tr>
328    <td>agent.long.slots</td>
329    <td>2</td>
330    <td>
331      Number of slots to reserve for jobs that have estimated that it
332      takes &gt; 1 hour to execute.
333    </td>
334  </tr>
335
336  <tr>
337    <td>agent.long.priority</td>
338    <td>3</td>
339    <td>
340      The priority to give to jobs that have estimated that it
341      takes &gt; 1 hour to execute. The priority is a value between 1
342      and 10. See <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html"
343      >http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html</a> for more information
344      about thread priorities.
345    </td>
346  </tr>
347
348  </table>
349
350</body>
351</html>
Note: See TracBrowser for help on using the repository browser.