Changes between Version 97 and Version 98 of ProjectOptions

Timestamp:

Jun 1, 2010, 4:17:47 PM (14 years ago)

Author:

davea

Comment:

--

ProjectOptions

@@ -15 +15 @@
 
 === General ===
+
+{{{
+<ignore_delay_bound/>
+}}}
+By default, results are not sent to hosts too slow to complete them within delay bound.
+If this flag is set, this rule is not enforced.
+{{{
+<ban_os>regexp</ban_os>
+}}}
+Any host for which os_name<tab>os_version matches the given regular expression will not be sent jobs.
+This is a POSIX extended regular expression.
+{{{
+<ban_cpu>regexp</ban_cpu>
+}}}
+Any host for which p_vendor<tab>p_model matches the given regular expression will not be sent jobs.
+This is a POSIX extended regular expression.
+{{{
+<workload_sim>0|1</workload_sim>
+}}}
+Do a simulation, based on current client workload, in deciding whether a job's deadline can be met.
+{{{
+<homogeneous_redundancy>N</homogeneous_redundancy>
+}}}
+If zero (default) don't use the [HomogeneousRedundancy homogeneous redundancy] mechanism.
+Otherwise, specifies the granularity of host classification (1=fine, 2=coarse).
+(Note: you may also specify this on a per-application basis).
+{{{
+<distinct_beta_apps>0|1</distinct_beta_apps>
+}}}
+If set, [AppFiltering user application selection] applies to [BetaTest beta test applications] as well as others.
+{{{
+<nowork_skip> 0|1 </nowork_skip>
+}}}
+If the scheduler has no work, it replies to RPCs without doing any database access
+(e.g., without looking up the user or host record).
+This reduces DB load, but it fails to update preferences when users click on Update.
+Use it if your server DB is overloaded.
+{{{
+<multiple_clients_per_host>0|1</multiple_clients_per_host>
+}}}
+Set this if some of your hosts run multiple BOINC clients simultaneously
+(this is the case on projects that use Condor and/or grid resources,
+which require each client to use only 1 CPU).
+If set, the scheduler will skip a check that tries to locate the host
+based on its IP address.
+
+=== Job limits ===
 {{{
 <one_result_per_user_per_wu/>
@@ -26 +73 @@
 If present, send at most one result of a given workunit to a given host.
 This is weaker than `one_result_per_user_per_wu`;
-it is useful if you're using homogeneous redundancy and most of the hosts of a particular class belong to a single user.
+it's useful if you're using homogeneous redundancy
+and most of the hosts of a particular class belong to a single user.
 
 {{{
@@ -46 +94 @@
 
 {{{
+<max_jobs_in_progress>
+        <project>
+                <total_limit>
+                        <jobs>N</jobs>
+                </total_limit>
+                [ <gpu_limit> ]
+                        <jobs>N</jobs>
+                        [ <per_proc/> ]
+                                if set, limit is per processor
+                [ <cpu_limit> ]
+                ...
+        </project>
+        <app>
+                <app>name</app>
+                [ <total_limit> ... ]
+                [ <cpu_limit> ... ]
+                [ <gpu_limit> ... ]
+        </app>
+        ...
+</max_jobs_in_progress>
+}}}
+A more adaptable way of expressing limits on the number of jobs in progress on a host.
+You can specify limits for specific apps, and for your projects as a whole.
+Within each of these, you can specify limits for CPU jobs, GPU jobs, or total.
+In the case of CPU and GPU jobs, you can specify whether the limit should be
+scaled by the number of devices present on the host.
+
+{{{
 <gpu_multiplier> GM </gpu_multiplier>
 }}}
@@ -57 +133 @@
 You can use this to limit the impact of faulty hosts.
 Default is 10.
+{{{
+<max_ncpus>N</max_ncpus>
+}}}
+An upper bound on NCPUS (default: 16)
 
 {{{
@@ -62 +142 @@
 }}}
 Each host has a field MRD in the interval [1 .. daily_result_quota];
-it's initially daily_result_quota, and is adjusted as the host sends good or bad results.
-The maximum number of jobs sent to a given host in a 24-hour period is '''MRD*(NCPUS + GM*NGPUS)'''.
+it's initially daily_result_quota,
+and is adjusted as the host sends good or bad results.
+The maximum number of jobs sent to a given host in a 24-hour period is
+'''MRD*(NCPUS + GM*NGPUS)'''.
 You can use this to limit the impact of faulty hosts.
-{{{
-<ignore_delay_bound/>
-}}}
-By default, results are not sent to hosts too slow to complete them within delay bound.
-If this flag is set, this rule is not enforced.
-{{{
-<ban_os>regexp</ban_os>
-}}}
-Any host for which os_name<tab>os_version matches the given regular expression will not be sent jobs.
-This is a POSIX extended regular expression.
-{{{
-<ban_cpu>regexp</ban_cpu>
-}}}
-Any host for which p_vendor<tab>p_model matches the given regular expression will not be sent jobs.
-This is a POSIX extended regular expression.
-{{{
-<workload_sim>0|1</workload_sim>
-}}}
-Do a simulation, based on current client workload, in deciding whether a job's deadline can be met.
-{{{
-<homogeneous_redundancy>N</homogeneous_redundancy>
-}}}
-If zero (default) don't use the [HomogeneousRedundancy homogeneous redundancy] mechanism.
-Otherwise, specifies the granularity of host classification (1=fine, 2=coarse).
-{{{
-<distinct_beta_apps>0|1</distinct_beta_apps>
-}}}
-If set, [AppFiltering user application selection] applies to [BetaTest beta test applications] as well as others.
-{{{
-<nowork_skip> 0|1 </nowork_skip>
-}}}
-If the scheduler has no work, it replies to RPCs without doing any database access (e.g., without looking up the user or host record).
-This reduces DB load, but it fails to update preferences when users click on Update.
-Use it if your server DB is overloaded.
-{{{
-<multiple_clients_per_host>0|1</multiple_clients_per_host>
-}}}
-Set this if some of your hosts run multiple BOINC clients simultaneously
-(this is the case on projects that use Condor and/or grid resources,
-which require each client to use only 1 CPU).
-If set, the scheduler will skip a check that tries to locate the host
-based on its IP address.
-{{{
-<max_ncpus>N</max_ncpus>
-}}}
-An upper bound on NCPUS (default: 8)
-
-{{{
-<ignore_dcf>0|1</ignore_dcf>
-}}}
-If true, ignore duration correction factor.
-Use this temporarily if you've made a major change to your workunit FLOPS estimates.
+
 === Job-cache scheduling ===
 
@@ -165 +196 @@
  * Hosts are deemed "reliable" (a slight misnomer) if they satisfy turnaround time and error rate criteria.
  * A job instance is deemed "need-reliable" if its priority is above a threshold.
- * The scheduler tries to send need-reliable jobs to reliable hosts.  When it does, it reduces the delay bound of the job.
- * When job replicas are created in response to errors or timeouts, their priority is raised relative to the job's base priority.
+ * The scheduler tries to send need-reliable jobs to reliable hosts.
+   When it does, it reduces the delay bound of the job.
+ * When job replicas are created in response to errors or timeouts,
+   their priority is raised relative to the job's base priority.
 
 The configurable parameters are:
@@ -216 +249 @@
 <locality_scheduling_wait_period> N </locality_scheduling_wait_period>
 }}}
-This element only has an effect when used in conjunction with the previous locality scheduling element. It tells the scheduler to use 'trigger files' to inform the project that more work is needed for specific files. The period is the number of seconds which the scheduler will wait to see if the project can create additional work. Together with project-specific daemons or scripts this can be used for 'just-in-time' workunit creation. See [LocalityScheduling Locality Scheduling].
+This element only has an effect when used in conjunction with the previous locality scheduling element.
+It tells the scheduler to use 'trigger files' to inform the project that more work is needed for specific files.
+The period is the number of seconds which the scheduler will wait to see if the project can create additional work.
+Together with project-specific daemons or scripts this can be used for 'just-in-time' workunit creation.
+See [LocalityScheduling Locality Scheduling].
 
 === Job retransmission ===
@@ -222 +259 @@
 <resend_lost_results> 0|1 </resend_lost_results>
 }}}
