parent

Documentation

Index

• Constants
• func InitStateDir(stateDir string) error
• func LockStateDir(stateDir string) (*flock.Flock, error)
• func Parent(opt Opt) error
• type Opt

Constants

const (
	StateFileLock     = "lock"
	StateFileChildPID = "child_pid" // decimal pid number text
	StateFileAPISock  = "api.sock"  // REST API Socket
)

Documented state files. Undocumented ones are subject to change.

Functions

func InitStateDir

func InitStateDir(stateDir string) error

InitStateDir removes everything in the state dir except the lock file. This is needed because when the previous execution crashed, the state dir may not be removed successfully.

InitStateDir must be called before calling parent functions.

func LockStateDir

func LockStateDir(stateDir string) (*flock.Flock, error)

LockStateDir creates and locks "lock" file in the state dir.

func Parent

func Parent(opt Opt) error

Types

type Opt

type Opt struct {
	PipeFDEnvKey     string               // needs to be set
	StateDir         string               // directory needs to be precreated
	StateDirEnvKey   string               // optional env key to propagate StateDir value
	NetworkDriver    network.ParentDriver // nil for HostNetwork
	PortDriver       port.ParentDriver    // nil for --port-driver=none
	PublishPorts     []port.Spec
	CreatePIDNS      bool
	CreateCgroupNS   bool
	CreateUTSNS      bool
	CreateIPCNS      bool
	ParentEUIDEnvKey string // optional env key to propagate geteuid() value
	ParentEGIDEnvKey string // optional env key to propagate getegid() value
	Propagation      string
	EvacuateCgroup2  string // e.g. "rootlesskit_evacuation"
}