parent

Documentation

Index

• Constants
• 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 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
}