-If set, and a <other_results> list is present in scheduler request, resend any in-progress results not in the list. This is recommended; it may increase the efficiency of your project. For reasons that are not well understood, a BOINC client sometimes fails to receive the scheduler reply. This flag addresses that issue: it causes the SAME results to be resent by the scheduler, if the client has failed to receive them.  Note: this will increase the load on your DB server; you can minimize this by creating an index:
+If set, and a <other_results> list is present in scheduler request, resend any in-progress results not in the list.
+This is recommended; it may increase the efficiency of your project.
+For reasons that are not well understood, a BOINC client sometimes fails to receive the scheduler reply.
+This flag addresses that issue: it causes the SAME results to be resent by the scheduler,
+if the client has failed to receive them.
+Note: this will increase the load on your DB server; you can minimize this by creating an index:
 {{{
 alter table result add index res_host_state (hostid, server_state);
@@ -229 +271 @@
 <send_result_abort>0|1</send_result_abort>
 }}}
-If set, and the client is processing a result for a WU that has been canceled or is not in the DB (i.e. there's no chance of getting credit), tell the client to abort the result regardless of state. If client is processing a result for a WU that has been assimilated or is overdue (i.e. there's a chance of not getting credit) tell the client to abort the result if it hasn't started yet. Note: this will increase the load on your DB server.
+If set, and the client is processing a result for a WU that has been canceled or is not in the DB
+(i.e. there's no chance of getting credit), tell the client to abort the result regardless of state.
+If client is processing a result for a WU that has been assimilated or is overdue
+(i.e. there's a chance of not getting credit) tell the client to abort the result if it hasn't started yet.
+Note: this will increase the load on your DB server.
 
 
@@ -237 +283 @@
 }}}
 OUTDATED: BERND, PLEASE UPDATE.
