⚠️ Refactor clusterctl alpha rollout

[hiromu-a5a]

What this PR does / why we need it:

A tiny refactoring of the RolloutOptions structure used by clusterctl alpha rollout. Defined RolloutOptions for each command.

The current codes for rollout reuses a common RolloutOptions structure among all kinds of rollout commands, i.e., undo, resume, restart and pause. However, the required inputs for those commands might be different in the future extension. From this perspective, the structure should be defined separately for each command.

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

Tracking Issue:
#3439

[k8s-ci-robot]

Hi @hiromu-a5a. 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.

[hiromu-a5a]

Following the other cluster alpha rollout patches, I didn't create a specific issue for this PR also because it's a small PR. If I have to create an issue, please kindly let me know.

[fabriziopandini]

/ok-to-test

[fabriziopandini]

I'm generally +1 for the change, but let's wait for a pass from clusterctl reviewers first.

[Jont828]

Thanks for the contribution! I think it makes sense to make the roll out options more fine-grained.

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 8d309115c279eea1e6424f31c05bd1e5be57c1c4

[Jont828]

Only thing seems to be that the main test is failing btw.

[fabriziopandini]

/retest
seems a flake

[fabriziopandini]

last nits from my side assuming test failures are flakes.
Given that this PR changes our API let's use ⚠️ instead of 🌱 in the title.
Also, let's add a note for this change in https://main.cluster-api.sigs.k8s.io/developer/providers/v1.3-to-v1.4.html#api-changes

[hiromu-a5a]

Thank you for your prompt reply!

I added note.

I have one question. The failing test pull-cluster-api-apidiff-main shows the changes are incompatible as follows. Any appropriate ways to solve this?
According to the past discussion and the Contributing Guideline, clusterctl is not required to provide any backward compatible guarantees but should be checked by approvers/maintainers if the change is acceptable.

 Incompatible changes:
  - (*clusterctlClient).RolloutRestart: changed from func(RolloutOptions) error to func(RolloutRestartOptions) error
  - (*clusterctlClient).RolloutResume: changed from func(RolloutOptions) error to func(RolloutResumeOptions) error
  - (*clusterctlClient).RolloutUndo: changed from func(RolloutOptions) error to func(RolloutUndoOptions) error
  - AlphaClient.RolloutRestart: changed from func(RolloutOptions) error to func(RolloutRestartOptions) error
  - AlphaClient.RolloutResume: changed from func(RolloutOptions) error to func(RolloutResumeOptions) error
  - AlphaClient.RolloutUndo: changed from func(RolloutOptions) error to func(RolloutUndoOptions) error

[k8s-ci-robot]

@hiromu-a5a: The following test 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-apidiff-main	efe3728	link	false	/test pull-cluster-api-apidiff-main

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.

[killianmuldoon]

I have one question. The failing test pull-cluster-api-apidiff-main shows the changes are incompatible as follows. Any appropriate ways to solve this?

You're right that the guarantees for clusterclt are different 🙂. The test will fail, but that won't block this PR getting merged. In this case it acts more as a signal to reviewers to consider what is being changed in the API.

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: fdbdd037ae87775fe04e122b4d9e73b3cfffb4eb

[fabriziopandini]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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 [fabriziopandini]

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

[fabriziopandini]

/hold
checking the lint job

[fabriziopandini]

/hold cancel