Fix race with ActivePlan between Instance and PlanExecution controllers #722
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -101,7 +101,7 @@ func add(mgr manager.Manager, r reconcile.Reconciler) error { | |
| instance.Status.ActivePlan.Name == "" { | ||
|
|
||
| log.Printf("InstanceController: Creating a deploy execution plan for the instance %v", instance.Name) | ||
| err = createPlan(mgr.GetClient(), mgr.GetEventRecorderFor("instance-controller"), mgr.GetScheme(), "deploy", &instance) | ||
| if err != nil { | ||
| log.Printf("InstanceController: Error creating \"%v\" object for \"deploy\": %v", instance.Name, err) | ||
| } | ||
|
|
@@ -264,7 +264,7 @@ func instanceEventFilter(mgr manager.Manager) predicate.Funcs { | |
| } | ||
| } | ||
|
|
||
| if err = createPlan(mgr.GetClient(), mgr.GetEventRecorderFor("instance-controller"), mgr.GetScheme(), planName, new); err != nil { | ||
| log.Printf("InstanceController: Error creating PlanExecution \"%v\" for instance \"%v\": %v", planName, new.Name, err) | ||
| } | ||
| } | ||
|
|
@@ -305,57 +305,42 @@ func instanceEventFilter(mgr manager.Manager) predicate.Funcs { | |
| } | ||
| } | ||
|
|
||
| func createPlan(c client.Client, r record.EventRecorder, scheme *runtime.Scheme, planName string, instance *kudov1alpha1.Instance) error { | ||
| ctx := context.TODO() | ||
|
|
||
| planExecution := newPlanExecution(instance, planName, scheme) | ||
| log.Printf("Creating PlanExecution of planExecution %s for instance %s", planName, instance.Name) | ||
| r.Event(instance, "Normal", "CreatePlanExecution", fmt.Sprintf("Creating \"%v\" planExecution execution", planName)) | ||
|
|
||
| // Make this instance the owner of the PlanExecution | ||
| if err := controllerutil.SetControllerReference(instance, planExecution, scheme); err != nil { | ||
| log.Printf("InstanceController: Error setting ControllerReference") | ||
| return err | ||
| } | ||
| if err := c.Create(ctx, planExecution); err != nil { | ||
| log.Printf("InstanceController: Error creating planexecution \"%v\": %v", planExecution.Name, err) | ||
| r.Event(instance, "Warning", "CreatePlanExecution", fmt.Sprintf("Error creating planexecution \"%v\": %v", planExecution.Name, err)) | ||
| return err | ||
| } | ||
| log.Printf("Created PlanExecution of planExecution %s for instance %s", planName, instance.Name) | ||
| r.Event(instance, "Normal", "PlanCreated", fmt.Sprintf("PlanExecution \"%v\" created", planExecution.Name)) | ||
|
|
||
|
There was a problem hiding this comment. it was real pain maintaining two, while the only difference was how they accepted the dependencies which was pretty easy to unite |
||
| return addActivePlanReference(c, r, planExecution, instance) | ||
| } | ||
|
|
||
| func addActivePlanReference(c client.Client, r record.EventRecorder, planExecution *kudov1alpha1.PlanExecution, instance *kudov1alpha1.Instance) error { | ||
|
|
||
| instance.Status.ActivePlan = corev1.ObjectReference{ | ||
| Name: planExecution.Name, | ||
| Kind: "PlanExecution", | ||
| Namespace: planExecution.Namespace, | ||
| APIVersion: "kudo.dev/v1alpha1", | ||
| UID: planExecution.UID, | ||
| } | ||
| err := c.Update(context.TODO(), instance) | ||
| if err != nil { | ||
| r.Event(instance, "Warning", "UpdateError", fmt.Sprintf("Could not update the ActivePlan for (%v): %v", planExecution.Spec.Instance.Name, err)) | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| var _ reconcile.Reconciler = &ReconcileInstance{} | ||
|
|
@@ -392,7 +377,7 @@ func (r *ReconcileInstance) Reconcile(request reconcile.Request) (reconcile.Resu | |
|
|
||
| // if this is new create and create and assign a planexecution and return | ||
| if isNewInstance(instance) { | ||
| err = createPlan(r.Client, r.recorder, r.scheme, "deploy", instance) | ||
| // err or not we return. If err == nil the controller is done, else requeue | ||
| return reconcile.Result{}, err | ||
| } | ||
|
|
@@ -477,14 +462,18 @@ func parameterDifference(old, new map[string]string) map[string]string { | |
| } | ||
|
|
||
| // newPlanExecution creates a PlanExecution based on the kind and instance for a given planName | ||
| func newPlanExecution(instance *kudov1alpha1.Instance, planName string, scheme *runtime.Scheme) *kudov1alpha1.PlanExecution { | ||
| gvk, _ := apiutil.GVKForObject(instance, scheme) | ||
| ref := corev1.ObjectReference{ | ||
| Kind: gvk.Kind, | ||
| Name: instance.Name, | ||
| Namespace: instance.Namespace, | ||
| } | ||
| planExecution := kudov1alpha1.PlanExecution{ | ||
| TypeMeta: metav1.TypeMeta{ | ||
| Kind: "PlanExecution", | ||
| APIVersion: "kudo.dev/v1alpha1", | ||
|
There was a problem hiding this comment. We have this dotted in a lot of places, so I looked for some "standardization" point that already exists in our codebase generated by kubebuilder, maybe we start moving to something more like this? Or at least turn it into a constant we can reference elsewhere. Maybe this is the constant? kudo/pkg/apis/kudo/v1alpha1/register.go Line 33 in 4def9dc There was a problem hiding this comment. let's try to unify this in another PR... I'll prepare one. Btw. how do you convert the groupversion to the string? There was a problem hiding this comment. Agree, let's unify in a separate PR There was a problem hiding this comment. 👍 we'll have to look that up. hopefully it's something we can just set as a var and not have as a function call everywhere. |
||
| }, | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: fmt.Sprintf("%v-%v-%v", instance.Name, planName, time.Now().Nanosecond()), | ||
| Namespace: instance.GetNamespace(), | ||
|
|
@@ -500,5 +489,6 @@ func newPlanExecution(instance *kudov1alpha1.Instance, planName string, scheme * | |
| Template: instance.Spec, | ||
| }, | ||
| } | ||
|
|
||
| return &planExecution | ||
| } | ||
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This method should be called
createPlanAndUpdateInstanceor evencreatePlanAndUpdateInstanceActivePlanReerence:P