-When the scheduler sends work to hosts, it replaces the download URL appearing in the data and executable file descriptions with the download URL closest to the host's timezone. The project must provide a two-column file called 'download_servers' in the project root directory. This is a list of all download servers that will be inserted when work is sent to hosts. The first column is an integer listing the server's offset in seconds from UTC. The second column is the server URL in the format such as !http://einstein.phys.uwm.edu. The download servers must have identical file hierarchies and contents, and the path to file and executables must start with '/download/...' as in '!http://X/download/123/some_file_name'.
+When the scheduler sends work to hosts,
+it replaces the download URL appearing in the data and executable file descriptions
+with the download URL closest to the host's timezone.
+The project must provide a two-column file called 'download_servers' in the project root directory.
+This is a list of all download servers that will be inserted when work is sent to hosts.
+The first column is an integer listing the server's offset in seconds from UTC.
+The second column is the server URL in the format such as !http://einstein.phys.uwm.edu.
+The download servers must have identical file hierarchies and contents,
+and the path to file and executables must start with '/download/...' as in '!http://X/download/123/some_file_name'.
 {{{
 <cache_md5_info> 0|1 </cache_md5_info>
 }}}
-When creating work, keep a record (in files called foo.md5) of the file length and md5 sum of data files and executables. This can greatly reduce the time needed to create work, if (1) these files are re-used, and (2) there are many of these files, and (3) reading the files from disk is time-consuming.
+When creating work, keep a record (in files called foo.md5) of the file length and md5 sum of data files and executables.
+This can greatly reduce the time needed to create work, if (1) these files are re-used, and (2) there are many of these files,
+and (3) reading the files from disk is time-consuming.
 
 === Logging ===
@@ -362 +418 @@
 <dont_generate_upload_certificates/>
 }}}
-Don't put upload certificates in results. This makes result generation a lot faster, since no encryption is done, but you lose protection against DoS attacks on your upload servers.
+Don't put upload certificates in results.
+This makes result generation a lot faster,
+since no encryption is done, but you lose protection against DoS attacks on your upload servers.
 {{{
 <ignore_upload_certificates/>
@@ -372 +430 @@
 <default_disk_max_used_gb> X </default_disk_max_used_gb>
 }}}
-Sets the default value for the `disk_max_used_gb` preference so it's consistent between the scheduler and web pages. The scheduler uses it when a request for work doesn't include preferences, or the preference is set to zero. The web page scripts use it to set the initial value when displaying or editing preferences the first time, or when the user never saved them. Default is 100.
+Sets the default value for the `disk_max_used_gb` preference so it's consistent between the scheduler and web pages.
+The scheduler uses it when a request for work doesn't include preferences, or the preference is set to zero.
+The web page scripts use it to set the initial value when displaying or editing preferences the first time, or when the user never saved them.
+Default is 100.
 {{{
 <default_disk_max_used_pct> X </default_disk_max_used_pct>
 }}}
