1CALENDAR_CONF(5)           Grid Engine File Formats           CALENDAR_CONF(5)
2
3
4

NAME

6       calendar_conf - Grid Engine calendar configuration file format
7

DESCRIPTION

9       calendar_conf  reflects the format of the Grid Engine calendar configu‐
10       ration. The definition of calendars is used to specify  "on  duty"  and
11       "off duty" time periods for Grid Engine queues on a time of day, day of
12       week or day of year basis. Various calendars can be implemented and the
13       appropriate  calendar  definition  for  a  certain class of jobs can be
14       attached to a queue.
15
16       calendar_conf entries can be added, modified  and  displayed  with  the
17       -Acal,  -acal,  -Mcal,  -mcal,  -scal and -scall options to qconf(1) or
18       with the calendar configuration dialog of the graphical user  interface
19       qmon(1).
20
21       Note:  Grid  Engine  allows  backslashes  (\) be used to escape newline
22       (\newline) characters. The backslash and the newline are replaced  with
23       a space (" ") character before any interpretation.
24

FORMAT

26   calendar_name
27       The name of the calendar to be used when attaching it to queues or when
28       administering   the   calendar   definition.   See   calendar_name   in
29       sge_types(1) for a precise definition of valid calendar names.
30
31   year
32       The queue status definition on a day of the year basis. This field gen‐
33       erally will specify on which days of a year (and  optionally  at  which
34       times  on  those days) a queue, to which the calendar is attached, will
35       change to a certain state. The syntax of the year field is  defined  as
36       follows:
37
38       year:=
39           { NONE
40           | year_day_range_list=daytime_range_list[=state]
41           | year_day_range_list=[daytime_range_list=]state
42           | state}
43
44       Where
45
46       ·  NONE means, no definition is made on the year basis
47
48       ·  if  a  definition  is  made  on  the  year  basis,  at  least one of
49          year_day_range_list, daytime_range_list and  state  must  always  be
50          present
51
52       ·  all day long is assumed if daytime_range_list is omitted,
53
54       ·  switching the queue to "off" (i.e. disabling it) is assumed if state
55          is omitted,
56
57       ·  the queue is assumed to  be  enabled  for  days  neither  referenced
58          implicitly (by omitting the year_day_range_list) nor explicitly
59
60       and the syntactical components are defined as follows:
61
62         year_day_range_list := {yearday-yearday|yearday},...
63         daytime_range_list :=  hour[:minute][:second]-
64                                hour[:minute][:second],...
65         state :=     {on|off|suspended}
66         year_day :=  month_day.month.year
67         month_day := {1|2|...|31}
68         month :=     {jan|feb|...|dec|1|2|...|12}
69         year :=      {1970|1971|...|2037}
70
71   week
72       The queue status definition on a day of the week basis. This field gen‐
73       erally will specify on which days of a week (and  optionally  at  which
74       times  on  those days) a queue, to which the calendar is attached, will
75       change to a certain state. The syntax of the week field is  defined  as
76       follows:
77
78       week:=
79           { NONE
80           | week_day_range_list[=daytime_range_list][=state]
81           | [week_day_range_list=]daytime_range_list[=state]
82           | [week_day_range_list=][daytime_range_list=]state} ...
83
84       Where
85
86       ·  NONE means, no definition is made on the week basis
87
88       ·  if  a  definition  is  made  on  the  week  basis,  at  least one of
89          week_day_range_list, daytime_range_list and state always have to  be
90          present,
91
92       ·  every day in the week is assumed if week_day_range_list is omitted,
93
94       ·  syntax  and  semantics of daytime_range_list and state are identical
95          to the definition given for the year field above,
96
97       ·  the queue is assumed to  be  enabled  for  days  neither  referenced
98          implicitly (by omitting the week_day_range_list) nor explicitly
99
100       and where week_day_range_list is defined as
101
102         week_day_range_list := {weekday-weekday|weekday},...
103         week_day :=  {mon|tue|wed|thu|fri|sat|sun}
104
105       with week_day ranges the week_day identifiers must be different.
106

SEMANTICS

108       Successive  entries  to  the year and week fields (separated by blanks)
109       are combined in compliance with the following rule:
110
111       ·  "off"-areas  are  overridden  by   overlapping   "on"-   and   "sus‐
112          pended"-areas and "suspended"-areas are overridden by "on"-areas.
113
114       Hence an entry of the form
115
116         week  12-18 tue=13-17=on
117
118       means  that  queues referencing the corresponding calendar are disabled
119       the entire week from 12.00-18.00 with the exception of Tuesday  between
120       13.00-17.00 where the queues are available.
121
122
123       ·  Area  overriding  occurs  only  within  a year/week basis. If a year
124          entry exists for a day then only the year  calendar  is  taken  into
125          account  and  no area overriding is done with a possibly conflicting
126          week area.
127
128
129       ·  the second time specification in a daytime_range_list may be  before
130          the first one and treated as expected. Thus an entry of the form
131
132            year  12.03.2004=12-11=off
133
134          causes  the queue(s) be disabled 12.03.2004 from 00:00:00 - 10:59:59
135          and 12:00:00 - 23:59:59.
136

EXAMPLES

138       (The   following   examples   are   contained    in    the    directory
139       $SGE_ROOT/util/resources/calendars).
140
141       ·  Night, weekend and public holiday calendar:
142
143          On public holidays "night" queues are explicitly enabled. On working
144          days queues are disabled between 6.00 and 20.00. Saturday and Sunday
145          are implicitly handled as enabled times:
146
147            calendar_name  night
148            year           1.1.1999,6.1.1999,28.3.1999,30.3.1999-
149            31.3.1999,18.5.1999-19.5.1999,3.10.1999,25.12.1999,26
150            .12.1999=on
151            week           mon-fri=6-20
152
153
154       ·  Day calendar:
155
156          On  public  holidays "day"-queues are disabled. On working days such
157          queues are closed during the night between 20.00 and 6.00, i.e.  the
158          queues  are  also  closed  on Monday from 0.00 to 6.00 and on Friday
159          from 20.00 to 24.00. On Saturday and Sunday the queues are disabled.
160
161            calendar_name  day
162            year           1.1.1999,6.1.1999,28.3.1999,30.3.1999-
163            31.3.1999,18.5.1999-19.5.1999,3.10.1999,25.12.1999,26
164            .12.1999
165            week           mon-fri=20-6 sat-sun
166
167
168       ·  Night, weekend and public holiday calendar with suspension:
169
170          Essentially the same scenario as the first example  but  queues  are
171          suspended instead of switching them "off".
172
173            calendar_name  night_s
174            year           1.1.1999,6.1.1999,28.3.1999,30.3.1999-
175            31.3.1999,18.5.1999-19.5.1999,3.10.1999,25.12.1999,26
176            .12.1999=on
177            week           mon-fri=6-20=suspended
178
179
180       ·  Day calendar with suspension:
181
182          Essentially  the  same scenario as the second example but queues are
183          suspended instead of switching them "off".
184
185            calendar_name  day_s
186            year           1.1.1999,6.1.1999,28.3.1999,30.3.1999-
187            31.3.1999,18.5.1999-19.5.1999,3.10.1999,25.12.1999,26
188            .12.1999=suspended
189            week           mon-fri=20-6=suspended sat-sun=suspended
190
191
192       ·  Weekend calendar with suspension, ignoring public holidays:
193
194          Settings are only done on the week basis, no settings  on  the  year
195          basis (keyword "NONE").
196
197            calendar_name  weekend_s
198            year           NONE
199            week           sat-sun=suspended
200
201

SEE ALSO

203       sge_intro(1), sge__types(1), qconf(1), queue_conf(5).
204
206       See sge_intro(1) for a full statement of rights and permissions.
207
208
209
210GE 6.1                   $Date: 2007/09/27 13:25:18 $         CALENDAR_CONF(5)
Impressum