Implement Ready condition for Instance type #1706

alenkacz · 2020-10-07T08:42:32Z

Signed-off-by: Alena Varkockova varkockova.a@gmail.com

What this PR does / why we need it:
This is an implementation of KEP-34. It adds Status.Conditions.Ready to an Instance while this property is being computed from the owned resources of certain types.

nfnt

This looks great already! Found some nits, but also have some questions around setting the "Unknown" state.

pkg/apis/kudo/v1beta1/instance_types_helpers.go

pkg/controller/instance/instance_controller.go

pkg/kubernetes/status/readiness.go

zen-dog

Good start, left a few comments and nits 👍

pkg/apis/kudo/v1beta1/instance_types_helpers.go

zen-dog · 2020-10-07T15:44:06Z

pkg/controller/instance/instance_controller.go

@@ -536,5 +560,6 @@ func scheduledPlan(i *kudoapi.Instance, ov *kudoapi.OperatorVersion) (string, ty
 		i.Spec.PlanExecution.Status = kudoapi.ExecutionNeverRun
 	}

+	i.SetReadinessUnknownForDeploy()


This func scheduledPlan was supposed to simply return the i.Spec.PlanExecution.PlanName. Now, scheduling a cleanup is already an ugly exception we need to make, but this method shouldn't update instance status.

zen-dog · 2020-10-07T15:54:29Z

pkg/apis/kudo/v1beta1/instance_types_helpers.go

