Skip to content

Commit 6fc74c0

Browse files
metalcyclingmetalcycling
authored
Updated schedulingSpec documentation (#287)
* Updated schedulingSpec documentation * Fixed formatting problem preventing the CRD to be created. Descriptions cannot start with '...' characters.
1 parent 7281b13 commit 6fc74c0

File tree

5 files changed

+191
-26
lines changed

5 files changed

+191
-26
lines changed

‎config/crd/bases/mcad.ibm.com_appwrappers.yaml

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,29 +253,48 @@ spec:
253253
type: object
254254
type: object
255255
schedulingSpec:
256-
description: SchedSpec specifies the parameters for scheduling.
256+
description: Field 'schedulingSpec' specifies the parameters used for scheduling generic items
257+
wrapped inside AppWrappers. It defines the policy for requeuing jobs based on the number
258+
of running pods.
257259
properties:
258260
minAvailable:
261+
description: Expected number of pods in running and/or completed state. Requeuing is triggered
262+
when the number of running/completed pods is not equal to this value. When not specified,
263+
requeuing is disabled and no check is performed.
259264
type: integer
260265
requeuing:
261-
description: Specification of the requeuing strategy based on
262-
waiting time
266+
description: Specification of the requeuing strategy based on waiting time. Values in this field
267+
control how often the pod check should happen and if requeuing has reached its maximum number of
268+
times.
263269
properties:
264270
initialTimeInSeconds:
271+
description: Value to keep track of the initial wait time. Users cannot set this as it is
272+
taken from 'timeInSeconds'.
265273
type: integer
266274
timeInSeconds:
275+
description: Initial waiting time before requeuing conditions are checked. This value is
276+
specified by the user, but it may grow as requeuing events happen.
267277
type: integer
268278
default: 300
269279
maxTimeInSeconds:
280+
description: Maximum waiting time for requeuing checks
270281
type: integer
271282
default: 0
272283
growthType:
284+
description: Growth strategy to increase the waiting time between requeuing checks. The values
285+
available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
286+
double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
287+
is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
273288
type: string
274289
default: "exponential"
275290
numRequeuings:
291+
description: Field to keep track of how many times a requeuing event has been triggered
276292
type: integer
277293
default: 0
278294
maxNumRequeuings:
295+
description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
296+
'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
297+
items are stopped and removed from the cluster (AppWrapper remains deployed).
279298
type: integer
280299
default: 0
281300
type: object

‎config/crd/bases/mcad.ibm.com_queuejobs.yaml

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,29 +39,48 @@ spec:
3939
schedulerName:
4040
type: string
4141
schedulingSpec:
42-
description: SchedSpec specifies the parameters for scheduling.
42+
description: Field 'schedulingSpec' specifies the parameters used for scheduling generic items
43+
wrapped inside AppWrappers. It defines the policy for requeuing jobs based on the number
44+
of running pods.
4345
properties:
4446
minAvailable:
47+
description: Expected number of pods in running and/or completed state. Requeuing is triggered
48+
when the number of running/completed pods is not equal to this value. When not specified,
49+
requeuing is disabled and no check is performed.
4550
type: integer
4651
requeuing:
47-
description: Specification of the requeuing strategy based on
48-
waiting time
52+
description: Specification of the requeuing strategy based on waiting time. Values in this field
53+
control how often the pod check should happen and if requeuing has reached its maximum number of
54+
times.
4955
properties:
5056
initialTimeInSeconds:
57+
description: Value to keep track of the initial wait time. Users cannot set this as it is
58+
taken from 'timeInSeconds'.
5159
type: integer
5260
timeInSeconds:
61+
description: Initial waiting time before requeuing conditions are checked. This value is
62+
specified by the user, but it may grow as requeuing events happen.
5363
type: integer
5464
default: 300
5565
maxTimeInSeconds:
66+
description: Maximum waiting time for requeuing checks
5667
type: integer
5768
default: 0
5869
growthType:
70+
description: Growth strategy to increase the waiting time between requeuing checks. The values
71+
available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
72+
double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
73+
is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
5974
type: string
6075
default: "exponential"
6176
numRequeuings:
77+
description: Field to keep track of how many times a requeuing event has been triggered
6278
type: integer
6379
default: 0
6480
maxNumRequeuings:
81+
description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
82+
'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
83+
items are stopped and removed from the cluster (AppWrapper remains deployed).
6584
type: integer
6685
default: 0
6786
type: object

‎config/crd/bases/mcad.ibm.com_schedulingspecs.yaml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,43 @@ spec:
3535
spec:
3636
properties:
3737
minAvailable:
38+
description: Expected number of pods in running and/or completed state. Requeuing is triggered
39+
when the number of running/completed pods is not equal to this value. When not specified,
40+
requeuing is disabled and no check is performed.
3841
type: integer
3942
requeuing:
40-
description: Specification of the requeuing strategy based on
41-
waiting time
43+
description: Specification of the requeuing strategy based on waiting time. Values in this field
44+
control how often the pod check should happen and if requeuing has reached its maximum number of
45+
times.
4246
properties:
4347
initialTimeInSeconds:
48+
description: Value to keep track of the initial wait time. Users cannot set this as it is
49+
taken from 'timeInSeconds'.
4450
type: integer
4551
timeInSeconds:
52+
description: Initial waiting time before requeuing conditions are checked. This value is
53+
specified by the user, but it may grow as requeuing events happen.
4654
type: integer
4755
default: 300
4856
maxTimeInSeconds:
57+
description: Maximum waiting time for requeuing checks
4958
type: integer
5059
default: 0
5160
growthType:
61+
description: Growth strategy to increase the waiting time between requeuing checks. The values
62+
available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
63+
double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
64+
is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
5265
type: string
5366
default: "exponential"
5467
numRequeuings:
68+
description: Field to keep track of how many times a requeuing event has been triggered
5569
type: integer
5670
default: 0
5771
maxNumRequeuings:
72+
description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
73+
'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
74+
items are stopped and removed from the cluster (AppWrapper remains deployed).
5875
type: integer
5976
default: 0
6077
type: object

‎deployment/mcad-controller/templates/deployment.yaml

Lines changed: 63 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,26 +135,43 @@ spec:
135135
spec:
136136
properties:
137137
minAvailable:
138+
description: Expected number of pods in running and/or completed state. Requeuing is triggered
139+
when the number of running/completed pods is not equal to this value. When not specified,
140+
requeuing is disabled and no check is performed.
138141
type: integer
139142
requeuing:
140-
description: Specification of the requeuing strategy based on
141-
waiting time
143+
description: Specification of the requeuing strategy based on waiting time. Values in this field
144+
control how often the pod check should happen and if requeuing has reached its maximum number of
145+
times.
142146
properties:
143147
initialTimeInSeconds:
148+
description: Value to keep track of the initial wait time. Users cannot set this as it is
149+
taken from 'timeInSeconds'.
144150
type: integer
145151
timeInSeconds:
152+
description: Initial waiting time before requeuing conditions are checked. This value is
153+
specified by the user, but it may grow as requeuing events happen.
146154
type: integer
147155
default: 300
148156
maxTimeInSeconds:
157+
description: Maximum waiting time for requeuing checks
149158
type: integer
150159
default: 0
151160
growthType:
161+
description: Growth strategy to increase the waiting time between requeuing checks. The values
162+
available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
163+
double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
164+
is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
152165
type: string
153166
default: "exponential"
154167
numRequeuings:
168+
description: Field to keep track of how many times a requeuing event has been triggered
155169
type: integer
156170
default: 0
157171
maxNumRequeuings:
172+
description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
173+
'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
174+
items are stopped and removed from the cluster (AppWrapper remains deployed).
158175
type: integer
159176
default: 0
160177
type: object
@@ -218,29 +235,48 @@ spec:
218235
schedulerName:
219236
type: string
220237
schedulingSpec:
221-
description: SchedSpec specifies the parameters for scheduling.
238+
description: Field 'schedulingSpec' specifies the parameters used for scheduling generic items
239+
wrapped inside AppWrappers. It defines the policy for requeuing jobs based on the number
240+
of running pods.
222241
properties:
223242
minAvailable:
243+
description: Expected number of pods in running and/or completed state. Requeuing is triggered
244+
when the number of running/completed pods is not equal to this value. When not specified,
245+
requeuing is disabled and no check is performed.
224246
type: integer
225247
requeuing:
226-
description: Specification of the requeuing strategy based on
227-
waiting time
248+
description: Specification of the requeuing strategy based on waiting time. Values in this field
249+
control how often the pod check should happen and if requeuing has reached its maximum number of
250+
times.
228251
properties:
229252
initialTimeInSeconds:
253+
description: Value to keep track of the initial wait time. Users cannot set this as it is
254+
taken from 'timeInSeconds'.
230255
type: integer
231256
timeInSeconds:
257+
description: Initial waiting time before requeuing conditions are checked. This value is
258+
specified by the user, but it may grow as requeuing events happen.
232259
type: integer
233260
default: 300
234261
maxTimeInSeconds:
262+
description: Maximum waiting time for requeuing checks
235263
type: integer
236264
default: 0
237265
growthType:
266+
description: Growth strategy to increase the waiting time between requeuing checks. The values
267+
available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
268+
double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
269+
is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
238270
type: string
239271
default: "exponential"
240272
numRequeuings:
273+
description: Field to keep track of how many times a requeuing event has been triggered
241274
type: integer
242275
default: 0
243276
maxNumRequeuings:
277+
description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
278+
'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
279+
items are stopped and removed from the cluster (AppWrapper remains deployed).
244280
type: integer
245281
default: 0
246282
type: object
@@ -7285,29 +7321,48 @@ spec:
72857321
type: object
72867322
type: object
72877323
schedulingSpec:
7288-
description: SchedSpec specifies the parameters for scheduling.
7324+
description: Field 'schedulingSpec' specifies the parameters used for scheduling generic items
7325+
wrapped inside AppWrappers. It defines the policy for requeuing jobs based on the number
7326+
of running pods.
72897327
properties:
72907328
minAvailable:
7329+
description: Expected number of pods in running and/or completed state. Requeuing is triggered
7330+
when the number of running/completed pods is not equal to this value. When not specified,
7331+
requeuing is disabled and no check is performed.
72917332
type: integer
72927333
requeuing:
7293-
description: Specification of the requeuing strategy based on
7294-
waiting time
7334+
description: Specification of the requeuing strategy based on waiting time. Values in this field
7335+
control how often the pod check should happen and if requeuing has reached its maximum number of
7336+
times.
72957337
properties:
72967338
initialTimeInSeconds:
7339+
description: Value to keep track of the initial wait time. Users cannot set this as it is
7340+
taken from 'timeInSeconds'.
72977341
type: integer
72987342
timeInSeconds:
7343+
description: Initial waiting time before requeuing conditions are checked. This value is
7344+
specified by the user, but it may grow as requeuing events happen.
72997345
type: integer
73007346
default: 300
73017347
maxTimeInSeconds:
7348+
description: Maximum waiting time for requeuing checks
73027349
type: integer
73037350
default: 0
73047351
growthType:
7352+
description: Growth strategy to increase the waiting time between requeuing checks. The values
7353+
available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
7354+
double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
7355+
is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
73057356
type: string
73067357
default: "exponential"
73077358
numRequeuings:
7359+
description: Field to keep track of how many times a requeuing event has been triggered
73087360
type: integer
73097361
default: 0
73107362
maxNumRequeuings:
7363+
description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
7364+
'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
7365+
items are stopped and removed from the cluster (AppWrapper remains deployed).
73117366
type: integer
73127367
default: 0
73137368
type: object

0 commit comments

Comments
 (0)