-
Notifications
You must be signed in to change notification settings - Fork 706
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
188 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| // Copyright 2021 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 util | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
| "strings" | ||
|
|
||
| "github.com/kubeflow/common/pkg/controller.v1/common" | ||
| "github.com/sirupsen/logrus" | ||
| log "github.com/sirupsen/logrus" | ||
|
|
||
| commonv1 "github.com/kubeflow/common/pkg/apis/common/v1" | ||
| "github.com/kubeflow/common/pkg/controller.v1/expectation" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "sigs.k8s.io/controller-runtime/pkg/event" | ||
| ) | ||
|
|
||
| // GenExpectationGenericKey generates an expectation key for {Kind} of a job | ||
| func GenExpectationGenericKey(jobKey string, replicaType string, pl string) string { | ||
| return jobKey + "/" + strings.ToLower(replicaType) + "/" + pl | ||
| } | ||
|
|
||
| // LoggerForGenericKind generates log entry for generic Kubernetes resource Kind | ||
| func LoggerForGenericKind(obj metav1.Object, kind string) *log.Entry { | ||
| job := "" | ||
| if controllerRef := metav1.GetControllerOf(obj); controllerRef != nil { | ||
| if controllerRef.Kind == kind { | ||
| job = obj.GetNamespace() + "." + controllerRef.Name | ||
| } | ||
| } | ||
| return log.WithFields(log.Fields{ | ||
| // We use job to match the key used in controller.go | ||
| // In controller.go we log the key used with the workqueue. | ||
| "job": job, | ||
| kind: obj.GetNamespace() + "." + obj.GetName(), | ||
| "uid": obj.GetUID(), | ||
| }) | ||
| } | ||
|
|
||
| // OnDependentCreateFuncGeneric modify expectations when dependent (pod/service) creation observed. | ||
| func OnDependentCreateFuncGeneric(exp expectation.ControllerExpectationsInterface) func(event.CreateEvent) bool { | ||
| return func(e event.CreateEvent) bool { | ||
| rtype := e.Object.GetLabels()[commonv1.ReplicaTypeLabel] | ||
| if len(rtype) == 0 { | ||
| return false | ||
| } | ||
|
|
||
| if controllerRef := metav1.GetControllerOf(e.Object); controllerRef != nil { | ||
| jobKey := fmt.Sprintf("%s/%s", e.Object.GetNamespace(), controllerRef.Name) | ||
| var expectKey string | ||
| pl := strings.ToLower(e.Object.GetObjectKind().GroupVersionKind().Kind) + "s" | ||
| expectKey = GenExpectationGenericKey(jobKey, rtype, pl) | ||
| exp.CreationObserved(expectKey) | ||
| return true | ||
| } | ||
|
|
||
| return true | ||
| } | ||
| } | ||
|
|
||
| // OnDependentUpdateFuncGeneric modify expectations when dependent (pod/service) update observed. | ||
| func OnDependentUpdateFuncGeneric(jc *common.JobController) func(updateEvent event.UpdateEvent) bool { | ||
| return func(e event.UpdateEvent) bool { | ||
| newObj := e.ObjectNew | ||
| oldObj := e.ObjectOld | ||
| if newObj.GetResourceVersion() == oldObj.GetResourceVersion() { | ||
| // Periodic resync will send update events for all known pods. | ||
| // Two different versions of the same pod will always have different RVs. | ||
| return false | ||
| } | ||
|
|
||
| kind := jc.Controller.GetAPIGroupVersionKind().Kind | ||
| var logger *logrus.Entry | ||
| logger = LoggerForGenericKind(newObj, kind) | ||
|
|
||
| newControllerRef := metav1.GetControllerOf(newObj) | ||
| oldControllerRef := metav1.GetControllerOf(oldObj) | ||
| controllerRefChanged := !reflect.DeepEqual(newControllerRef, oldControllerRef) | ||
|
|
||
| if controllerRefChanged && oldControllerRef != nil { | ||
| // The ControllerRef was changed. Sync the old controller, if any. | ||
| if job := resolveControllerRef(jc, oldObj.GetName(), oldControllerRef); job != nil { | ||
| logger.Infof("%s controller ref updated: %v, %v", kind, newObj, oldObj) | ||
| return true | ||
| } | ||
| } | ||
|
|
||
| // If it has a controller ref, that's all that matters. | ||
| if newControllerRef != nil { | ||
| job := resolveControllerRef(jc, newObj.GetNamespace(), newControllerRef) | ||
| if job == nil { | ||
| return false | ||
| } | ||
| logger.Debugf("%s has a controller ref: %v, %v", kind, newObj, oldObj) | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| // OnDependentDeleteFuncGeneric modify expectations when dependent (pod/service) deletion observed. | ||
| func OnDependentDeleteFuncGeneric(exp expectation.ControllerExpectationsInterface) func(event.DeleteEvent) bool { | ||
| return func(e event.DeleteEvent) bool { | ||
|
|
||
| rtype := e.Object.GetLabels()[commonv1.ReplicaTypeLabel] | ||
| if len(rtype) == 0 { | ||
| return false | ||
| } | ||
|
|
||
| // logrus.Info("Update on deleting function ", xgbr.ControllerName(), " delete object ", e.Object.GetName()) | ||
| if controllerRef := metav1.GetControllerOf(e.Object); controllerRef != nil { | ||
| jobKey := fmt.Sprintf("%s/%s", e.Object.GetNamespace(), controllerRef.Name) | ||
| pl := strings.ToLower(e.Object.GetObjectKind().GroupVersionKind().Kind) + "s" | ||
| var expectKey string | ||
| expectKey = GenExpectationGenericKey(jobKey, rtype, pl) | ||
|
|
||
| exp.DeletionObserved(expectKey) | ||
| return true | ||
| } | ||
|
|
||
| return true | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters