Skip to content

Commit c0c2024

Browse files
astefanuttiastefanutti
committed
api: Update API documentation
1 parent 4e8e71e commit c0c2024

File tree

8 files changed

+327
-82
lines changed

8 files changed

+327
-82
lines changed

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

Lines changed: 65 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,24 @@ spec:
5555
format: int32
5656
type: integer
5757
completionstatus:
58-
description: Optional field for users to determine completion
59-
status of item
58+
description: 'Optional field that drives completion status
59+
of this AppWrapper. This field within an item of an AppWrapper
60+
determines the full state of the AppWrapper. The completionstatus
61+
field contains a list of conditions that make the associate
62+
item considered completed, for instance: - completion
63+
conditions could be "Complete" or "Failed". The associated
64+
item''s level .status.conditions[].type field is monitored
65+
for any one of these conditions. Once all items with this
66+
option is set and the conditionstatus is met the entire
67+
AppWrapper state will be changed to one of the valid AppWrapper
68+
completion state. Note: - this is an AND operation for
69+
all items where this option is set. See the list of AppWrapper
70+
states for a list of valid complete states.'
6071
type: string
6172
custompodresources:
6273
description: Optional section that specifies resource requirements
6374
for non-standard k8s resources, follows same format as
64-
that of standard k8s resources
75+
that of standard k8s resources.
6576
items:
6677
properties:
6778
limits:
@@ -105,8 +116,8 @@ spec:
105116
type: integer
106117
priority:
107118
description: The priority of this resource
108-
format: float
109-
type: number
119+
format: int32
120+
type: integer
110121
priorityslope:
111122
description: The increasing rate of priority value for this
112123
resource
@@ -181,7 +192,9 @@ spec:
181192
- metadata
182193
type: object
183194
schedulingSpec:
184-
description: SchedSpec specifies the parameters for scheduling.
195+
description: SchedSpec specifies the parameters used for scheduling
196+
generic items wrapped inside AppWrappers. It defines the policy
197+
for requeuing jobs based on the number of running pods.
185198
properties:
186199
clusterScheduling:
187200
properties:
@@ -245,6 +258,7 @@ spec:
245258
type: array
246259
type: object
247260
dispatchDuration:
261+
description: Wall clock duration time of appwrapper in seconds.
248262
properties:
249263
expected:
250264
type: integer
@@ -281,24 +295,57 @@ spec:
281295
type: object
282296
type: object
283297
minAvailable:
298+
description: Expected number of pods in running and/or completed
299+
state. Requeuing is triggered when the number of running/completed
300+
pods is not equal to this value. When not specified, requeuing
301+
is disabled and no check is performed.
284302
type: integer
285303
nodeSelector:
286304
additionalProperties:
287305
type: string
288306
type: object
289307
requeuing:
308+
description: Specification of the requeuing strategy based on
309+
waiting time. Values in this field control how often the pod
310+
check should happen, and if requeuing has reached its maximum
311+
number of times.
290312
properties:
291313
growthType:
314+
default: exponential
315+
description: Growth strategy to increase the waiting time
316+
between requeuing checks. The values available are 'exponential',
317+
'linear', or 'none'. For example, 'exponential' growth would
318+
double the 'timeInSeconds' value every time a requeuing
319+
event is triggered. If the string value is misspelled or
320+
not one of the possible options, the growth behavior is
321+
defaulted to 'none'.
292322
type: string
293323
initialTimeInSeconds:
324+
description: Value to keep track of the initial wait time.
325+
Users cannot set this as it is taken from 'timeInSeconds'.
294326
type: integer
295327
maxNumRequeuings:
328+
default: 0
329+
description: Maximum number of requeuing events allowed. Once
330+
this value is reached (e.g., 'numRequeuings = maxNumRequeuings',
331+
no more requeuing checks are performed and the generic items
332+
are stopped and removed from the cluster (AppWrapper remains
333+
deployed).
296334
type: integer
297335
maxTimeInSeconds:
336+
default: 0
337+
description: Maximum waiting time for requeuing checks.
298338
type: integer
299339
numRequeuings:
340+
default: 0
341+
description: Field to keep track of how many times a requeuing
342+
event has been triggered.
300343
type: integer
301344
timeInSeconds:
345+
default: 300
346+
description: Initial waiting time before requeuing conditions
347+
are checked. This value is specified by the user, but it
348+
may grow as requeuing events happen.
302349
type: integer
303350
type: object
304351
type: object
@@ -686,10 +733,10 @@ spec:
686733
description: Can run?
687734
type: boolean
688735
conditions:
689-
description: Represents the latest available observations of a appwrapper's
736+
description: Represents the latest available observations of the AppWrapper's
690737
current condition.
691738
items:
692-
description: DeploymentCondition describes the state of a deployment
739+
description: AppWrapperCondition describes the state of an AppWrapper
693740
at a certain point.
694741
properties:
695742
lastTransitionMicroTime:
@@ -702,7 +749,7 @@ spec:
702749
format: date-time
703750
type: string
704751
message:
705-
description: A human readable message indicating details about
752+
description: A human-readable message indicating details about
706753
the transition.
707754
type: string
708755
reason:
@@ -712,7 +759,7 @@ spec:
712759
description: Status of the condition, one of True, False, Unknown.
713760
type: string
714761
type:
715-
description: Type of appwrapper condition.
762+
description: Type of AppWrapper condition.
716763
type: string
717764
required:
718765
- status
@@ -721,7 +768,7 @@ spec:
721768
type: array
722769
controllerfirstdispatchtimestamp:
723770
description: Microsecond level timestamp when controller first dispatches
724-
appwrapper
771+
the AppWrapper
725772
format: date-time
726773
type: string
727774
controllerfirsttimestamp:
@@ -756,7 +803,7 @@ spec:
756803
type: integer
757804
pendingpodconditions:
758805
description: Represents the latest available observations of pods
759-
under appwrapper
806+
belonging to the AppWrapper.
760807
items:
761808
properties:
762809
conditions:
@@ -826,20 +873,18 @@ spec:
826873
format: int32
827874
type: integer
828875
totalcpu:
829-
description: Represents the number of cpu consumed by all pods belonging
830-
to an appwrapper.
876+
description: The number of CPU consumed by all pods belonging to the
877+
AppWrapper.
831878
type: number
832879
totalgpu:
833-
description: Represents the total number of GPUs consumed by all pods
834-
belonging to an appwrapper.
880+
description: The total number of GPUs consumed by all pods belonging
881+
to the AppWrapper.
835882
format: int64
836883
type: integer
837884
totalmemory:
838-
description: Represents the amount of memory consumed by all pods
839-
belonging to an appwrapper.
885+
description: The amount of memory consumed by all pods belonging to
886+
the AppWrapper.
840887
type: number
841-
required:
842-
- pendingpodconditions
843888
type: object
844889
required:
845890
- 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)