(This repo is mirrored to https://codeberg.org/flowerinthenight/kubepfm).

Overview

kubepfm is a simple wrapper to the kubectl port-forward command for multiple pods/deployments/services. It can start multiple kubectl port-forward processes based on the number of input targets. Terminating the tool (Ctrl-C) will also terminate all running kubectl sub-processes.

Installation

Using Homebrew:

$ brew install flowerinthenight/tap/kubepfm

If you have a Go environment:

$ go get -u -v github.com/flowerinthenight/kubepfm

Usage

$ kubepfm \
  --target [ctx=context:[ns=]namespace:]name|pattern:[localaddress:]localport:remoteport \
  [--target ...]

If the [ctx=context] part is not specified, the current context is used. If the [ns=namespace:] part is not specified, the default namespace is used.

This tool uses regexp.FindAllString to resolve the input pattern. Since this tool uses the : character as its input separator, at the moment, it cannot process input patterns that contain :, such as [[:alpha:]]). Also, the .* string is appended to the input name/pattern before it is resolved. For example, if the input name pattern is my.+d, it is resolved as my.+d.*.

# Simple pattern, namespace not needed.
$ kubepfm --target mypod:8080:1222

# With namespace input (`ns=` is optional).
$ kubepfm --target default:mypod:8080:1222
$ kubepfm --target ns=default:mypod:8080:1222

# With context. Useful if you need to port-forward to different clusters in one go.
# See 'kubectl config' for more information.
$ kubepfm --target "ctx=devcluster:ns=default:mypod:8080:1222" \
          --target "ctx=prodcluster:ns=default:somepod:8081:1222"

# With address specified:
$ kubepfm --target "ctx=prodcluster:ns=default:somepod:127.0.0.2:8081:1222"

You can also pipe input from STDIN as well.

$ cat input.txt
mypod:8080:1222
otherpod:8081:1222
$ cat input.txt | kubepfm

# Or you can do it this way:
$ kubepfm
mypod:8080:1222
otherpod:8081:1222
Ctrl+D

By default, this tool will port-forward to pods. If you want to forward to deployments or services, you can prefix the name/pattern with the resource type.

# Using deployment
$ kubepfm --target deployment/dep1:8080:8080

# Using services
$ kubepfm --target service/svc1:8080:8080 --target service/svc2:8081:80

Examples

View our running pods:

$ kubectl get pod
NAME                                 READY     STATUS      RESTARTS   AGE
mypod-7c497c9d94-8xls2               1/1       Running     0          7d
otherpod-5987f84db4-9mhxf            1/1       Running     0          4d
hispod-7d8c4cbd9-dqjc6               1/1       Running     0          21d
herpod-7d48964997-d6pgs              1/1       Running     0          3d
...

Do a port-forward to two pods using port 1222 to our local 8080 and 8081 ports:

$ kubepfm --target mypod:8080:1222 --target otherpod:8081:1222

Both pods are now accessible from localhost:

localhost:8080 --> mypod
localhost:8081 --> otherpod