kubectl proxy: append context host path to request path #97350

FabianKramm · 2020-12-16T17:24:39Z

Signed-off-by: fabiankramm fab.kramm@googlemail.com

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR adds a new flag --append-server-path to kubectl proxy that changes the way how kube contexts are handled that specify a server with an appended path, e.g. https://my-apiserver.com/path/to/kubernetes. Before this change, kubectl proxy would always expose the api at http://127.0.0.1:8001/path/to/kubernetes/..., with this change and flag enabled it exposes the api at http://127.0.0.1:8001/... and automatically appends the kube context server path.

Which issue(s) this PR fixes:

Fixes #94280

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Added a new flag `--append-server-path` to `kubectl proxy` that will automatically append the kube context server path to each request.

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

none

k8s-ci-robot · 2020-12-16T17:24:47Z

Welcome @FabianKramm!

It looks like this is your first PR to kubernetes/kubernetes 🎉. 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/kubernetes 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 · 2020-12-16T17:24:48Z

Hi @FabianKramm. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

FabianKramm · 2020-12-17T09:01:42Z

/cc @lavalamp

FabianKramm · 2020-12-17T09:10:52Z

@pwittrock @eddiezane

eddiezane · 2020-12-17T18:12:57Z

/ok-to-test

eddiezane · 2020-12-17T18:13:16Z

/triage accepted

eddiezane

Thanks for opening this PR!

I think we should consider this a breaking change and make it opt-in instead of opt-out.

We could deprecate the old behavior?

Thoughts @soltysh?

staging/src/k8s.io/apimachinery/pkg/util/proxy/upgradeaware.go

staging/src/k8s.io/apimachinery/pkg/util/proxy/upgradeaware_test.go

lavalamp · 2020-12-17T18:38:17Z

I won't be able to review right now (also this is SIG CLI) but I think you should make it opt-in rather than opt-out.

FabianKramm · 2020-12-17T18:59:28Z

/retest

dougsland · 2021-08-10T01:34:14Z

Hi,

@soltysh @eddiezane @dougsland any updates on when this PR would be merged?

@varshaprasad96 @FabianKramm I would suggest raise this PR in SIG-CLI meeting to get attention from the group.

Here the data for the meeting:
Regular SIG Meeting: Wednesdays at 09:00 PT (Pacific Time) (biweekly).
https://github.com/kubernetes/community/tree/master/sig-cli

soltysh

I'm fine with this as is, the only addition I'd consider is adding an information that when your config's cluster has a path to print an information suggesting to use this flag. But that's rather a small nit.
/lgtm
/approve

/assign @lavalamp
for apimachinery bits approval

soltysh · 2021-08-19T09:49:55Z

staging/src/k8s.io/kubectl/pkg/proxy/proxy_server.go

