remotecommand

Documentation

Overview

Package remotecommand adds support for executing commands in containers, with support for separate stdin, stdout, and stderr streams, as well as TTY.

Index

• type Executor
• type StreamExecutor
  • func NewExecutor(config *restclient.Config, method string, url *url.URL) (StreamExecutor, error)
  • func NewStreamExecutor(upgrader httpstream.UpgradeRoundTripper, ...) (StreamExecutor, error)
• type StreamOptions
• type TerminalSize
• type TerminalSizeQueue

Types

type Executor

type Executor interface {
	// Stream initiates the transport of the standard shell streams. It will transport any
	// non-nil stream to a remote system, and return an error if a problem occurs. If tty
	// is set, the stderr stream is not used (raw TTY manages stdout and stderr over the
	// stdout stream).
	Stream(options StreamOptions) error
}

Executor is an interface for transporting shell-style streams.

type StreamExecutor

type StreamExecutor interface {
	Executor
	httpstream.Dialer
}

StreamExecutor supports the ability to dial an httpstream connection and the ability to run a command line stream protocol over that dialer.

func NewExecutor

func NewExecutor(config *restclient.Config, method string, url *url.URL) (StreamExecutor, error)

NewExecutor connects to the provided server and upgrades the connection to multiplexed bidirectional streams. The current implementation uses SPDY, but this could be replaced with HTTP/2 once it's available, or something else. TODO: the common code between this and portforward could be abstracted.

func NewStreamExecutor

func NewStreamExecutor(upgrader httpstream.UpgradeRoundTripper, fn func(http.RoundTripper) http.RoundTripper, method string, url *url.URL) (StreamExecutor, error)

NewStreamExecutor upgrades the request so that it supports multiplexed bidirectional streams. This method takes a stream upgrader and an optional function that is invoked to wrap the round tripper. This method may be used by clients that are lower level than Kubernetes clients or need to provide their own upgrade round tripper.

type StreamOptions

type StreamOptions struct {
	SupportedProtocols []string
	Stdin              io.Reader
	Stdout             io.Writer
	Stderr             io.Writer
	Tty                bool
	TerminalSizeQueue  TerminalSizeQueue
}

StreamOptions holds information pertaining to the current streaming session: supported stream protocols, input/output streams, if the client is requesting a TTY, and a terminal size queue to support terminal resizing.

type TerminalSize

type TerminalSize struct {
	Width  uint16
	Height uint16
}

TerminalSize represents the width and height of a terminal.

type TerminalSizeQueue

type TerminalSizeQueue interface {
	// Next returns the new terminal size after the terminal has been resized. It returns nil when
	// monitoring has been stopped.
	Next() *TerminalSize
}

TerminalSizeQueue is capable of returning terminal resize events as they occur.