WIP: Update docs on updating clusterctl API version upgrade tests

[willie-yao]

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR updates documentation on how to update the clusterctl API version upgrade tests on a new release. Previously the docs were pointing to the wrong place for updating versions, as well as not including guidance on how to update the cluster-template-prow.yaml that the test was using.

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 #

Special notes for your reviewer:

• cherry-pick candidate

TODOs:

• squashed commits
• includes documentation
• adds unit tests

Release note:

NONE

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from willie-yao. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

• OWNERS

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

[nojnhuh]

I don't think this describes the nuance that the template in test/e2e/data/infrastructure-azure/v* needs to keep its AzureClusterIdentity and not use the one from templates/test/ci/cluster-template-prow.yaml. Instead of updating this doc for now, I'd rather see if we can get kustomize to start generating these templates and automatically take care of that. Explaining that in plain language here is going to make this too cumbersome IMO.

[willie-yao]

Sure, I can pivot this PR to get kustomize to generate it, since leaving these docs are outdated as-is. So the template is templates/test/ci/cluster-template-prow.yaml but with the AzureClusterIdentity from test/e2e/data/infrastructure-azure/v*?

[nojnhuh]

The formula we'd want is templates/test/ci/cluster-template-prow.yaml + this patch:

diff --git a/test/e2e/data/infrastructure-azure/v1.15.1/cluster-template-prow.yaml b/test/e2e/data/infrastructure-azure/v1.15.1/cluster-template-prow.yaml
index abcfffe4f..af51d864c 100644
--- a/test/e2e/data/infrastructure-azure/v1.15.1/cluster-template-prow.yaml
+++ b/test/e2e/data/infrastructure-azure/v1.15.1/cluster-template-prow.yaml
@@ -381,9 +381,10 @@ metadata:
   namespace: default
 spec:
   allowedNamespaces: {}
-  clientID: ${AZURE_CLIENT_ID_USER_ASSIGNED_IDENTITY}
+  clientID: ${AZURE_CLIENT_ID_CLOUD_PROVIDER}
+  resourceID: /subscriptions/${AZURE_SUBSCRIPTION_ID}/resourceGroups/${CI_RG:=capz-ci}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/${USER_IDENTITY:=cloud-provider-user-identity}
   tenantID: ${AZURE_TENANT_ID}
-  type: WorkloadIdentity
+  type: UserAssignedMSI
 ---
 apiVersion: addons.cluster.x-k8s.io/v1beta1
 kind: ClusterResourceSet

[nojnhuh]

This isn't super critical though, so maybe opening an issue for now is best while we iron out the rest of the failing tests.

[willie-yao]

Created an issue #4997. Should I close this PR or just include the changes on line 204 to the docs so that it points to the correct files?

[jackfrancis]

Let's stand by to see how things shake out in #4992

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.18%. Comparing base (334aef3) to head (12bba90).
Report is 43 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4996   +/-   ##
=======================================
  Coverage   51.18%   51.18%           
=======================================
  Files         274      274           
  Lines       24625    24625           
=======================================
  Hits        12605    12605           
  Misses      11234    11234           
  Partials      786      786           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.