| 41 | | <dont_generate_upload_certificates/> |
| 42 | | }}} |
| 43 | | 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. |
| 44 | | {{{ |
| 45 | | <ignore_upload_certificates/> |
| 46 | | }}} |
| 47 | | If upload certificates are not generated, this option must be enabled to force file upload handler accept files being uploaded. |
| 48 | | {{{ |
| 49 | | <locality_scheduling/> |
| 50 | | }}} |
| 51 | | When possible, send work that uses the same files that the host already has. This is intended for projects which have large data files, where many different workunits use the same data file. In this case, to reduce download demands on the server, it may be advantageous to retain the data files on the hosts, and send them work for the files that they already have. See [LocalityScheduling Locality Scheduling]. |
| 52 | | {{{ |
| 53 | | <locality_scheduling_wait_period> N </locality_scheduling_wait_period> |
| 54 | | }}} |
| 55 | | 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]. |
| 56 | | {{{ |
| 57 | | <min_core_client_version> N </min_core_client_version> |
| 58 | | }}} |
| 59 | | If the scheduler gets a request from a client with a version number less than this, it returns an error message and doesn't do any other processing. The version number is expressed as an integer with the encoding major*100+minor. You can also specify this separately for each [AppVersion application]. |
| 60 | | {{{ |
| 61 | | <choose_download_url_by_timezone> 0|1 </choose_download_url_by_timezone> |
| 62 | | }}} |
| 63 | | 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'. |
| 64 | | {{{ |
| 65 | | <cache_md5_info> 0|1 </cache_md5_info> |
| 66 | | }}} |
| 67 | | 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. |
| 68 | | {{{ |
| 69 | | <nowork_skip> 0|1 </nowork_skip> |
| 70 | | }}} |
| 71 | | If the scheduling server 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. |
| 72 | | {{{ |
| 73 | | <resend_lost_results> 0|1 </resend_lost_results> |
| 74 | | }}} |
| 75 | | 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: |
| 76 | | {{{ |
| 77 | | alter table result add index res_host_state (hostid, server_state); |
| 78 | | }}} |
| 79 | | {{{ |
| 80 | | <send_result_abort>0|1</send_result_abort> |
| 81 | | }}} |
| 82 | | 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. |
| 83 | | {{{ |
| 84 | | <default_disk_max_used_gb> X </default_disk_max_used_gb> |
| 85 | | }}} |
| 86 | | 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. |
| 87 | | {{{ |
| 88 | | <default_disk_max_used_pct> X </default_disk_max_used_pct> |
| 89 | | }}} |
| 90 | | 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. |
| 91 | | {{{ |
| 92 | | <default_disk_min_free_gb> X </default_disk_min_free_gb> |
| 93 | | }}} |
| 94 | | 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. |
| 95 | | {{{ |
| 96 | | <one_result_per_host_per_wu/> |
| 97 | | }}} |
| 98 | | 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. |
| 99 | | {{{ |
| 100 | | <next_rpc_delay>x</next_rpc_delay> |
| 101 | | }}} |
| 102 | | In each scheduler reply, tell the clients to do another scheduler RPC after at most X seconds, regardless of whether they need work. This is useful, e.g., to ensure that in-progress jobs can be canceled in a bounded amount of time. |
| | 45 | <ban_os>regexp</ban_os> |
| | 46 | }}} |
| | 47 | 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. |
| | 48 | {{{ |
| | 49 | <ban_cpu>regexp</ban_cpu> |
| | 50 | }}} |
| | 51 | 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. |
| 146 | | }}} |
| 147 | | Hosts whose average turnaround is at most reliable_max_avg_turnaround and whose error rate is at most reliable_max_error_rate are considered 'reliable'. |
| | 65 | |
| | 66 | == Scheduling: array-based scheduling == |
| | 67 | {{{ |
| | 68 | <nowork_skip> 0|1 </nowork_skip> |
| | 69 | }}} |
| | 70 | If the scheduling server 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. |
| | 71 | {{{ |
| | 72 | <shmem_work_items>N</shmem_work_items> |
| | 73 | }}} |
| | 74 | The size of the shared-memory array of jobs. Default is 100. |
| | 75 | {{{ |
| | 76 | <feeder_query_size>N</feeder_query_size> |
| | 77 | }}} |
| | 78 | The size of the feeder's enumeration query. Default is 200. |
| | 79 | |
| | 80 | {{{ |
| | 81 | <reliable_max_avg_turnaround_time>secs</reliable_max_avg_turnaround_time> |
| | 82 | <reliable_max_error_rate>secs</reliable_max_error_rate> |
| | 83 | }}} |
| | 84 | Hosts whose average turnaround is at most reliable_max_avg_turnaround |
| | 85 | and whose error rate is at most reliable_max_error_rate |
| | 86 | are considered 'reliable'. |
| 158 | | {{{ |
| 159 | | <granted_credit_weight>X</granted_credit_weight> |
| 160 | | }}} |
| 161 | | KEVIN - PLEASE EXPLAIN |
| | 97 | |
| | 98 | |
| | 99 | == Scheduling: locality scheduling == |
| | 100 | {{{ |
| | 101 | <locality_scheduling/> |
| | 102 | }}} |
| | 103 | When possible, send work that uses the same files that the host already has. This is intended for projects which have large data files, where many different workunits use the same data file. In this case, to reduce download demands on the server, it may be advantageous to retain the data files on the hosts, and send them work for the files that they already have. See [LocalityScheduling Locality Scheduling]. |
| | 104 | {{{ |
| | 105 | <locality_scheduling_wait_period> N </locality_scheduling_wait_period> |
| | 106 | }}} |
| | 107 | 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]. |
| | 108 | |
| | 109 | == Scheduling: job retransmission == |
| | 110 | {{{ |
| | 111 | <resend_lost_results> 0|1 </resend_lost_results> |
| | 112 | }}} |
| | 113 | 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: |
| | 114 | {{{ |
| | 115 | alter table result add index res_host_state (hostid, server_state); |
| | 116 | }}} |
| | 117 | {{{ |
| | 118 | <send_result_abort>0|1</send_result_abort> |
| | 119 | }}} |
| | 120 | 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. |
| | 121 | |
| | 122 | |
| | 123 | == Scheduling: data distribution == |
| | 124 | {{{ |
| | 125 | <choose_download_url_by_timezone> 0|1 </choose_download_url_by_timezone> |
| | 126 | }}} |
| | 127 | 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'. |
| | 128 | {{{ |
| | 129 | <cache_md5_info> 0|1 </cache_md5_info> |
| | 130 | }}} |
| | 131 | 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. |
| | 132 | |
| | 133 | == Upload certificates == |
| | 134 | {{{ |
| | 135 | <dont_generate_upload_certificates/> |
| | 136 | }}} |
| | 137 | 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. |
| | 138 | {{{ |
| | 139 | <ignore_upload_certificates/> |
| | 140 | }}} |
| | 141 | If upload certificates are not generated, this option must be enabled to force file upload handler accept files being uploaded. |
| | 142 | |
| | 143 | == Default preferences == |
| | 144 | {{{ |
| | 145 | <default_disk_max_used_gb> X </default_disk_max_used_gb> |
| | 146 | }}} |
| | 147 | 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. |
| | 148 | {{{ |
| | 149 | <default_disk_max_used_pct> X </default_disk_max_used_pct> |
| | 150 | }}} |
| | 151 | 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. |
| | 152 | {{{ |
| | 153 | <default_disk_min_free_gb> X </default_disk_min_free_gb> |
| | 154 | }}} |
| | 155 | 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. |
| | 156 | |
