kubernetes

Documentation

Index

• Variables
• type Interface
• type Local
• type Mapping
  • func NewMapping(args ...string) (Mapping, error)
• type Pod
  • func (pod Pod) Like(pattern string) bool
  • func (pod Pod) String() string
• type Pods
  • func (pods Pods) AsStrings() []string
  • func (pods Pods) Default() Pod
• type Port
  • func (port Port) String() string
• type Remote

Variables

var Forwarding = regexp.MustCompile(`^\d+(?::\d+)?$`)

Forwarding defines the format for port forwarding input.

Types

type Interface

type Interface interface {
	// Find tries to find pods suitable by the pattern.
	Find(string) (Pods, error)
	// Forward initiates the port forwarding process.
	Forward(Pod, Mapping) error
}

Interface defines a top-level behavior of Kubernetes provider (API or CLI).

type Local

type Local Port

Local specifies local ports.

type Mapping

type Mapping map[Local]Remote

Mapping specifies port forwarding rules.

func NewMapping

func NewMapping(args ...string) (Mapping, error)

NewMapping returns port forwarding rules.

type Pod

type Pod string

Pod specifies a fully-qualified pod name.

func (Pod) Like

func (pod Pod) Like(pattern string) bool

Like compares the fully-qualified pod name with the pattern.

func (Pod) String

func (pod Pod) String() string

String returns string representation of the fully-qualified pod name.

type Pods

type Pods []Pod

Pods is a list of fully-qualified pod names.

func (Pods) AsStrings

func (pods Pods) AsStrings() []string

AsStrings converts a list of fully-qualified pod names into a string list.

func (Pods) Default

func (pods Pods) Default() Pod

Default returns a default fully-qualified pod name from the list.

type Port

type Port int16

Port is a type for port number.

func (Port) String

func (port Port) String() string

String returns string representation of the port number.

type Remote

type Remote Port

Remote specifies remote ports.