portforward

Documentation

Index

• type Manager
  • func New(kubectl string, log *logger.Logger) *Manager
  • func (m *Manager) Start(namespace, serviceName string, remotePort, preferredLocalPort int) (string, error)
  • func (m *Manager) StartDetached(namespace, serviceName string, remotePort, preferredLocalPort int) (string, int, error)
  • func (m *Manager) Stop()

Types

type Manager

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

Manager manages a kubectl port-forward subprocess and exposes a localhost endpoint

func New

func New(kubectl string, log *logger.Logger) *Manager

New creates a new PortForwardManager

func (*Manager) Start

func (m *Manager) Start(namespace, serviceName string, remotePort, preferredLocalPort int) (string, error)

Start starts port-forward to the given service; returns "127.0.0.1:<port>" If already running, this is a no-op and returns the existing endpoint

func (*Manager) StartDetached

func (m *Manager) StartDetached(namespace, serviceName string, remotePort, preferredLocalPort int) (string, int, error)

StartDetached starts port-forward as a detached process that survives the parent process exiting. Returns the endpoint and the PID of the subprocess. The caller is responsible for killing the process when done.

func (*Manager) Stop

func (m *Manager) Stop()

Stop stops the active port-forward if running