This repository has been archived by the owner on Nov 16, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 44
/
types.go
622 lines (557 loc) · 26.7 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
// MIT License
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE
package v1
import (
core "k8s.io/api/core/v1"
meta "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
)
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type FrameworkList struct {
meta.TypeMeta `json:",inline"`
meta.ListMeta `json:"metadata"`
Items []Framework `json:"items"`
}
// +genclient
// +genclient:noStatus
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
//////////////////////////////////////////////////////////////////////////////////////////////////
// A Framework represents an application with a set of Tasks:
// 1. Executed by Kubernetes Pod
// 2. Partitioned to different heterogeneous TaskRoles which share the same lifecycle
// 3. Ordered in the same homogeneous TaskRole by TaskIndex
// 4. With consistent identity {FrameworkName}-{TaskRoleName}-{TaskIndex} as PodName
// 5. With fine grained ExecutionType to Start/Stop the whole Framework
// 6. With fine grained RetryPolicy for each Task and the whole Framework
// 7. With fine grained FrameworkAttemptCompletionPolicy for each TaskRole
// 8. With PodGracefulDeletionTimeoutSec for each Task to tune Consistency vs Availability
// 9. With fine grained Status for each TaskAttempt/Task, each TaskRole and the whole
// FrameworkAttempt/Framework
//
// Notes:
// 1. Status field should only be modified by FrameworkController, and
// other fields should not be modified by FrameworkController.
// TODO: Remove +genclient:noStatus after ApiServer has supported CRD Subresources.
// Leverage CRD status subresource to isolate Status field modification with other fields.
// This can help to avoid unintended modification, such as users may unintendedly modify
// the status when updating the spec.
//////////////////////////////////////////////////////////////////////////////////////////////////
type Framework struct {
meta.TypeMeta `json:",inline"`
meta.ObjectMeta `json:"metadata"`
Spec FrameworkSpec `json:"spec"`
Status *FrameworkStatus `json:"status"`
}
//////////////////////////////////////////////////////////////////////////////////////////////////
// Spec
//////////////////////////////////////////////////////////////////////////////////////////////////
type FrameworkSpec struct {
Description string `json:"description"`
ExecutionType ExecutionType `json:"executionType"`
RetryPolicy RetryPolicySpec `json:"retryPolicy"`
TaskRoles []*TaskRoleSpec `json:"taskRoles"`
}
type TaskRoleSpec struct {
// TaskRoleName
Name string `json:"name"`
// Tasks with TaskIndex in range [0, TaskNumber)
TaskNumber int32 `json:"taskNumber"`
FrameworkAttemptCompletionPolicy CompletionPolicySpec `json:"frameworkAttemptCompletionPolicy"`
Task TaskSpec `json:"task"`
}
type TaskSpec struct {
RetryPolicy RetryPolicySpec `json:"retryPolicy"`
// If the Task's current associated Pod object is being deleted, i.e. graceful
// deletion, but the graceful deletion cannot finish within this timeout, then
// the Pod will be deleted forcefully by FrameworkController.
// Default to nil.
//
// If this timeout is not nil, the Pod may be deleted forcefully by FrameworkController.
// The force deletion does not wait for confirmation that the Pod has been terminated
// totally, and then the Task will be immediately transitioned to TaskAttemptCompleted.
// As a consequence, the Task will be immediately completed or retried with another
// new Pod, however the old Pod may be still running.
// So, in this setting, the Task behaves like ReplicaSet, and choose it if the Task
// favors availability over consistency, such as stateless Task.
// However, to still best effort execute graceful deletion with the toleration for
// transient deletion failures, this timeout should be at least longer than the Pod
// TerminationGracePeriodSeconds + minimal TolerationSeconds for TaintBasedEvictions.
//
// If this timeout is nil, the Pod will always be deleted gracefully, i.e. never
// be deleted forcefully by FrameworkController. This helps to guarantee at most
// one instance of a specific Task is running at any point in time.
// So, in this setting, the Task behaves like StatefulSet, and choose it if the Task
// favors consistency over availability, such as stateful Task.
PodGracefulDeletionTimeoutSec *int64 `json:"podGracefulDeletionTimeoutSec"`
Pod core.PodTemplateSpec `json:"pod"`
}
// User can set any ExecutionType when create a Framework, and then he can choose
// to change the ExecutionType or not.
// However, only below changes are supported:
// 1. ExecutionCreate -> ExecutionStart/ExecutionStop
// 2. ExecutionStart -> ExecutionStop
type ExecutionType string
const (
// The Framework will be kept in FrameworkAttemptCreationPending.
// So it will never start to run or complete.
ExecutionCreate ExecutionType = "Create"
// The Framework will be transitioned from FrameworkAttemptCreationPending.
// So it will immediately start to run.
ExecutionStart ExecutionType = "Start"
// The Framework will be transitioned to FrameworkCompleted.
// So it will immediately start to complete.
ExecutionStop ExecutionType = "Stop"
)
// RetryPolicySpec can be configured for the whole Framework and each TaskRole
// to control:
// 1. Framework RetryPolicy:
// The conditions to retry the whole Framework after the Framework's current
// FrameworkAttempt completed.
// It can also be considered as Framework CompletionPolicy, i.e. the conditions
// to complete the whole Framework.
// 2. Task RetryPolicy:
// The conditions to retry a single Task in the TaskRole after the Task's
// current TaskAttempt completed.
// It can also be considered as Task CompletionPolicy, i.e. the conditions to
// complete a single Task in the TaskRole.
//
// Usage:
// If the ExecutionType is ExecutionStop or
// the Task's FrameworkAttempt is completing or
// the Task is DeletionPending (ScaleDown),
// will not retry.
//
// If the FancyRetryPolicy is enabled,
// will retry if the completion is due to Transient Failed CompletionType,
// will not retry if the completion is due to Permanent Failed CompletionType,
// will apply the NormalRetryPolicy defined below if all above conditions are
// not satisfied.
//
// If the FancyRetryPolicy is not enabled,
// will directly apply the NormalRetryPolicy for all kinds of completions.
//
// The NormalRetryPolicy is defined as,
// will retry and AccountableRetriedCount++ if MaxRetryCount == -2,
// will retry and AccountableRetriedCount++ if the completion is due to any
// failure and MaxRetryCount == -1,
// will retry and AccountableRetriedCount++ if the completion is due to any
// failure and AccountableRetriedCount < MaxRetryCount,
// will not retry if all above conditions are not satisfied.
//
// After the retry is exhausted, the final CompletionStatus is defined as,
// the CompletionStatus of the last attempt.
//
// Notes:
// 1. The existence of an attempt instance may not always be observed, such as
// create fails but succeeds on remote and then followed by an external delete.
// So, an attempt identified by its attempt id may be associated with multiple
// attempt instances over time, i.e. multiple instances may be run for the
// attempt over time, however, at most one instance is exposed into ApiServer
// over time.
// So, the actual retried attempt instances may exceed the RetryPolicySpec in
// rare cases, however, the RetryPolicyStatus will never exceed the RetryPolicySpec.
// 2. Resort to other spec to control other kind of RetryPolicy:
// 1. Container RetryPolicy is the RestartPolicy in Pod Spec.
// See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
type RetryPolicySpec struct {
FancyRetryPolicy bool `json:"fancyRetryPolicy"`
MaxRetryCount int32 `json:"maxRetryCount"`
}
// CompletionPolicySpec can be configured for each TaskRole to control:
// 1. FrameworkAttempt CompletionPolicy:
// 1. The conditions to complete a FrameworkAttempt.
// 2. The CompletionStatus of the completed FrameworkAttempt.
//
// Usage:
// 1. If the ExecutionType is ExecutionStop, immediately complete the FrameworkAttempt,
// regardless of any uncompleted Task, and the CompletionStatus is failed which
// is not inherited from any Task.
// 2. If MinFailedTaskCount >= 1 and MinFailedTaskCount <= failed Task count of
// current TaskRole, immediately complete the FrameworkAttempt, regardless of
// any uncompleted Task, and the CompletionStatus is failed which is inherited
// from the Task which triggers the completion.
// 3. If MinSucceededTaskCount >= 1 and MinSucceededTaskCount <= succeeded Task
// count of current TaskRole, immediately complete the FrameworkAttempt, regardless
// of any uncompleted Task, and the CompletionStatus is succeeded which is inherited
// from the Task which triggers the completion.
// 4. If multiple above conditions are satisfied at the same time, the behavior can
// be any one of these satisfied conditions.
// 5. If none of above conditions are satisfied until all Tasks of the Framework are
// completed and the Framework has at least one Task, immediately complete the
// FrameworkAttempt and the CompletionStatus is succeeded which is not inherited
// from any Task.
//
// Notes:
// 1. When the FrameworkAttempt is completed, the FrameworkState is transitioned to
// FrameworkAttemptCompleted, so the Framework may still be retried with another
// new FrameworkAttempt according to the Framework RetryPolicySpec.
// 2. Resort to other spec to control other kind of CompletionPolicy:
// 1. Framework CompletionPolicy is equivalent to Framework RetryPolicy.
// 2. Task CompletionPolicy is equivalent to Task RetryPolicy.
// 3. TaskAttempt CompletionPolicy is equivalent to Pod CompletionPolicy,
// i.e. the PodPhase conditions for PodSucceeded or PodFailed.
// See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase
type CompletionPolicySpec struct {
MinFailedTaskCount int32 `json:"minFailedTaskCount"`
MinSucceededTaskCount int32 `json:"minSucceededTaskCount"`
}
//////////////////////////////////////////////////////////////////////////////////////////////////
// Status
// It is used to:
// 1. Aggregate the ground truth from other related objects, such as Pod.Status.
// 2. Maintain the Framework owned ground truth, such as PodUID.
// 3. Retain the ground truth even if other related objects are deleted.
//
// Notes:
// 1. It should only contain current status, history status should be a different type
// and stored in a history database.
// 2. For field which is not the ground truth, such as the TaskState, it should be
// totally reconstructable from its ground truth, in case the Status is failed to
// persist due to FrameworkController restart.
// The ground truth may be other fields in Framework.Status or the fields in other
// related objects, such as the PodUID and Pod.Status.
// 3. For field which is the ground truth, such as the PodUID, it should be
// Monotonically Exposed which means it should only be changed to a future state in
// ApiServer. However, it does not mean other related objects are also Monotonically
// Exposed.
// For example, from the view of any ApiServer client, the PodUID should be changed
// from a not nil value to a different not nil value, if and only if its TaskAttemptID
// is also increased.
// 4. It is better to keep the ground truth in other related objects instead of in the
// Status here, so that the Framework can be more compatible with other k8s features,
// such as labels and selectors.
//////////////////////////////////////////////////////////////////////////////////////////////////
type FrameworkStatus struct {
StartTime meta.Time `json:"startTime"`
CompletionTime *meta.Time `json:"completionTime"`
State FrameworkState `json:"state"`
TransitionTime meta.Time `json:"transitionTime"`
RetryPolicyStatus RetryPolicyStatus `json:"retryPolicyStatus"`
AttemptStatus FrameworkAttemptStatus `json:"attemptStatus"`
}
type FrameworkAttemptStatus struct {
// FrameworkAttemptID = {FrameworkStatus.RetryPolicyStatus.TotalRetriedCount}
// It can only locate the FrameworkAttempt within a specific Framework, i.e.
// it cannot universally locate the FrameworkAttempt and cannot locate the
// FrameworkAttemptInstance even within a specific Framework.
ID int32 `json:"id"`
StartTime meta.Time `json:"startTime"`
RunTime *meta.Time `json:"runTime"`
CompletionTime *meta.Time `json:"completionTime"`
// Current associated FrameworkAttemptInstance:
// FrameworkAttemptInstanceUID = {FrameworkAttemptID}_{ConfigMapUID}
// It is ordered by FrameworkAttemptID and can universally locate the
// FrameworkAttemptInstance.
InstanceUID *types.UID `json:"instanceUID"`
// A FrameworkAttemptInstance is represented by a ConfigMap object:
// ConfigMapName = {FrameworkName}-attempt
// It will never be changed during the whole lifetime of a specific Framework.
ConfigMapName string `json:"configMapName"`
// ConfigMapUID can also universally locate the FrameworkAttemptInstance.
ConfigMapUID *types.UID `json:"configMapUID"`
CompletionStatus *FrameworkAttemptCompletionStatus `json:"completionStatus"`
TaskRoleStatuses []*TaskRoleStatus `json:"taskRoleStatuses"`
TaskRoleStatusesCompressed []byte `json:"taskRoleStatusesCompressed,omitempty"`
}
type TaskRoleStatus struct {
// TaskRoleName
Name string `json:"name"`
// Effective and Backup PodGracefulDeletionTimeoutSec:
// It is the immediate backup of corresponding field in TaskRoleSpec.TaskSpec,
// in case the TaskRoleSpec is directly deleted later while the TaskRole's
// TaskRoleStatus still exist due to graceful deletion.
PodGracefulDeletionTimeoutSec *int64 `json:"podGracefulDeletionTimeoutSec"`
// Tasks with TaskIndex in range [0, TaskNumber)
TaskStatuses []*TaskStatus `json:"taskStatuses"`
}
type TaskStatus struct {
// TaskIndex
Index int32 `json:"index"`
StartTime meta.Time `json:"startTime"`
CompletionTime *meta.Time `json:"completionTime"`
State TaskState `json:"state"`
TransitionTime meta.Time `json:"transitionTime"`
// Task DeletionPending is caused by Framework ScaleDown.
// If a Task is DeletionPending, it is logically detached from its Framework
// immediately, and will be proactively but still gracefully completed and
// finally deleted.
DeletionPending bool `json:"deletionPending"`
RetryPolicyStatus RetryPolicyStatus `json:"retryPolicyStatus"`
AttemptStatus TaskAttemptStatus `json:"attemptStatus"`
}
type TaskAttemptStatus struct {
// TaskAttemptID = {TaskStatus.RetryPolicyStatus.TotalRetriedCount}
// It can only locate the TaskAttempt within a specific Task, i.e. it cannot
// universally locate the TaskAttempt and cannot locate the TaskAttemptInstance
// even within a specific Task.
ID int32 `json:"id"`
StartTime meta.Time `json:"startTime"`
RunTime *meta.Time `json:"runTime"`
CompletionTime *meta.Time `json:"completionTime"`
// Current associated TaskAttemptInstance:
// TaskAttemptInstanceUID = {TaskAttemptID}_{PodUID}
// It is ordered by TaskAttemptID and can universally locate the
// TaskAttemptInstance.
InstanceUID *types.UID `json:"instanceUID"`
// A TaskAttemptInstance is represented by a Pod object:
// PodName = {FrameworkName}-{TaskRoleName}-{TaskIndex}
// It will never be changed during the whole lifetime of a specific Task.
PodName string `json:"podName"`
// PodUID can also universally locate the TaskAttemptInstance.
PodUID *types.UID `json:"podUID"`
PodNodeName *string `json:"podNodeName"`
PodIP *string `json:"podIP"`
PodHostIP *string `json:"podHostIP"`
CompletionStatus *TaskAttemptCompletionStatus `json:"completionStatus"`
}
type RetryPolicyStatus struct {
// Used as the ground truth of current attempt id.
// If it is for Framework, TotalRetriedCount = FrameworkAttemptID
// If it is for Task, TotalRetriedCount = TaskAttemptID
TotalRetriedCount int32 `json:"totalRetriedCount"`
// Used to compare against MaxRetryCount.
// If the FancyRetryPolicy is not enabled,
// it is the same as the TotalRetriedCount.
// If the FancyRetryPolicy is enabled,
// it does not count into the retries for the completion which is due to
// Transient CompletionType, so only in this case, it may be less than the
// TotalRetriedCount.
AccountableRetriedCount int32 `json:"accountableRetriedCount"`
// Used to expose the ScheduledRetryTime after which current retry can be
// executed.
// ScheduledRetryTime = AttemptStatus.CompletionTime + RetryDelaySec
// It is not nil only if the retry has been scheduled but not yet executed, i.e.
// current attempt is in AttemptCompleted state and is not the last attempt.
RetryDelaySec *int64 `json:"retryDelaySec"`
}
// It is generated from Predefined CompletionCodes or PodPattern matching.
// For a Pod, if no PodPattern is matched and failed Container exists, the
// CompletionCode is the same as the last failed Container ExitCode.
// See PodFailureSpec.
type CompletionStatus struct {
// See corresponding fields in CompletionCodeInfo.
Code CompletionCode `json:"code"`
Phrase CompletionPhrase `json:"phrase"`
Type CompletionType `json:"type"`
// It is the summarized diagnostic information of the completion.
// Such as if the CompletionCodeInfo is generated from the PodPattern matching,
// the Diagnostics will include the matched Pod field which is explicitly
// specified in the corresponding PodPattern.
// For detailed and structured diagnostic information, check its outer embedding
// type.
Diagnostics string `json:"diagnostics"`
}
type PodCompletionStatus struct {
Reason string `json:"reason,omitempty"`
Message string `json:"message,omitempty"`
Containers []*ContainerCompletionStatus `json:"containers,omitempty"`
}
type ContainerCompletionStatus struct {
Name string `json:"name"`
Reason string `json:"reason,omitempty"`
Message string `json:"message,omitempty"`
Signal int32 `json:"signal,omitempty"`
Code int32 `json:"code"`
}
type TaskAttemptCompletionStatus struct {
// Summary
// Must be not nil for TaskAttemptCompleted and TaskCompleted Task.
*CompletionStatus `json:",inline"`
// Detail
Pod *PodCompletionStatus `json:"pod,omitempty"`
}
type CompletionPolicyTriggerStatus struct {
Message string `json:"message"`
TaskRoleName string `json:"taskRoleName"`
TaskIndex int32 `json:"taskIndex"`
}
type FrameworkAttemptCompletionStatus struct {
// Summary
// Must be not nil for FrameworkAttemptCompleted and FrameworkCompleted Framework.
*CompletionStatus `json:",inline"`
// Detail
Trigger *CompletionPolicyTriggerStatus `json:"trigger,omitempty"`
}
type CompletionCode int32
type CompletionPhrase string
type CompletionType struct {
Name CompletionTypeName `json:"name" yaml:"name"`
Attributes []CompletionTypeAttribute `json:"attributes" yaml:"attributes"`
}
type CompletionTypeName string
const (
CompletionTypeNameSucceeded CompletionTypeName = "Succeeded"
CompletionTypeNameFailed CompletionTypeName = "Failed"
)
type CompletionTypeAttribute string
const (
// CompletionTypeName must be different within a finite retry times:
// such as failed due to dependent components shutdown, machine error,
// network error, environment error, workload spike, etc.
CompletionTypeAttributeTransient CompletionTypeAttribute = "Transient"
// CompletionTypeName must be the same in every retry times:
// such as failed due to incorrect usage, incorrect configuration, etc.
CompletionTypeAttributePermanent CompletionTypeAttribute = "Permanent"
// The completion must be caused by Resource Conflict (Resource Contention):
// such as failed due to Gang Allocation timeout.
CompletionTypeAttributeConflict CompletionTypeAttribute = "Conflict"
)
// The ground truth of FrameworkState is the current associated FrameworkAttemptInstance
// which is represented by the ConfigMapUID and the corresponding ConfigMap object in
// the local cache.
//
// [AssociatedState]: ConfigMapUID is not nil
type FrameworkState string
const (
// ConfigMap does not exist and
// may not have been creation requested successfully and is expected to exist.
// [StartState]
// [AttemptStartState]
// -> FrameworkAttemptCreationRequested
// -> FrameworkAttemptCompleted
FrameworkAttemptCreationPending FrameworkState = "AttemptCreationPending"
// ConfigMap does not exist and
// must have been creation requested successfully and is expected to exist.
// [AssociatedState]
// -> FrameworkAttemptPreparing
// -> FrameworkAttemptDeleting
// -> FrameworkAttemptCompleted
FrameworkAttemptCreationRequested FrameworkState = "AttemptCreationRequested"
// ConfigMap exists and is not deleting and
// may not have been deletion requested successfully and
// FrameworkAttemptCompletionPolicy may not have been satisfied and
// no Task of current attempt has ever entered TaskAttemptRunning state.
// [AssociatedState]
// -> FrameworkAttemptRunning
// -> FrameworkAttemptDeletionPending
// -> FrameworkAttemptDeleting
// -> FrameworkAttemptCompleted
FrameworkAttemptPreparing FrameworkState = "AttemptPreparing"
// ConfigMap exists and is not deleting and
// may not have been deletion requested successfully and
// FrameworkAttemptCompletionPolicy may not have been satisfied and
// at least one Task of current attempt has ever entered TaskAttemptRunning state.
// [AssociatedState]
// -> FrameworkAttemptDeletionPending
// -> FrameworkAttemptDeleting
// -> FrameworkAttemptCompleted
FrameworkAttemptRunning FrameworkState = "AttemptRunning"
// ConfigMap exists and is not deleting and
// may not have been deletion requested successfully and
// FrameworkAttemptCompletionPolicy must have been satisfied.
// [AssociatedState]
// -> FrameworkAttemptDeletionRequested
// -> FrameworkAttemptDeleting
// -> FrameworkAttemptCompleted
FrameworkAttemptDeletionPending FrameworkState = "AttemptDeletionPending"
// ConfigMap exists and is not deleting and
// must have been deletion requested successfully.
// [AssociatedState]
// -> FrameworkAttemptDeleting
// -> FrameworkAttemptCompleted
FrameworkAttemptDeletionRequested FrameworkState = "AttemptDeletionRequested"
// ConfigMap exists and is deleting.
// [AssociatedState]
// -> FrameworkAttemptCompleted
FrameworkAttemptDeleting FrameworkState = "AttemptDeleting"
// ConfigMap does not exist and
// is not expected to exist and will never exist and
// current attempt is not the last attempt or to be determined.
// [AttemptFinalState]
// -> FrameworkAttemptCreationPending
// -> FrameworkCompleted
FrameworkAttemptCompleted FrameworkState = "AttemptCompleted"
// ConfigMap does not exist and
// is not expected to exist and will never exist and
// current attempt is the last attempt.
// [FinalState]
FrameworkCompleted FrameworkState = "Completed"
)
// The ground truth of TaskState is the current associated TaskAttemptInstance
// which is represented by the PodUID and the corresponding Pod object in the
// local cache.
//
// [AssociatedState]: PodUID is not nil
type TaskState string
const (
// Pod does not exist and
// may not have been creation requested successfully and is expected to exist.
// [StartState]
// [AttemptStartState]
// -> TaskAttemptCreationRequested
// -> TaskAttemptCompleted
TaskAttemptCreationPending TaskState = "AttemptCreationPending"
// Pod does not exist and
// must have been creation requested successfully and is expected to exist.
// [AssociatedState]
// -> TaskAttemptPreparing
// -> TaskAttemptDeleting
// -> TaskAttemptCompleted
TaskAttemptCreationRequested TaskState = "AttemptCreationRequested"
// Pod exists and is not deleting and
// may not have been deletion requested successfully and
// its PodPhase is PodPending or PodUnknown afterwards.
// [AssociatedState]
// -> TaskAttemptRunning
// -> TaskAttemptDeletionPending
// -> TaskAttemptDeleting
// -> TaskAttemptCompleted
TaskAttemptPreparing TaskState = "AttemptPreparing"
// Pod exists and is not deleting and
// may not have been deletion requested successfully and
// its PodPhase is PodRunning or PodUnknown afterwards.
// [AssociatedState]
// -> TaskAttemptDeletionPending
// -> TaskAttemptDeleting
// -> TaskAttemptCompleted
TaskAttemptRunning TaskState = "AttemptRunning"
// Pod exists and is not deleting and
// may not have been deletion requested successfully and
// its PodPhase is PodSucceeded or PodFailed.
// [AssociatedState]
// -> TaskAttemptDeletionRequested
// -> TaskAttemptDeleting
// -> TaskAttemptCompleted
TaskAttemptDeletionPending TaskState = "AttemptDeletionPending"
// Pod exists and is not deleting and
// must have been deletion requested successfully.
// [AssociatedState]
// -> TaskAttemptDeleting
// -> TaskAttemptCompleted
TaskAttemptDeletionRequested TaskState = "AttemptDeletionRequested"
// Pod exists and is deleting.
// [AssociatedState]
// -> TaskAttemptCompleted
TaskAttemptDeleting TaskState = "AttemptDeleting"
// Pod does not exist and
// is not expected to exist and will never exist and
// current attempt is not the last attempt or to be determined.
// [AttemptFinalState]
// -> TaskAttemptCreationPending
// -> TaskCompleted
TaskAttemptCompleted TaskState = "AttemptCompleted"
// Pod does not exist and
// is not expected to exist and will never exist and
// current attempt is the last attempt.
// [FinalState]
TaskCompleted TaskState = "Completed"
)