From 74d55cc94bf58c11c7b4985e04da5b7d14a11f93 Mon Sep 17 00:00:00 2001 From: Christopher Montoro Date: Wed, 7 Oct 2020 21:37:03 -0400 Subject: [PATCH] Update the example for kubectl port-forward Clarify that `REMOTE_PORT` is interpreted as identifying a _Service_ port when provided `TYPE` is `service`. Also, highlight support for specifying a named port as `REMOTE_PORT`. Kubernetes-commit: 68e8fd5f33647f22a1bd9ff8508003a969036e25 --- .../container_debugging/port_forward_to_pods.md | 14 ++++++++++++++ pkg/cmd/portforward/portforward.go | 4 ++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/book/pages/container_debugging/port_forward_to_pods.md b/docs/book/pages/container_debugging/port_forward_to_pods.md index d983cf74f..21162f6b8 100644 --- a/docs/book/pages/container_debugging/port_forward_to_pods.md +++ b/docs/book/pages/container_debugging/port_forward_to_pods.md @@ -41,6 +41,20 @@ kubectl port-forward deployment/mydeployment 5000 6000 --- +{% method %} +## Pod in a Service + +Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service +{% sample lang="yaml" %} + +```bash +kubectl port-forward service/myservice 8443:https +``` + +{% endmethod %} + +--- + {% method %} ## Different Local and Remote Ports diff --git a/pkg/cmd/portforward/portforward.go b/pkg/cmd/portforward/portforward.go index 5755055ed..3573a921e 100644 --- a/pkg/cmd/portforward/portforward.go +++ b/pkg/cmd/portforward/portforward.go @@ -76,8 +76,8 @@ var ( # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment kubectl port-forward deployment/mydeployment 5000 6000 - # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the service - kubectl port-forward service/myservice 5000 6000 + # Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service + kubectl port-forward service/myservice 8443:https # Listen on port 8888 locally, forwarding to 5000 in the pod kubectl port-forward pod/mypod 8888:5000