port-forward listen on address #46517

goblain · 2017-05-26T16:20:32Z

What this PR does / why we need it:

Implements #43962 proposal. Adds --address flag to port-forward command that allows listening on addresses other then localhost, so that port-forward can ie. be opened to consumers other then residing in local host like running in docker or different machine/vm

Which issue this PR fixes:

fixes #43962, fixes #36152, fixes #29678

Release note:

allows selecting non-localhost addresses to listen on with port-forward

mengqiy · 2017-07-01T00:43:53Z

@goblain Are you still working on this? If so, please rebase. I can help review this.

mengqiy · 2017-07-01T00:44:07Z

/assign

goblain · 2017-08-01T08:55:17Z

@mengqiy please take a look at this

mengqiy · 2017-08-01T21:04:40Z

/ok-to-test
@goblain Thanks for contributing.
Can you add some test please?

mengqiy · 2017-08-03T17:37:44Z

/retest

mengqiy · 2017-08-04T22:17:21Z

/retest

mengqiy · 2017-08-16T19:41:31Z

@goblain Any update on the failing test?

goblain · 2018-10-08T07:11:03Z

rebased yet again

@dims @mengqiy @liggitt @soltysh chances to get final review and approval / merge before another rebase is required ? :)

soltysh

/lgtm
/approve

dixudx

Actually I was wondering whether we could use 10.19.21.23:8888:5000 to indicate port 8888 open on 10.19.21.23 and forward to 5000 in the pod.

dixudx · 2018-10-09T14:10:58Z

pkg/kubectl/cmd/portforward/portforward.go

@@ -50,6 +50,7 @@ type PortForwardOptions struct {
 	RESTClient    *restclient.RESTClient
 	Config        *restclient.Config
 	PodClient     corev1client.PodsGetter
+	Address       []string


s/Address/Addresses

LocalAddresses?

(but see my suggestion to only serve one local address)

lavalamp · 2018-10-09T17:13:27Z

pkg/kubectl/cmd/portforward/portforward.go

@@ -113,6 +120,7 @@ func NewCmdPortForward(f cmdutil.Factory, streams genericclioptions.IOStreams) *
 		},
 	}
 	cmdutil.AddPodRunningTimeoutFlag(cmd, defaultPodPortForwardWaitTimeout)
+	cmd.Flags().StringSliceVar(&opts.Address, "address", []string{"localhost"}, "Addresses to listen on (comma separated)")


I suggest "local-addresses"?

address was selected as it's the same as for ie. kubectl proxy, so makes sense to stay coherent

lavalamp · 2018-10-09T17:18:53Z

staging/src/k8s.io/client-go/tools/portforward/portforward.go

