-
Notifications
You must be signed in to change notification settings - Fork 691
/
mpijob.go
260 lines (219 loc) · 8.68 KB
/
mpijob.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
// Copyright 2019 The Kubeflow Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package mpi
import (
"strings"
commonv1 "github.com/kubeflow/common/pkg/apis/common/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
mpiv1 "github.com/kubeflow/training-operator/pkg/apis/mpi/v1"
)
const (
configSuffix = "-config"
configVolumeName = "mpi-job-config"
configMountPath = "/etc/mpi"
kubexecScriptName = "kubexec.sh"
hostfileName = "hostfile"
discoverHostsScriptName = "discover_hosts.sh"
kubectlDeliveryName = "kubectl-delivery"
kubectlTargetDirEnv = "TARGET_DIR"
kubectlVolumeName = "mpi-job-kubectl"
kubectlMountPath = "/opt/kube"
launcher = "launcher"
worker = "worker"
launcherSuffix = "-launcher"
workerSuffix = "-worker"
gpuResourceNameSuffix = ".com/gpu"
gpuResourceNamePattern = "gpu"
labelGroupName = "group-name"
labelMPIJobName = "mpi-job-name"
labelMPIRoleType = "mpi-job-role"
initContainerCpu = "100m"
initContainerEphStorage = "5Gi"
initContainerMem = "512Mi"
)
const (
// ErrResourceExists is used as part of the Event 'reason' when an MPIJob
// fails to sync due to dependent resources of the same name already
// existing.
ErrResourceExists = "ErrResourceExists"
// MessageResourceExists is the message used for Events when a resource
// fails to sync due to dependent resources already existing.
MessageResourceExists = "Resource %q of Kind %q already exists and is not managed by MPIJob"
// ErrResourceDoesNotExist is used as part of the Event 'reason' when some
// resource is missing in yaml
ErrResourceDoesNotExist = "ErrResourceDoesNotExist"
// MessageResourceDoesNotExist is used for Events when some
// resource is missing in yaml
MessageResourceDoesNotExist = "Resource %q is missing in yaml"
// podTemplateRestartPolicyReason is the warning reason when the restart
// policy is set in pod template.
podTemplateRestartPolicyReason = "SettedPodTemplateRestartPolicy"
// gang scheduler name.
gangSchedulerName = "volcano"
// podTemplateSchedulerNameReason is the warning reason when other scheduler name is set
// in pod templates with gang-scheduling enabled
podTemplateSchedulerNameReason = "SettedPodTemplateSchedulerName"
// gangSchedulingPodGroupAnnotation is the annotation key used by batch schedulers
gangSchedulingPodGroupAnnotation = "scheduling.k8s.io/group-name"
// volcanoTaskSpecKey task spec key used in pod annotation when EnableGangScheduling is true
volcanoTaskSpecKey = "volcano.sh/task-spec"
)
const (
// mpiJobCreatedReason is added in a mpijob when it is created.
mpiJobCreatedReason = "MPIJobCreated"
// mpiJobSucceededReason is added in a mpijob when it is succeeded.
mpiJobSucceededReason = "MPIJobSucceeded"
// mpiJobRunningReason is added in a mpijob when it is running.
mpiJobRunningReason = "MPIJobRunning"
// mpiJobFailedReason is added in a mpijob when it is failed.
mpiJobFailedReason = "MPIJobFailed"
// mpiJobEvict
mpiJobEvict = "MPIJobEvicted"
)
// initializeMPIJobStatuses initializes the ReplicaStatuses for MPIJob.
func initializeMPIJobStatuses(mpiJob *mpiv1.MPIJob, mtype commonv1.ReplicaType) {
replicaType := commonv1.ReplicaType(mtype)
if mpiJob.Status.ReplicaStatuses == nil {
mpiJob.Status.ReplicaStatuses = make(map[commonv1.ReplicaType]*commonv1.ReplicaStatus)
}
mpiJob.Status.ReplicaStatuses[replicaType] = &commonv1.ReplicaStatus{}
}
// updateMPIJobConditions updates the conditions of the given mpiJob.
func updateMPIJobConditions(mpiJob *mpiv1.MPIJob, conditionType commonv1.JobConditionType, reason, message string) error {
condition := newCondition(conditionType, reason, message)
setCondition(&mpiJob.Status, condition)
return nil
}
// newCondition creates a new mpiJob condition.
func newCondition(conditionType commonv1.JobConditionType, reason, message string) commonv1.JobCondition {
return commonv1.JobCondition{
Type: conditionType,
Status: corev1.ConditionTrue,
LastUpdateTime: metav1.Now(),
LastTransitionTime: metav1.Now(),
Reason: reason,
Message: message,
}
}
// getCondition returns the condition with the provided type.
func getCondition(status commonv1.JobStatus, condType commonv1.JobConditionType) *commonv1.JobCondition {
for _, condition := range status.Conditions {
if condition.Type == condType {
return &condition
}
}
return nil
}
func isEvicted(status commonv1.JobStatus) bool {
for _, condition := range status.Conditions {
if condition.Type == commonv1.JobFailed &&
condition.Status == corev1.ConditionTrue &&
condition.Reason == mpiJobEvict {
return true
}
}
return false
}
// setCondition updates the mpiJob to include the provided condition.
// If the condition that we are about to add already exists
// and has the same status and reason then we are not going to update.
func setCondition(status *commonv1.JobStatus, condition commonv1.JobCondition) {
currentCond := getCondition(*status, condition.Type)
// Do nothing if condition doesn't change
if currentCond != nil && currentCond.Status == condition.Status && currentCond.Reason == condition.Reason {
return
}
// Do not update lastTransitionTime if the status of the condition doesn't change.
if currentCond != nil && currentCond.Status == condition.Status {
condition.LastTransitionTime = currentCond.LastTransitionTime
}
// Append the updated condition
newConditions := filterOutCondition(status.Conditions, condition.Type)
status.Conditions = append(newConditions, condition)
}
// filterOutCondition returns a new slice of mpiJob conditions without conditions with the provided type.
func filterOutCondition(conditions []commonv1.JobCondition, condType commonv1.JobConditionType) []commonv1.JobCondition {
var newConditions []commonv1.JobCondition
for _, c := range conditions {
if condType == commonv1.JobRestarting && c.Type == commonv1.JobRunning {
continue
}
if condType == commonv1.JobRunning && c.Type == commonv1.JobRestarting {
continue
}
if c.Type == condType {
continue
}
// Set the running condition status to be false when current condition failed or succeeded
if (condType == commonv1.JobFailed || condType == commonv1.JobSucceeded) && (c.Type == commonv1.JobRunning || c.Type == commonv1.JobFailed) {
c.Status = corev1.ConditionFalse
}
newConditions = append(newConditions, c)
}
return newConditions
}
func isPodFinished(j *corev1.Pod) bool {
return isPodSucceeded(j) || isPodFailed(j)
}
func isPodFailed(p *corev1.Pod) bool {
return p.Status.Phase == corev1.PodFailed
}
func isPodSucceeded(p *corev1.Pod) bool {
return p.Status.Phase == corev1.PodSucceeded
}
func isPodRunning(p *corev1.Pod) bool {
return p.Status.Phase == corev1.PodRunning
}
// isGPULauncher checks whether the launcher needs GPU.
func isGPULauncher(mpiJob *mpiv1.MPIJob) bool {
for _, container := range mpiJob.Spec.MPIReplicaSpecs[mpiv1.MPIReplicaTypeLauncher].Template.Spec.Containers {
for key := range container.Resources.Limits {
if strings.HasSuffix(string(key), gpuResourceNameSuffix) {
return true
}
if strings.Contains(string(key), gpuResourceNamePattern) {
return true
}
}
}
return false
}
func defaultWorkerLabels(mpiJobName string) map[string]string {
return map[string]string{
labelGroupName: "kubeflow.org",
labelMPIJobName: mpiJobName,
labelMPIRoleType: worker,
}
}
func workerSelector(mpiJobName string) (labels.Selector, error) {
labels := defaultWorkerLabels(mpiJobName)
labelSelector := metav1.LabelSelector{
MatchLabels: labels,
}
selector, err := metav1.LabelSelectorAsSelector(&labelSelector)
if err != nil {
return nil, err
}
return selector, nil
}
// initializeReplicaStatuses initializes the ReplicaStatuses for replica.
// originally from pkg/controller.v1/tensorflow/status.go (deleted)
func initializeReplicaStatuses(jobStatus *commonv1.JobStatus, rtype commonv1.ReplicaType) {
if jobStatus.ReplicaStatuses == nil {
jobStatus.ReplicaStatuses = make(map[commonv1.ReplicaType]*commonv1.ReplicaStatus)
}
jobStatus.ReplicaStatuses[rtype] = &commonv1.ReplicaStatus{}
}