1SGE_RESOURCE_QUOTA(5) Grid Engine File Formats SGE_RESOURCE_QUOTA(5)
2
6 SGE_resource_quota - Grid Engine resource quota file format
7
9 Resource quota sets (rqs) are a flexible way to set a maximum resource
10 consumption for any job requests. They are used by the scheduler to
11 select the next possible jobs for running. The job request distinction
12 is done by a set of user, project, cluster queue, host and pe filter
13 criteria.
14 By using the resource quota sets administrators can define a fine gran‐
16 ular resource quota configuration. This helps restricting some job
17 requests to a lesser resource usage and granting other job requests a
18 higher resource usage.
19 A list of currently configured rqs can be displayed via the qconf(1)
21 -srqsl option. The contents of each listed rqs definition can be shown
22 via the -srqs switch. The output follows the SGE_resource_quota format
23 description. New rqs can be created and existing can be modified via
24 the -arqs, -mrqs and -drqs options to qconf(1).
25 A resource quota set defines a maximum resource quota for a particular
27 job request. All of the configured rule sets apply all of the time.
28 This means that if multiple resource quota sets are defined, the most
29 restrictive set is used.
30 Every resource quota set consist of one or more resource quota rules.
32 These rules are evaluated in order, and the first rule that matches a
33 specific request will be used. A resource quota set always results in
34 at most one effective resource quota rule for a specific request.
35 Note: Grid Engine allows backslashes (\) be used to escape newline
37 (\newline) characters. The backslash and the newline are replaced with
38 a space (" ") character before any interpretation.
39
41 A resource quota set definition contains the following parameters:
42 name
44 The resource quota set name.
45 enabled
47 If set to true the resource quota set is active and will be considered
48 for scheduling decisions. The default value is false.
49 description
51 This description field is optional and can be set to arbitrary string.
52 The default value is NONE.
53 limit
55 Every resource quota set needs at least one resource quota rule defini‐
56 tion started with the limit field. It's possible to define more
57 resource quota rules divided by a new line. A resource quota rule con‐
58 sists of an optional name, the filters for a specific job request and
59 the resource quota limit.
60 By default, the expressed limit counts for the entire filter scope. To
62 express a filter-scope-specific limit, it's possible to define an
63 expanded list by setting the list between '{' '}'. It's only possible
64 to set one complete filter in an expanded list. The tags for express‐
65 ing a resource quota rule are:
66 name The name of the rule. The use is optional. The rule name must be
68 unique in one resource quota set.
69 users Contains a comma separated list of UNIX users or ACLs (see
71 access_list(5)). This parameter filters for jobs by a user in
72 the list or one of the ACLs in the list. Any user not in the
73 list will not be considered for the resource quota rule. The
74 default value is '*', which means any user. An ACL is differen‐
75 tiated from a UNIX user name by prefixing the ACL name with an
76 '@' sign. To exclude a user or ACL from the rule, the name can
77 be prefixed with the '!' sign. Defined UNIX user or ACL names
78 need not be known in the Grid Engine configuration.
79 projects
81 Contains a comma separated list of projects (see project(5)).
82 This parameter filters for jobs requesting a project in the
83 list. Any project not in the list will not be considered for the
84 resource quota rule. If no project filter is specified, all
85 projects and jobs with no requested project match the rule. The
86 value '*' means all jobs with requested projects. To exclude a
87 project from the rule, the name can be prefixed with the '!'
88 sign. The value '!*' means only jobs with no project requested.
89 pes Contains a comma separated list of PEs (see sge_pe(5)). This
91 parameter filters for jobs requesting a pe in the list. Any PE
92 not in the list will not be considered for the resource quota
93 rule. If no pe filter is specified, all pe and jobs with no
94 requested pe matches the rule. The value '*' means all jobs with
95 requested pe. To exclude a pe from the rule, the name can be
96 prefixed with the '!' sign. The value '!*' means only jobs with
97 no pe requested.
98 queues Contains a comma separated list of cluster queues (see
100 queue_conf(5)). This parameter filters for jobs that may be
101 scheduled in a queue in the list. Any queue not in the list
102 will not be considered for the resource quota rule. The default
103 value is '*', which means any queue. To exclude a queue from the
104 rule, the name can be prefixed with the '!' sign.
105 hosts Contains a comma separated list of host or hostgroups (see
107 host(5) and hostgroup(5)). This parameter filters for jobs that
108 may be scheduled in a host in the list or a host contained in a
109 hostgroup in the list. Any host not in the list will not be con‐
110 sidered for the resource quota rule. The default value is '*',
111 which means any hosts. To exclude a host or hostgroup from the
112 rule, the name can be prefixed with the
113 to This mandatory field defines the quota for resource attributes
115 for this rule. The quota is expressed by one or more limit defi‐
116 nitions separated by commas. The configuration allows two kind
117 of limits definitions
118 static limits
120 Static limits sets static values as quotas. Each limits
121 consists of a complex attribute followed by an "=" sign
122 and the value specification compliant with the complex
123 attribute type (see complex(5)).
124 dynamic limits
126 A dynamic limit is a simple algebraic expression used to
127 derive the limit value. To be dynamic, the formula can
128 reference a complex attribute whose value is used for the
129 calculation of the resulting limit. The formula expres‐
130 sion syntax is that of a sum of weighted complex values,
131 that is:
132 {w1|$complex1[*w1]}[{+|-}{w2|$complex2[*w2]}[{+|-}...]]
134 The weighting factors (w1, ...) are positive integers or
136 floating point numbers in double precision. The complex
137 values (complex1, ...) are specified by the name defined
138 as type INT or DOUBLE in the complex list (see com‐
139 plex(5)).
140 Note: Dynamic limits can only configured for a host-spe‐
141 cific rule.
142
144 The following is the simplest form of a resource quota set. It
145 restricts all users together to the maximal use of 100 slots in the
146 whole cluster.
147 =======================================================================
149 {
150 name max_u_slots
151 description "All users max use of 100 slots"
152 enabled true
153 limit to slots=100
154 }
155 =======================================================================
156 The next example restricts user1 and user2 to 6g virtual_free and all
159 other users to the maximal use of 4g virtual_free on every host in
160 hostgroup lx_hosts.
161 =======================================================================
163 {
164 name max_virtual_free_on_lx_hosts
165 description "resource quota for virtual_free restriction"
166 enabled true
167 limit users {user1,user2} hosts {@lx_host} to virtual_free=6g
168 limit users {*} hosts {@lx_host} to virtual_free=4g
169 }
170 =======================================================================
171 The next example shows the use of a dynamic limit. It restricts all
174 users together to a maximum use of the double size of num_proc.
175 =======================================================================
177 {
178 name max_slots_on_every_host
179 enabled true
180 limit hosts {*} to slots=$num_proc*2
181 }
182 =======================================================================
183
186 sge_intro(1), access_list(5), complex(5), host(5), hostgroup(5),
187 qconf(1), qquota(1), project(5).
188
190 See sge_intro(1) for a full statement of rights and permissions.
191GE 6.1 $Date: 2007/06/26 22:21:09 $ SGE_RESOURCE_QUOTA(5)