view release on metacpan or  search on metacpan

lib/API/Docker/Type/Resources.pm  view on Meta::CPAN

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

=head2 cpuset_mems

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

=head2 devices

A list of devices to add to the container. See
L<API::Docker::Type::DeviceMapping>.

=head2 device_cgroup_rules

A list of cgroup rules to apply to the container.

=head2 device_requests

A list of requests for devices to be sent to device drivers. See
L<API::Docker::Type::DeviceRequest>.

=head2 kernel_memory_tcp

Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI
runtime in use, this option may be ignored. It is no longer supported by the
default (runc) runtime.

This field is omitted when empty.

B<Deprecated>: This field is deprecated as kernel 6.12 has deprecated
C<memory.kmem.tcp.limit_in_bytes> field for cgroups v1. This field will be
removed in a future release. Serialised as C<KernelMemoryTCP> -- spelled
out, because deriving it from the Perl name would produce
C<KernelMemoryTcp>.

=head2 memory_reservation

Memory soft limit in bytes.

=head2 memory_swap

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

=head2 memory_swappiness

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

=head2 nano_cpus

CPU quota in units of 10^-9 CPUs.

=head2 oom_kill_disable

Disable OOM Killer for the container.

=head2 init

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.

=head2 pids_limit

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

=head2 ulimits

A list of resource limits to set in the container. For example:

    {"Name": "nofile", "Soft": 1024, "Hard": 2048}

See L<API::Docker::Type::Resources::Ulimit>.

=head2 cpu_count

The number of usable CPUs (Windows only).

On Windows Server containers, the processor resource controls are mutually
exclusive. The order of precedence is C<CPUCount> first, then C<CPUShares>,
and C<CPUPercent> last.

=head2 cpu_percent

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 C<CPUCount> first, then C<CPUShares>,
and C<CPUPercent> last.

=head2 io_maximum_iops

Maximum IOps for the container system drive (Windows only). Serialised as
C<IOMaximumIOps> -- spelled out, because deriving it from the Perl name
would produce C<IoMaximumIops>.

=head2 io_maximum_bandwidth

Maximum IO in bytes per second for the container system drive (Windows
only). Serialised as C<IOMaximumBandwidth> -- spelled out, because deriving
it from the Perl name would produce C<IoMaximumBandwidth>.

=head1 SUPPORT

=head2 Issues

Please report bugs and feature requests on GitHub at
L<https://github.com/Getty/p5-api-docker/issues>.

=head1 CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

=head1 AUTHOR

Torsten Raudssus <getty@cpan.org>

=head1 COPYRIGHT AND LICENSE