Add watch on cluster.status.infrastructureReady to reconcile vsphereMachine when cluster infrastructure is ready

[mrajashree]

What this PR does / why we need it:
After clusterctl move for self-managed CAPV clusters, worker machines take around 10-15 minutes to go to "Running" phase.
It could be due to the following reasons:

1. During clusterctl move, the Status fields are removed. So none of the CAPI objects retain the status fields, including the Cluster object. Once the Cluster.Spec.Paused field is unset after move, controllers begin to reconcile and the status fields get set again.
2. The capv vsphereMachine controller while reconciling the VsphereMachine object checks for the Cluster.Status.InfrastructureReady field before proceeding, which will be false immediately after the move until the cluster controller has reconciled & updated it.
3. The vsphereMachine controller gets the Cluster object at the start of every Reconcile, and it's possible that the CAPI cluster controller updates the Cluster object after it has already been picked up by the vsphereMachine controller. It's also possible that CAPV could be hitting this bug where controller-runtime GET is reading stale data. And from the comments on that bug the recommended way is to keep retrying.
4. CAPV syncs with CAPI objects eventually after the sync period which is by default set to 10 minutes. Because of which, after around 10 minutes the vsphereMachine controller gets the latest copy of the Cluster object and reconciles VsphereMachine successfully because by then the Cluster.Status.InfrastructureReady field has been set to true.
5. So the solution is either reducing the sync period time so that CAPV gets the latest Cluster object sooner or requeuing VsphereMachine until Cluster.Status.InfrastructureReady is true. It is recommended to requeue the object instead of reducing the sync period in this case as per these comments in the controller-runtime code.
6. This PR modifies the watch on Cluster object, to receive update events when cluster.status.infrastructureReady field becomes true. This way it enqueues the vsphereMachine for reconcilation once infrastructure is ready post clusterctl move

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1211

Release note:

NONE

[k8s-ci-robot]

Welcome @mrajashree!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-vsphere 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-vsphere has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @mrajashree. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[neolit123]

deferring to the CAPV maintainers:
/assign yastij randomvariable

[neolit123]

/ok-to-test

[vincepri]

Should we have a watch here instead of requeueing?

[mrajashree]

@vincepri oh you mean just like there's a watch on Cluster for the VSphereCluster object, we should add one mapping Cluster to VSphereMachine?

[vincepri]

Yeah if we're waiting for it, we probably should add watch instead of using RequeueAfter

[mrajashree]

oh looks like there is a watch for Cluster, just need to update the predicate to check for this

[mrajashree]

I tested changing the update predicate for the watch on Cluster but I see the same, machines reconcile after a while. I'll see if I missed something and test again. Only requeuing seems to work

[mrajashree]

The watch on cluster object's infrastructureReady field change wasn't working because it wasn't enqueuing the vsphereMachine object. Opened a PR for that #1306
With the change in clusterToVsphereMachine mapper, updating the watch on cluster object to enqueue vsphereMachine when cluster.status.infrastructureReady becomes true works. I'll rebase this PR when the other one is merged

[srm09]

Retriggering, seems to be an unrelated failure

[srm09]

/test pull-cluster-api-provider-vsphere-e2e

[yastij]

/assign @srm09

[yastij]

/retest

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-ci-robot]

@mrajashree: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-provider-vsphere-verify-shell	a4156ff	link	true	/test pull-cluster-api-provider-vsphere-verify-shell
pull-cluster-api-provider-vsphere-verify-markdown	a4156ff	link	true	/test pull-cluster-api-provider-vsphere-verify-markdown

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[mrajashree]

Updated the PR to replace predicates on cluster watch with ClusterUnpausedAndInfrastructureReady
This covers create events when Cluster.Spec.Paused is false and Cluster.Status.InfrastructureReady is true
And covers update events when either Cluster.Spec.Paused transitions to false or Cluster.Status.InfrastructureReady transitions to true

[srm09]

/lgtm

[mrajashree]

/remove-lifecycle stale

[srm09]

/lgtm

[srm09]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: srm09

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [srm09]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment