Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OCPBUGS-41892: Single Watch on GWAPI CRD #1165

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Thealisyed
Copy link

A single CRD watch was added with a predicate to filter CRDs based on the gatewayapiv1.GroupName. This ensures that only relevant CRDs are watched, reducing unnecessary logging when the Gateway API feature is not enabled.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 4, 2024
@openshift-ci-robot openshift-ci-robot added jira/severity-moderate Referenced Jira bug's severity is moderate for the branch this PR is targeting. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Nov 4, 2024
@openshift-ci-robot
Copy link
Contributor

@Thealisyed: This pull request references Jira Issue OCPBUGS-41892, which is invalid:

  • expected the bug to target the "4.18.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

A single CRD watch was added with a predicate to filter CRDs based on the gatewayapiv1.GroupName. This ensures that only relevant CRDs are watched, reducing unnecessary logging when the Gateway API feature is not enabled.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot requested review from Miciah and miheer November 4, 2024 13:48
@Thealisyed
Copy link
Author

/jira refresh

@openshift-ci-robot openshift-ci-robot added jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. and removed jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Nov 4, 2024
@openshift-ci-robot
Copy link
Contributor

@Thealisyed: This pull request references Jira Issue OCPBUGS-41892, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target version (4.18.0) matches configured target version for branch (4.18.0)
  • bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @lihongan

In response to this:

/jira refresh

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot requested a review from lihongan November 4, 2024 13:48
@Thealisyed
Copy link
Author

/test e2e-aws-ovn-single-node

@Thealisyed
Copy link
Author

/retest-required

@Thealisyed Thealisyed changed the title [WIP] OCPBUGS-41892: Single Watch on GWAPI CRD OCPBUGS-41892: Single Watch on GWAPI CRD Nov 6, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 6, 2024
Copy link
Contributor

@Miciah Miciah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Whoops, I've had this review pending, waiting for me to submit it, for 5 days...)

Is it true that the existing watch only generates reconciliation requests when the Gateway API feature is not enabled?

In any case, please add a little more detail in the commit message. For example:

gatewayapi: Use single watch for CRDs

Replace the multiple watches for Gateway API CRDs with a single CRD watch, with a predicate to filter CRDs based on the gatewayapiv1.GroupName.  This ensures that only relevant CRDs are watched, reducing unnecessary reconciliation requests and log messages.

This commit fixes OCPBUGS-41892.

https://issues.redhat.com/browse/OCPBUGS-41892

pkg/operator/controller/gatewayapi/controller.go Outdated Show resolved Hide resolved
pkg/operator/controller/gatewayapi/controller.go Outdated Show resolved Hide resolved
@Miciah Miciah added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Nov 13, 2024
@candita
Copy link
Contributor

candita commented Nov 13, 2024

/assign
/assign @Miciah

@candita
Copy link
Contributor

candita commented Nov 13, 2024

@Thealisyed please investigate the failures in the CI tests, especially e2e-aws-gatewayapi, which is the GWAPI test. I ran a retest to see if the issue with imagestreams had gone away.

@candita
Copy link
Contributor

candita commented Nov 13, 2024

/retest

return crd.Spec.Group == gatewayapiv1.GroupName
})

if err = c.Watch(source.Kind[client.Object](operatorCache, &apiextensionsv1.CustomResourceDefinition{}, handler.EnqueueRequestsFromMapFunc(toFeatureGate), crdPredicate)); err != nil {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why we need to use handler.EnqueueRequestsFromMapFunc(toFeatureGate) here. Can you add a comment as to why it is used instead of handler.EnqueueRequestForObject{}? I suspect it may have been a mistake that we should remove.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is that handler.EnqueueRequestsFromMapFunc(toFeatureGate) ensures that any changes to the watched CRDs trigger a reconcile request specifically for the feature gate, maintaining its correct state and configuration. This targeted reconciliation is crucial for feature gate-specific logic.

On the other hand, handler.EnqueueRequestForObject{} would enqueue the object itself for reconciliation but may not ensure the correct handling of feature gate-specific logic.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clarify:

trigger a reconcile request specifically for the feature gate, maintaining its correct state and configuration.

We don't reconcile feature gate changes and the only change that can happen is for a feature to move from disabled to enabled. We do reconcile Gateway API crds: https://github.com/openshift/cluster-ingress-operator/blob/master/pkg/operator/controller/gatewayapi/controller.go#L106

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the clarification.
I understand now that we don't reconcile feature gate changes and the only change that can happen is for a feature to move from disabled to enabled.
Given this, I will update it to use handler.EnqueueRequestForObject{} accordingly then!

…atch with a predicate to filter CRDs based on the gatewayapiv1.GroupName.
Copy link
Contributor

openshift-ci bot commented Nov 15, 2024

[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 candita. 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:

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

Copy link
Contributor

openshift-ci bot commented Nov 15, 2024

@Thealisyed: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-azure-ovn b3604b2 link false /test e2e-azure-ovn
ci/prow/e2e-azure-operator b3604b2 link true /test e2e-azure-operator
ci/prow/e2e-gcp-ovn b3604b2 link false /test e2e-gcp-ovn
ci/prow/e2e-aws-ovn-serial b3604b2 link true /test e2e-aws-ovn-serial
ci/prow/okd-scos-e2e-aws-ovn b3604b2 link false /test okd-scos-e2e-aws-ovn

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/severity-moderate Referenced Jira bug's severity is moderate for the branch this PR is targeting. jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants