si618 / kubempf

Tool to forward and maintain multiple port forwards to kubernetes pods

kubempf

Tool to forward and maintain multiple port forwards to kubernetes pods

Usage

Multi-service port proxying tool for Kubernetes

Usage: kubempf [OPTIONS] <[[LOCAL_ADDRESS:]LOCAL_PORT:][NAMESPACE/]SERVICE:PORT>...

Arguments:
  <[[LOCAL_ADDRESS:]LOCAL_PORT:][NAMESPACE/]SERVICE:PORT>...
          Establish a new port forward - multiple entries can be speficied.

          SERVICE:PORT - Binds to localhost (127.0.0.1 and ::1) on PORT and forwards connections to PORT on SERVICE in the default namespace
          NAMESPACE/SERVICE:PORT - Binds to localhost (127.0.0.1 and ::1) on PORT and forwards connections to PORT on SERVICE in NAMESPACE
          LOCAL_PORT:SERVICE:PORT - Binds to localhost (127.0.0.1 and ::1) on LOCAL_PORT and forwards connections to PORT on SERVICE in the default namespace
          LOCAL_ADDRESS:LOCAL_PORT:SERVICE:PORT - Binds to LOCAL_ADDRESS on LOCAL_PORT and forwards connections to PORT on SERVICE in the default namespace

Options:
  -c, --context <CONTEXT>
          Kubernetes Context

  -n, --namespace <NAMESPACE>
          Default Kubernetes Namespace to match services in

      --compact
          Enable compact console output

      --ignore-readiness
          Don't check the readiness of the pod when selecting which pod to forward to

      --close-on-unready
          Close the connection when the pod goes unready

      --randomise
          Chose the pod to connect to randomly instead of the first in the list

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Forwards

Each forward is passed as plain (positional) argument in the following format

[[LOCAL_ADDRESS:]LOCAL_PORT:]SERVICE_NAME:SERVICE_OR_POD_PORT

eg. kubempf 192.0.2.31:8080:nginx:80 will bind locally to TCP 192.0.2.31:8080 and forward all traffic to port 80 on one of the pods matching the label selector for the nginx service.

If local address is left off (eg. kubempf 8080:nginx:80) the local address will be set to 127.0.0.1 If local port is also left off (eg. kubempf postgresql:5432) the local port will be set to the remote port. It is not currently possible to use this shorthand with named ports.

To forward to a service in a different namespace to the one specified by the namespace argument (or if that is not set, in the context) you can specify the specify the namespace by prefixing it to the service name and separating with a /. eg. kubempf rabbitmq/rabbitmq:15672 rabbitmq/rabbitmq:5672 would forward the local ports 5672 and 15672 to the rabbitmq service in the rabbitmq namespace.

It is also possible to forward to named ports, such that kubempf 8080:nginx:http will try and find a port named http first on the nginx service, and if that fails it will then try and find a port named http on the pod matched by the services label selector.

Arguments

Short	Long	Description
-c	--context	Name of the context from the kube config to use
-n	--namespace	Default Kubernetes namespace to find the services in
	--compact	Enable compact console output
	--ignore-readiness	Ignores Ready state when selecting the pod to forward to
	--close-on-unready	Close open connections when the pod switches to unready
	--randomise	Randomly select which pod should be forwarded to