KPF (Kube Port Forward)

What is KPF?

KPF is a tool to assist in port redirects made through port-forward kubectl, keeping the current state and giving it a more refined control, being able to even save a state of several active redirects and restore them later, among other functions.

Getting started

Required dependencies

• kubectl
• jq
• gawk (Linux distribution package)
• fzf (optional)

Install KPF

curl -L https://github.com/supermock/kpf/releases/download/v1.4.5/kpf -o /usr/local/bin/kpf
chmod +x /usr/local/bin/kpf

Note: If you have installed the completions of kubectl and you are not able to access the kpf command, add to your bashrc or zshrc unalias kpf

Some examples

Adding a port forward from:

• Interactive (need fzf dependency)

  kpf

• Command

  # In this example I am adding a port forward to the Kubernetes Dashboard
  kpf add kube-system k8s-app=kubernetes-dashboard 8443

  Use help flag for more documentation

  kpf -h add
  [KPF] Supported types:
  [KPF]   - svc or service
  [KPF]   - rs or replicaset
  [KPF]   - deploy or deployment
  [KPF] Samples:
  [KPF]   - kpf add [namespace] [pod-selector]    [port]
  [KPF]   - kpf add [namespace] [service-name]    [port] svc
  [KPF]   - kpf add [namespace] [replicaset-name] [port] rs
  [KPF]   - kpf add [namespace] [deployment-name] [port] deploy
  [KPF] kpf add [namespace] [selector] [port or local_port:cluster_port] [type?]
  

Listing port forwards

kpf list

Removing a port forward

kpf del kube-system k8s-app=kubernetes-dashboard

Saving a current port forward state

kpf state save my-forwards

Restoring port forward from state

kpf state restore my-forwards

Update kpf to another version (Supported after 1.2.2)

kpf update 1.4.5

For more information, see the help...

License

MIT