Add Kubernetes Conditions to SR-IOV Network Operator CRDs

[SchSeba]

This PR enhances the observability and operational transparency of the SR-IOV Network Operator by integrating standard Kubernetes conditions into the status of all key Custom Resource Definitions (CRDs). This enables users and automated systems to easily understand the current state, progress, and health of SR-IOV network configurations directly through Kubernetes API objects.

[github-actions]

Thanks for your PR,
To run vendors CIs, Maintainers can use one of:

• /test-all: To run all tests for all vendors.
• /test-e2e-all: To run all E2E tests for all vendors.
• /test-e2e-nvidia-all: To run all E2E tests for NVIDIA vendor.

To skip the vendors CIs, Maintainers can use one of:

• /skip-all: To skip all tests for all vendors.
• /skip-e2e-all: To skip all E2E tests for all vendors.
• /skip-e2e-nvidia-all: To skip all E2E tests for NVIDIA vendor.
  Best regards.

[gemini-code-assist]

Summary of Changes

Hello @SchSeba, 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 significantly improves the observability and operational transparency of the SR-IOV Network Operator by integrating standard Kubernetes conditions into the status of its Custom Resource Definitions. This change allows users and automated systems to easily understand the current state, progress, and health of SR-IOV network configurations and operator components directly through Kubernetes API objects, facilitating better monitoring, debugging, and automated remediation workflows.

Highlights

• Kubernetes Conditions Integration: Introduced standard Kubernetes conditions (Ready, Progressing, Degraded) to the status of all major SR-IOV Network Operator Custom Resource Definitions (CRDs): SriovNetwork, SriovIBNetwork, OVSNetwork, SriovNetworkNodeState, SriovOperatorConfig, SriovNetworkNodePolicy, and SriovNetworkPoolConfig. This enhances observability and operational transparency.
• New Status Controllers: Added dedicated status controllers (SriovNetworkNodePolicyStatusReconciler and SriovNetworkPoolConfigStatusReconciler) responsible for aggregating conditions from individual SriovNetworkNodeState objects to provide a consolidated status for policies and pool configurations.
• Generic Status Patcher: Implemented a new pkg/status package providing a generic Patcher interface and implementation. This utility simplifies status updates with built-in retry logic for conflicts and automatic event emission for condition transitions, ensuring consistency and robustness across controllers.
• Enhanced kubectl get Output: Added +kubebuilder:printcolumn annotations to CRD definitions, allowing users to quickly view the Ready, Progressing, and Degraded statuses directly from kubectl get commands for all affected CRDs.
• Improved Node Drain Observability: Updated the node drain logic to include specific conditions (DrainProgressing, DrainDegraded, DrainComplete) in the SriovNetworkNodeState status, providing clearer insight into the node draining process and any encountered errors.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 is an excellent pull request that significantly enhances the observability of the SR-IOV Network Operator by integrating standard Kubernetes conditions into all key CRDs. The changes are comprehensive, well-structured, and follow Kubernetes API conventions. The introduction of a status.Patcher utility for handling status updates with retries and event emissions is a great abstraction. The addition of additionalPrinterColumns is a valuable UX improvement for kubectl users. The test coverage is thorough, including unit, integration, and conformance tests, which gives high confidence in the changes. I've also noted a subtle but important bug fix in the drain controller's predicate logic. Overall, this is a high-quality contribution.

[gemini-code-assist]

This is a great catch! Using GetAnnotations() here instead of GetLabels() fixes a bug where the DrainStateAnnotationPredicate would not have correctly detected updates to the sriovnetwork.openshift.io/state annotation. This ensures the drain controller will be properly triggered on state changes.

[coveralls]

Pull Request Test Coverage Report for Build 20831826835

Details

• 857 of 1087 (78.84%) changed or added relevant lines in 15 files are covered.
• 27 unchanged lines in 7 files lost coverage.
• Overall coverage increased (+1.1%) to 64.352%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
pkg/drain/drainer.go	25	27	92.59%
controllers/drain_controller.go	3	6	50.0%
pkg/status/transitions.go	56	59	94.92%
api/v1/zz_generated.deepcopy.go	41	48	85.42%
api/v1/helper.go	206	218	94.5%
controllers/drain_controller_helper.go	38	62	61.29%
controllers/sriovoperatorconfig_controller.go	49	83	59.04%
controllers/generic_network_controller.go	68	111	61.26%
pkg/status/patcher.go	58	103	56.31%
controllers/status_controller.go	272	329	82.67%

Files with Coverage Reduction	New Missed Lines	%
controllers/sriovoperatorconfig_controller.go	1	72.46%
controllers/helper.go	2	69.85%
pkg/utils/cluster.go	3	84.54%
controllers/drain_controller.go	4	77.69%
controllers/generic_network_controller.go	4	72.73%
controllers/sriovnetworkpoolconfig_controller.go	4	64.71%
controllers/drain_controller_helper.go	9	62.68%

Totals
Change from base Build 20823552175:	1.1%
Covered Lines:	9963
Relevant Lines:	15482

---

💛 - Coveralls

[SchSeba]

/gemini review

[gemini-code-assist]

Code Review

This pull request introduces comprehensive Kubernetes condition integration across all major SR-IOV Network Operator Custom Resource Definitions (CRDs), including SriovNetwork, SriovIBNetwork, OVSNetwork, SriovNetworkNodeState, SriovOperatorConfig, SriovNetworkNodePolicy, and SriovNetworkPoolConfig. The changes define common condition types (Ready, Progressing, Degraded) and specific drain-related conditions (DrainProgressing, DrainDegraded, DrainComplete) along with detailed reasons. Each CRD's status now includes a Conditions array, and kubectl get -o wide output is enhanced with new columns to display these conditions. A new pkg/status package provides a Patcher interface for managing status updates with retry logic and event emission, ensuring conditions are updated consistently and atomically. Controllers are updated to utilize this StatusPatcher to set appropriate conditions based on reconciliation outcomes, node states, and drain operations. Specifically, the drain controller now uses an onError callback to immediately update drain conditions with specific error messages, making the drain process more robust. Review comments suggest further enhancing the drain process by adding retry logic to the node cordon operation, similar to the previous exponential backoff approach, to improve resilience against transient failures during cordoning.

[gemini-code-assist]

The drain.RunCordonOrUncordon call for cordoning the node does not include retry logic. While drain.RunNodeDrain has its own retry mechanism, a transient error during the initial cordon operation could prematurely fail the entire drain process. Adding a retry mechanism (similar to the previous wait.ExponentialBackoffWithContext approach) around the cordon operation would make the drain process more robust against transient API server issues or other temporary failures during cordoning.

    // Cordon the node first
    if err = wait.ExponentialBackoffWithContext(ctx, wait.Backoff{
        Steps:    3,
        Duration: 2 * time.Second,
        Factor:   2,
    }, func(ctx context.Context) (bool, error) {
        if err := drain.RunCordonOrUncordon(drainHelper, node, true); err != nil {
            reqLogger.Info("drainNode(): Cordon failed, retrying", "error", err)
            if onError != nil {
                onError(err)
            }
            return false, nil
        }
        return true, nil
    }); err != nil {
        reqLogger.Error(err, "drainNode(): Cordon failed after retries")
        return false, err
    }

[SchSeba]

not implementing this one better to just return error and requeue

[SchSeba]

/gemini review

[gemini-code-assist]

Code Review

This is a substantial and valuable pull request that introduces standard Kubernetes conditions across the SR-IOV Network Operator's CRDs. This change significantly enhances observability and aligns the operator with Kubernetes best practices. The implementation is well-structured, introducing a dedicated status patcher, new status controllers for aggregated status, and comprehensive test coverage. My feedback focuses on improving the efficiency of status updates, ensuring consistency in how condition changes are detected, and increasing the robustness of the drain error handling.

[SchSeba]

To make the review process easier I split this one into separate PRs.
please review them in the following order

Networks-crd (sriovNetwork,sriovIBNetwork,ovsNetwork)
#1010
operatorconfig
#1011
nodeState
#1012
nodePolicy + nodePool (based on nodeState one)
#1013

closing this one