@@ -173,8 +173,8 @@ func makeUpgradeTransport(config *rest.Config, keepalive time.Duration) (proxy.U

 // NewServer creates and installs a new Server.
 // 'filter', if non-nil, protects requests to the api only.
-func NewServer(filebase string, apiProxyPrefix string, staticPrefix string, filter *FilterServer, cfg *rest.Config, keepalive time.Duration) (*Server, error) {
-	proxyHandler, err := NewProxyHandler(apiProxyPrefix, filter, cfg, keepalive)
+func NewServer(filebase string, apiProxyPrefix string, staticPrefix string, filter *FilterServer, cfg *rest.Config, keepalive time.Duration, appendLocationPath bool) (*Server, error) {


Yeah, kubectl-wise I'm ok with extending this method signature.

soltysh · 2021-08-19T09:50:23Z

staging/src/k8s.io/kubectl/pkg/proxy/proxy_server.go

@@ -189,7 +189,7 @@ func NewServer(filebase string, apiProxyPrefix string, staticPrefix string, filt
 }

 // NewProxyHandler creates an api proxy handler for the cluster
-func NewProxyHandler(apiProxyPrefix string, filter *FilterServer, cfg *rest.Config, keepalive time.Duration) (http.Handler, error) {
+func NewProxyHandler(apiProxyPrefix string, filter *FilterServer, cfg *rest.Config, keepalive time.Duration, appendLocationPath bool) (http.Handler, error) {


soltysh · 2021-08-19T09:53:15Z

/priority important-longterm

FabianKramm · 2021-08-19T10:36:43Z

@soltysh thanks for the review, I added a warning that shows up if a server path is detected and the flag is not enabled

soltysh

/lgtm

soltysh · 2021-08-19T11:18:23Z

staging/src/k8s.io/kubectl/pkg/cmd/proxy/proxy.go

+			return err
+		}
+		if target.Path != "" && target.Path != "/" {
+			klog.Warning("Your kube context contains a server path " + target.Path + ", use --append-server-path to automatically append the path to each request")


staging/src/k8s.io/apimachinery/pkg/util/proxy/upgradeaware_test.go

lavalamp · 2021-08-19T15:21:13Z

Needs one more test, then I can approve for api machinery.

Signed-off-by: fabiankramm <fab.kramm@googlemail.com>

FabianKramm · 2021-08-19T15:34:42Z

@lavalamp I added the test like you requested

lavalamp · 2021-08-19T16:18:24Z

/approve

for api machinery code.

k8s-ci-robot · 2021-08-19T16:19:00Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: FabianKramm, lavalamp, soltysh

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:

~~staging/src/k8s.io/apimachinery/pkg/OWNERS~~ [lavalamp]
~~staging/src/k8s.io/kubectl/OWNERS~~ [lavalamp,soltysh]
~~test/OWNERS~~ [lavalamp,soltysh]

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

lavalamp · 2021-08-20T14:43:08Z

/lgtm

k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 16, 2020

k8s-ci-robot added area/kubectl sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Dec 16, 2020

k8s-ci-robot requested review from derekwaynecarr and thockin December 16, 2020 17:25

k8s-ci-robot requested a review from lavalamp December 17, 2020 09:01

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 17, 2020

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 17, 2020

eddiezane reviewed Dec 17, 2020

View reviewed changes

FabianKramm force-pushed the master branch from f592338 to 8fb465e Compare December 17, 2020 18:58

soltysh approved these changes Aug 19, 2021

View reviewed changes

k8s-ci-robot assigned lavalamp Aug 19, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2021

k8s-ci-robot added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Aug 19, 2021

FabianKramm force-pushed the master branch from 91e7e47 to 07ea983 Compare August 19, 2021 10:32

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2021

FabianKramm force-pushed the master branch 2 times, most recently from 087ad25 to 9399ea2 Compare August 19, 2021 10:34

soltysh approved these changes Aug 19, 2021

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2021

lavalamp reviewed Aug 19, 2021

View reviewed changes

staging/src/k8s.io/apimachinery/pkg/util/proxy/upgradeaware_test.go Show resolved Hide resolved

kubectl proxy: append context host path to request path

b1a6f8c

Signed-off-by: fabiankramm <fab.kramm@googlemail.com>

FabianKramm force-pushed the master branch from 9399ea2 to b1a6f8c Compare August 19, 2021 15:32

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 19, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 20, 2021

k8s-ci-robot merged commit 341d312 into kubernetes:master Aug 20, 2021

k8s-ci-robot added this to the v1.23 milestone Aug 20, 2021

SvenDowideit mentioned this pull request Sep 30, 2021

use kubectl proxy --append-server-path for e2e proxy [Conformance] test #105363

Closed

nevalla mentioned this pull request Mar 10, 2022

Proxy cannot connect to rancher cluster lensapp/lens#4984

Closed

laxmikantbpandhare mentioned this pull request Apr 11, 2022

removed path check as kubectl is handling path in it operator-framework/operator-sdk#5648

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kubectl proxy: append context host path to request path #97350

kubectl proxy: append context host path to request path #97350

FabianKramm commented Dec 16, 2020 •

edited

k8s-ci-robot commented Dec 16, 2020

k8s-ci-robot commented Dec 16, 2020

FabianKramm commented Dec 17, 2020

FabianKramm commented Dec 17, 2020

eddiezane commented Dec 17, 2020

eddiezane commented Dec 17, 2020

eddiezane left a comment

lavalamp commented Dec 17, 2020

FabianKramm commented Dec 17, 2020

dougsland commented Aug 10, 2021

soltysh left a comment

soltysh Aug 19, 2021

soltysh Aug 19, 2021

soltysh commented Aug 19, 2021

FabianKramm commented Aug 19, 2021

soltysh left a comment

soltysh Aug 19, 2021

lavalamp commented Aug 19, 2021

FabianKramm commented Aug 19, 2021

lavalamp commented Aug 19, 2021

k8s-ci-robot commented Aug 19, 2021

lavalamp commented Aug 20, 2021

kubectl proxy: append context host path to request path #97350

kubectl proxy: append context host path to request path #97350

Conversation

FabianKramm commented Dec 16, 2020 • edited

k8s-ci-robot commented Dec 16, 2020

k8s-ci-robot commented Dec 16, 2020

FabianKramm commented Dec 17, 2020

FabianKramm commented Dec 17, 2020

eddiezane commented Dec 17, 2020

eddiezane commented Dec 17, 2020

eddiezane left a comment

Choose a reason for hiding this comment

lavalamp commented Dec 17, 2020

FabianKramm commented Dec 17, 2020

dougsland commented Aug 10, 2021

soltysh left a comment

Choose a reason for hiding this comment

soltysh Aug 19, 2021

Choose a reason for hiding this comment

soltysh Aug 19, 2021

Choose a reason for hiding this comment

soltysh commented Aug 19, 2021

FabianKramm commented Aug 19, 2021

soltysh left a comment

Choose a reason for hiding this comment

soltysh Aug 19, 2021

Choose a reason for hiding this comment

lavalamp commented Aug 19, 2021

FabianKramm commented Aug 19, 2021

lavalamp commented Aug 19, 2021

k8s-ci-robot commented Aug 19, 2021

lavalamp commented Aug 20, 2021

FabianKramm commented Dec 16, 2020 •

edited