shim

Documentation

Index

• Constants
• type Options
• type Shim
  • func NewShim(options Options) (Shim, error)

Constants

const (
	// DisableService is used to mark a socket/service to not be connected.
	DisableService = client.DontConnect
)

Types

type Options

type Options struct {
	// ShimSocket is the socket path for the CRI shim services.
	ShimSocket string
	// ImageSocket is the socket path for the (real) CRI image services.
	ImageSocket string
}

Options contains the configurable options of our CRI shim.

type Shim

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

Shim is the interface we expose for controlling our CRI shim.

func NewShim

func NewShim(options Options) (Shim, error)

NewShim creates a new shim instance.