A container's resources (cgroups config, ulimits, etc) Resources

interface Resources {
    BlkioDeviceReadBps?: ThrottleDevice[];
    BlkioDeviceReadIOps?: ThrottleDevice[];
    BlkioDeviceWriteBps?: ThrottleDevice[];
    BlkioDeviceWriteIOps?: ThrottleDevice[];
    BlkioWeight?: number;
    BlkioWeightDevice?: ResourcesBlkioWeightDeviceInner[];
    CgroupParent?: string;
    CpuCount?: number;
    CpuPercent?: number;
    CpuPeriod?: number;
    CpuQuota?: number;
    CpuRealtimePeriod?: number;
    CpuRealtimeRuntime?: number;
    CpuShares?: number;
    CpusetCpus?: string;
    CpusetMems?: string;
    DeviceCgroupRules?: string[];
    DeviceRequests?: DeviceRequest[];
    Devices?: DeviceMapping[];
    IOMaximumBandwidth?: number;
    IOMaximumIOps?: number;
    Init?: null | boolean;
    KernelMemory?: number;
    KernelMemoryTCP?: number;
    Memory?: number;
    MemoryReservation?: number;
    MemorySwap?: number;
    MemorySwappiness?: number;
    NanoCpus?: number;
    OomKillDisable?: boolean;
    PidsLimit?: null | number;
    Ulimits?: ResourcesUlimitsInner[];
}

Properties

BlkioDeviceReadBps?: ThrottleDevice[]

Limit read rate (bytes per second) from a device, in the form: [{\"Path\": \"device_path\", \"Rate\": rate}]

BlkioDeviceReadIOps?: ThrottleDevice[]

Limit read rate (IO per second) from a device, in the form: [{\"Path\": \"device_path\", \"Rate\": rate}]

BlkioDeviceWriteBps?: ThrottleDevice[]

Limit write rate (bytes per second) to a device, in the form: [{\"Path\": \"device_path\", \"Rate\": rate}]

BlkioDeviceWriteIOps?: ThrottleDevice[]

Limit write rate (IO per second) to a device, in the form: [{\"Path\": \"device_path\", \"Rate\": rate}]

BlkioWeight?: number

Block IO weight (relative weight).

BlkioWeightDevice?: ResourcesBlkioWeightDeviceInner[]

Block IO weight (relative device weight) in the form: [{\"Path\": \"device_path\", \"Weight\": weight}]

CgroupParent?: string

Path to cgroups under which the container's cgroup is created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups are created if they do not already exist.

CpuCount?: number

The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is CPUCount first, then CPUShares, and CPUPercent last.

CpuPercent?: number

The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is CPUCount first, then CPUShares, and CPUPercent last.

CpuPeriod?: number

The length of a CPU period in microseconds.

CpuQuota?: number

Microseconds of CPU time that the container can get in a CPU period.

CpuRealtimePeriod?: number

The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks.

CpuRealtimeRuntime?: number

The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks.

CpuShares?: number

An integer value representing this container's relative CPU weight versus other containers.

CpusetCpus?: string

CPUs in which to allow execution (e.g., 0-3, 0,1).

CpusetMems?: string

Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.

DeviceCgroupRules?: string[]

a list of cgroup rules to apply to the container

DeviceRequests?: DeviceRequest[]

A list of requests for devices to be sent to device drivers.

Devices?: DeviceMapping[]

A list of devices to add to the container.

IOMaximumBandwidth?: number

Maximum IO in bytes per second for the container system drive (Windows only).

IOMaximumIOps?: number

Maximum IOps for the container system drive (Windows only)

Init?: null | boolean

Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used.

KernelMemory?: number

Kernel memory limit in bytes.


> Deprecated: This field is deprecated as the kernel 5.4 deprecated > kmem.limit_in_bytes.

KernelMemoryTCP?: number

Hard limit for kernel TCP buffer memory (in bytes).

Memory?: number

Memory limit in bytes.

MemoryReservation?: number

Memory soft limit in bytes.

MemorySwap?: number

Total memory limit (memory + swap). Set as -1 to enable unlimited swap.

MemorySwappiness?: number

Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.

NanoCpus?: number

CPU quota in units of 10-9 CPUs.

OomKillDisable?: boolean

Disable OOM Killer for the container.

PidsLimit?: null | number

Tune a container's PIDs limit. Set 0 or -1 for unlimited, or null to not change.

A list of resource limits to set in the container. For example: {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}