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, nonewns, debug bool, ...) 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)
  • func (s *Service) Wait(ctx context.Context, r *shimapi.WaitRequest) (*shimapi.WaitResponse, error)

Constants

const InitPidFile = "init.pid"

InitPidFile name of the file that contains the init pid

const RuncRoot = "/run/containerd/runc"

RuncRoot is the path to the root runc state directory

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
}

Client is a shim client containing the connection to a shim

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

Close the cient connection

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)

ClientOpt is an option for a shim client configuration

func WithConnect

func WithConnect(address string) ClientOpt

WithConnect connects to an existing shim

func WithStart

func WithStart(binary, address, daemonAddress, cgroup string, nonewns, 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
}

Config contains shim specific configuration

type Service

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

Service is the shim implementation of a remote shim over GRPC

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)

Checkpoint the container

func (*Service) CloseIO

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

CloseIO of a process

func (*Service) Create

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

Create a new initial process and container with the underlying OCI runtime

func (*Service) Delete

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

Delete the initial process and container

func (*Service) DeleteProcess

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

DeleteProcess deletes an exec'd process

func (*Service) Exec

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

Exec an additional process inside the container

func (*Service) Kill

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

Kill a process with the provided signal

func (*Service) ListPids

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

ListPids returns all pids inside the container

func (*Service) Pause

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

Pause the container

func (*Service) ResizePty

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

ResizePty of a process

func (*Service) Resume

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

Resume the container

func (*Service) ShimInfo

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

ShimInfo returns shim information such as the shim's pid

func (*Service) Start

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

Start a process

func (*Service) State

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

State returns runtime state information for a process

func (*Service) Update

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

Update a running container

func (*Service) Wait

func (s *Service) Wait(ctx context.Context, r *shimapi.WaitRequest) (*shimapi.WaitResponse, error)

Wait for a process to exit