Fix dynamic client watch of named resource #2076

bobh66 · 2023-06-16T15:59:22Z

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

Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>

k8s-ci-robot · 2023-06-16T15:59:30Z

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. 😃

roycaihw · 2023-07-20T00:19:15Z

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}"


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?

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.

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

roycaihw · 2023-07-20T00:20:56Z

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

kubealex · 2023-10-12T12:24:50Z

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

bobh66 · 2023-10-12T13:17:42Z

@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

k8s-triage-robot · 2024-01-22T07:24:54Z

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

bobh66 · 2024-01-22T14:02:01Z

/remove-lifecycle stale

k8s-triage-robot · 2024-04-23T21:56:37Z

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

bobh66 · 2024-04-23T21:59:02Z

/remove-lifecycle stale

bobh66 · 2024-04-23T21:59:56Z

@roycaihw did you have any more concerns? Thanks

roycaihw

/lgtm
/approve

roycaihw · 2024-04-23T22:21:25Z

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}"


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

k8s-ci-robot · 2024-04-23T22:21:49Z

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

~~kubernetes/base/OWNERS~~ [roycaihw]

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

Fix dynamic client watch of named resource

cb2aa4e

Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>

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 requested review from fabianvf and roycaihw June 16, 2023 15:59

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 16, 2023

bobh66 mentioned this pull request Jun 29, 2023

Add Dynamic Client support tomplus/kubernetes_asyncio#260

Merged

roycaihw reviewed Jul 20, 2023

View reviewed changes

kubealex mentioned this pull request Oct 12, 2023

Handle filtering by name and minor exceptions sabre1041/sabre1041.eda#2

Merged

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

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-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

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

roycaihw approved these changes Apr 23, 2024

View reviewed changes

k8s-ci-robot assigned roycaihw Apr 23, 2024

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 merged commit 9f9bec2 into kubernetes-client:master Apr 23, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix dynamic client watch of named resource #2076

Fix dynamic client watch of named resource #2076

bobh66 commented Jun 16, 2023 •

edited by roycaihw

Loading

k8s-ci-robot commented Jun 16, 2023

roycaihw Jul 20, 2023

bobh66 Jul 20, 2023

roycaihw Apr 23, 2024

roycaihw commented Jul 20, 2023

kubealex commented Oct 12, 2023

bobh66 commented Oct 12, 2023 •

edited

Loading

k8s-triage-robot commented Jan 22, 2024

bobh66 commented Jan 22, 2024

k8s-triage-robot commented Apr 23, 2024

bobh66 commented Apr 23, 2024

bobh66 commented Apr 23, 2024

roycaihw left a comment

roycaihw Apr 23, 2024

k8s-ci-robot commented Apr 23, 2024

Fix dynamic client watch of named resource #2076

Fix dynamic client watch of named resource #2076

Conversation

bobh66 commented Jun 16, 2023 • edited by roycaihw Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

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

k8s-ci-robot commented Jun 16, 2023

roycaihw Jul 20, 2023

Choose a reason for hiding this comment

bobh66 Jul 20, 2023

Choose a reason for hiding this comment

roycaihw Apr 23, 2024

Choose a reason for hiding this comment

roycaihw commented Jul 20, 2023

kubealex commented Oct 12, 2023

bobh66 commented Oct 12, 2023 • edited Loading

k8s-triage-robot commented Jan 22, 2024

bobh66 commented Jan 22, 2024

k8s-triage-robot commented Apr 23, 2024

bobh66 commented Apr 23, 2024

bobh66 commented Apr 23, 2024

roycaihw left a comment

Choose a reason for hiding this comment

roycaihw Apr 23, 2024

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 23, 2024

bobh66 commented Jun 16, 2023 •

edited by roycaihw

Loading

bobh66 commented Oct 12, 2023 •

edited

Loading