← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman5/calendar_conf.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/htmlman/htmlman5/calendar_conf.html
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     calendar_conf - Grid Engine calendar configuration file for-
 
7
     mat
 
8
 
 
9
DESCRIPTION
 
10
     <I>calendar</I>_<I>conf</I> reflects the format of the Grid Engine  calen-
 
11
     dar  configuration.  The  definition of calendars is used to
 
12
     specify "on duty" and  "off  duty"  time  periods  for  Grid
 
13
     Engine  queues  on a time of day, day of week or day of year
 
14
     basis.  Various  calendars  can  be  implemented   and   the
 
15
     appropriate  calendar definition for a certain class of jobs
 
16
     can be attached to a queue.
 
17
 
 
18
     <I>calendar</I>_<I>conf</I> entries can be added, modified  and  displayed
 
19
     with  the  -<I>Acal</I>,  -<I>acal</I>,  -<I>Mcal</I>,  -<I>mcal</I>,  -<I>scal</I>  and -<I>scall</I>
 
20
     options to <B><A HREF="../htmlman1/qconf.html">qconf(1)</A></B> or with the calendar configuration  dia-
 
21
     log  of the graphical user interface <B><A HREF="../htmlman1/qmon.html">qmon(1)</A></B>.  The format of
 
22
     the calendar configuration entries is defined as follows:
 
23
 
 
24
FORMAT
 
25
  calendar_name
 
26
     The name of the calendar to be used  when  attaching  it  to
 
27
     queues or when administering the calendar definition.
 
28
 
 
29
  year
 
30
     The queue status definition on a day of the year basis. This
 
31
     field  generally  will  specify on which days of a year (and
 
32
     optionally at which times on those days) a queue,  to  which
 
33
     the  calendar  is  attached, will change to a certain state.
 
34
     The syntax of the year field is defined as follows:
 
35
 
 
36
     year:=
 
37
         {year_day_range_list=daytime_range_list[=state]
 
38
         |year_day_range_list=[daytime_range_list=]state
 
39
        |state} ...
 
40
 
 
41
     Where
 
42
 
 
43
     <B>o</B>  at least one of  year_day_range_list,  daytime_range_list
 
44
        and state always have to be present,
 
45
 
 
46
     <B>o</B>  all day long is assumed if daytime_range_list is omitted,
 
47
 
 
48
     <B>o</B>  switching the queue  to  "off"  (i.e.  disabling  it)  is
 
49
        assumed if state is omitted,
 
50
 
 
51
     <B>o</B>  the queue is assumed  to  be  enabled  for  days  neither
 
52
        referenced      implicitly      (by      omitting     the
 
53
        year_day_range_list) nor explicitly
 
54
 
 
55
     and the syntactical components are defined as follows:
 
56
 
 
57
       year_day_range_list := {yearday-yearday|yearday},...
 
58
       daytime_range_list :=  hour[:minute][:second]-
 
59
                              hour[:minute][:second],...
 
60
       state :=     {on|off|suspended}
 
61
       year_day :=  month_day.month.year
 
62
       month_day := {1|2|...|31}
 
63
       month :=     {jan|feb|...|dec|1|2|...|12}
 
64
       year :=      {1970|1971|...|2037}
 
65
 
 
66
  week
 
67
     The queue status definition on a day of the week basis. This
 
68
     field  generally  will  specify on which days of a week (and
 
69
     optionally at which times on those days) a queue,  to  which
 
70
     the  calendar  is  attached, will change to a certain state.
 
71
     The syntax of the week field is defined as follows:
 
72
 
 
73
     week:=
 
74
         {week_day_range_list[=daytime_range_list][=state]
 
75
         |[week_day_range_list=]daytime_range_list[=state]
 
76
         |[week_day_range_list=][daytime_range_list=]state} ...
 
77
 
 
78
     Where
 
79
 
 
80
     <B>o</B>  at least one of  week_day_range_list,  daytime_range_list
 
81
        and state always have to be present,
 
82
 
 
83
     <B>o</B>  every day in the week is assumed  if  week_day_range_list
 
84
        is omitted,
 
85
 
 
86
     <B>o</B>  syntax and semantics of daytime_range_list and state  are
 
87
        identical  to  the  definition  given  for the year field
 
88
        above,
 
89
 
 
90
     <B>o</B>  the queue is assumed  to  be  enabled  for  days  neither
 
91
        referenced      implicitly      (by      omitting     the
 
92
        week_day_range_list) nor explicitly
 
93
 
 
94
     and where week_day_range_list is defined as
 
95
 
 
96
       week_day_range_list := {weekday-weekday|weekday},...
 
97
       week_day :=  {mon|tue|wed|thu|fri|sat|sun}
 
