view release on metacpan or  search on metacpan

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

package API::Docker::Type::Resources;
# ABSTRACT: A container's resources (cgroups config, ulimits, etc)
our $VERSION = '0.004';
use API::Docker::Type;
use API::Docker::Type::DeviceMapping;
use API::Docker::Type::DeviceRequest;
use API::Docker::Type::Resources::BlkioWeightDevice;
use API::Docker::Type::Resources::Ulimit;
use API::Docker::Type::ThrottleDevice;
use namespace::clean;


docker cpu_shares => Int;


docker memory => Int;


docker cgroup_parent => Str;


docker blkio_weight => Int;


docker blkio_weight_device => [ 'Resources::BlkioWeightDevice' ];


docker blkio_device_read_bps => [ 'ThrottleDevice' ];


docker blkio_device_write_bps => [ 'ThrottleDevice' ];


docker blkio_device_read_iops => [ 'ThrottleDevice' ],
  wire => 'BlkioDeviceReadIOps';


docker blkio_device_write_iops => [ 'ThrottleDevice' ],
  wire => 'BlkioDeviceWriteIOps';


docker cpu_period => Int;


docker cpu_quota => Int;


docker cpu_realtime_period => Int;


docker cpu_realtime_runtime => Int;


docker cpuset_cpus => Str;


docker cpuset_mems => Str;


docker devices => [ 'DeviceMapping' ];


docker device_cgroup_rules => [Str];


docker device_requests => [ 'DeviceRequest' ];


docker kernel_memory_tcp => Int, wire => 'KernelMemoryTCP';


docker memory_reservation => Int;


docker memory_swap => Int;


docker memory_swappiness => Int;

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

docker oom_kill_disable => Bool;


docker init => Bool;


docker pids_limit => Int;


docker ulimits => [ 'Resources::Ulimit' ];


docker cpu_count => Int;


docker cpu_percent => Int;


docker io_maximum_iops => Int, wire => 'IOMaximumIOps';


docker io_maximum_bandwidth => Int, wire => 'IOMaximumBandwidth';


1;

__END__

=pod

=encoding UTF-8

=head1 NAME

API::Docker::Type::Resources - A container's resources (cgroups config, ulimits, etc)

=head1 VERSION

version 0.004

=head1 DESCRIPTION

Generated from the C<Resources> definition of C<spec/v1.51.yaml>.

L<API::Docker::Type::HostConfig> is C<allOf [ $ref Resources, ... ]> in the
swagger and therefore inherits from this class, which is why every field
below is also a field of a C<HostConfig>. C<TaskSpec> references the
definition directly.

=head2 cpu_shares

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

=head2 memory

Memory limit in bytes. The daemon defaults it to 0.

=head2 cgroup_parent

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

=head2 blkio_weight

Block IO weight (relative weight).

=head2 blkio_weight_device

Block IO weight (relative device weight) in the form:

    [{"Path": "device_path", "Weight": weight}]

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

=head2 blkio_device_read_bps

Limit read rate (bytes per second) from a device, in the form:

    [{"Path": "device_path", "Rate": rate}]

See L<API::Docker::Type::ThrottleDevice>.

=head2 blkio_device_write_bps

Limit write rate (bytes per second) to a device, in the form:

    [{"Path": "device_path", "Rate": rate}]

See L<API::Docker::Type::ThrottleDevice>.

=head2 blkio_device_read_iops

Limit read rate (IO per second) from a device, in the form:

    [{"Path": "device_path", "Rate": rate}]

See L<API::Docker::Type::ThrottleDevice>. Serialised as
C<BlkioDeviceReadIOps> -- spelled out, because deriving it from the Perl
name would produce C<BlkioDeviceReadIops>.

=head2 blkio_device_write_iops

Limit write rate (IO per second) to a device, in the form:

    [{"Path": "device_path", "Rate": rate}]

See L<API::Docker::Type::ThrottleDevice>. Serialised as
C<BlkioDeviceWriteIOps> -- spelled out, because deriving it from the Perl
name would produce C<BlkioDeviceWriteIops>.

=head2 cpu_period

The length of a CPU period in microseconds.

=head2 cpu_quota