-Sets the default value for the `disk_max_used_pct` preference so its consistent between the scheduler and web pages. The scheduler uses it when a request for work doesn't include preferences, or the preference is set to zero. The web page scripts use it to set the initial value when displaying or editing preferences the first time, or when the user never saved them. Default is 50.
+Sets the default value for the `disk_max_used_pct` preference so its consistent between the scheduler and web pages.
+The scheduler uses it when a request for work doesn't include preferences, or the preference is set to zero.
+The web page scripts use it to set the initial value when displaying or editing preferences the first time,
+or when the user never saved them. Default is 50.
 {{{
 <default_disk_min_free_gb> X </default_disk_min_free_gb>
 }}}
-Sets the default value for the `disk_min_free_gb` preference so its consistent between the scheduler and web pages. The scheduler uses it when a request for work doesn't include preferences. The web page scripts use it to set the initial value when displaying or editing preferences the first time, or when the user never saved them. Also, the scheduler uses this setting to override any smaller preference from the host, it enforces a 'minimum free disk space' to keep from filling up the drive. Recommend setting this no smaller than .001 (1MB or 1,000,000 bytes). Default is .001.
-
-
+Sets the default value for the `disk_min_free_gb` preference so its consistent between the scheduler and web pages.
+The scheduler uses it when a request for work doesn't include preferences.
+The web page scripts use it to set the initial value when displaying or editing preferences the first time,
+or when the user never saved them.
+Also, the scheduler uses this setting to override any smaller preference from the host,
+it enforces a 'minimum free disk space' to keep from filling up the drive.
+Recommend setting this no smaller than .001 (1MB or 1,000,000 bytes). Default is .001.
 
 
@@ -396 +464 @@
 <fp_benchmark_weight> X </fp_benchmark_weight>
 }}}
-The weighting given to the Whetstone benchmark in the calculation of claimed credit. Must be in [0 .. 1]. Projects whose applications are floating-point intensive should use 1; pure integer applications, 0. Choosing an appropriate value will reduce the disparity in claimed credit between hosts. The script html/ops/credit_study.php, run against the database of a running project, will suggest what value to use.
+The weighting given to the Whetstone benchmark in the calculation of claimed credit.
+Must be in [0 .. 1]. Projects whose applications are floating-point intensive should use 1; pure integer applications, 0.
+Choosing an appropriate value will reduce the disparity in claimed credit between hosts.
+The script html/ops/credit_study.php, run against the database of a running project, will suggest what value to use.
 {{{
 <granted_credit_weight>X</granted_credit_weight>
@@ -457 +528 @@
 <akismet_key> 1234567890ab </akismet_key>
 }}}
-If set, akismet.com is used to check post contents to protect forums from spam. See [ProtectionFromSpam Protecting message boards from spam] for more information.
+If set, akismet.com is used to check post contents to protect forums from spam.
+See [ProtectionFromSpam Protecting message boards from spam] for more information.
 {{{
 <users_per_page>N</users_per_page>
@@ -472 +544 @@
 <recaptcha_private_key>X</recaptcha_private_key>
 }}}
-Enable the use of Recaptcha for profile creation/editing; see [ProtectionFromSpam Protecting message boards from spam] for more information.
+Enable the use of Recaptcha for profile creation/editing;
+see [ProtectionFromSpam Protecting message boards from spam] for more information.
 {{{
 <profile_min_credit>X</profile_min_credit>
@@ -524 +597 @@
 <dont_store_success_stderr/>
 }}}
-If present, don't store the stderr log in the database for successful workunits. May be useful to save on database size. Available since r18528. 
+If present, don't store the stderr log in the database for successful workunits.
+May be useful to save on database size. Available since r18528. 
 
 == Hosts, directories, and URLs == #dirs
@@ -538 +612 @@
 <host>hostname</host>
 }}}
-name of project's main host, as given by Python's `socket.hostname()`. Daemons and tasks run on this host by default.
+name of project's main host, as given by Python's `socket.hostname()`.
+Daemons and tasks run on this host by default.
 {{{
 <db_name>name</db_name>
@@ -600 +675 @@
 <sched_lockfile_dir>path</sched_lockfile_dir>
 }}}
-Enables scheduler locking (recommended) and specifies directory where scheduler lockfiles are stored. Must be writable to the Apache user.
+Enables scheduler locking (recommended) and specifies directory where scheduler lockfiles are stored.
+Must be writable to the Apache user.
 
 = Parsing project options = #parsing-config