Skip to content

Commit 5bec02f

Browse files
astefanuttiastefanutti
committed
api: Update API documentation
1 parent 4d0a1e7 commit 5bec02f

File tree

8 files changed

+353
-102
lines changed

8 files changed

+353
-102
lines changed

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

Lines changed: 76 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,24 @@ spec:
5454
format: int32
5555
type: integer
5656
completionstatus:
57-
description: Optional field for users to determine completion
58-
status of item
57+
description: 'Optional field that drives completion status
58+
of this AppWrapper. This field within an item of an AppWrapper
59+
determines the full state of the AppWrapper. The completionstatus
60+
field contains a list of conditions that make the associate
61+
item considered completed, for instance: - completion
62+
conditions could be "Complete" or "Failed". The associated
63+
item''s level .status.conditions[].type field is monitored
64+
for any one of these conditions. Once all items with this
65+
option is set and the conditionstatus is met the entire
66+
AppWrapper state will be changed to one of the valid AppWrapper
67+
completion state. Note: - this is an AND operation for
68+
all items where this option is set. See the list of AppWrapper
69+
states for a list of valid complete states.'
5970
type: string
6071
custompodresources:
6172
description: Optional section that specifies resource requirements
6273
for non-standard k8s resources, follows same format as
63-
that of standard k8s resources
74+
that of standard k8s resources.
6475
items:
6576
properties:
6677
limits:
@@ -104,8 +115,8 @@ spec:
104115
type: integer
105116
priority:
106117
description: The priority of this resource
107-
format: float
108-
type: number
118+
format: int32
119+
type: integer
109120
priorityslope:
110121
description: The increasing rate of priority value for this
111122
resource
@@ -133,8 +144,9 @@ spec:
133144
format: int32
134145
type: integer
135146
priority:
136-
format: float
137-
type: number
147+
description: The priority of this resource
148+
format: int32
149+
type: integer
138150
priorityslope:
139151
description: The increasing rate of priority value for this
140152
resource
@@ -155,7 +167,6 @@ spec:
155167
Pod, a ReplicaSet, a ... ?)
156168
type: string
157169
required:
158-
- priorityslope
159170
- template
160171
type: object
161172
type: array
@@ -222,7 +233,9 @@ spec:
222233
- metadata
223234
type: object
224235
schedulingSpec:
225-
description: SchedSpec specifies the parameters for scheduling.
236+
description: SchedSpec specifies the parameters used for scheduling
237+
generic items wrapped inside AppWrappers. It defines the policy
238+
for requeuing jobs based on the number of running pods.
226239
properties:
227240
clusterScheduling:
228241
properties:
@@ -286,6 +299,7 @@ spec:
286299
type: array
287300
type: object
288301
dispatchDuration:
302+
description: Wall clock duration time of appwrapper in seconds.
289303
properties:
290304
expected:
291305
type: integer
@@ -322,24 +336,57 @@ spec:
322336
type: object
323337
type: object
324338
minAvailable:
339+
description: Expected number of pods in running and/or completed
340+
state. Requeuing is triggered when the number of running/completed
341+
pods is not equal to this value. When not specified, requeuing
342+
is disabled and no check is performed.
325343
type: integer
326344
nodeSelector:
327345
additionalProperties:
328346
type: string
329347
type: object
330348
requeuing:
349+
description: Specification of the requeuing strategy based on
350+
waiting time. Values in this field control how often the pod
351+
check should happen, and if requeuing has reached its maximum
352+
number of times.
331353
properties:
332354
growthType:
355+
default: exponential
356+
description: Growth strategy to increase the waiting time
357+
between requeuing checks. The values available are 'exponential',
358+
'linear', or 'none'. For example, 'exponential' growth would
359+
double the 'timeInSeconds' value every time a requeuing
360+
event is triggered. If the string value is misspelled or
361+
not one of the possible options, the growth behavior is
362+
defaulted to 'none'.
333363
type: string
334364
initialTimeInSeconds:
365+
description: Value to keep track of the initial wait time.
366+
Users cannot set this as it is taken from 'timeInSeconds'.
335367
type: integer
336368
maxNumRequeuings:
369+
default: 0
370+
description: Maximum number of requeuing events allowed. Once
371+
this value is reached (e.g., 'numRequeuings = maxNumRequeuings',
372+
no more requeuing checks are performed and the generic items
373+
are stopped and removed from the cluster (AppWrapper remains
374+
deployed).
337375
type: integer
338376
maxTimeInSeconds:
377+
default: 0
378+
description: Maximum waiting time for requeuing checks.
339379
type: integer
340380
numRequeuings:
381+
default: 0
382+
description: Field to keep track of how many times a requeuing
383+
event has been triggered.
341384
type: integer
342385
timeInSeconds:
386+
default: 300
387+
description: Initial waiting time before requeuing conditions
388+
are checked. This value is specified by the user, but it
389+
may grow as requeuing events happen.
343390
type: integer
344391
type: object
345392
type: object
@@ -727,10 +774,10 @@ spec:
727774
description: Can run?
728775
type: boolean
729776
conditions:
730-
description: Represents the latest available observations of a appwrapper's
777+
description: Represents the latest available observations of the AppWrapper's
731778
current condition.
732779
items:
733-
description: DeploymentCondition describes the state of a deployment
780+
description: AppWrapperCondition describes the state of an AppWrapper
734781
at a certain point.
735782
properties:
736783
lastTransitionMicroTime:
@@ -743,7 +790,7 @@ spec:
743790
format: date-time
744791
type: string
745792
message:
746-
description: A human readable message indicating details about
793+
description: A human-readable message indicating details about
747794
the transition.
748795
type: string
749796
reason:
@@ -762,7 +809,7 @@ spec:
762809
type: array
763810
controllerfirstdispatchtimestamp:
764811
description: Microsecond level timestamp when controller first sets
765-
appwrapper in state Running
812+
the AppWrapper in state Running
766813
format: date-time
767814
type: string
768815
controllerfirsttimestamp:
@@ -787,25 +834,13 @@ spec:
787834
type: boolean
788835
message:
789836
type: string
790-
totalcpu:
791-
description: The number of cpu consumed by all pods belonging to an appwrapper.
792-
format: int32
793-
type: integer
794-
totalmemory:
795-
description: The amount of memory consumed by all pods belonging to an appwrapper.
796-
format: int32
797-
type: integer
798-
totalgpu:
799-
description: The total number of GPUs consumed by all pods belonging to an appwrapper.
800-
format: int32
801-
type: integer
802837
pending:
803838
description: The number of pending pods.
804839
format: int32
805840
type: integer
806841
pendingpodconditions:
807842
description: Represents the latest available observations of pods
808-
under appwrapper
843+
belonging to the AppWrapper.
809844
items:
810845
properties:
811846
conditions:
@@ -870,8 +905,21 @@ spec:
870905
(is this different from the MinAvailable from JobStatus)
871906
format: int32
872907
type: integer
873-
required:
874-
- pendingpodconditions
908+
totalcpu:
909+
description: The number of CPU consumed by all pods belonging to the
910+
AppWrapper.
911+
format: int32
912+
type: integer
913+
totalgpu:
914+
description: The total number of GPUs consumed by all pods belonging
915+
to the AppWrapper.
916+
format: int64
917+
type: integer
918+
totalmemory:
919+
description: The amount of memory consumed by all pods belonging to
920+
the AppWrapper.
921+
format: int32
922+
type: integer
875923
type: object
876924
required:
877925
- spec

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ spec:
102102
type: array
103103
type: object
104104
dispatchDuration:
105+
description: Wall clock duration time of appwrapper in seconds.
105106
properties:
106107
expected:
107108
type: integer
@@ -138,24 +139,57 @@ spec:
138139
type: object
139140
type: object
140141
minAvailable:
142+
description: Expected number of pods in running and/or completed
143+
state. Requeuing is triggered when the number of running/completed
144+
pods is not equal to this value. When not specified, requeuing
145+
is disabled and no check is performed.
141146
type: integer
142147
nodeSelector:
143148
additionalProperties:
144149
type: string
145150
type: object
146151
requeuing:
152+
description: Specification of the requeuing strategy based on
153+
waiting time. Values in this field control how often the pod
154+
check should happen, and if requeuing has reached its maximum
155+
number of times.
147156
properties:
148157
growthType:
158+
default: exponential
159+
description: Growth strategy to increase the waiting time
160+
between requeuing checks. The values available are 'exponential',
161+
'linear', or 'none'. For example, 'exponential' growth would
162+
double the 'timeInSeconds' value every time a requeuing
163+
event is triggered. If the string value is misspelled or
164+
not one of the possible options, the growth behavior is
165+
defaulted to 'none'.
149166
type: string
150167
initialTimeInSeconds:
168+
description: Value to keep track of the initial wait time.
169+
Users cannot set this as it is taken from 'timeInSeconds'.
151170
type: integer
152171
maxNumRequeuings:
172+
default: 0
173+
description: Maximum number of requeuing events allowed. Once
174+
this value is reached (e.g., 'numRequeuings = maxNumRequeuings',
175+
no more requeuing checks are performed and the generic items
176+
are stopped and removed from the cluster (AppWrapper remains
177+
deployed).
153178
type: integer
154179
maxTimeInSeconds:
180+
default: 0
181+
description: Maximum waiting time for requeuing checks.
155182
type: integer
156183
numRequeuings:
184+
default: 0
185+
description: Field to keep track of how many times a requeuing
186+
event has been triggered.
157187
type: integer
158188
timeInSeconds:
189+
default: 300
190+
description: Initial waiting time before requeuing conditions
191+
are checked. This value is specified by the user, but it
192+
may grow as requeuing events happen.
159193
type: integer
160194
type: object
161195
type: object

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ spec:
9494
type: array
9595
type: object
9696
dispatchDuration:
97+
description: Wall clock duration time of appwrapper in seconds.
9798
properties:
9899
expected:
99100
type: integer
@@ -130,24 +131,55 @@ spec:
130131
type: object
131132
type: object
132133
minAvailable:
134+
description: Expected number of pods in running and/or completed state.
135+
Requeuing is triggered when the number of running/completed pods
136+
is not equal to this value. When not specified, requeuing is disabled
137+
and no check is performed.
133138
type: integer
134139
nodeSelector:
135140
additionalProperties:
136141
type: string
137142
type: object
138143
requeuing:
144+
description: Specification of the requeuing strategy based on waiting
145+
time. Values in this field control how often the pod check should
146+
happen, and if requeuing has reached its maximum number of times.
139147
properties:
140148
growthType:
149+
default: exponential
150+
description: Growth strategy to increase the waiting time between
151+
requeuing checks. The values available are 'exponential', 'linear',
152+
or 'none'. For example, 'exponential' growth would double the
153+
'timeInSeconds' value every time a requeuing event is triggered.
154+
If the string value is misspelled or not one of the possible
155+
options, the growth behavior is defaulted to 'none'.
141156
type: string
142157
initialTimeInSeconds:
158+
description: Value to keep track of the initial wait time. Users
159+
cannot set this as it is taken from 'timeInSeconds'.
143160
type: integer
144161
maxNumRequeuings:
162+
default: 0
163+
description: Maximum number of requeuing events allowed. Once
164+
this value is reached (e.g., 'numRequeuings = maxNumRequeuings',
165+
no more requeuing checks are performed and the generic items
166+
are stopped and removed from the cluster (AppWrapper remains
167+
deployed).
145168
type: integer
146169
maxTimeInSeconds:
170+
default: 0
171+
description: Maximum waiting time for requeuing checks.
147172
type: integer
148173
numRequeuings:
174+
default: 0
175+
description: Field to keep track of how many times a requeuing
176+
event has been triggered.
149177
type: integer
150178
timeInSeconds:
179+
default: 300
180+
description: Initial waiting time before requeuing conditions
181+
are checked. This value is specified by the user, but it may
182+
grow as requeuing events happen.
151183
type: integer
152184
type: object
153185
type: object

0 commit comments

Comments
 (0)