https://github.com/flowerinthenight/kubepfm
A simple wrapper to kubectl port-forward for multiple pods/deployments/services.
https://github.com/flowerinthenight/kubepfm
kubectl kubernetes multiple-pods port-forward
Last synced: 4 months ago
JSON representation
A simple wrapper to kubectl port-forward for multiple pods/deployments/services.
- Host: GitHub
- URL: https://github.com/flowerinthenight/kubepfm
- Owner: flowerinthenight
- License: mit
- Created: 2018-06-29T01:56:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T13:53:53.000Z (over 1 year ago)
- Last Synced: 2024-06-20T06:36:23.271Z (over 1 year ago)
- Topics: kubectl, kubernetes, multiple-pods, port-forward
- Language: Go
- Homepage:
- Size: 1.54 MB
- Stars: 35
- Watchers: 4
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/flowerinthenight/kubepfm/actions/workflows/main.yml)
(This repo is mirrored to [https://codeberg.org/flowerinthenight/kubepfm](https://codeberg.org/flowerinthenight/kubepfm)).
## Overview
`kubepfm` is a simple wrapper to the [`kubectl port-forward`](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) 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](https://brew.sh/):
```bash
$ brew install flowerinthenight/tap/kubepfm
```
If you have a Go environment:
```bash
$ go get -u -v github.com/flowerinthenight/kubepfm
```
## Usage
```bash
$ 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`](https://golang.org/pkg/regexp/#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.*`.
```bash
# 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.
```bash
$ 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.
```bash
# 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:
```bash
$ 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:
```bash
$ kubepfm --target mypod:8080:1222 --target otherpod:8081:1222
```
Both pods are now accessible from localhost:
```bash
localhost:8080 --> mypod
localhost:8081 --> otherpod
```