kube-pfw: kubectl port forward wrapper

kube-pfw (Kubernetes Port Forward Wrapper) is a command-line interface (CLI) tool designed to simplify the process of port forwarding for Kubernetes services. It provides an interactive way to select services and ports, making it easier to use than the standard kubectl port-forward command, especially for services with multiple ports.

Features

Lists all services in a specified namespace
Displays available ports for each service
Allows interactive selection of services and ports
Supports forwarding multiple ports simultaneously
Executes kubectl port-forward command with selected options

Installation

Build the tool:

$ go build

Usage

Run the tool by specifying the namespace:

./kube-pfw <namespace>

For example:

./kube-pfw default

Follow the interactive prompts to:

Select a service
Choose one or more ports (if the service has multiple ports)

The tool will then execute the appropriate kubectl port-forward command, forwarding all selected ports.

Examples

Let's look at the services in our cluster:

$ kubectl get svc
NAME             TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)                    AGE
kubernetes       ClusterIP   10.96.0.1       <none>        443/TCP                    2d
nginx-service1   ClusterIP   10.96.253.72    <none>        80/TCP,8000/TCP,8001/TCP   2m53s
nginx-service2   ClusterIP   10.96.234.132   <none>        8010/TCP                   2m53s

Service with Multiple Ports

Here's an example of using kube-pfw with a service that has multiple ports:

$ ./kube-pfw default
* service:
  1. kubernetes ( port 443 )
  2. nginx-service1 ( port 80 , 8000 , 8001 )
  3. nginx-service2 ( port 8010 )
Enter the number: 2
* nginx-service1:
  1. 80
  2. 8000
  3. 8001
Enter the numbers (comma-separated) or 'all' for all ports: 2,3
Exec Command: kubectl port-forward service/nginx-service1 8000:8000 8001:8001 -n default
Forwarding from 127.0.0.1:8000 -> 8000
Forwarding from [::1]:8000 -> 8000
Forwarding from 127.0.0.1:8001 -> 8001
Forwarding from [::1]:8001 -> 8001
Handling connection for 8000
Handling connection for 8001

In this example, we selected nginx-service1, which has multiple ports. We then chose ports 8000 and 8001, and the tool forwarded both ports simultaneously.

Service with a Single Port

Here's an example of using kube-pfw with a service that has a single port:

$ ./kube-pfw default
* service:
  1. kubernetes ( port 443 )
  2. nginx-service1 ( port 80 , 8000 , 8001 )
  3. nginx-service2 ( port 8010 )
Enter the number: 3
Exec Command: kubectl port-forward service/nginx-service2 8010:8010 -n default
Forwarding from 127.0.0.1:8010 -> 8010
Forwarding from [::1]:8010 -> 8010

In this example, we selected nginx-service2, which has only one port (8010). The tool automatically selected this port and started the port forwarding.

License

This project is licensed under the MIT License - see the LICENSE for details.

zinrai/kube-pfw