-
Notifications
You must be signed in to change notification settings - Fork 441
/
experiment_util.go
169 lines (142 loc) · 5.74 KB
/
experiment_util.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
package experiment
import (
"context"
"k8s.io/apimachinery/pkg/api/errors"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
experimentsv1beta1 "github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1"
suggestionsv1beta1 "github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1"
trialsv1beta1 "github.com/kubeflow/katib/pkg/apis/controller/trials/v1beta1"
"github.com/kubeflow/katib/pkg/controller.v1beta1/util"
)
const (
updatePrometheusMetrics = "update-prometheus-metrics"
)
func (r *ReconcileExperiment) createTrialInstance(expInstance *experimentsv1beta1.Experiment, trialAssignment *suggestionsv1beta1.TrialAssignment) error {
logger := log.WithValues("Experiment", types.NamespacedName{Name: expInstance.GetName(), Namespace: expInstance.GetNamespace()})
trial := &trialsv1beta1.Trial{}
trial.Name = trialAssignment.Name
trial.Namespace = expInstance.GetNamespace()
trial.Labels = util.TrialLabels(expInstance)
if err := controllerutil.SetControllerReference(expInstance, trial, r.scheme); err != nil {
logger.Error(err, "Set controller reference error")
return err
}
trial.Spec.Objective = expInstance.Spec.Objective
hps := trialAssignment.ParameterAssignments
trial.Spec.ParameterAssignments = trialAssignment.ParameterAssignments
runSpec, err := r.GetRunSpecWithHyperParameters(expInstance, trial.Name, trial.Namespace, hps)
if err != nil {
logger.Error(err, "Fail to get RunSpec from experiment", expInstance.Name)
return err
}
trial.Spec.RunSpec = runSpec
if expInstance.Spec.TrialTemplate != nil {
trial.Spec.RetainRun = expInstance.Spec.TrialTemplate.Retain
}
if expInstance.Spec.MetricsCollectorSpec != nil {
trial.Spec.MetricsCollector = *expInstance.Spec.MetricsCollectorSpec
}
if err := r.Create(context.TODO(), trial); err != nil {
logger.Error(err, "Trial create error", "Trial name", trial.Name)
return err
}
return nil
}
func needUpdateFinalizers(exp *experimentsv1beta1.Experiment) (bool, []string) {
deleted := !exp.ObjectMeta.DeletionTimestamp.IsZero()
pendingFinalizers := exp.GetFinalizers()
contained := false
for _, elem := range pendingFinalizers {
if elem == updatePrometheusMetrics {
contained = true
break
}
}
if !deleted && !contained {
finalizers := append(pendingFinalizers, updatePrometheusMetrics)
return true, finalizers
}
if deleted && contained {
finalizers := []string{}
for _, pendingFinalizer := range pendingFinalizers {
if pendingFinalizer != updatePrometheusMetrics {
finalizers = append(finalizers, pendingFinalizer)
}
}
return true, finalizers
}
return false, []string{}
}
func (r *ReconcileExperiment) updateFinalizers(instance *experimentsv1beta1.Experiment, finalizers []string) (reconcile.Result, error) {
instance.SetFinalizers(finalizers)
if err := r.Update(context.TODO(), instance); err != nil {
return reconcile.Result{}, err
} else {
if !instance.ObjectMeta.DeletionTimestamp.IsZero() {
r.collector.IncreaseExperimentsDeletedCount(instance.Namespace)
} else {
r.collector.IncreaseExperimentsCreatedCount(instance.Namespace)
}
// Need to requeue because finalizer update does not change metadata.generation
return reconcile.Result{Requeue: true}, err
}
}
func (r *ReconcileExperiment) cleanupSuggestionResources(instance *experimentsv1beta1.Experiment) error {
logger := log.WithValues("Suggestion", types.NamespacedName{Name: instance.GetName(), Namespace: instance.GetNamespace()})
original := &suggestionsv1beta1.Suggestion{}
err := r.Get(context.TODO(),
types.NamespacedName{Namespace: instance.GetNamespace(), Name: instance.GetName()}, original)
if err != nil {
if errors.IsNotFound(err) {
return nil
}
return err
}
// If Suggestion is failed or Suggestion is Succeeded, not needed to terminate Suggestion
if original.IsFailed() || original.IsSucceeded() {
return nil
}
logger.Info("Start cleanup suggestion resources")
suggestion := original.DeepCopy()
reason := "Experiment is succeeded"
// If ResumePolicy = Never, mark suggestion status succeeded, can't be restarted
if instance.Spec.ResumePolicy == experimentsv1beta1.NeverResume {
msg := "Suggestion is succeeded, can't be restarted"
suggestion.MarkSuggestionStatusSucceeded(reason, msg)
logger.Info("Mark suggestion succeeded, can't be restarted")
// If ResumePolicy = FromVolume, mark suggestion status succeeded, can be restarted
} else if instance.Spec.ResumePolicy == experimentsv1beta1.FromVolume {
msg := "Suggestion is succeeded, suggestion volume is not deleted, can be restarted"
suggestion.MarkSuggestionStatusSucceeded(reason, msg)
logger.Info("Mark suggestion succeeded, can be restarted")
}
if err := r.UpdateSuggestionStatus(suggestion); err != nil {
return err
}
return nil
}
func (r *ReconcileExperiment) restartSuggestion(instance *experimentsv1beta1.Experiment) error {
logger := log.WithValues("Suggestion", types.NamespacedName{Name: instance.GetName(), Namespace: instance.GetNamespace()})
original := &suggestionsv1beta1.Suggestion{}
err := r.Get(context.TODO(),
types.NamespacedName{Namespace: instance.GetNamespace(), Name: instance.GetName()}, original)
if err != nil {
if errors.IsNotFound(err) {
return nil
}
return err
}
logger.Info("Suggestion is restarting, suggestion Running status is false")
suggestion := original.DeepCopy()
reason := "Experiment is restarting"
msg := "Suggestion is not running"
// Mark suggestion status not running because experiment is restarting and suggestion deployment is not ready
suggestion.MarkSuggestionStatusRunning(corev1.ConditionFalse, reason, msg)
if err := r.UpdateSuggestionStatus(suggestion); err != nil {
return err
}
return nil
}