✨ Add Namespace Scoped Zone Discovery and Watch

[zhanggbj]

What this PR does / why we need it:
This is to support the new Namespace Scoped Zone for isolation.

• Introduce a feature flag to enable Namespace Scoped Zone.
• Enhance zone discovery to support Namespace Scoped Zones.
• Filter out zones marked for deletion during the discovery process.
• Add Watch for Zone changes to update FailureDomains accordingly

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 #

[sbueringer]

@zhanggbj Should we already take a look or wait until the PR is out of draft?

[zhanggbj]

@sbueringer @chrischdi @fabriziopandini
Just removed the WIP as I was fixing some test job errors, but feel free to start a review, thanks!

About testing results with a real supervisor:

1. With a Supervisor which has both Cluster scoped AZ (zone-1, zone-2 and zone-3)and NS scoped Zone (zone-2 and zone-3), with NamespaceScopedZone enabled, cluster creation completes successfully.

tkg-test    tkg-multizone-e-drr4s-kpl8m                     zone-2   vsphere://302b8630-234d-4870-9ba6-0440fa2bf00e   192.168.128.77
tkg-test    tkg-multizone-e-drr4s-svwcc                     zone-3   vsphere://1c295476-e071-4d31-b737-7e30467650e3   192.168.128.74
tkg-test    tkg-multizone-e-drr4s-v7wzr                     zone-2   vsphere://ebb2f15d-5196-4dc7-88e5-fac9f6ced243   192.168.128.73
tkg-test    tkg-multizone-e-worker-np-1-2plnn-4jj56-f5jgl   zone-2   vsphere://cecc5158-90d8-4226-9af8-165d9d4f3f7c   192.168.128.76
tkg-test    tkg-multizone-e-worker-np-3-8kw7k-vnq7j-mw8p5   zone-3   vsphere://e1cda4ef-1826-4347-a9e0-740e61716237   192.168.128.75

2. With a Supervisor which has both Cluster scoped AZ (zone-1, zone-2 and zone-3)and NS scoped Zone (zone-2 and zone-3), with NamespaceScopedZone disabled, CAPV will discover Cluster scoped AZ zone-1, zone-2 and zone-3 as expected.

[chrischdi]

We also need to add a watch ca. at:
https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/main/controllers/vspherecluster_controller.go#L75

But only if the featuregate is enabled.

It should then use a EnqueueRequestFromMapFunc for all clusters in the namespace where the zone change was detected.

[zhanggbj]

We also need to add a watch ca. at: main/controllers/vspherecluster_controller.go#L75

But only if the featuregate is enabled.

It should then use a EnqueueRequestFromMapFunc for all clusters in the namespace where the zone change was detected.

Sure, we need to watch the Zone event, but I was planning to add it in a separate PR, as so far I cannot test it locally as the supervisor hasn't fully supported Zone deletion.

Currently only Zone discovery and cluster creation can be tested.

[sbueringer]

I really would prefer adding the watch in this PR already, even if we can't manually test it. Although it's not clear to me why we can't test it. Basically you can add/remove Zone objects and these should be then reflected in VSphereCluster and directly afterwards on Cluster, right?
(they don't even have to work to test that)

[zhanggbj]

Have to add a dot after this line, otherwise godot linter will fail Comment should end in a period (godot) and seems I cannot add a //nolint:godot in a commented line.

// SPDX-License-Identifier: Apache-2.0

[zhanggbj]

@chrischdi @sbueringer
I'm OK to add the Watch in this PR for code review first, I'll test it later locally, just want to make sure code changes are tested with the supervisor before sending for review.

[chrischdi]

Have to add a dot after this line, otherwise godot linter will fail Comment should end in a period (godot) and seems I cannot add a //nolint:godot in a commented line.

// SPDX-License-Identifier: Apache-2.0

Let's add a global ignore to this path in .golangci.yaml

Should then be something like:

  skip-files:
    - "zz_generated.*\\.go$"
    - "_conversion\\.go$"
    - "vendored_cluster_api\\.go$"
    - "^internal/apis/topology/v1alpha1"

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 73bebc55504d8679c600b53018c2cd01d0629ff6

[sbueringer]

/assign @chrischdi

for a final review

[chrischdi]

/approve
/hold cancel

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chrischdi, sbueringer

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 [chrischdi,sbueringer]

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

[sbueringer]

/hold
for another round of tests on the mirror :)

[chrischdi]

/lgtm

/test help

[k8s-ci-robot]

@chrischdi: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

• /test pull-cluster-api-provider-vsphere-e2e-vcsim-govmomi-main
• /test pull-cluster-api-provider-vsphere-e2e-vcsim-supervisor-main
• /test pull-cluster-api-provider-vsphere-test-main
• /test pull-cluster-api-provider-vsphere-verify-main

The following commands are available to trigger optional jobs:

• /test pull-cluster-api-provider-vsphere-apidiff-main

Use /test all to run the following jobs that were automatically triggered:

• pull-cluster-api-provider-vsphere-apidiff-main
• pull-cluster-api-provider-vsphere-test-main
• pull-cluster-api-provider-vsphere-verify-main

In response to this:

/lgtm

/test help

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-sigs/prow repository.

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 09e4e29248e364c519a92078215bfb1640c9f861

[chrischdi]

/test pull-cluster-api-provider-vsphere-e2e-vcsim-govmomi-main
/test pull-cluster-api-provider-vsphere-e2e-vcsim-supervisor-main

[chrischdi]

/hold

Waiting for jobs here and at team-cluster-api#7 to succeed

[sbueringer]

Tests are green.

Nice work everyone!

/hold cancel