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.

Sign up for GitHub

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

Jump to bottom

Fix dynamic client watch of named resource #2076

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Fix dynamic client watch of named resource #2076

merged 1 commit into from
Apr 23, 2024
+9 −1

Conversation

bobh66
Copy link
Contributor

@bobh66 bobh66 commented Jun 16, 2023 •
edited by roycaihw
Loading

What type of PR is this?

/kind bug

What this PR does / why we need it:

This PR fixes a problem the DynamicClient watch method which has a name parameter to specify a specific resource to watch. This causes KeyError exceptions in watch.unmarshal_event because the API returns the named resource and ignores the watch parameter. The change converts the name parameter to fieldSelector="metadata.name=foo" before calling the watch.stream() method.

Which issue(s) this PR fixes:

Fixes #1484

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Fix dynamic client watch of named resource

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@bobh66
Fix dynamic client watch of named resource
Loading
Loading status checks…
cb2aa4e 
Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 16, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @bobh66!

It looks like this is your first PR to kubernetes-client/python 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/python has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 16, 2023
@bobh66 bobh66 mentioned this pull request Jun 29, 2023
Merged
roycaihw
roycaihw reviewed Jul 20, 2023
View reviewed changes
kubernetes/base/dynamic/client.py
@@ -195,10 +195,13 @@ def watch(self, resource, namespace=None, name=None, label_selector=None, field_
"""
if not watcher: watcher = watch.Watch()

# Use field selector to query for named instance so the watch parameter is handled properly.
if name:
field_selector = f"metadata.name={name}"
Copy link
Member

Choose a reason for hiding this comment

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

If in addition to name, the user also specified field_selector when calling watch(), shall we also persist the user-specified value instead of overwriting it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought about that, but according to this: https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/#chained-selectors multiple field selectors are and-ed together, and since name is unique including additional field selectors didn't seem to make any sense.

Copy link
Member

Choose a reason for hiding this comment

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

Sorry for the super late response. That makes sense. Thanks!

@roycaihw
Copy link
Member

Thanks for sending the fix! I have one question. Otherwise LGTM

@kubealex
Copy link

Any news on this? I tested the proposed solution and works like a charm!

@bobh66
Copy link
Contributor Author

bobh66 commented Oct 12, 2023 •
edited
Loading

@kubealex - if it helps this fix is in the kubernetes_asyncio package DynamicClient watch implementation. I found the issue when I was porting DynamicClient to kubernetes_asyncio, and this PR is the backport of that fix:

https://github.com/tomplus/kubernetes_asyncio/blob/master/kubernetes_asyncio/dynamic/client.py#L214

@kubealex kubealex mentioned this pull request Oct 12, 2023
Merged
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 22, 2024
@bobh66
Copy link
Contributor Author

bobh66 commented Jan 22, 2024

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 22, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 23, 2024
@bobh66
Copy link
Contributor Author

bobh66 commented Apr 23, 2024

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 23, 2024
@bobh66
Copy link
Contributor Author

bobh66 commented Apr 23, 2024

@roycaihw did you have any more concerns? Thanks

roycaihw
roycaihw approved these changes Apr 23, 2024
View reviewed changes
Copy link
Member

@roycaihw roycaihw left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

kubernetes/base/dynamic/client.py
@@ -195,10 +195,13 @@ def watch(self, resource, namespace=None, name=None, label_selector=None, field_
"""
if not watcher: watcher = watch.Watch()

# Use field selector to query for named instance so the watch parameter is handled properly.
if name:
field_selector = f"metadata.name={name}"
Copy link
Member

Choose a reason for hiding this comment

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

Sorry for the super late response. That makes sense. Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 23, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bobh66, roycaihw

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:

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

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Apr 23, 2024
@k8s-ci-robot k8s-ci-robot merged commit 9f9bec2 into kubernetes-client:master Apr 23, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@roycaihw roycaihw

@fabianvf fabianvf

Assignees

@roycaihw roycaihw

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

KeyError: 'object' while trying to get events for named Deployment
5 participants
@bobh66 @k8s-ci-robot @roycaihw @kubealex @k8s-triage-robot