/kind feature
This a feature addition to start supporting the 'proxy-url' field in the kubernetes config files.
This will support most proxies. An upcoming version of OpenAPI generator will support Socks proxies as well.

Additionally this PR has changes that the support 7.x OpenAPI generator.

Fixes:#1967

Special notes for your reviewer:

Note this Socks5 support is dependent on a recently merged update I made to OpenAPI generator to support Socks5 proxies:OpenAPITools/openapi-generator#16918 that will be in the upcoming 7.2 release.

For now the python.sh in the gen project (that auto-generates the full client) should be updated to use 7.1.0. Example:
OPENAPI_GENERATOR_COMMIT="${OPENAPI_GENERATOR_COMMIT:-v7.1.0}"

A sample generated project is visible here
https://github.com/rolf-moz/kubernetes-client-python/tree/feat/add-proxy-support-gen

Does this PR introduce a user-facing change?

Yes

Added support for the 'proxy-url' cluster setting in kube config files, including support for proxies .

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

Proxy support.

read proxy config for cluster and add to openapi config

71bb5fa

k8s-ci-robot added the release-noteDenotes a PR that will be considered when it comes time to generate release notes. label

Nov 15, 2023

Copy link

linux-foundation-easyclabot commentedNov 15, 2023•
edited
Loading

The committers listed above are authorized under a signed CLA.

✅ login: rolf-moz / name: Rolf Rando (71bb5fa,c184309,64336af)

k8s-ci-robot added cncf-cla: no

Indicates the PR's author has not signed the CNCF CLA.

needs-kindIndicates a PR lacks a `kind/foo` label and requires one. labels

Nov 15, 2023

Copy link

Contributor

k8s-ci-robot commentedNov 15, 2023

Welcome@rolf-moz!

It looks like this is your first PR tokubernetes-client/python 🎉. Please refer to ourpull 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 hasits own contribution guidelines.

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

If you are having difficulty getting your pull request seen, please follow therecommended escalation practices. Also, for tips and tricks in the contribution process you may want to read theKubernetes 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 added the size/XSDenotes a PR that changes 0-9 lines, ignoring generated files. label

Nov 15, 2023

k8s-ci-robot requested review fromfabianvf androycaihw

November 15, 2023 02:43

rolf-moz changed the title~~read proxy config for cluster and add to openapi config~~Add proxy support, including Socks5 proxy, to connect to clusters

Nov 16, 2023

k8s-ci-robot added cncf-cla: yesIndicates the PR's author has signed the CNCF CLA. and removed cncf-cla: noIndicates the PR's author has not signed the CNCF CLA. labels

Nov 17, 2023

Minor auth changes to support OpenAPI generator 7.x and above

c184309

k8s-ci-robot added size/SDenotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XSDenotes a PR that changes 0-9 lines, ignoring generated files. labels

Nov 25, 2023

Copy link

Contributor

k8s-ci-robot commentedNov 25, 2023

[APPROVALNOTIFIER] This PR isNOT APPROVED

This pull-request has been approved by:rolf-moz
Once this PR has been reviewed and has the lgtm label, please assignroycaihw for approval. For more information seethe Kubernetes Code Review Process.

The full list of commands accepted by this bot can be foundhere.

Needs approval from an approver in each of these files:

OWNERS

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

rolf-moz changed the title~~Add proxy support, including Socks5 proxy, to connect to clusters~~Add proxy support to connect to clusters, upgrade gen to OpenAPI 7.1.0 client

Nov 25, 2023

Copy link

Member

roycaihw commentedNov 28, 2023

For now the python.sh in the gen project (that auto-generates the full client) should be updated to use 7.1.0. Example:
OPENAPI_GENERATOR_COMMIT="${OPENAPI_GENERATOR_COMMIT:-v7.1.0}"

The version is the gen project is actually not honored. This client overrides the valuehere.

roycaihw reviewed

Nov 28, 2023

View reviewed changes

Copy link

Member

roycaihw left a comment

Choose a reason for hiding this comment

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

The change looks good to me. Should we wait for this project to be upgrade to OpenAPI 7.1.0+ first?

Copy link

Author

rolf-moz commentedNov 28, 2023•
edited
Loading

The change looks good to me. Should we wait for this project to be upgrade to OpenAPI 7.1.0+ first?

@roycaihw
Actually several changes I made are fixes for the OpenAPI 7.1 gen compatibility. One thing I could do is a separate PR for the OpenAPI 7.1.0 support first, and then redo this pr once that gets approved.

removed patch

64336af

k8s-ci-robot added size/MDenotes a PR that changes 30-99 lines, ignoring generated files. and removed size/SDenotes a PR that changes 10-29 lines, ignoring generated files. labels

Dec 2, 2023

rolf-moz requested a review fromroycaihw

December 2, 2023 00:18

k8s-ci-robot added the needs-rebaseIndicates a PR cannot be merged because it has merge conflicts with HEAD. label

Jan 9, 2024

Copy link

Contributor

k8s-ci-robot commentedJan 9, 2024

PR needs rebase.