98
 
 
99
     with week_day ranges the week_day identifiers must  be  dif-
 
100
     ferent.
 
101
 
 
102
SEMANTICS
 
103
     Successive entries to the year and week fields (separated by
 
104
     blanks) are combined in compliance with the following rule:
 
105
 
 
106
     <B>o</B>  "off"-areas  are  overridden  by  overlapping  "on"-  and
 
107
        "suspended"-areas and "suspended"-areas are overridden by
 
108
        "on"-areas.
 
109
 
 
110
     Hence an entry of the form
 
111
 
 
112
       week  12-18 tue=13-17=on
 
113
 
 
114
     means that queues referencing the corresponding calendar are
 
115
     disabled the entire week from 12.00-18.00 with the exception
 
116
     of Tuesday between 13.00-17.00 where the queues  are  avail-
 
117
     able.
 
118
 
 
119
 
 
120
     <B>o</B>  Area overriding occurs only within a year/week basis.  If
 
121
        a year entry exists for a day then only the year calendar
 
122
        is taken into account and no area overriding is done with
 
123
        a possibly conflicting week area.
 
124
 
 
125
 
 
126
     <B>o</B>  the second time specification in a daytime_range_list may
 
127
        be  before the first one and treated as expected. Thus an
 
128
        entry of the form
 
129
 
 
130
          year  12.03.2004=12-11=off
 
131
 
 
132
        causes the queue(s) be disabled 12.03.2004 from  00:00:00
 
133
        - 10:59:59 and 12:00:00 - 23:59:59.
 
134
 
 
135
EXAMPLES
 
136
     (The following  examples  are  contained  in  the  directory
 
137
     $SGE_ROOT/util/resources/calendars).
 
138
 
 
139
     <B>o</B>  Night, weekend and public holiday calendar:
 
140
 
 
141
        On public holidays "night" queues are explicitly enabled.
 
142
        On  working  days  queues  are  disabled between 6.00 and
 
143
        20.00. Saturday and  Sunday  are  implicitly  handled  as
 
144
        enabled times:
 
145
 
 
146
          calendar_name  night
 
147
          year           1.1.1999,6.1.1999,28.3.1999,30.3.1999-
 
148
          31.3.1999,18.5.1999-19.5.1999,3.10.1999,25.12.1999,26
 
149
          .12.1999=on
 
150
          week           mon-fri=6-20
 
151
 
 
152
 
 
153
     <B>o</B>  Day calendar:
 
154
 
 
155
        On public holidays "day"-queues are disabled. On  working
 
156
        days  such  queues  are  closed  during the night between
 
157
        20.00 and 6.00, i.e. the queues are also closed on Monday
 
158
        from  0.00  to 6.00 and on Friday from 20.00 to 24.00. On
 
159
        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
     <B>o</B>  Night, weekend and public holiday calendar  with  suspen-
 
169
        sion:
 
170
 
 
171
        Essentially the same scenario as the  first  example  but
 
172
        queues are suspended instead of switching them "off".
 
173
 
 
174
          calendar_name  night_s
 
175
          year           1.1.1999,6.1.1999,28.3.1999,30.3.1999-
 
176
          31.3.1999,18.5.1999-19.5.1999,3.10.1999,25.12.1999,26
 
177
          .12.1999=on
 
178
          week           mon-fri=6-20=suspended
 
179
 
 
180
 
 
181
     <B>o</B>  Day calendar with suspension:
 
182
 
 
183
        Essentially the same scenario as the second  example  but
 
184
        queues are suspended instead of switching them "off".
 
185
 
 
186
          calendar_name  day_s
 
187
          year           1.1.1999,6.1.1999,28.3.1999,30.3.1999-
 
188
          31.3.1999,18.5.1999-19.5.1999,3.10.1999,25.12.1999,26
 
189
          .12.1999=suspended
 
190
          week           mon-fri=20-6=suspended sat-sun=suspend
 
191
          ed
 
192
 
 
193
 
 
194
SEE ALSO
 
195
     <B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B>, <B><A HREF="../htmlman1/qconf.html">qconf(1)</A></B>, <B><A HREF="../htmlman5/queue_conf.html">queue_conf(5)</A></B>.
 
196
 
 
197
COPYRIGHT
 
198
     See <B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B> for a full statement of rights and  permis-
 
199
     sions.
 
200
 
 
201
 
 
202
 
 
203
 
 
204
 
 
205
 
 
206
 
 
207
 
 
208
 
 
209
 
 
210
 
 
211
 
 
212
 
 
213
 
 
214
</PRE>
 
215
<HR>
 
216
<ADDRESS>
 
217
Man(1) output converted with
 
218
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 
219
</ADDRESS>
 
220
</BODY>
 
221
</HTML>