Group Cluster Failover flags into a single command flagSet

[XiShanYongYe-Chang]

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Currently, there are an increasing number of parameters in the generic component of karmada-controller-manager. It might be a good idea to group these parameters according to the functions or controllers they handle.

Let's first take Cluster Failover as an example to create a template, and then we will gradually group and process other parameters in the following sections.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

[karmada-bot]

[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 xishanyongye-chang. 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:

• cmd/OWNERS
• pkg/controllers/OWNERS

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

[gemini-code-assist]

Summary of Changes

Hello @XiShanYongYe-Chang, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a cleanup effort by refactoring the configuration options related to cluster failover. The primary goal is to enhance code clarity and maintainability by renaming the relevant struct and file, and by organizing its command-line flags into a distinct group. This change ensures that the configuration for cluster failover is explicitly named and presented, making it easier for developers and users to understand and manage.

Highlights

• Refactoring: The FailoverOptions struct and its associated file have been renamed to ClusterFailoverOptions and cluster_failover.go respectively, to provide clearer naming and intent.
• Flag Grouping: Command-line flags related to cluster failover configurations are now grouped under a dedicated cluster failover flag set, improving organization and user experience.
• Codebase Update: All references and usages of the old FailoverOptions have been updated to the new ClusterFailoverOptions across the codebase, including in controller setup, validation, and testing.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively groups the cluster failover flags into a dedicated flagSet, which improves the clarity of the command-line interface. The related options and configurations have been consistently renamed from FailoverOptions to ClusterFailoverOptions across the codebase. The changes are well-contained and correctly implemented. I've added a few minor suggestions to further improve the code by removing magic strings and updating a comment.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 35.71429% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.39%. Comparing base (d8473e1) to head (1589cb3).

Files with missing lines	Patch %	Lines
cmd/controller-manager/app/controllermanager.go	0.00%	7 Missing ⚠️
...controller-manager/app/options/cluster_failover.go	66.66%	2 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6905      +/-   ##
==========================================
- Coverage   46.39%   46.39%   -0.01%     
==========================================
  Files         697      697              
  Lines       47764    47766       +2     
==========================================
- Hits        22162    22161       -1     
- Misses      23932    23936       +4     
+ Partials     1670     1669       -1     

Flag	Coverage Δ
unittests	46.39% <35.71%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[XiShanYongYe-Chang]

/gemini review

[gemini-code-assist]

Code Review

This pull request effectively refactors the cluster failover flags into a dedicated flagSet, which improves the clarity and organization of the command-line interface. The changes are well-executed, including renaming FailoverOptions to ClusterFailoverOptions for better specificity and replacing magic strings with constants from policyv1alpha1, which enhances maintainability. Overall, this is a great cleanup that sets a good template for grouping other parameters in the future. I have one suggestion to improve the validation logic for the new options.

[XiShanYongYe-Chang]

/retest

[XiShanYongYe-Chang]

/cc @RainbowMango