Instructions for interacting with me using PR comments are availablehere. If you have questions or suggestions related to my behavior, please file an issue against thekubernetes/test-infra repository.

Copy link

k8s-triage-robot commentedApr 8, 2024

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 sincelifecycle/stale was applied,lifecycle/rotten is applied
After 30d of inactivity sincelifecycle/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 withIssue Triage

Please send feedback to sig-contributor-experience atkubernetes/community.

/lifecycle stale

k8s-ci-robot added the lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale. label

Apr 8, 2024

Copy link

UnsolvedCypher commentedApr 26, 2024

@roycaihw I just wanted to follow up as I think this PR is important. Is it good to merge as-is or would you like to split it up between the adding of OpenAPI 7.1.0 support and the actual upgrade?

Copy link

k8s-triage-robot commentedMay 26, 2024

The Kubernetes project currently lacks enough active 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 sincelifecycle/stale was applied,lifecycle/rotten is applied
After 30d of inactivity sincelifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with/remove-lifecycle rotten
Close this PR with/close
Offer to help out withIssue Triage

Please send feedback to sig-contributor-experience atkubernetes/community.

/lifecycle rotten

k8s-ci-robot added lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale. labels

May 26, 2024

Copy link

UnsolvedCypher commentedMay 26, 2024

/remove-lifecycle rotten

k8s-ci-robot removed the lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed. label

May 26, 2024

Copy link

PhroZenOne commentedJun 25, 2024

I'm are using ansible k8s to connect to a cluster but we need to be able to connect over socks5, If I understand the stacktrace and the discussion in this PR, this contains the stuff I am looking for. :)

urllib3.exceptions.ProxySchemeUnknown: Proxy URL had unsupported scheme socks5, should use http:// or https://

Anything I can do to help here?@roycaihw @rolf-moz

Copy link

Author

rolf-moz commentedJun 27, 2024

@PhroZenOne yes if you want to rebase you can. I might have time later this week too.

I'm not up to date... is kubernetes client using 7.x openapi generator yet?

If you'd like to try a built library with this support you can usehttps://github.com/rolf-moz/kubernetes-client-python/tree/feat/add-proxy-support-gen and let me know how it works for you.

PhroZenOne mentioned this pull request

Jul 22, 2024

Rebase and fixes for https://github.com/kubernetes-client/python/pull/2147#2255

Closed

Copy link

PhroZenOne commentedJul 22, 2024

@rolf-moz Did a rebase, PR here:#2255 Please have a look.

If you want to update your PR with this I can close mine so we keep this in one place.

Copy link

PhroZenOne commentedJul 22, 2024

Hm, there are API changes with the newer kubernetes API that breaks when testing so my branch will not work:

     File .../kubernetes/dynamic/client.py", line 273, in request    api_response = self.client.call_api(TypeError: ApiClient.call_api() got multiple values for argument 'body'

I dont have more time to spend on this right now I'm afraid so for now I will give up. I might have more time next month to look at it.

Copy link

PhroZenOne commentedJul 22, 2024

Made some changes to client.py to make it work again for my use case, but I have no idea if this is a good solution:PhroZenOne@97c36c3

Copy link

Author

rolf-moz commentedJul 22, 2024

@PhroZenOne @roycaihw Ok looks like this branch is getting some use. Let me see if I can update this PR later today to be up to date with main

Copy link

kwibus commentedOct 16, 2024

Would be really nice if this pull request would be merged would also help with:
#2183

Made pull request forproxy_url before, but it got ignored. But it also include some tests. You could use that if you want.
https://github.com/kubernetes-client/python/pull/2182/files

Copy link

k8s-triage-robot commentedJan 14, 2025

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 sincelifecycle/stale was applied,lifecycle/rotten is applied
After 30d of inactivity sincelifecycle/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 withIssue Triage

Please send feedback to sig-contributor-experience atkubernetes/community.

/lifecycle stale

k8s-ci-robot added the lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale. label

Jan 14, 2025

Copy link

k8s-triage-robot commentedFeb 13, 2025

The Kubernetes project currently lacks enough active 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 sincelifecycle/stale was applied,lifecycle/rotten is applied
After 30d of inactivity sincelifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with/remove-lifecycle rotten
Close this PR with/close
Offer to help out withIssue Triage

Please send feedback to sig-contributor-experience atkubernetes/community.

/lifecycle rotten

Feb 13, 2025

Copy link

UnsolvedCypher commentedFeb 13, 2025

/remove-lifecycle rotten

k8s-ci-robot removed the lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed. label

Feb 13, 2025

roycaihw reviewed

May 13, 2025

View reviewed changes

scripts/update-client.sh

		@@ -22,7 +22,7 @@ set -o nounset
		set -o pipefail

		# The openapi-generator version used by this client
		export OPENAPI_GENERATOR_COMMIT="v4.3.0"
		export OPENAPI_GENERATOR_COMMIT="v7.1.0"

Copy link

Member

roycaihwMay 13, 2025

Choose a reason for hiding this comment

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

I think we need to first regenerate this client and review the diff. In particular we want to make sure the breaking changes are captured, and tests continue to pass.