HostConfig
Table of Contents
- $autoRemove : bool|null
- Automatically remove the container when the container's process.
- $binds : array<string|int, string>|null
- A list of volume bindings for this container. Each volume binding.
- $blkioDeviceReadBps : array<string|int, ThrottleDevice>|null
- Limit read rate (bytes per second) from a device, in the form:.
- $blkioDeviceReadIOps : array<string|int, ThrottleDevice>|null
- Limit read rate (IO per second) from a device, in the form:.
- $blkioDeviceWriteBps : array<string|int, ThrottleDevice>|null
- Limit write rate (bytes per second) to a device, in the form:.
- $blkioDeviceWriteIOps : array<string|int, ThrottleDevice>|null
- Limit write rate (IO per second) to a device, in the form:.
- $blkioWeight : int|null
- Block IO weight (relative weight).
- $blkioWeightDevice : array<string|int, ResourcesBlkioWeightDeviceItem>|null
- Block IO weight (relative device weight) in the form:.
- $capabilities : array<string|int, string>|null
- A list of kernel capabilities to be available for container (this.
- $capAdd : array<string|int, string>|null
- A list of kernel capabilities to add to the container. Conflicts.
- $capDrop : array<string|int, string>|null
- A list of kernel capabilities to drop from the container. Conflicts.
- $cgroup : string|null
- Cgroup to use for the container.
- $cgroupParent : string|null
- Path to `cgroups` under which the container's `cgroup` is created. If.
- $consoleSize : array<string|int, int>|null
- Initial console size, as an `[height, width]` array. (Windows only).
- $containerIDFile : string|null
- Path to a file where the container ID is written.
- $cpuCount : int|null
- The number of usable CPUs (Windows only).
- $cpuPercent : int|null
- The usable percentage of the available CPUs (Windows only).
- $cpuPeriod : int|null
- The length of a CPU period in microseconds.
- $cpuQuota : int|null
- Microseconds of CPU time that the container can get in a CPU period.
- $cpuRealtimePeriod : int|null
- The length of a CPU real-time period in microseconds. Set to 0 to.
- $cpuRealtimeRuntime : int|null
- The length of a CPU real-time runtime in microseconds. Set to 0 to.
- $cpusetCpus : string|null
- CPUs in which to allow execution (e.g., `0-3`, `0,1`).
- $cpusetMems : string|null
- Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
- $cpuShares : int|null
- An integer value representing this container's relative CPU weight.
- $deviceCgroupRules : array<string|int, string>|null
- a list of cgroup rules to apply to the container.
- $deviceRequests : array<string|int, DeviceRequest>|null
- A list of requests for devices to be sent to device drivers.
- $devices : array<string|int, DeviceMapping>|null
- A list of devices to add to the container.
- $dns : array<string|int, string>|null
- A list of DNS servers for the container to use.
- $dnsOptions : array<string|int, string>|null
- A list of DNS options.
- $dnsSearch : array<string|int, string>|null
- A list of DNS search domains.
- $extraHosts : array<string|int, string>|null
- A list of hostnames/IP mappings to add to the container's `/etc/hosts`.
- $groupAdd : array<string|int, string>|null
- A list of additional groups that the container process will run as.
- $init : bool|null
- Run an init inside the container that forwards signals and reaps.
- $iOMaximumBandwidth : int|null
- Maximum IO in bytes per second for the container system drive.
- $iOMaximumIOps : int|null
- Maximum IOps for the container system drive (Windows only).
- $ipcMode : string|null
- IPC sharing mode for the container. Possible values are:.
- $isolation : string|null
- Isolation technology of the container. (Windows only).
- $kernelMemory : int|null
- Kernel memory limit in bytes.
- $kernelMemoryTCP : int|null
- Hard limit for kernel TCP buffer memory (in bytes).
- $links : array<string|int, string>|null
- A list of links for the container in the form `container_name:alias`.
- $logConfig : HostConfigLogConfig|null
- The logging configuration for this container.
- $maskedPaths : array<string|int, string>|null
- The list of paths to be masked inside the container (this overrides.
- $memory : int|null
- Memory limit in bytes.
- $memoryReservation : int|null
- Memory soft limit in bytes.
- $memorySwap : int|null
- Total memory limit (memory + swap). Set as `-1` to enable unlimited.
- $memorySwappiness : int|null
- Tune a container's memory swappiness behavior. Accepts an integer.
- $mounts : array<string|int, Mount>|null
- Specification for mounts to be added to the container.
- $nanoCPUs : int|null
- CPU quota in units of 10<sup>-9</sup> CPUs.
- $networkMode : string|null
- Network mode to use for this container. Supported standard values.
- $oomKillDisable : bool|null
- Disable OOM Killer for the container.
- $oomScoreAdj : int|null
- An integer value containing the score given to the container in.
- $pidMode : string|null
- Set the PID (Process) Namespace mode for the container. It can be.
- $pidsLimit : int|null
- Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
- $portBindings : array<string|int, array<string|int, PortBinding>>|null
- PortMap describes the mapping of container ports to host ports, using the.
- $privileged : bool|null
- Gives the container full access to the host.
- $publishAllPorts : bool|null
- Allocates an ephemeral host port for all of a container's.
- $readonlyPaths : array<string|int, string>|null
- The list of paths to be set as read-only inside the container.
- $readonlyRootfs : bool|null
- Mount the container's root filesystem as read only.
- $restartPolicy : RestartPolicy|null
- The behavior to apply when the container exits. The default is not to.
- $runtime : string|null
- Runtime to use with this container.
- $securityOpt : array<string|int, string>|null
- A list of string values to customize labels for MLS systems, such as SELinux.
- $shmSize : int|null
- Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
- $storageOpt : array<string|int, string>|null
- Storage driver options for this container, in the form `{"size": "120G"}`.
- $sysctls : array<string|int, string>|null
- A list of kernel parameters (sysctls) to set in the container.
- $tmpfs : array<string|int, string>|null
- A map of container directories which should be replaced by tmpfs.
- $ulimits : array<string|int, ResourcesUlimitsItem>|null
- A list of resource limits to set in the container. For example:.
- $usernsMode : string|null
- Sets the usernamespace mode for the container when usernamespace.
- $uTSMode : string|null
- UTS namespace to use for the container.
- $volumeDriver : string|null
- Driver that this container uses to mount volumes.
- $volumesFrom : array<string|int, string>|null
- A list of volumes to inherit from another container, specified in.
- getAutoRemove() : bool|null
- Automatically remove the container when the container's process.
- getBinds() : array<string|int, string>|null
- A list of volume bindings for this container. Each volume binding.
- getBlkioDeviceReadBps() : array<string|int, ThrottleDevice>|null
- Limit read rate (bytes per second) from a device, in the form:.
- getBlkioDeviceReadIOps() : array<string|int, ThrottleDevice>|null
- Limit read rate (IO per second) from a device, in the form:.
- getBlkioDeviceWriteBps() : array<string|int, ThrottleDevice>|null
- Limit write rate (bytes per second) to a device, in the form:.
- getBlkioDeviceWriteIOps() : array<string|int, ThrottleDevice>|null
- Limit write rate (IO per second) to a device, in the form:.
- getBlkioWeight() : int|null
- Block IO weight (relative weight).
- getBlkioWeightDevice() : array<string|int, ResourcesBlkioWeightDeviceItem>|null
- Block IO weight (relative device weight) in the form:.
- getCapabilities() : array<string|int, string>|null
- A list of kernel capabilities to be available for container (this.
- getCapAdd() : array<string|int, string>|null
- A list of kernel capabilities to add to the container. Conflicts.
- getCapDrop() : array<string|int, string>|null
- A list of kernel capabilities to drop from the container. Conflicts.
- getCgroup() : string|null
- Cgroup to use for the container.
- getCgroupParent() : string|null
- Path to `cgroups` under which the container's `cgroup` is created. If.
- getConsoleSize() : array<string|int, int>|null
- Initial console size, as an `[height, width]` array. (Windows only).
- getContainerIDFile() : string|null
- Path to a file where the container ID is written.
- getCpuCount() : int|null
- The number of usable CPUs (Windows only).
- getCpuPercent() : int|null
- The usable percentage of the available CPUs (Windows only).
- getCpuPeriod() : int|null
- The length of a CPU period in microseconds.
- getCpuQuota() : int|null
- Microseconds of CPU time that the container can get in a CPU period.
- getCpuRealtimePeriod() : int|null
- The length of a CPU real-time period in microseconds. Set to 0 to.
- getCpuRealtimeRuntime() : int|null
- The length of a CPU real-time runtime in microseconds. Set to 0 to.
- getCpusetCpus() : string|null
- CPUs in which to allow execution (e.g., `0-3`, `0,1`).
- getCpusetMems() : string|null
- Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
- getCpuShares() : int|null
- An integer value representing this container's relative CPU weight.
- getDeviceCgroupRules() : array<string|int, string>|null
- a list of cgroup rules to apply to the container.
- getDeviceRequests() : array<string|int, DeviceRequest>|null
- A list of requests for devices to be sent to device drivers.
- getDevices() : array<string|int, DeviceMapping>|null
- A list of devices to add to the container.
- getDns() : array<string|int, string>|null
- A list of DNS servers for the container to use.
- getDnsOptions() : array<string|int, string>|null
- A list of DNS options.
- getDnsSearch() : array<string|int, string>|null
- A list of DNS search domains.
- getExtraHosts() : array<string|int, string>|null
- A list of hostnames/IP mappings to add to the container's `/etc/hosts`.
- getGroupAdd() : array<string|int, string>|null
- A list of additional groups that the container process will run as.
- getInit() : bool|null
- Run an init inside the container that forwards signals and reaps.
- getIOMaximumBandwidth() : int|null
- Maximum IO in bytes per second for the container system drive.
- getIOMaximumIOps() : int|null
- Maximum IOps for the container system drive (Windows only).
- getIpcMode() : string|null
- IPC sharing mode for the container. Possible values are:.
- getIsolation() : string|null
- Isolation technology of the container. (Windows only).
- getKernelMemory() : int|null
- Kernel memory limit in bytes.
- getKernelMemoryTCP() : int|null
- Hard limit for kernel TCP buffer memory (in bytes).
- getLinks() : array<string|int, string>|null
- A list of links for the container in the form `container_name:alias`.
- getLogConfig() : HostConfigLogConfig|null
- The logging configuration for this container.
- getMaskedPaths() : array<string|int, string>|null
- The list of paths to be masked inside the container (this overrides.
- getMemory() : int|null
- Memory limit in bytes.
- getMemoryReservation() : int|null
- Memory soft limit in bytes.
- getMemorySwap() : int|null
- Total memory limit (memory + swap). Set as `-1` to enable unlimited.
- getMemorySwappiness() : int|null
- Tune a container's memory swappiness behavior. Accepts an integer.
- getMounts() : array<string|int, Mount>|null
- Specification for mounts to be added to the container.
- getNanoCPUs() : int|null
- CPU quota in units of 10<sup>-9</sup> CPUs.
- getNetworkMode() : string|null
- Network mode to use for this container. Supported standard values.
- getOomKillDisable() : bool|null
- Disable OOM Killer for the container.
- getOomScoreAdj() : int|null
- An integer value containing the score given to the container in.
- getPidMode() : string|null
- Set the PID (Process) Namespace mode for the container. It can be.
- getPidsLimit() : int|null
- Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
- getPortBindings() : array<string|int, array<string|int, PortBinding>>|null
- PortMap describes the mapping of container ports to host ports, using the.
- getPrivileged() : bool|null
- Gives the container full access to the host.
- getPublishAllPorts() : bool|null
- Allocates an ephemeral host port for all of a container's.
- getReadonlyPaths() : array<string|int, string>|null
- The list of paths to be set as read-only inside the container.
- getReadonlyRootfs() : bool|null
- Mount the container's root filesystem as read only.
- getRestartPolicy() : RestartPolicy|null
- The behavior to apply when the container exits. The default is not to.
- getRuntime() : string|null
- Runtime to use with this container.
- getSecurityOpt() : array<string|int, string>|null
- A list of string values to customize labels for MLS systems, such as SELinux.
- getShmSize() : int|null
- Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
- getStorageOpt() : array<string|int, string>|null
- Storage driver options for this container, in the form `{"size": "120G"}`.
- getSysctls() : array<string|int, string>|null
- A list of kernel parameters (sysctls) to set in the container.
- getTmpfs() : array<string|int, string>|null
- A map of container directories which should be replaced by tmpfs.
- getUlimits() : array<string|int, ResourcesUlimitsItem>|null
- A list of resource limits to set in the container. For example:.
- getUsernsMode() : string|null
- Sets the usernamespace mode for the container when usernamespace.
- getUTSMode() : string|null
- UTS namespace to use for the container.
- getVolumeDriver() : string|null
- Driver that this container uses to mount volumes.
- getVolumesFrom() : array<string|int, string>|null
- A list of volumes to inherit from another container, specified in.
- setAutoRemove() : self
- Automatically remove the container when the container's process.
- setBinds() : self
- A list of volume bindings for this container. Each volume binding.
- setBlkioDeviceReadBps() : self
- Limit read rate (bytes per second) from a device, in the form:.
- setBlkioDeviceReadIOps() : self
- Limit read rate (IO per second) from a device, in the form:.
- setBlkioDeviceWriteBps() : self
- Limit write rate (bytes per second) to a device, in the form:.
- setBlkioDeviceWriteIOps() : self
- Limit write rate (IO per second) to a device, in the form:.
- setBlkioWeight() : self
- Block IO weight (relative weight).
- setBlkioWeightDevice() : self
- Block IO weight (relative device weight) in the form:.
- setCapabilities() : self
- A list of kernel capabilities to be available for container (this.
- setCapAdd() : self
- A list of kernel capabilities to add to the container. Conflicts.
- setCapDrop() : self
- A list of kernel capabilities to drop from the container. Conflicts.
- setCgroup() : self
- Cgroup to use for the container.
- setCgroupParent() : self
- Path to `cgroups` under which the container's `cgroup` is created. If.
- setConsoleSize() : self
- Initial console size, as an `[height, width]` array. (Windows only).
- setContainerIDFile() : self
- Path to a file where the container ID is written.
- setCpuCount() : self
- The number of usable CPUs (Windows only).
- setCpuPercent() : self
- The usable percentage of the available CPUs (Windows only).
- setCpuPeriod() : self
- The length of a CPU period in microseconds.
- setCpuQuota() : self
- Microseconds of CPU time that the container can get in a CPU period.
- setCpuRealtimePeriod() : self
- The length of a CPU real-time period in microseconds. Set to 0 to.
- setCpuRealtimeRuntime() : self
- The length of a CPU real-time runtime in microseconds. Set to 0 to.
- setCpusetCpus() : self
- CPUs in which to allow execution (e.g., `0-3`, `0,1`).
- setCpusetMems() : self
- Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
- setCpuShares() : self
- An integer value representing this container's relative CPU weight.
- setDeviceCgroupRules() : self
- a list of cgroup rules to apply to the container.
- setDeviceRequests() : self
- A list of requests for devices to be sent to device drivers.
- setDevices() : self
- A list of devices to add to the container.
- setDns() : self
- A list of DNS servers for the container to use.
- setDnsOptions() : self
- A list of DNS options.
- setDnsSearch() : self
- A list of DNS search domains.
- setExtraHosts() : self
- A list of hostnames/IP mappings to add to the container's `/etc/hosts`.
- setGroupAdd() : self
- A list of additional groups that the container process will run as.
- setInit() : self
- Run an init inside the container that forwards signals and reaps.
- setIOMaximumBandwidth() : self
- Maximum IO in bytes per second for the container system drive.
- setIOMaximumIOps() : self
- Maximum IOps for the container system drive (Windows only).
- setIpcMode() : self
- IPC sharing mode for the container. Possible values are:.
- setIsolation() : self
- Isolation technology of the container. (Windows only).
- setKernelMemory() : self
- Kernel memory limit in bytes.
- setKernelMemoryTCP() : self
- Hard limit for kernel TCP buffer memory (in bytes).
- setLinks() : self
- A list of links for the container in the form `container_name:alias`.
- setLogConfig() : self
- The logging configuration for this container.
- setMaskedPaths() : self
- The list of paths to be masked inside the container (this overrides.
- setMemory() : self
- Memory limit in bytes.
- setMemoryReservation() : self
- Memory soft limit in bytes.
- setMemorySwap() : self
- Total memory limit (memory + swap). Set as `-1` to enable unlimited.
- setMemorySwappiness() : self
- Tune a container's memory swappiness behavior. Accepts an integer.
- setMounts() : self
- Specification for mounts to be added to the container.
- setNanoCPUs() : self
- CPU quota in units of 10<sup>-9</sup> CPUs.
- setNetworkMode() : self
- Network mode to use for this container. Supported standard values.
- setOomKillDisable() : self
- Disable OOM Killer for the container.
- setOomScoreAdj() : self
- An integer value containing the score given to the container in.
- setPidMode() : self
- Set the PID (Process) Namespace mode for the container. It can be.
- setPidsLimit() : self
- Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
- setPortBindings() : self
- PortMap describes the mapping of container ports to host ports, using the.
- setPrivileged() : self
- Gives the container full access to the host.
- setPublishAllPorts() : self
- Allocates an ephemeral host port for all of a container's.
- setReadonlyPaths() : self
- The list of paths to be set as read-only inside the container.
- setReadonlyRootfs() : self
- Mount the container's root filesystem as read only.
- setRestartPolicy() : self
- The behavior to apply when the container exits. The default is not to.
- setRuntime() : self
- Runtime to use with this container.
- setSecurityOpt() : self
- A list of string values to customize labels for MLS systems, such as SELinux.
- setShmSize() : self
- Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
- setStorageOpt() : self
- Storage driver options for this container, in the form `{"size": "120G"}`.
- setSysctls() : self
- A list of kernel parameters (sysctls) to set in the container.
- setTmpfs() : self
- A map of container directories which should be replaced by tmpfs.
- setUlimits() : self
- A list of resource limits to set in the container. For example:.
- setUsernsMode() : self
- Sets the usernamespace mode for the container when usernamespace.
- setUTSMode() : self
- UTS namespace to use for the container.
- setVolumeDriver() : self
- Driver that this container uses to mount volumes.
- setVolumesFrom() : self
- A list of volumes to inherit from another container, specified in.
Properties
$autoRemove
Automatically remove the container when the container's process.
protected
bool|null
$autoRemove
$binds
A list of volume bindings for this container. Each volume binding.
protected
array<string|int, string>|null
$binds
$blkioDeviceReadBps
Limit read rate (bytes per second) from a device, in the form:.
protected
array<string|int, ThrottleDevice>|null
$blkioDeviceReadBps
$blkioDeviceReadIOps
Limit read rate (IO per second) from a device, in the form:.
protected
array<string|int, ThrottleDevice>|null
$blkioDeviceReadIOps
$blkioDeviceWriteBps
Limit write rate (bytes per second) to a device, in the form:.
protected
array<string|int, ThrottleDevice>|null
$blkioDeviceWriteBps
$blkioDeviceWriteIOps
Limit write rate (IO per second) to a device, in the form:.
protected
array<string|int, ThrottleDevice>|null
$blkioDeviceWriteIOps
$blkioWeight
Block IO weight (relative weight).
protected
int|null
$blkioWeight
$blkioWeightDevice
Block IO weight (relative device weight) in the form:.
protected
array<string|int, ResourcesBlkioWeightDeviceItem>|null
$blkioWeightDevice
$capabilities
A list of kernel capabilities to be available for container (this.
protected
array<string|int, string>|null
$capabilities
$capAdd
A list of kernel capabilities to add to the container. Conflicts.
protected
array<string|int, string>|null
$capAdd
$capDrop
A list of kernel capabilities to drop from the container. Conflicts.
protected
array<string|int, string>|null
$capDrop
$cgroup
Cgroup to use for the container.
protected
string|null
$cgroup
$cgroupParent
Path to `cgroups` under which the container's `cgroup` is created. If.
protected
string|null
$cgroupParent
$consoleSize
Initial console size, as an `[height, width]` array. (Windows only).
protected
array<string|int, int>|null
$consoleSize
$containerIDFile
Path to a file where the container ID is written.
protected
string|null
$containerIDFile
$cpuCount
The number of usable CPUs (Windows only).
protected
int|null
$cpuCount
$cpuPercent
The usable percentage of the available CPUs (Windows only).
protected
int|null
$cpuPercent
$cpuPeriod
The length of a CPU period in microseconds.
protected
int|null
$cpuPeriod
$cpuQuota
Microseconds of CPU time that the container can get in a CPU period.
protected
int|null
$cpuQuota
$cpuRealtimePeriod
The length of a CPU real-time period in microseconds. Set to 0 to.
protected
int|null
$cpuRealtimePeriod
$cpuRealtimeRuntime
The length of a CPU real-time runtime in microseconds. Set to 0 to.
protected
int|null
$cpuRealtimeRuntime
$cpusetCpus
CPUs in which to allow execution (e.g., `0-3`, `0,1`).
protected
string|null
$cpusetCpus
$cpusetMems
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
protected
string|null
$cpusetMems
$cpuShares
An integer value representing this container's relative CPU weight.
protected
int|null
$cpuShares
$deviceCgroupRules
a list of cgroup rules to apply to the container.
protected
array<string|int, string>|null
$deviceCgroupRules
$deviceRequests
A list of requests for devices to be sent to device drivers.
protected
array<string|int, DeviceRequest>|null
$deviceRequests
$devices
A list of devices to add to the container.
protected
array<string|int, DeviceMapping>|null
$devices
$dns
A list of DNS servers for the container to use.
protected
array<string|int, string>|null
$dns
$dnsOptions
A list of DNS options.
protected
array<string|int, string>|null
$dnsOptions
$dnsSearch
A list of DNS search domains.
protected
array<string|int, string>|null
$dnsSearch
$extraHosts
A list of hostnames/IP mappings to add to the container's `/etc/hosts`.
protected
array<string|int, string>|null
$extraHosts
$groupAdd
A list of additional groups that the container process will run as.
protected
array<string|int, string>|null
$groupAdd
$init
Run an init inside the container that forwards signals and reaps.
protected
bool|null
$init
$iOMaximumBandwidth
Maximum IO in bytes per second for the container system drive.
protected
int|null
$iOMaximumBandwidth
$iOMaximumIOps
Maximum IOps for the container system drive (Windows only).
protected
int|null
$iOMaximumIOps
$ipcMode
IPC sharing mode for the container. Possible values are:.
protected
string|null
$ipcMode
$isolation
Isolation technology of the container. (Windows only).
protected
string|null
$isolation
$kernelMemory
Kernel memory limit in bytes.
protected
int|null
$kernelMemory
$kernelMemoryTCP
Hard limit for kernel TCP buffer memory (in bytes).
protected
int|null
$kernelMemoryTCP
$links
A list of links for the container in the form `container_name:alias`.
protected
array<string|int, string>|null
$links
$logConfig
The logging configuration for this container.
protected
HostConfigLogConfig|null
$logConfig
$maskedPaths
The list of paths to be masked inside the container (this overrides.
protected
array<string|int, string>|null
$maskedPaths
$memory
Memory limit in bytes.
protected
int|null
$memory
= 0
$memoryReservation
Memory soft limit in bytes.
protected
int|null
$memoryReservation
$memorySwap
Total memory limit (memory + swap). Set as `-1` to enable unlimited.
protected
int|null
$memorySwap
$memorySwappiness
Tune a container's memory swappiness behavior. Accepts an integer.
protected
int|null
$memorySwappiness
$mounts
Specification for mounts to be added to the container.
protected
array<string|int, Mount>|null
$mounts
$nanoCPUs
CPU quota in units of 10<sup>-9</sup> CPUs.
protected
int|null
$nanoCPUs
$networkMode
Network mode to use for this container. Supported standard values.
protected
string|null
$networkMode
$oomKillDisable
Disable OOM Killer for the container.
protected
bool|null
$oomKillDisable
$oomScoreAdj
An integer value containing the score given to the container in.
protected
int|null
$oomScoreAdj
$pidMode
Set the PID (Process) Namespace mode for the container. It can be.
protected
string|null
$pidMode
$pidsLimit
Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
protected
int|null
$pidsLimit
$portBindings
PortMap describes the mapping of container ports to host ports, using the.
protected
array<string|int, array<string|int, PortBinding>>|null
$portBindings
$privileged
Gives the container full access to the host.
protected
bool|null
$privileged
$publishAllPorts
Allocates an ephemeral host port for all of a container's.
protected
bool|null
$publishAllPorts
$readonlyPaths
The list of paths to be set as read-only inside the container.
protected
array<string|int, string>|null
$readonlyPaths
$readonlyRootfs
Mount the container's root filesystem as read only.
protected
bool|null
$readonlyRootfs
$restartPolicy
The behavior to apply when the container exits. The default is not to.
protected
RestartPolicy|null
$restartPolicy
$runtime
Runtime to use with this container.
protected
string|null
$runtime
$securityOpt
A list of string values to customize labels for MLS systems, such as SELinux.
protected
array<string|int, string>|null
$securityOpt
$shmSize
Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
protected
int|null
$shmSize
$storageOpt
Storage driver options for this container, in the form `{"size": "120G"}`.
protected
array<string|int, string>|null
$storageOpt
$sysctls
A list of kernel parameters (sysctls) to set in the container.
protected
array<string|int, string>|null
$sysctls
$tmpfs
A map of container directories which should be replaced by tmpfs.
protected
array<string|int, string>|null
$tmpfs
$ulimits
A list of resource limits to set in the container. For example:.
protected
array<string|int, ResourcesUlimitsItem>|null
$ulimits
$usernsMode
Sets the usernamespace mode for the container when usernamespace.
protected
string|null
$usernsMode
$uTSMode
UTS namespace to use for the container.
protected
string|null
$uTSMode
$volumeDriver
Driver that this container uses to mount volumes.
protected
string|null
$volumeDriver
$volumesFrom
A list of volumes to inherit from another container, specified in.
protected
array<string|int, string>|null
$volumesFrom
Methods
getAutoRemove()
Automatically remove the container when the container's process.
public
getAutoRemove() : bool|null
exits. This has no effect if RestartPolicy is set.
Return values
bool|null —getBinds()
A list of volume bindings for this container. Each volume binding.
public
getBinds() : array<string|int, string>|null
Return values
array<string|int, string>|null —getBlkioDeviceReadBps()
Limit read rate (bytes per second) from a device, in the form:.
public
getBlkioDeviceReadBps() : array<string|int, ThrottleDevice>|null
Return values
array<string|int, ThrottleDevice>|null —getBlkioDeviceReadIOps()
Limit read rate (IO per second) from a device, in the form:.
public
getBlkioDeviceReadIOps() : array<string|int, ThrottleDevice>|null
Return values
array<string|int, ThrottleDevice>|null —getBlkioDeviceWriteBps()
Limit write rate (bytes per second) to a device, in the form:.
public
getBlkioDeviceWriteBps() : array<string|int, ThrottleDevice>|null
Return values
array<string|int, ThrottleDevice>|null —getBlkioDeviceWriteIOps()
Limit write rate (IO per second) to a device, in the form:.
public
getBlkioDeviceWriteIOps() : array<string|int, ThrottleDevice>|null
Return values
array<string|int, ThrottleDevice>|null —getBlkioWeight()
Block IO weight (relative weight).
public
getBlkioWeight() : int|null
Return values
int|null —getBlkioWeightDevice()
Block IO weight (relative device weight) in the form:.
public
getBlkioWeightDevice() : array<string|int, ResourcesBlkioWeightDeviceItem>|null
Return values
array<string|int, ResourcesBlkioWeightDeviceItem>|null —getCapabilities()
A list of kernel capabilities to be available for container (this.
public
getCapabilities() : array<string|int, string>|null
Return values
array<string|int, string>|null —getCapAdd()
A list of kernel capabilities to add to the container. Conflicts.
public
getCapAdd() : array<string|int, string>|null
Return values
array<string|int, string>|null —getCapDrop()
A list of kernel capabilities to drop from the container. Conflicts.
public
getCapDrop() : array<string|int, string>|null
Return values
array<string|int, string>|null —getCgroup()
Cgroup to use for the container.
public
getCgroup() : string|null
Return values
string|null —getCgroupParent()
Path to `cgroups` under which the container's `cgroup` is created. If.
public
getCgroupParent() : string|null
already exist.
Return values
string|null —getConsoleSize()
Initial console size, as an `[height, width]` array. (Windows only).
public
getConsoleSize() : array<string|int, int>|null
Return values
array<string|int, int>|null —getContainerIDFile()
Path to a file where the container ID is written.
public
getContainerIDFile() : string|null
Return values
string|null —getCpuCount()
The number of usable CPUs (Windows only).
public
getCpuCount() : int|null
CPUShares, and CPUPercent last.
Return values
int|null —getCpuPercent()
The usable percentage of the available CPUs (Windows only).
public
getCpuPercent() : int|null
CPUShares, and CPUPercent last.
Return values
int|null —getCpuPeriod()
The length of a CPU period in microseconds.
public
getCpuPeriod() : int|null
Return values
int|null —getCpuQuota()
Microseconds of CPU time that the container can get in a CPU period.
public
getCpuQuota() : int|null
Return values
int|null —getCpuRealtimePeriod()
The length of a CPU real-time period in microseconds. Set to 0 to.
public
getCpuRealtimePeriod() : int|null
allocate no time allocated to real-time tasks.
Return values
int|null —getCpuRealtimeRuntime()
The length of a CPU real-time runtime in microseconds. Set to 0 to.
public
getCpuRealtimeRuntime() : int|null
allocate no time allocated to real-time tasks.
Return values
int|null —getCpusetCpus()
CPUs in which to allow execution (e.g., `0-3`, `0,1`).
public
getCpusetCpus() : string|null
Return values
string|null —getCpusetMems()
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
public
getCpusetMems() : string|null
effective on NUMA systems.
Return values
string|null —getCpuShares()
An integer value representing this container's relative CPU weight.
public
getCpuShares() : int|null
versus other containers.
Return values
int|null —getDeviceCgroupRules()
a list of cgroup rules to apply to the container.
public
getDeviceCgroupRules() : array<string|int, string>|null
Return values
array<string|int, string>|null —getDeviceRequests()
A list of requests for devices to be sent to device drivers.
public
getDeviceRequests() : array<string|int, DeviceRequest>|null
Return values
array<string|int, DeviceRequest>|null —getDevices()
A list of devices to add to the container.
public
getDevices() : array<string|int, DeviceMapping>|null
Return values
array<string|int, DeviceMapping>|null —getDns()
A list of DNS servers for the container to use.
public
getDns() : array<string|int, string>|null
Return values
array<string|int, string>|null —getDnsOptions()
A list of DNS options.
public
getDnsOptions() : array<string|int, string>|null
Return values
array<string|int, string>|null —getDnsSearch()
A list of DNS search domains.
public
getDnsSearch() : array<string|int, string>|null
Return values
array<string|int, string>|null —getExtraHosts()
A list of hostnames/IP mappings to add to the container's `/etc/hosts`.
public
getExtraHosts() : array<string|int, string>|null
Return values
array<string|int, string>|null —getGroupAdd()
A list of additional groups that the container process will run as.
public
getGroupAdd() : array<string|int, string>|null
Return values
array<string|int, string>|null —getInit()
Run an init inside the container that forwards signals and reaps.
public
getInit() : bool|null
configured on the daemon) is used.
Return values
bool|null —getIOMaximumBandwidth()
Maximum IO in bytes per second for the container system drive.
public
getIOMaximumBandwidth() : int|null
(Windows only).
Return values
int|null —getIOMaximumIOps()
Maximum IOps for the container system drive (Windows only).
public
getIOMaximumIOps() : int|null
Return values
int|null —getIpcMode()
IPC sharing mode for the container. Possible values are:.
public
getIpcMode() : string|null
or "shareable", depending on daemon version and configuration.
Return values
string|null —getIsolation()
Isolation technology of the container. (Windows only).
public
getIsolation() : string|null
Return values
string|null —getKernelMemory()
Kernel memory limit in bytes.
public
getKernelMemory() : int|null
Return values
int|null —getKernelMemoryTCP()
Hard limit for kernel TCP buffer memory (in bytes).
public
getKernelMemoryTCP() : int|null
Return values
int|null —getLinks()
A list of links for the container in the form `container_name:alias`.
public
getLinks() : array<string|int, string>|null
Return values
array<string|int, string>|null —getLogConfig()
The logging configuration for this container.
public
getLogConfig() : HostConfigLogConfig|null
Return values
HostConfigLogConfig|null —getMaskedPaths()
The list of paths to be masked inside the container (this overrides.
public
getMaskedPaths() : array<string|int, string>|null
Return values
array<string|int, string>|null —getMemory()
Memory limit in bytes.
public
getMemory() : int|null
Return values
int|null —getMemoryReservation()
Memory soft limit in bytes.
public
getMemoryReservation() : int|null
Return values
int|null —getMemorySwap()
Total memory limit (memory + swap). Set as `-1` to enable unlimited.
public
getMemorySwap() : int|null
swap.
Return values
int|null —getMemorySwappiness()
Tune a container's memory swappiness behavior. Accepts an integer.
public
getMemorySwappiness() : int|null
between 0 and 100.
Return values
int|null —getMounts()
Specification for mounts to be added to the container.
public
getMounts() : array<string|int, Mount>|null
Return values
array<string|int, Mount>|null —getNanoCPUs()
CPU quota in units of 10<sup>-9</sup> CPUs.
public
getNanoCPUs() : int|null
Return values
int|null —getNetworkMode()
Network mode to use for this container. Supported standard values.
public
getNetworkMode() : string|null
container should connect to.
Return values
string|null —getOomKillDisable()
Disable OOM Killer for the container.
public
getOomKillDisable() : bool|null
Return values
bool|null —getOomScoreAdj()
An integer value containing the score given to the container in.
public
getOomScoreAdj() : int|null
order to tune OOM killer preferences.
Return values
int|null —getPidMode()
Set the PID (Process) Namespace mode for the container. It can be.
public
getPidMode() : string|null
-
"host": use the host's PID namespace inside the container
Return values
string|null —getPidsLimit()
Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
public
getPidsLimit() : int|null
to not change.
Return values
int|null —getPortBindings()
PortMap describes the mapping of container ports to host ports, using the.
public
getPortBindings() : array<string|int, array<string|int, PortBinding>>|null
Return values
array<string|int, array<string|int, PortBinding>>|null —getPrivileged()
Gives the container full access to the host.
public
getPrivileged() : bool|null
Return values
bool|null —getPublishAllPorts()
Allocates an ephemeral host port for all of a container's.
public
getPublishAllPorts() : bool|null
/proc/sys/net/ipv4/ip_local_port_range.
Return values
bool|null —getReadonlyPaths()
The list of paths to be set as read-only inside the container.
public
getReadonlyPaths() : array<string|int, string>|null
Return values
array<string|int, string>|null —getReadonlyRootfs()
Mount the container's root filesystem as read only.
public
getReadonlyRootfs() : bool|null
Return values
bool|null —getRestartPolicy()
The behavior to apply when the container exits. The default is not to.
public
getRestartPolicy() : RestartPolicy|null
added before each restart to prevent flooding the server.
Return values
RestartPolicy|null —getRuntime()
Runtime to use with this container.
public
getRuntime() : string|null
Return values
string|null —getSecurityOpt()
A list of string values to customize labels for MLS systems, such as SELinux.
public
getSecurityOpt() : array<string|int, string>|null
Return values
array<string|int, string>|null —getShmSize()
Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
public
getShmSize() : int|null
Return values
int|null —getStorageOpt()
Storage driver options for this container, in the form `{"size": "120G"}`.
public
getStorageOpt() : array<string|int, string>|null
Return values
array<string|int, string>|null —getSysctls()
A list of kernel parameters (sysctls) to set in the container.
public
getSysctls() : array<string|int, string>|null
Return values
array<string|int, string>|null —getTmpfs()
A map of container directories which should be replaced by tmpfs.
public
getTmpfs() : array<string|int, string>|null
Return values
array<string|int, string>|null —getUlimits()
A list of resource limits to set in the container. For example:.
public
getUlimits() : array<string|int, ResourcesUlimitsItem>|null
Return values
array<string|int, ResourcesUlimitsItem>|null —getUsernsMode()
Sets the usernamespace mode for the container when usernamespace.
public
getUsernsMode() : string|null
remapping option is enabled.
Return values
string|null —getUTSMode()
UTS namespace to use for the container.
public
getUTSMode() : string|null
Return values
string|null —getVolumeDriver()
Driver that this container uses to mount volumes.
public
getVolumeDriver() : string|null
Return values
string|null —getVolumesFrom()
A list of volumes to inherit from another container, specified in.
public
getVolumesFrom() : array<string|int, string>|null
Return values
array<string|int, string>|null —setAutoRemove()
Automatically remove the container when the container's process.
public
setAutoRemove(bool|null $autoRemove) : self
exits. This has no effect if RestartPolicy is set.
Parameters
- $autoRemove : bool|null
Return values
self —setBinds()
A list of volume bindings for this container. Each volume binding.
public
setBinds(array<string|int, string>|null $binds) : self
Parameters
- $binds : array<string|int, string>|null
Return values
self —setBlkioDeviceReadBps()
Limit read rate (bytes per second) from a device, in the form:.
public
setBlkioDeviceReadBps(array<string|int, ThrottleDevice>|null $blkioDeviceReadBps) : self
Parameters
- $blkioDeviceReadBps : array<string|int, ThrottleDevice>|null
Return values
self —setBlkioDeviceReadIOps()
Limit read rate (IO per second) from a device, in the form:.
public
setBlkioDeviceReadIOps(array<string|int, ThrottleDevice>|null $blkioDeviceReadIOps) : self
Parameters
- $blkioDeviceReadIOps : array<string|int, ThrottleDevice>|null
Return values
self —setBlkioDeviceWriteBps()
Limit write rate (bytes per second) to a device, in the form:.
public
setBlkioDeviceWriteBps(array<string|int, ThrottleDevice>|null $blkioDeviceWriteBps) : self
Parameters
- $blkioDeviceWriteBps : array<string|int, ThrottleDevice>|null
Return values
self —setBlkioDeviceWriteIOps()
Limit write rate (IO per second) to a device, in the form:.
public
setBlkioDeviceWriteIOps(array<string|int, ThrottleDevice>|null $blkioDeviceWriteIOps) : self
Parameters
- $blkioDeviceWriteIOps : array<string|int, ThrottleDevice>|null
Return values
self —setBlkioWeight()
Block IO weight (relative weight).
public
setBlkioWeight(int|null $blkioWeight) : self
Parameters
- $blkioWeight : int|null
Return values
self —setBlkioWeightDevice()
Block IO weight (relative device weight) in the form:.
public
setBlkioWeightDevice(array<string|int, ResourcesBlkioWeightDeviceItem>|null $blkioWeightDevice) : self
Parameters
- $blkioWeightDevice : array<string|int, ResourcesBlkioWeightDeviceItem>|null
Return values
self —setCapabilities()
A list of kernel capabilities to be available for container (this.
public
setCapabilities(array<string|int, string>|null $capabilities) : self
Parameters
- $capabilities : array<string|int, string>|null
Return values
self —setCapAdd()
A list of kernel capabilities to add to the container. Conflicts.
public
setCapAdd(array<string|int, string>|null $capAdd) : self
Parameters
- $capAdd : array<string|int, string>|null
Return values
self —setCapDrop()
A list of kernel capabilities to drop from the container. Conflicts.
public
setCapDrop(array<string|int, string>|null $capDrop) : self
Parameters
- $capDrop : array<string|int, string>|null
Return values
self —setCgroup()
Cgroup to use for the container.
public
setCgroup(string|null $cgroup) : self
Parameters
- $cgroup : string|null
Return values
self —setCgroupParent()
Path to `cgroups` under which the container's `cgroup` is created. If.
public
setCgroupParent(string|null $cgroupParent) : self
already exist.
Parameters
- $cgroupParent : string|null
Return values
self —setConsoleSize()
Initial console size, as an `[height, width]` array. (Windows only).
public
setConsoleSize(array<string|int, int>|null $consoleSize) : self
Parameters
- $consoleSize : array<string|int, int>|null
Return values
self —setContainerIDFile()
Path to a file where the container ID is written.
public
setContainerIDFile(string|null $containerIDFile) : self
Parameters
- $containerIDFile : string|null
Return values
self —setCpuCount()
The number of usable CPUs (Windows only).
public
setCpuCount(int|null $cpuCount) : self
CPUShares, and CPUPercent last.
Parameters
- $cpuCount : int|null
Return values
self —setCpuPercent()
The usable percentage of the available CPUs (Windows only).
public
setCpuPercent(int|null $cpuPercent) : self
CPUShares, and CPUPercent last.
Parameters
- $cpuPercent : int|null
Return values
self —setCpuPeriod()
The length of a CPU period in microseconds.
public
setCpuPeriod(int|null $cpuPeriod) : self
Parameters
- $cpuPeriod : int|null
Return values
self —setCpuQuota()
Microseconds of CPU time that the container can get in a CPU period.
public
setCpuQuota(int|null $cpuQuota) : self
Parameters
- $cpuQuota : int|null
Return values
self —setCpuRealtimePeriod()
The length of a CPU real-time period in microseconds. Set to 0 to.
public
setCpuRealtimePeriod(int|null $cpuRealtimePeriod) : self
allocate no time allocated to real-time tasks.
Parameters
- $cpuRealtimePeriod : int|null
Return values
self —setCpuRealtimeRuntime()
The length of a CPU real-time runtime in microseconds. Set to 0 to.
public
setCpuRealtimeRuntime(int|null $cpuRealtimeRuntime) : self
allocate no time allocated to real-time tasks.
Parameters
- $cpuRealtimeRuntime : int|null
Return values
self —setCpusetCpus()
CPUs in which to allow execution (e.g., `0-3`, `0,1`).
public
setCpusetCpus(string|null $cpusetCpus) : self
Parameters
- $cpusetCpus : string|null
Return values
self —setCpusetMems()
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
public
setCpusetMems(string|null $cpusetMems) : self
effective on NUMA systems.
Parameters
- $cpusetMems : string|null
Return values
self —setCpuShares()
An integer value representing this container's relative CPU weight.
public
setCpuShares(int|null $cpuShares) : self
versus other containers.
Parameters
- $cpuShares : int|null
Return values
self —setDeviceCgroupRules()
a list of cgroup rules to apply to the container.
public
setDeviceCgroupRules(array<string|int, string>|null $deviceCgroupRules) : self
Parameters
- $deviceCgroupRules : array<string|int, string>|null
Return values
self —setDeviceRequests()
A list of requests for devices to be sent to device drivers.
public
setDeviceRequests(array<string|int, DeviceRequest>|null $deviceRequests) : self
Parameters
- $deviceRequests : array<string|int, DeviceRequest>|null
Return values
self —setDevices()
A list of devices to add to the container.
public
setDevices(array<string|int, DeviceMapping>|null $devices) : self
Parameters
- $devices : array<string|int, DeviceMapping>|null
Return values
self —setDns()
A list of DNS servers for the container to use.
public
setDns(array<string|int, string>|null $dns) : self
Parameters
- $dns : array<string|int, string>|null
Return values
self —setDnsOptions()
A list of DNS options.
public
setDnsOptions(array<string|int, string>|null $dnsOptions) : self
Parameters
- $dnsOptions : array<string|int, string>|null
Return values
self —setDnsSearch()
A list of DNS search domains.
public
setDnsSearch(array<string|int, string>|null $dnsSearch) : self
Parameters
- $dnsSearch : array<string|int, string>|null
Return values
self —setExtraHosts()
A list of hostnames/IP mappings to add to the container's `/etc/hosts`.
public
setExtraHosts(array<string|int, string>|null $extraHosts) : self
Parameters
- $extraHosts : array<string|int, string>|null
Return values
self —setGroupAdd()
A list of additional groups that the container process will run as.
public
setGroupAdd(array<string|int, string>|null $groupAdd) : self
Parameters
- $groupAdd : array<string|int, string>|null
Return values
self —setInit()
Run an init inside the container that forwards signals and reaps.
public
setInit(bool|null $init) : self
configured on the daemon) is used.
Parameters
- $init : bool|null
Return values
self —setIOMaximumBandwidth()
Maximum IO in bytes per second for the container system drive.
public
setIOMaximumBandwidth(int|null $iOMaximumBandwidth) : self
(Windows only).
Parameters
- $iOMaximumBandwidth : int|null
Return values
self —setIOMaximumIOps()
Maximum IOps for the container system drive (Windows only).
public
setIOMaximumIOps(int|null $iOMaximumIOps) : self
Parameters
- $iOMaximumIOps : int|null
Return values
self —setIpcMode()
IPC sharing mode for the container. Possible values are:.
public
setIpcMode(string|null $ipcMode) : self
or "shareable", depending on daemon version and configuration.
Parameters
- $ipcMode : string|null
Return values
self —setIsolation()
Isolation technology of the container. (Windows only).
public
setIsolation(string|null $isolation) : self
Parameters
- $isolation : string|null
Return values
self —setKernelMemory()
Kernel memory limit in bytes.
public
setKernelMemory(int|null $kernelMemory) : self
Parameters
- $kernelMemory : int|null
Return values
self —setKernelMemoryTCP()
Hard limit for kernel TCP buffer memory (in bytes).
public
setKernelMemoryTCP(int|null $kernelMemoryTCP) : self
Parameters
- $kernelMemoryTCP : int|null
Return values
self —setLinks()
A list of links for the container in the form `container_name:alias`.
public
setLinks(array<string|int, string>|null $links) : self
Parameters
- $links : array<string|int, string>|null
Return values
self —setLogConfig()
The logging configuration for this container.
public
setLogConfig(HostConfigLogConfig|null $logConfig) : self
Parameters
- $logConfig : HostConfigLogConfig|null
Return values
self —setMaskedPaths()
The list of paths to be masked inside the container (this overrides.
public
setMaskedPaths(array<string|int, string>|null $maskedPaths) : self
Parameters
- $maskedPaths : array<string|int, string>|null
Return values
self —setMemory()
Memory limit in bytes.
public
setMemory(int|null $memory) : self
Parameters
- $memory : int|null
Return values
self —setMemoryReservation()
Memory soft limit in bytes.
public
setMemoryReservation(int|null $memoryReservation) : self
Parameters
- $memoryReservation : int|null
Return values
self —setMemorySwap()
Total memory limit (memory + swap). Set as `-1` to enable unlimited.
public
setMemorySwap(int|null $memorySwap) : self
swap.
Parameters
- $memorySwap : int|null
Return values
self —setMemorySwappiness()
Tune a container's memory swappiness behavior. Accepts an integer.
public
setMemorySwappiness(int|null $memorySwappiness) : self
between 0 and 100.
Parameters
- $memorySwappiness : int|null
Return values
self —setMounts()
Specification for mounts to be added to the container.
public
setMounts(array<string|int, Mount>|null $mounts) : self
Parameters
- $mounts : array<string|int, Mount>|null
Return values
self —setNanoCPUs()
CPU quota in units of 10<sup>-9</sup> CPUs.
public
setNanoCPUs(int|null $nanoCPUs) : self
Parameters
- $nanoCPUs : int|null
Return values
self —setNetworkMode()
Network mode to use for this container. Supported standard values.
public
setNetworkMode(string|null $networkMode) : self
container should connect to.
Parameters
- $networkMode : string|null
Return values
self —setOomKillDisable()
Disable OOM Killer for the container.
public
setOomKillDisable(bool|null $oomKillDisable) : self
Parameters
- $oomKillDisable : bool|null
Return values
self —setOomScoreAdj()
An integer value containing the score given to the container in.
public
setOomScoreAdj(int|null $oomScoreAdj) : self
order to tune OOM killer preferences.
Parameters
- $oomScoreAdj : int|null
Return values
self —setPidMode()
Set the PID (Process) Namespace mode for the container. It can be.
public
setPidMode(string|null $pidMode) : self
-
"host": use the host's PID namespace inside the container
Parameters
- $pidMode : string|null
Return values
self —setPidsLimit()
Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
public
setPidsLimit(int|null $pidsLimit) : self
to not change.
Parameters
- $pidsLimit : int|null
Return values
self —setPortBindings()
PortMap describes the mapping of container ports to host ports, using the.
public
setPortBindings(array<string|int, array<string|int, PortBinding>>|null $portBindings) : self
Parameters
- $portBindings : array<string|int, array<string|int, PortBinding>>|null
Return values
self —setPrivileged()
Gives the container full access to the host.
public
setPrivileged(bool|null $privileged) : self
Parameters
- $privileged : bool|null
Return values
self —setPublishAllPorts()
Allocates an ephemeral host port for all of a container's.
public
setPublishAllPorts(bool|null $publishAllPorts) : self
/proc/sys/net/ipv4/ip_local_port_range.
Parameters
- $publishAllPorts : bool|null
Return values
self —setReadonlyPaths()
The list of paths to be set as read-only inside the container.
public
setReadonlyPaths(array<string|int, string>|null $readonlyPaths) : self
Parameters
- $readonlyPaths : array<string|int, string>|null
Return values
self —setReadonlyRootfs()
Mount the container's root filesystem as read only.
public
setReadonlyRootfs(bool|null $readonlyRootfs) : self
Parameters
- $readonlyRootfs : bool|null
Return values
self —setRestartPolicy()
The behavior to apply when the container exits. The default is not to.
public
setRestartPolicy(RestartPolicy|null $restartPolicy) : self
added before each restart to prevent flooding the server.
Parameters
- $restartPolicy : RestartPolicy|null
Return values
self —setRuntime()
Runtime to use with this container.
public
setRuntime(string|null $runtime) : self
Parameters
- $runtime : string|null
Return values
self —setSecurityOpt()
A list of string values to customize labels for MLS systems, such as SELinux.
public
setSecurityOpt(array<string|int, string>|null $securityOpt) : self
Parameters
- $securityOpt : array<string|int, string>|null
Return values
self —setShmSize()
Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
public
setShmSize(int|null $shmSize) : self
Parameters
- $shmSize : int|null
Return values
self —setStorageOpt()
Storage driver options for this container, in the form `{"size": "120G"}`.
public
setStorageOpt(array<string|int, string>|null $storageOpt) : self
Parameters
- $storageOpt : array<string|int, string>|null
Return values
self —setSysctls()
A list of kernel parameters (sysctls) to set in the container.
public
setSysctls(array<string|int, string>|null $sysctls) : self
Parameters
- $sysctls : array<string|int, string>|null
Return values
self —setTmpfs()
A map of container directories which should be replaced by tmpfs.
public
setTmpfs(array<string|int, string>|null $tmpfs) : self
Parameters
- $tmpfs : array<string|int, string>|null
Return values
self —setUlimits()
A list of resource limits to set in the container. For example:.
public
setUlimits(array<string|int, ResourcesUlimitsItem>|null $ulimits) : self
Parameters
- $ulimits : array<string|int, ResourcesUlimitsItem>|null
Return values
self —setUsernsMode()
Sets the usernamespace mode for the container when usernamespace.
public
setUsernsMode(string|null $usernsMode) : self
remapping option is enabled.
Parameters
- $usernsMode : string|null
Return values
self —setUTSMode()
UTS namespace to use for the container.
public
setUTSMode(string|null $uTSMode) : self
Parameters
- $uTSMode : string|null
Return values
self —setVolumeDriver()
Driver that this container uses to mount volumes.
public
setVolumeDriver(string|null $volumeDriver) : self
Parameters
- $volumeDriver : string|null
Return values
self —setVolumesFrom()
A list of volumes to inherit from another container, specified in.
public
setVolumesFrom(array<string|int, string>|null $volumesFrom) : self
Parameters
- $volumesFrom : array<string|int, string>|null