view release on metacpan or  search on metacpan

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

docker working_dir => Str;


docker entrypoint => [Str];


docker network_disabled => Bool;


docker mac_address => Str;


docker on_build => [Str];


docker labels => { Str, Str };


docker stop_signal => Str;


docker stop_timeout => Int;


docker shell => [Str];


1;

__END__

=pod

=encoding UTF-8

=head1 NAME

API::Docker::Type::ContainerConfig - Configuration for a container that is portable between hosts

=head1 VERSION

version 0.004

=head1 DESCRIPTION

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

=head2 hostname

The hostname to use for the container, as a valid RFC 1123 hostname.

=head2 domainname

The domain name to use for the container.

=head2 user

Commands run as this user inside the container. If omitted, commands run as
the user specified in the image the container was started from.

Can be either user-name or UID, and optional group-name or GID, separated by
a colon (C<< <user-name|UID>[<:group-name|GID>] >>).

=head2 attach_stdin

Whether to attach to C<stdin>. The daemon defaults it to false.

=head2 attach_stdout

Whether to attach to C<stdout>. The daemon defaults it to true.

=head2 attach_stderr

Whether to attach to C<stderr>. The daemon defaults it to true.

=head2 exposed_ports

An object mapping ports to an empty object in the form:

C<< {"<port>/<tcp|udp|sctp>": {}} >> B<The keys are the caller's data> and
are never translated.

=head2 tty

Attach standard streams to a TTY, including C<stdin> if it is not closed.
The daemon defaults it to false.

=head2 open_stdin

Open C<stdin> The daemon defaults it to false.

=head2 stdin_once

Close C<stdin> after one attached client disconnects. The daemon defaults it
to false.

=head2 env

A list of environment variables to set inside the container in the form
C<["VAR=value", ...]>. A variable without C<=> is removed from the
environment, rather than to have an empty value.

=head2 cmd

Command to run specified as a string or an array of strings.

=head2 healthcheck

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

=head2 args_escaped

Command is already escaped (Windows only). The daemon defaults it to false.

=head2 image

The name (or reference) of the image to use when creating the container, or
which was used when the container was created.