relay

Documentation

Index

• Constants
• type Options
• type Relay
  • func NewRelay(options Options) (Relay, error)

Constants

const (
	// DisableService is used to mark a socket/service to not be connected.
	DisableService = client.DontConnect
	// DefaultImageSocket uses the runtime socket for the image servie, too.
	DefaultImageSocket = "default"
)

Types

type Options

type Options struct {
	// RelaySocket is the socket path for the CRI relay services.
	RelaySocket string
	// ImageSocket is the socket path for the (real) CRI image services.
	ImageSocket string
	// RuntimeSocket is the socket path for the (real) CRI runtime services.
	RuntimeSocket string
	// QualifyReqFn produces context for disambiguating a CRI request/reply.
	QualifyReqFn func(interface{}) string
}

Options contains the configurable options of our CRI relay.

type Relay

type Relay interface {
	// Setup prepares the relay to start processing CRI requests.
	Setup() error
	// Start starts the relay.
	Start() error
	// Stop stops the relay.
	Stop()
	// Client returns the relays client interface.
	Client() client.Client
	// Server returns the relays server interface.
	Server() server.Server
}

Relay is the interface we expose for controlling our CRI relay.

func NewRelay

func NewRelay(options Options) (Relay, error)

NewRelay creates a new relay instance.