File: host_conf.5

package info (click to toggle)
gridengine 6.2-4
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 51,532 kB
  • ctags: 51,172
  • sloc: ansic: 418,155; java: 37,080; sh: 22,593; jsp: 7,699; makefile: 5,292; csh: 4,244; xml: 2,901; cpp: 2,086; perl: 1,895; tcl: 1,188; lisp: 669; ruby: 642; yacc: 393; lex: 266
file content (254 lines) | stat: -rw-r--r-- 9,473 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
'\" t
.\"___INFO__MARK_BEGIN__
.\"
.\" Copyright: 2004 by Sun Microsystems, Inc.
.\"
.\"___INFO__MARK_END__
.\" $RCSfile$     Last Update: $Date$     Revision: $Revision$
.\"
.\"
.\" Some handy macro definitions [from Tom Christensen's man(1) manual page].
.\"
.de SB		\" small and bold
.if !"\\$1"" \\s-2\\fB\&\\$1\\s0\\fR\\$2 \\$3 \\$4 \\$5
..
.\"
.de T		\" switch to typewriter font
.ft CW		\" probably want CW if you don't have TA font
..
.\"
.de TY		\" put $1 in typewriter font
.if t .T
.if n ``\c
\\$1\c
.if t .ft P
.if n \&''\c
\\$2
..
.\"
.de M		\" man page reference
\\fI\\$1\\fR\\|(\\$2)\\$3
..
.TH HOST_CONF 5 "$Date$" "xxRELxx" "xxQS_NAMExx File Formats"
.\"
.SH NAME
host_conf \- xxQS_NAMExx execution host configuration file format
.\"
.\"
.SH DESCRIPTION
.I Host_conf
reflects the format of the template file for the execution host configuration.
Via the \fB\-ae\fP and \fB\-me\fP options of the
.M qconf 1
command, you can add execution hosts and modify the configuration of
any execution host in the cluster. Default execution host entries are added
automatically as soon as a
.M xxqs_name_sxx_execd 8
registers to
.M xxqs_name_sxx_qmaster 8
for the very first time from a certain host. The
.M qconf 1
\fB\-sel\fP switch can be used to display a list of execution host being
currently configured in your xxQS_NAMExx system. Via the \fB\-se\fP
option you can print the execution host configuration of a
specified host.
.PP
The special hostname "global" can be used to define cluster global 
characteristics.
.PP
Note, xxQS_NAMExx allows backslashes (\\) be used to escape newline
(\\newline) characters. The backslash and the newline are replaced with a
space (" ") character before any interpretation.
.\"
.\"
.SH FORMAT
The format of a
.I host_conf
file is defined as follows:
.SS "\fBhostname\fP"
The execution hosts name as defined for \fIhost_name\fP in
.M sge_types 1 .
.SS "\fBload_scaling\fP"
A comma separated list of scaling values to be applied to each or part
of the load values being reported by the
.M xxqs_name_sxx_execd 8
on the host and being defined in the cluster global "host" complex
(see
.M complex 5 ).
The load scaling factors are intended to level hardware or operating
system specific differences between execution hosts. 
.sp 1
The syntax of a load factor specification is as follows: First the name of
the load value (as defined in the "host" complex) is given and, separated
by an equal sign, the load scaling value is provided. No blanks are
allowed in between the load_scaling value string.
.sp 1
The parameter
.B load_scaling
is not meaningful for the definition of the "global" host.
.SS "\fBcomplex_values\fP"
.B complex_values
defines quotas for resource attributes managed via this 
host. Each complex attribute is followed by an "=" sign and the value 
specification compliant with the complex attribute type (see
.M complex 5 ). 
Quota specifications are separated by commas. 
.sp 1
The quotas are related to the resource consumption of all jobs on a host in 
the case of consumable resources (see
.M complex 5
for details on 
consumable resources) or they are interpreted on a per job slot basis in the 
case of non-consumable resources. Consumable resource attributes are 
commonly used to manage free memory, free disk space or available 
floating software licenses while non-consumable attributes usually define 
distinctive characteristics like type of hardware installed.
.sp 1
For consumable resource attributes an available resource amount is 
determined by subtracting the current resource consumption of all 
running jobs on the host from the quota in the
.B complex_values
list. Jobs 
can only be dispatched to a host if no resource requests exceed any
corresponding resource 
availability obtained by this scheme. The quota definition in the 
.B complex_values
list is automatically replaced by the current load value 
reported for this attribute, if load is monitored for this resource and if the 
reported load value is more stringent than the quota. This effectively 
avoids oversubscription of resources.
.sp 1
.B Note:
Load values replacing the quota specifications may have become 
more stringent because they have been scaled (see
.B load_scaling
above) and/or
load adjusted (see
.M sched_conf 5 ).
The \fI\-F\fP option of
.M qstat 1
and the load display in the
.M qmon 1
queue control dialog (activated by 
clicking on a queue icon while the "Shift" key is pressed) provide 
detailed information on the actual availability of consumable 
resources and on the origin of the values taken into account currently.
.sp 1
.B Note also:
The resource consumption of running jobs (used for the availability 
calculation) as well as the resource requests of the jobs waiting to be 
dispatched either may be derived from explicit user requests during 
job submission (see the \fI\-l\fP option to
.M qsub 1 )
or from a "default" value 
configured for an attribute by the administrator (see
.M complex 5 ).
The \fI\-r\fP option to
.M qstat 1
can be used for retrieving full detail on the actual 
resource requests of all jobs in the system.
.sp 1
For non-consumable resources xxQS_NAMExx simply compares the 
job's attribute requests with the corresponding specification in 
.B complex_values
taking the relation operator of the complex attribute 
definition into account (see
.M complex 5 ).
If the result of the comparison is 
"true", the host is suitable for the job with respect to the particular 
attribute. For parallel jobs each job slot to be occupied by a parallel task is 
meant to provide the same resource attribute value.
.sp 1
.B Note:
Only numeric complex attributes can be defined as consumable 
resources and hence non-numeric attributes are always handled on a 
per job slot basis.
.sp 1
The default value for this parameter is NONE, i.e. no administrator 
defined resource attribute quotas are associated with the host.
.SS "\fBload_values\fP"
This entry cannot be configured but is only displayed in case of a
.M qconf 1
\fB\-se\fP command. All load values are displayed as reported by the
.M xxqs_name_sxx_execd 8
on the host. The load values are enlisted in a comma separated list. Each
load value start with its name, followed by an equal sign and the reported
value.
.SS "\fBprocessors\fP"
.B Note:
Deprecated, may be removed in future release.
.br
This entry cannot be configured but is only displayed in case of a
.M qconf 1
\fB\-se\fP command. Its value is the number of processors which has been
detected by
.M xxqs_name_sxx_execd 8
on the corresponding host.
.SS "\fBusage_scaling\fP"
The format is equivalent to
.B load_scaling
(see above), the only valid attributes to be scaled however are
.B cpu
for CPU time consumption,
.B mem 
for Memory consumption aggregated over the life-time of jobs and
.B io
for data transferred via any I/O devices. The default NONE means
"no scaling", i.e. all scaling factors are 1.
.SS "\fBuser_lists\fP"
The \fBuser_lists\fP parameter contains a comma separated list of so called
user access lists as described in
.M access_list 5 .
Each user contained in at least one of the enlisted access lists has
access to the host. If the \fBuser_lists\fP parameter is set to
NONE (the default) any user has access being not explicitly excluded
via the \fBxuser_lists\fP parameter described below.
If a user is contained both in an access list enlisted in \fBxuser_lists\fP
and \fBuser_lists\fP the user is denied access to the host.
.SS "\fBxuser_lists\fP"
The \fBxuser_lists\fP parameter contains a comma separated list of so called
user access lists as described in
.M access_list 5 .
Each user contained in at least one of the enlisted access lists is not
allowed to access the host. If the \fBxuser_lists\fP parameter is set to
NONE (the default) any user has access.
If a user is contained both in an access list enlisted in \fBxuser_lists\fP
and \fBuser_lists\fP the user is denied access to the host.
.SS "\fBprojects\fP"
The \fBprojects\fP parameter contains a comma separated list of projects
that have access to the host. Any projects not in this list are denied
access to the host. If set to NONE (the default), any project
has access that is not specifically excluded via the \fBxprojects\fP
parameter described below. If a project is in both the \fBprojects\fP and
\fBxprojects\fP parameters, the project is denied access to the host.
.SS "\fBxprojects\fP"
The \fBxprojects\fP parameter contains a comma separated list of projects
that are denied access to the host. If set to NONE (the default), no
projects are denied access other than those denied access based on the
\fBprojects\fP parameter described above.  If a project is in both the
\fBprojects\fP and \fBxprojects\fP parameters, the project is denied
access to the host.
.\"
.SS "\fBreport_variables\fP"
The \fBreport_variables\fP parameter contains a comma separated list of 
variables that shall be written to the reporting file.
The variables listed here will be written to the reporting file when a load report arrives from an execution host.
.sp 1
Default settings can be done in the global host. Host specific settings for 
report_variables will override settings from the global host.
.\"
.\"
.SH "SEE ALSO"
.M xxqs_name_sxx_intro 1 ,
.M xxqs_name_sxx_types 1 ,
.M qconf 1 ,
.M uptime 1 ,
.M access_list 5 ,
.M complex 5 ,
.M xxqs_name_sxx_execd 8 ,
.M xxqs_name_sxx_qmaster 8 .
.\"
.SH "COPYRIGHT"
See
.M xxqs_name_sxx_intro 1
for a full statement of rights and permissions.