API-Docker

 view release on metacpan or  search on metacpan

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


docker user => Str;


docker exposed_ports => { Str, Any };


docker env => [Str];


docker cmd => [Str];


docker healthcheck => 'HealthConfig';


docker args_escaped => Bool;


docker volumes => { Str, Any };


docker working_dir => Str;


docker entrypoint => [Str];


docker on_build => [Str];


docker labels => { Str, Str };


docker stop_signal => Str;


docker shell => [Str];


1;

__END__

=pod

=encoding UTF-8

=head1 NAME

API::Docker::Type::ImageConfig - Configuration of the image

=head1 VERSION

version 0.006

=head1 DESCRIPTION

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

These fields are used as defaults when starting a container from the image.

=head2 user

The user that commands are run as inside the container.

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

An object mapping mount point paths inside the container to empty objects.
B<The keys are the caller's data> and are never translated.

=head2 working_dir

The working directory for commands to run in.

=head2 entrypoint

The entry point for the container as a string or an array of strings.

If the array consists of exactly one empty string (C<[""]>) then the entry
point is reset to system default (i.e., the entry point used by docker when
there is no C<ENTRYPOINT> instruction in the C<Dockerfile>).

=head2 on_build

C<ONBUILD> metadata that were defined in the image's C<Dockerfile>.

=head2 labels

User-defined key/value metadata. B<The keys are the caller's data> and are
never translated.

=head2 stop_signal

Signal to stop a container as a string or unsigned integer.



( run in 1.598 second using v1.01-cache-2.11-cpan-234fa220139 )