-
Notifications
You must be signed in to change notification settings - Fork 440
/
suggestion_controller.go
278 lines (244 loc) · 8.98 KB
/
suggestion_controller.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
/*
Copyright 2019 The Kubernetes 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 suggestion
import (
"context"
"fmt"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
"sigs.k8s.io/controller-runtime/pkg/source"
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/consts"
"github.com/kubeflow/katib/pkg/controller.v1beta1/suggestion/composer"
"github.com/kubeflow/katib/pkg/controller.v1beta1/suggestion/suggestionclient"
"github.com/kubeflow/katib/pkg/controller.v1beta1/util"
)
const (
ControllerName = "suggestion-controller"
)
var log = logf.Log.WithName(ControllerName)
// Add creates a new Suggestion Controller and adds it to the Manager with default RBAC. The Manager will set fields on the Controller
// and Start it when the Manager is Started.
func Add(mgr manager.Manager) error {
return add(mgr, newReconciler(mgr))
}
// newReconciler returns a new reconcile.Reconciler
func newReconciler(mgr manager.Manager) reconcile.Reconciler {
return &ReconcileSuggestion{
Client: mgr.GetClient(),
SuggestionClient: suggestionclient.New(),
scheme: mgr.GetScheme(),
Composer: composer.New(mgr),
recorder: mgr.GetRecorder(ControllerName),
}
}
// add adds a new Controller to mgr with r as the reconcile.Reconciler
func add(mgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New("suggestion-controller", mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
err = c.Watch(&source.Kind{Type: &suggestionsv1beta1.Suggestion{}}, &handler.EnqueueRequestForObject{})
if err != nil {
return err
}
err = c.Watch(&source.Kind{Type: &appsv1.Deployment{}}, &handler.EnqueueRequestForOwner{
IsController: true,
OwnerType: &suggestionsv1beta1.Suggestion{},
})
if err != nil {
return err
}
err = c.Watch(&source.Kind{Type: &corev1.Service{}}, &handler.EnqueueRequestForOwner{
IsController: true,
OwnerType: &suggestionsv1beta1.Suggestion{},
})
if err != nil {
return err
}
err = c.Watch(&source.Kind{Type: &corev1.PersistentVolumeClaim{}}, &handler.EnqueueRequestForOwner{
IsController: true,
OwnerType: &suggestionsv1beta1.Suggestion{},
})
if err != nil {
return err
}
log.Info("Suggestion controller created")
return nil
}
var _ reconcile.Reconciler = &ReconcileSuggestion{}
// ReconcileSuggestion reconciles a Suggestion object
type ReconcileSuggestion struct {
client.Client
composer.Composer
suggestionclient.SuggestionClient
scheme *runtime.Scheme
recorder record.EventRecorder
}
// Reconcile reads that state of the cluster for a Suggestion object and makes changes based on the state read
// and what is in the Suggestion.Spec
// TODO(user): Modify this Reconcile function to implement your Controller logic. The scaffolding writes
// a Deployment as an example
// Automatically generate RBAC rules to allow the Controller to read and write Deployments
// +kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=apps,resources=deployments/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=katib.kubeflow.org,resources=suggestions,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=katib.kubeflow.org,resources=suggestions/status,verbs=get;update;patch
func (r *ReconcileSuggestion) Reconcile(request reconcile.Request) (reconcile.Result, error) {
logger := log.WithValues("Suggestion", request.NamespacedName)
// Fetch the Suggestion instance
oldS := &suggestionsv1beta1.Suggestion{}
err := r.Get(context.TODO(), request.NamespacedName, oldS)
if err != nil {
if errors.IsNotFound(err) {
// For additional cleanup logic use finalizers.
return reconcile.Result{}, nil
}
// Error reading the object - requeue the request.
return reconcile.Result{}, err
}
instance := oldS.DeepCopy()
// Suggestion will be succeeded if ResumePolicy = Never or ResumePolicy = FromVolume
if instance.IsSucceeded() {
err = r.deleteDeployment(instance)
if err != nil {
return reconcile.Result{}, err
}
err = r.deleteService(instance)
if err != nil {
return reconcile.Result{}, err
}
return reconcile.Result{}, nil
}
if !instance.IsCreated() {
if instance.Status.StartTime == nil {
now := metav1.Now()
instance.Status.StartTime = &now
}
msg := "Suggestion is created"
instance.MarkSuggestionStatusCreated(SuggestionCreatedReason, msg)
} else {
err := r.ReconcileSuggestion(instance)
if err != nil {
r.recorder.Eventf(instance, corev1.EventTypeWarning,
consts.ReconcileErrorReason, err.Error())
// Try updating just the status condition when possible
// Status conditions might need to be updated even in error
// Ignore all other status fields else it will be inconsistent during retry
_ = r.updateStatusCondition(instance, oldS)
logger.Error(err, "Reconcile Suggestion error")
return reconcile.Result{}, err
}
}
if err := r.updateStatus(instance, oldS); err != nil {
return reconcile.Result{}, err
}
return reconcile.Result{}, nil
}
// ReconcileSuggestion is the main reconcile loop for suggestion CR.
func (r *ReconcileSuggestion) ReconcileSuggestion(instance *suggestionsv1beta1.Suggestion) error {
logger := log.WithValues("Suggestion", types.NamespacedName{Name: instance.GetName(), Namespace: instance.GetNamespace()})
// If ResumePolicy = FromVolume volume is reconciled for suggestion
if instance.Spec.ResumePolicy == experimentsv1beta1.FromVolume {
pvc, pv, err := r.DesiredVolume(instance)
if err != nil {
return err
}
// Reconcile PVC and PV
_, _, err = r.reconcileVolume(pvc, pv)
if err != nil {
return err
}
}
service, err := r.DesiredService(instance)
if err != nil {
return err
}
_, err = r.reconcileService(service)
if err != nil {
return err
}
deploy, err := r.DesiredDeployment(instance)
if err != nil {
return err
}
if foundDeploy, err := r.reconcileDeployment(deploy); err != nil {
return err
} else {
if isReady := r.checkDeploymentReady(foundDeploy); isReady != true {
// deployment is not ready yet
msg := "Deployment is not ready"
instance.MarkSuggestionStatusDeploymentReady(corev1.ConditionFalse, SuggestionDeploymentNotReady, msg)
return nil
} else {
msg := "Deployment is ready"
instance.MarkSuggestionStatusDeploymentReady(corev1.ConditionTrue, SuggestionDeploymentReady, msg)
}
}
experiment := &experimentsv1beta1.Experiment{}
trials := &trialsv1beta1.TrialList{}
if err := r.Get(context.TODO(), types.NamespacedName{
Name: instance.Name,
Namespace: instance.Namespace,
}, experiment); err != nil {
return err
}
if err := r.List(context.TODO(),
client.MatchingLabels(util.TrialLabels(experiment)), trials); err != nil {
return err
}
// TODO (andreyvelich): Do we want to run ValidateAlgorithmSettings when Experiment is restarting?
// Currently it is running.
if !instance.IsRunning() {
if err = r.ValidateAlgorithmSettings(instance, experiment); err != nil {
logger.Error(err, "Marking suggestion failed as algorithm settings validation failed")
msg := fmt.Sprintf("Validation failed: %v", err)
instance.MarkSuggestionStatusFailed(SuggestionFailedReason, msg)
// return nil since it is a terminal condition
return nil
}
msg := "Suggestion is running"
instance.MarkSuggestionStatusRunning(corev1.ConditionTrue, SuggestionRunningReason, msg)
}
logger.Info("Sync assignments", "suggestions", instance.Spec.Requests)
if err = r.SyncAssignments(instance, experiment, trials.Items); err != nil {
return err
}
return nil
}
func (r *ReconcileSuggestion) checkDeploymentReady(deploy *appsv1.Deployment) bool {
if deploy == nil {
return false
} else {
for _, cond := range deploy.Status.Conditions {
if cond.Type == appsv1.DeploymentAvailable && cond.Status == corev1.ConditionTrue {
return true
}
}
}
return false
}