+	var addresses []listenAddress
+	parsed := make(map[string]listenAddress)
+	for _, address := range addressesToParse {
+		if address == "localhost" {


This looks wrong. I think you need to resolve the name rather than hard coding this stuff.

Likely you should attempt resolving any name that isn't an IP address.

lavalamp · 2018-10-09T18:12:30Z

staging/src/k8s.io/client-go/tools/portforward/portforward.go

 func New(dialer httpstream.Dialer, ports []string, stopChan <-chan struct{}, readyChan chan struct{}, out, errOut io.Writer) (*PortForwarder, error) {
+	return NewOnAddresses(dialer, []string{"localhost"}, ports, stopChan, readyChan, out, errOut)


Perhaps explicitly say 127.0.0.1 & ::1 here, then you can remove the special case in the parse function?

In a followup, I think we should do this after confirm that the address exists, if possible.

lavalamp · 2018-10-09T18:13:15Z

staging/src/k8s.io/client-go/tools/portforward/portforward.go

+	return NewOnAddresses(dialer, []string{"localhost"}, ports, stopChan, readyChan, out, errOut)
+}
+
+// NewOnAddresses creates a new PortForwarder with custom listen addresses.


Document that addresses must all be valid IPv4 or IPv6 addresses, no hostnames?

lavalamp · 2018-10-09T18:20:30Z

/approve

I think other changes can be made in a followup.

k8s-ci-robot · 2018-10-09T18:20:37Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: goblain, 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:

~~pkg/kubectl/OWNERS~~ [lavalamp,soltysh]
~~staging/src/k8s.io/client-go/OWNERS~~ [lavalamp]
~~test/e2e/kubectl/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

vladimirvivien · 2018-10-10T14:45:21Z

Wow. This is awesome.

Dimagog · 2018-10-13T02:03:07Z

This is great!
Where can I find Windows binary with this change?
I need it badly and all my attempts to build kubectl myself fail with:

E:\Go\home\src\k8s.io\kubernetes\pkg\features\kube_features.go:458:23: cannot use "k8s.io/apiextensions-apiserver/pkg/features".CustomResourceValidation (type "k8s.io/apiextensions-apiserver/vendor/k8s.
io/apiserver/pkg/util/feature".Feature) as type "k8s.io/apiserver/pkg/util/feature".Feature in map key
E:\Go\home\src\k8s.io\kubernetes\pkg\features\kube_features.go:459:23: cannot use "k8s.io/apiextensions-apiserver/pkg/features".CustomResourceSubresources (type "k8s.io/apiextensions-apiserver/vendor/k8
s.io/apiserver/pkg/util/feature".Feature) as type "k8s.io/apiserver/pkg/util/feature".Feature in map key

mengqiy · 2018-10-16T02:33:14Z

@Dimagog it should be in this prerelease: https://github.com/kubernetes/kubernetes/releases/tag/v1.13.0-alpha.1

Dimagog · 2018-10-16T19:18:16Z

@mengqiy Yes, latest binary from below has the --address switch, thanks!
https://storage.googleapis.com/kubernetes-release/release/v1.13.0-alpha.1/bin/windows/amd64/kubectl.exe

…elease-1.12 Partial cherry-pick of #46517 to fix flaky e2e skew tests

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 26, 2017

k8s-github-robot assigned j3ffml and davidopp May 26, 2017

k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 15, 2017

k8s-ci-robot assigned mengqiy Jul 1, 2017

goblain force-pushed the cli-port-forward-listen branch from d90d95c to d43f8d5 Compare July 26, 2017 20:32

k8s-github-robot removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. kind/old-docs labels Jul 26, 2017

goblain force-pushed the cli-port-forward-listen branch 2 times, most recently from d90d95c to 93d7a96 Compare August 1, 2017 08:53

k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 1, 2017

goblain force-pushed the cli-port-forward-listen branch 4 times, most recently from 66f0c8c to 187b337 Compare August 3, 2017 06:17

goblain force-pushed the cli-port-forward-listen branch from 187b337 to a27924e Compare August 23, 2017 07:20

k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 24, 2017

goblain force-pushed the cli-port-forward-listen branch from a27924e to d90d95c Compare September 11, 2017 09:59

soltysh approved these changes Oct 9, 2018

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 9, 2018

dixudx reviewed Oct 9, 2018

View reviewed changes

lavalamp reviewed Oct 9, 2018

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 9, 2018

k8s-ci-robot merged commit 830e09c into kubernetes:master Oct 9, 2018

wjoel mentioned this pull request Oct 9, 2018

Halyard: hal deploy connect in docker binds to localhost spinnaker/spinnaker#2409

Closed

seans3 mentioned this pull request Nov 8, 2018

kubectl port-forward flaky e2e tests kubernetes/kubectl#558

Closed

m1kola mentioned this pull request Nov 11, 2018

Fixes error message in e2e tests for kubectl port-forward #70923

Merged

roycaihw mentioned this pull request Nov 14, 2018

Port-forward failureMode can be overridden based on input addresses' order #71017

Closed

ALCarden mentioned this pull request Nov 23, 2018

Support port forwarding binding to interfaces other than loopback devspace-sh/devspace#394

Closed

m1kola mentioned this pull request Nov 23, 2018

Fixes inconsistent behaviour in portforward #70931

Merged

m1kola mentioned this pull request Dec 1, 2018

Partial cherry-pick of #46517 to fix flaky e2e skew tests #71631

Merged

matti mentioned this pull request Dec 3, 2018

Support port-forward address bind with skaffold dev GoogleContainerTools/skaffold#1358

Closed

k8s-ci-robot added a commit that referenced this pull request Dec 27, 2018

Merge pull request #71631 from m1kola/partial-cherry-pick-of-#46517-r…

67ef2b4

…elease-1.12 Partial cherry-pick of #46517 to fix flaky e2e skew tests

thockin mentioned this pull request Jan 3, 2019

kubectl port-forward should allow binding/listening to other interfaces #36152

Closed

simonfontana mentioned this pull request Feb 14, 2019

why "kubectl port-forward" just binds the 127.0.0.1 but not 0.0.0.0? #40053

Closed

maiamcc mentioned this pull request Aug 8, 2019

Change host used with port_forwards tilt-dev/tilt#2013

Closed

sandratatarevicova mentioned this pull request Mar 25, 2020

Error: unknown flag: --address AckeeCZ/goproxie#19

Open

nicksieger mentioned this pull request Dec 1, 2021

binding port-forwards to a non-localhost DNS fails tilt-dev/tilt#5043

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

port-forward listen on address #46517

port-forward listen on address #46517

goblain commented May 26, 2017 •

edited

Loading

mengqiy commented Jul 1, 2017

mengqiy commented Jul 1, 2017

goblain commented Aug 1, 2017

mengqiy commented Aug 1, 2017

mengqiy commented Aug 3, 2017

mengqiy commented Aug 4, 2017

mengqiy commented Aug 16, 2017

goblain commented Oct 8, 2018

soltysh left a comment

dixudx left a comment

dixudx Oct 9, 2018

lavalamp Oct 9, 2018

lavalamp Oct 9, 2018

lavalamp Oct 9, 2018

goblain Oct 9, 2018

lavalamp Oct 9, 2018

lavalamp Oct 9, 2018

lavalamp Oct 9, 2018

lavalamp Oct 9, 2018

lavalamp Oct 9, 2018

lavalamp commented Oct 9, 2018

k8s-ci-robot commented Oct 9, 2018

vladimirvivien commented Oct 10, 2018

Dimagog commented Oct 13, 2018

mengqiy commented Oct 16, 2018

Dimagog commented Oct 16, 2018

		func New(dialer httpstream.Dialer, ports []string, stopChan <-chan struct{}, readyChan chan struct{}, out, errOut io.Writer) (*PortForwarder, error) {
		return NewOnAddresses(dialer, []string{"localhost"}, ports, stopChan, readyChan, out, errOut)

port-forward listen on address #46517

port-forward listen on address #46517

Conversation

goblain commented May 26, 2017 • edited Loading

mengqiy commented Jul 1, 2017

mengqiy commented Jul 1, 2017

goblain commented Aug 1, 2017

mengqiy commented Aug 1, 2017

mengqiy commented Aug 3, 2017

mengqiy commented Aug 4, 2017

mengqiy commented Aug 16, 2017

goblain commented Oct 8, 2018

soltysh left a comment

Choose a reason for hiding this comment

dixudx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lavalamp commented Oct 9, 2018

k8s-ci-robot commented Oct 9, 2018

vladimirvivien commented Oct 10, 2018

Dimagog commented Oct 13, 2018

mengqiy commented Oct 16, 2018

Dimagog commented Oct 16, 2018

goblain commented May 26, 2017 •

edited

Loading