zeropod

Documentation

Index

• Constants
• Variables
• func GetNetworkNS(spec *specs.Spec) (string, error)
• func GetPIDNS(spec *specs.Spec) (string, error)
• func GetSpec(bundlePath string) (*specs.Spec, error)
• func NewRegistry() *prometheus.Registry
• type Config
  • func NewConfig(ctx context.Context, spec *specs.Spec) (*Config, error)
  • func (cfg Config) IsZeropodContainer() bool
• type Container
  • func New(ctx context.Context, cfg *Config, cr *sync.Mutex, container *runc.Container, ...) (*Container, error)
  • func (c *Container) AddCheckpointedPID(pid int)
  • func (c *Container) CancelScaleDown()
  • func (c *Container) CheckpointedPID(pid int) bool
  • func (c *Container) DeleteCheckpointedPID(pid int)
  • func (c *Container) ID() string
  • func (c *Container) InitialProcess() process.Process
  • func (c *Container) Process() process.Process
  • func (c *Container) RegisterPostRestore(f func(*runc.Container, HandleStartedFunc))
  • func (c *Container) RegisterPreRestore(f func() HandleStartedFunc)
  • func (c *Container) Restore(ctx context.Context) (*runc.Container, process.Process, error)
  • func (c *Container) ScaledDown() bool
  • func (c *Container) ScheduleScaleDown() error
  • func (c *Container) SetScaledDown(scaledDown bool)
  • func (c *Container) Status() *v1.ContainerStatus
  • func (c *Container) Stop(ctx context.Context)
  • func (c *Container) StopActivator(ctx context.Context)
• type HandleStartedFunc

Constants

const (
	NodeLabel                        = "zeropod.ctrox.dev/node"
	PortsAnnotationKey               = "zeropod.ctrox.dev/ports-map"
	ContainerNamesAnnotationKey      = "zeropod.ctrox.dev/container-names"
	ScaleDownDurationAnnotationKey   = "zeropod.ctrox.dev/scaledown-duration"
	DisableCheckpoiningAnnotationKey = "zeropod.ctrox.dev/disable-checkpointing"
	PreDumpAnnotationKey             = "zeropod.ctrox.dev/pre-dump"
	CRIContainerNameAnnotation       = "io.kubernetes.cri.container-name"
	CRIContainerTypeAnnotation       = "io.kubernetes.cri.container-type"
)

const (
	LabelPodName      = "pod"
	LabelPodNamespace = "namespace"

	MetricsNamespace         = "zeropod"
	MetricCheckPointDuration = "checkpoint_duration_seconds"
	MetricRestoreDuration    = "restore_duration_seconds"
	MetricLastCheckpointTime = "last_checkpoint_time"
	MetricLastRestoreTime    = "last_restore_time"
	MetricRunning            = "running"
)

const RuntimeName = "io.containerd.zeropod.v2"

Variables

var ErrAlreadyRestored = errors.New("container is already restored")

Functions

func GetNetworkNS

func GetNetworkNS(spec *specs.Spec) (string, error)

GetNetworkNS reads the bundle's OCI spec and returns the network NS path of the container.

func GetPIDNS

func GetPIDNS(spec *specs.Spec) (string, error)

GetPIDNS reads the bundle's OCI spec and returns the PID NS path of the container.

func GetSpec

func GetSpec(bundlePath string) (*specs.Spec, error)

func NewRegistry

func NewRegistry() *prometheus.Registry

Types

type Config

type Config struct {
	ZeropodContainerNames []string
	Ports                 []uint16
	ScaleDownDuration     time.Duration
	DisableCheckpointing  bool
	PreDump               bool
	ContainerName         string
	ContainerType         string
	PodName               string
	PodNamespace          string
	PodUID                string
	ContainerdNamespace   string
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(ctx context.Context, spec *specs.Spec) (*Config, error)

NewConfig uses the annotations from the container spec to create a new typed ZeropodConfig config.

func (Config) IsZeropodContainer

func (cfg Config) IsZeropodContainer() bool

type Container

type Container struct {
	*runc.Container
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, cfg *Config, cr *sync.Mutex, container *runc.Container, pt stdio.Platform, events chan *v1.ContainerStatus) (*Container, error)

func (*Container) AddCheckpointedPID

func (c *Container) AddCheckpointedPID(pid int)

AddCheckpointedPID registers a new pid that should be considered checkpointed.

func (*Container) CancelScaleDown

func (c *Container) CancelScaleDown()

func (*Container) CheckpointedPID

func (c *Container) CheckpointedPID(pid int) bool

CheckpointedPID indicates if the pid has been checkpointed before.

func (*Container) DeleteCheckpointedPID

func (c *Container) DeleteCheckpointedPID(pid int)

DeleteCheckpointedPID deletes a pid from the map of checkpointed pids.

func (*Container) ID

func (c *Container) ID() string

func (*Container) InitialProcess

func (c *Container) InitialProcess() process.Process

func (*Container) Process

func (c *Container) Process() process.Process

func (*Container) RegisterPostRestore

func (c *Container) RegisterPostRestore(f func(*runc.Container, HandleStartedFunc))

func (*Container) RegisterPreRestore

func (c *Container) RegisterPreRestore(f func() HandleStartedFunc)

func (*Container) Restore

func (c *Container) Restore(ctx context.Context) (*runc.Container, process.Process, error)

func (*Container) ScaledDown

func (c *Container) ScaledDown() bool

func (*Container) ScheduleScaleDown

func (c *Container) ScheduleScaleDown() error

func (*Container) SetScaledDown

func (c *Container) SetScaledDown(scaledDown bool)

func (*Container) Status

func (c *Container) Status() *v1.ContainerStatus

func (*Container) Stop

func (c *Container) Stop(ctx context.Context)

func (*Container) StopActivator

func (c *Container) StopActivator(ctx context.Context)

type HandleStartedFunc

type HandleStartedFunc func(*runc.Container, process.Process)