+// SetReadinessUnknownForDeploy sets an unknown state for Status.Conditions.Ready
+// this will modify instance only when deploy, upgrade, update plan is running
+func (i *Instance) SetReadinessUnknownForDeploy() {
+	if i.Spec.PlanExecution.PlanName == DeployPlanName || i.Spec.PlanExecution.PlanName == UpgradePlanName || i.Spec.PlanExecution.PlanName == UpdatePlanName {


This long if probably deserves a helper method of its own e.g. func IsDeployUpdateOrUpgradeScheduled or smth :D

yeah I am not sure :D I think long if vs long ugly name of method 🤷

pkg/controller/instance/instance_controller.go

pkg/kubernetes/status/readiness.go

pkg/apis/kudo/v1beta1/instance_types_helpers.go

nfnt

Almost there! Because I was just working on IsHealthy for #1707, I noticed something around readinessMessage that may need some changes.

pkg/controller/instance/instance_controller.go

pkg/kubernetes/status/readiness.go

pkg/apis/kudo/v1beta1/instance_types_helpers.go

pkg/controller/instance/instance_controller.go

ANeumann82 · 2020-10-08T09:37:56Z

pkg/controller/instance/instance_controller.go

@@ -536,5 +563,8 @@ func scheduledPlan(i *kudoapi.Instance, ov *kudoapi.OperatorVersion) (string, ty
 		i.Spec.PlanExecution.Status = kudoapi.ExecutionNeverRun
 	}

+	if i.Spec.PlanExecution.PlanName == kudoapi.DeployPlanName || i.Spec.PlanExecution.PlanName == kudoapi.UpgradePlanName || i.Spec.PlanExecution.PlanName == kudoapi.UpdatePlanName {


I'm not sure if we use these things somewhere else, but I wouldn't mind something like kudoapi.isDefaultPlan(planName) or similar...

yeah Aleksey wanted that as well I just don't know how to name it ... I am not sure default plan means something to me really. I don't want to do "IsDeployOrUpgradeOrUpdate" 🤷 so I ended up keeping this explicitly :/

zen-dog · 2020-10-08T11:13:48Z

pkg/controller/instance/instance_controller.go

@@ -536,5 +576,8 @@ func scheduledPlan(i *kudoapi.Instance, ov *kudoapi.OperatorVersion) (string, ty
 		i.Spec.PlanExecution.Status = kudoapi.ExecutionNeverRun
 	}

+	if i.Spec.PlanExecution.PlanName == kudoapi.DeployPlanName || i.Spec.PlanExecution.PlanName == kudoapi.UpgradePlanName || i.Spec.PlanExecution.PlanName == kudoapi.UpdatePlanName {
+		i.SetReadinessUnknown()


Again, this "simple getter" (with an exception) shouldn't update Instance status as a side effect. Let's move this someplace else.

how is this a getter if this method modifies Spec? :D

I meant in this comment that this is an ugly but necessary side-effect that is at least about the plan name. Instance status modification is an even bigger one.

pkg/apis/kudo/v1beta1/instance_types_helpers.go

Signed-off-by: Alena Varkockova <varkockova.a@gmail.com>

Signed-off-by: Jan Schlicht <jan@d2iq.com>

nfnt

LGTM!

zen-dog

One nit but otherwise lgtm 🚢

pkg/apis/kudo/v1beta1/instance_types_helpers.go

pkg/controller/instance/instance_controller.go

Signed-off-by: Jan Schlicht <jan@d2iq.com> Co-authored-by: Andreas Neumann <aneumann@mesosphere.com>

Signed-off-by: Jan Schlicht <jan@d2iq.com>

alenkacz requested review from gerred, kensipe, nfnt and zen-dog as code owners October 7, 2020 08:42

alenkacz force-pushed the av/readiness branch 6 times, most recently from 07dca3f to 952bf5e Compare October 7, 2020 10:14

alenkacz added this to the 0.17.0 milestone Oct 7, 2020

alenkacz changed the title ~~WIP: Implement Ready condition for Instance type~~ Implement Ready condition for Instance type Oct 7, 2020

alenkacz force-pushed the av/readiness branch 2 times, most recently from 3840d31 to 25329ed Compare October 7, 2020 10:55

nfnt requested changes Oct 7, 2020

View reviewed changes

zen-dog reviewed Oct 7, 2020

View reviewed changes

pkg/kubernetes/status/readiness.go Show resolved Hide resolved

zen-dog requested changes Oct 7, 2020

View reviewed changes

alenkacz force-pushed the av/readiness branch 3 times, most recently from c5abe48 to 960385b Compare October 8, 2020 08:24

nfnt reviewed Oct 8, 2020

View reviewed changes

pkg/apis/kudo/v1beta1/instance_types_helpers.go Outdated Show resolved Hide resolved

alenkacz force-pushed the av/readiness branch from 960385b to 6caf0d8 Compare October 8, 2020 08:53

nfnt reviewed Oct 8, 2020

View reviewed changes

pkg/controller/instance/instance_controller.go Outdated Show resolved Hide resolved

pkg/kubernetes/status/readiness.go Outdated Show resolved Hide resolved

ANeumann82 reviewed Oct 8, 2020

View reviewed changes

alenkacz force-pushed the av/readiness branch 2 times, most recently from e45f8ac to 2a3e605 Compare October 8, 2020 10:57

zen-dog reviewed Oct 8, 2020

View reviewed changes

pkg/apis/kudo/v1beta1/instance_types_helpers.go Outdated Show resolved Hide resolved

zen-dog reviewed Oct 8, 2020

View reviewed changes

pkg/apis/kudo/v1beta1/instance_types_helpers.go Outdated Show resolved Hide resolved

alenkacz force-pushed the av/readiness branch from 2a3e605 to 304fd67 Compare October 8, 2020 11:20

alenkacz force-pushed the av/readiness branch 2 times, most recently from 21e255d to c5a46b7 Compare October 8, 2020 11:55

Implement Ready condition for Instance type

cc07448

Signed-off-by: Alena Varkockova <varkockova.a@gmail.com>

alenkacz force-pushed the av/readiness branch from c5a46b7 to cc07448 Compare October 8, 2020 12:14

Fix readiness messages and reorder imports

2c922d7

Signed-off-by: Jan Schlicht <jan@d2iq.com>

nfnt approved these changes Oct 8, 2020

View reviewed changes

nfnt requested review from zen-dog and ANeumann82 October 8, 2020 12:46

nfnt added the release/blocker label Oct 8, 2020

zen-dog approved these changes Oct 8, 2020

View reviewed changes

pkg/apis/kudo/v1beta1/instance_types_helpers.go Outdated Show resolved Hide resolved

ANeumann82 reviewed Oct 8, 2020

View reviewed changes

Jan Schlicht and others added 4 commits October 8, 2020 16:26

Update pkg/controller/instance/instance_controller.go

cf9bbd1

Signed-off-by: Jan Schlicht <jan@d2iq.com> Co-authored-by: Andreas Neumann <aneumann@mesosphere.com>

Simplify equality check

7dc20e6

Signed-off-by: Jan Schlicht <jan@d2iq.com>

Don't dereference potential nil values

23eca12

Signed-off-by: Jan Schlicht <jan@d2iq.com>

Use a 'SetReadiness' command with a type

9bdce83

Signed-off-by: Jan Schlicht <jan@d2iq.com>

ANeumann82 approved these changes Oct 9, 2020

View reviewed changes

nfnt merged commit 7eefce1 into main Oct 9, 2020

nfnt deleted the av/readiness branch October 9, 2020 10:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Ready condition for Instance type #1706

Implement Ready condition for Instance type #1706

alenkacz commented Oct 7, 2020 •

edited

Loading

nfnt left a comment

zen-dog left a comment

zen-dog Oct 7, 2020

zen-dog Oct 7, 2020

alenkacz Oct 8, 2020

nfnt left a comment

ANeumann82 Oct 8, 2020

alenkacz Oct 8, 2020

zen-dog Oct 8, 2020

alenkacz Oct 8, 2020

zen-dog Oct 8, 2020

nfnt left a comment

zen-dog left a comment

Implement Ready condition for Instance type #1706

Implement Ready condition for Instance type #1706

Conversation

alenkacz commented Oct 7, 2020 • edited Loading

nfnt left a comment

Choose a reason for hiding this comment

zen-dog left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nfnt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nfnt left a comment

Choose a reason for hiding this comment

zen-dog left a comment

Choose a reason for hiding this comment

alenkacz commented Oct 7, 2020 •

edited

Loading