k8s

Documentation

Index

• type PortForwarder
  • func NewPortForwarder(restConfig *rest.Config, opts PortForwardingOpts) (*PortForwarder, error)
  • func (p *PortForwarder) Address() string
  • func (p *PortForwarder) Forward(ctx context.Context) error
  • func (p *PortForwarder) KeepAlive(ctx context.Context)
  • func (p *PortForwarder) Stop()
• type PortForwardingOpts

Types

type PortForwarder

type PortForwarder struct {
	// contains filtered or unexported fields
}

PortForwarder can manage a port forwarding session.

func NewPortForwarder

func NewPortForwarder(restConfig *rest.Config, opts PortForwardingOpts) (*PortForwarder, error)

NewPortForwarder creates a PortForwarder.

func (*PortForwarder) Address

func (p *PortForwarder) Address() string

Address returns an address for communicating with a port-forwarded pod.

func (*PortForwarder) Forward

func (p *PortForwarder) Forward(ctx context.Context) error

func (*PortForwarder) KeepAlive

func (p *PortForwarder) KeepAlive(ctx context.Context)

KeepAlive can be used to restart the port forwarding session in the background.

func (*PortForwarder) Stop

func (p *PortForwarder) Stop()

Stop terminates a port forwarding session.

type PortForwardingOpts

type PortForwardingOpts struct {
	Namespace     string
	LabelSelector string
	PodName       string
	LocalPort     int
	DestPort      int
}