portforward

package
v0.0.0-...-11dbe7b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 7, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type PortForward

type PortForward struct {
	// The parsed Kubernetes configuration file.
	Config *rest.Config

	// The initialized Kubernetes client.
	Clientset kubernetes.Interface

	// the pod name to use, required if Labels is empty.
	Name string

	// pod prefix, search first pod matching that name
	Pod string

	// The labels to use to find the pod.
	Labels metav1.LabelSelector

	// The port on the pod to forward traffic to.
	DestinationPort int

	// The port that the port forward should listen to, random if not set.
	ListenPort int

	// The namespace to look for the pod in.
	Namespace string
	// contains filtered or unexported fields
}

Used for creating a port forward into a Kubernetes pod in a Kubernetes cluster.

func NewPortForwarder

func NewPortForwarder(namespace string, pod string, dstPort int, listenPort int) (*PortForward, error)

Initialize a port forwarder, loads the Kubernetes configuration file and creates the client. You do not need to use this function if you have a client to use already - the PortForward struct can be created directly.

func NewPortForwarderOrig

func NewPortForwarderOrig(namespace string, labels metav1.LabelSelector, port int) (*PortForward, error)

func (*PortForward) Start

func (p *PortForward) Start(ctx context.Context) error

Start a port forward to a pod - blocks until the tunnel is ready for use.

func (*PortForward) Stop

func (p *PortForward) Stop()

Stop a port forward.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL