k8sportforward

README

k8sportforward

Package k8sportforward exposes functionality similar to kubectl port-forward.

License

k8sportforward is under the Apache 2.0 license. See the LICENSE file for details.

Projects using k8sportforward

Test libraries

Libraries

• https://github.com/giantswarm/apprclient
• https://github.com/giantswarm/helmclient

Services & operators

• https://github.com/giantswarm/chart-operator

Documentation

Index

• func IsInvalidConfig(err error) bool
• type Forwarder
  • func NewForwarder(config ForwarderConfig) (*Forwarder, error)
  • func (f *Forwarder) ForwardPort(namespace string, podName string, remotePort int) (*Tunnel, error)
• type ForwarderConfig
• type Tunnel
  • func (t *Tunnel) Close() error
  • func (t *Tunnel) LocalAddress() string

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Forwarder

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

func NewForwarder

func NewForwarder(config ForwarderConfig) (*Forwarder, error)

func (*Forwarder) ForwardPort

func (f *Forwarder) ForwardPort(namespace string, podName string, remotePort int) (*Tunnel, error)

ForwardPort opens a tunnel to a kubernetes pod.

type ForwarderConfig

type ForwarderConfig struct {
	RestConfig *rest.Config
}

type Tunnel

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

func (*Tunnel) Close

func (t *Tunnel) Close() error

Close disconnects a tunnel connection. It always returns nil error to fulfil io.Closer interface.

func (*Tunnel) LocalAddress

func (t *Tunnel) LocalAddress() string