shim

Documentation

Index

• Constants
• func NewLocal(s *Service) shimapi.ShimClient
• func WithLocal(publisher events.Publisher) func(context.Context, Config) (shim.ShimClient, io.Closer, error)
• type Client
  • func New(ctx context.Context, config Config, opt ClientOpt) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) IsAlive(ctx context.Context) (bool, error)
  • func (c *Client) KillShim(ctx context.Context) error
  • func (c *Client) StopShim(ctx context.Context) error
• type ClientOpt
  • func WithConnect(address string) ClientOpt
  • func WithStart(binary, address, daemonAddress, cgroup string, debug bool, exitHandler func()) ClientOpt
• type Config
• type Service
  • func NewService(config Config, publisher events.Publisher) (*Service, error)
  • func (s *Service) Checkpoint(ctx context.Context, r *shimapi.CheckpointTaskRequest) (*google_protobuf.Empty, error)
  • func (s *Service) CloseIO(ctx context.Context, r *shimapi.CloseIORequest) (*google_protobuf.Empty, error)
  • func (s *Service) Create(ctx context.Context, r *shimapi.CreateTaskRequest) (*shimapi.CreateTaskResponse, error)
  • func (s *Service) Delete(ctx context.Context, r *google_protobuf.Empty) (*shimapi.DeleteResponse, error)
  • func (s *Service) DeleteProcess(ctx context.Context, r *shimapi.DeleteProcessRequest) (*shimapi.DeleteResponse, error)
  • func (s *Service) Exec(ctx context.Context, r *shimapi.ExecProcessRequest) (*google_protobuf.Empty, error)
  • func (s *Service) Kill(ctx context.Context, r *shimapi.KillRequest) (*google_protobuf.Empty, error)
  • func (s *Service) ListPids(ctx context.Context, r *shimapi.ListPidsRequest) (*shimapi.ListPidsResponse, error)
  • func (s *Service) Pause(ctx context.Context, r *google_protobuf.Empty) (*google_protobuf.Empty, error)
  • func (s *Service) ResizePty(ctx context.Context, r *shimapi.ResizePtyRequest) (*google_protobuf.Empty, error)
  • func (s *Service) Resume(ctx context.Context, r *google_protobuf.Empty) (*google_protobuf.Empty, error)
  • func (s *Service) ShimInfo(ctx context.Context, r *google_protobuf.Empty) (*shimapi.ShimInfoResponse, error)
  • func (s *Service) Start(ctx context.Context, r *shimapi.StartRequest) (*shimapi.StartResponse, error)
  • func (s *Service) State(ctx context.Context, r *shimapi.StateRequest) (*shimapi.StateResponse, error)
  • func (s *Service) Update(ctx context.Context, r *shimapi.UpdateTaskRequest) (*google_protobuf.Empty, error)

Constants

const InitPidFile = "init.pid"

const RuncRoot = "/run/containerd/runc"

Functions

func NewLocal

func NewLocal(s *Service) shimapi.ShimClient

NewLocal returns a shim client implementation for issue commands to a shim

func WithLocal

func WithLocal(publisher events.Publisher) func(context.Context, Config) (shim.ShimClient, io.Closer, error)

WithLocal uses an in process shim

Types

type Client

type Client struct {
	shim.ShimClient
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, config Config, opt ClientOpt) (*Client, error)

New returns a new shim client

func (*Client) Close

func (c *Client) Close() error

func (*Client) IsAlive

func (c *Client) IsAlive(ctx context.Context) (bool, error)

IsAlive returns true if the shim can be contacted. NOTE: a negative answer doesn't mean that the process is gone.

func (*Client) KillShim

func (c *Client) KillShim(ctx context.Context) error

KillShim kills the shim forcefully and wait for the process to disappear

func (*Client) StopShim

func (c *Client) StopShim(ctx context.Context) error

StopShim signals the shim to exit and wait for the process to disappear

type ClientOpt

type ClientOpt func(context.Context, Config) (shim.ShimClient, io.Closer, error)

func WithConnect

func WithConnect(address string) ClientOpt

WithConnect connects to an existing shim

func WithStart

func WithStart(binary, address, daemonAddress, cgroup string, debug bool, exitHandler func()) ClientOpt

WithStart executes a new shim process

type Config

type Config struct {
	Path          string
	Namespace     string
	WorkDir       string
	Criu          string
	RuntimeRoot   string
	SystemdCgroup bool
}

type Service

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

func NewService

func NewService(config Config, publisher events.Publisher) (*Service, error)

NewService returns a new shim service that can be used via GRPC

func (*Service) Checkpoint

func (s *Service) Checkpoint(ctx context.Context, r *shimapi.CheckpointTaskRequest) (*google_protobuf.Empty, error)

func (*Service) CloseIO

func (s *Service) CloseIO(ctx context.Context, r *shimapi.CloseIORequest) (*google_protobuf.Empty, error)

func (*Service) Create

func (s *Service) Create(ctx context.Context, r *shimapi.CreateTaskRequest) (*shimapi.CreateTaskResponse, error)

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, r *google_protobuf.Empty) (*shimapi.DeleteResponse, error)

func (*Service) DeleteProcess

func (s *Service) DeleteProcess(ctx context.Context, r *shimapi.DeleteProcessRequest) (*shimapi.DeleteResponse, error)

func (*Service) Exec

func (s *Service) Exec(ctx context.Context, r *shimapi.ExecProcessRequest) (*google_protobuf.Empty, error)

func (*Service) Kill

func (s *Service) Kill(ctx context.Context, r *shimapi.KillRequest) (*google_protobuf.Empty, error)

func (*Service) ListPids

func (s *Service) ListPids(ctx context.Context, r *shimapi.ListPidsRequest) (*shimapi.ListPidsResponse, error)

func (*Service) Pause

func (s *Service) Pause(ctx context.Context, r *google_protobuf.Empty) (*google_protobuf.Empty, error)

func (*Service) ResizePty

func (s *Service) ResizePty(ctx context.Context, r *shimapi.ResizePtyRequest) (*google_protobuf.Empty, error)

func (*Service) Resume

func (s *Service) Resume(ctx context.Context, r *google_protobuf.Empty) (*google_protobuf.Empty, error)

func (*Service) ShimInfo

func (s *Service) ShimInfo(ctx context.Context, r *google_protobuf.Empty) (*shimapi.ShimInfoResponse, error)

func (*Service) Start

func (s *Service) Start(ctx context.Context, r *shimapi.StartRequest) (*shimapi.StartResponse, error)

func (*Service) State

func (s *Service) State(ctx context.Context, r *shimapi.StateRequest) (*shimapi.StateResponse, error)

func (*Service) Update

func (s *Service) Update(ctx context.Context, r *shimapi.UpdateTaskRequest) (*google_protobuf.Empty, error)