view release on metacpan or  search on metacpan

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

=head2 mounts

Specification for mounts to be added to containers created as part of the
service. See L<API::Docker::Type::Mount>.

=head2 stop_signal

Signal to stop the container.

=head2 stop_grace_period

Amount of time to wait for the container to terminate before forcefully
killing it.

=head2 health_check

A test to perform to check that the container is healthy. See
L<API::Docker::Type::HealthConfig>.

=head2 hosts

A list of hostname/IP mappings to add to the container's C<hosts> file. The
format of extra hosts is specified in the
L<hosts(5)|http://man7.org/linux/man-pages/man5/hosts.5.html> man page:

IP_address canonical_hostname [aliases...].

=head2 dns_config

Specification for DNS related configurations in resolver configuration file
(C<resolv.conf>). See
L<API::Docker::Type::TaskSpec::ContainerSpec::DNSConfig>. Serialised as
C<DNSConfig> -- spelled out, because deriving it from the Perl name would
produce C<DnsConfig>.

=head2 secrets

Secrets contains references to zero or more secrets that will be exposed to
the service. See L<API::Docker::Type::TaskSpec::ContainerSpec::Secret>.

=head2 oom_score_adj

An integer value containing the score given to the container in order to
tune OOM killer preferences.

=head2 configs

Configs contains references to zero or more configs that will be exposed to
the service. See L<API::Docker::Type::TaskSpec::ContainerSpec::Config>.

=head2 isolation

Isolation technology of the containers running the service. (Windows only).
The swagger enumerates C<default>, C<process>, C<hyperv> and the empty
string.

=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 sysctls

Set kernel namedspaced parameters (sysctls) in the container. The Sysctls
option on services accepts the same sysctls as the are supported on
containers. Note that while the same sysctls are supported, no guarantees or
checks are made about their suitability for a clustered environment, and
it's up to the user to determine whether a given sysctl will work properly
in a Service. B<The keys are the caller's data> and are never translated.

=head2 capability_add

A list of kernel capabilities to add to the default set for the container.

=head2 capability_drop

A list of kernel capabilities to drop from the default set for the
container.

=head2 ulimits

A list of resource limits to set in the container. For example: C<{"Name":
"nofile", "Soft": 1024, "Hard": 2048}>". See
L<API::Docker::Type::TaskSpec::ContainerSpec::Ulimit>.

=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

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> L<https://raudssus.de/>.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut