Type Alias: ContainerConfig
ContainerConfig =
object
A container's resource settings, in the Docker Engine's terms. No method of the component returns or accepts it: DockerContainer exposes these settings as its own properties (memoryLimit, cpuSet, devices, OOMKillDisable, restartPolicy), and ContainerSettingOptions sets them.
Properties
cpus
cpus:
number[]
The indexes of the host CPUs the container may run on ([0, 1]).
devices
devices:
object[]
The host devices made available in the container.
cgroupPermissions
cgroupPermissions:
string
What the container's cgroup allows on the device: a combination of r, w and m ("rwm").
containerPath
containerPath:
string
The path of the device in the container.
hostPath
hostPath:
string
The path of the device on the host (/dev/ttyUSB0).
memory
memory:
number
The memory limit, in bytes; 0 for no limit.
OOMKillDisable
OOMKillDisable:
boolean
true when the kernel's OOM killer does not kill the container's processes when it runs out of memory.
restartPolicy
restartPolicy:
object
When Docker restarts the container after it exits.
maximumRetryCount
maximumRetryCount:
number
With 'on-failure', the number of restarts before Docker gives up; 0 for no limit.
name
name:
""|"no"|"always"|"unless-stopped"|"on-failure"
The policy: '' or 'no', never; 'always', always; 'unless-stopped', always except after the container was stopped by hand; 'on-failure', only when it exits with a non-zero code.
ulimits
ulimits:
object[]
The resource limits (ulimits) of the container's processes.
hard
hard:
number
The hard limit.
name
name:
string
The limit name (nofile, nproc).
soft
soft:
number
The soft limit, which a process can raise up to the hard limit.