Skip to content

feat: Make resource lookup case-insensitive to match Kubernetes API behavior #2407

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Kevinz857
Copy link
Contributor

Make Resource Lookup Case-Insensitive to Match Kubernetes API Behavior

What type of PR is this?

/kind feature
/kind bug

What this PR does / why we need it

This PR implements case-insensitive resource lookup in the dynamic client to match the actual behavior of the Kubernetes API. Currently, when using the dynamic client to look up resources, the search is case-sensitive, which causes issues when users attempt to look up resources with different casing than what's defined in the API server.

The Kubernetes API itself is case-insensitive when it comes to resource kinds. For example, both kubectl get pod and kubectl get Pod work correctly. This PR makes the Python client's behavior consistent with the API server's behavior.

Key changes

  • Added a _find_resource_case_insensitive method to the Discoverer class
  • Modified the search methods in both LazyDiscoverer and EagerDiscoverer classes to:
    • First try exact case matching (original behavior)
    • If no match is found and a kind is specified, attempt case-insensitive lookup
    • On failure, refresh the cache and retry both strategies
  • Added test cases to verify case-insensitive lookup functionality

Special notes for your reviewer

This change is backward compatible with existing code as it maintains the same behavior for exact case matches. It only adds the additional capability to find resources when the case doesn't exactly match.

Does this PR introduce a user-facing change?

Make resource lookup case-insensitive in the dynamic client to match Kubernetes API behavior

Which issue(s) this PR fixes:

Fixes #2402

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. kind/bug Categorizes issue or PR as related to a bug. labels May 31, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Kevinz857
Once this PR has been reviewed and has the lgtm label, please assign roycaihw for approval. For more information see the 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

@k8s-ci-robot k8s-ci-robot requested review from fabianvf and roycaihw May 31, 2025 10:50
@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels May 31, 2025
@roycaihw
Copy link
Member

roycaihw commented Jun 4, 2025

/assign @fabianvf

@roycaihw
Copy link
Member

The Kubernetes API itself is case-insensitive when it comes to resource kinds. For example, both kubectl get pod and kubectl get Pod work correctly. This PR makes the Python client's behavior consistent with the API server's behavior.

I think the case-insensitive behavior comes from kubectl. Kubernetes API server is case sensitive. One can verify that by running kubectl with --v=9 to check the actual API request.

IIRC other clients like client-go are also case-sensitive.

/priority awaiting-more-evidence

@k8s-ci-robot k8s-ci-robot added the priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. label Jun 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. kind/feature Categorizes issue or PR as related to a new feature. priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[discovery] Resource lookup is case-sensitive while it shouldn't
4 participants