/ 
App-Docker-Client-0.010300
River stage zero No dependents
/ App::Docker::Client

NAME

App::Docker::Client - Simple and plain Docker client!

VERSION

Version 0.010300

new

Constructor

SUBROUTINES/METHODS

with_valid_code

without_valid_code

show_progress

attach

authority

Getter/Setter for internal hash key authority.

scheme

Getter/Setter for internal hash key scheme.

ssl_opts

Getter/Setter for internal hash key ssl_opts.

json

Getter/Setter for internal hash key json.

user_agent

Getter/Setter for internal hash key UserAgent.

get

delete

request

post

uri

Creating a new URI object.

Internal varibales:

* scheme
   
* authority

Given varibales:

* path

* query options

to_hashref

Getter/Setter for internal hash key ua.

post

post

_http_request

create HTTP::Request by uri params

_hande_response

_error_code

Simple error handler returns undef if everything is ok dies on error.

SYNOPSIS

Sample to inspect a conatainer, for mor posibilities see at the Docker API documentation https://docs.docker.com/engine/api/v1.25/

use App::Docker::Client;

my $client = App::Docker::Client->new();

my $hash_ref = $client->get('/containers/<container_id>/json');

Create a new container:

$client->post('/containers/create', {}, {
    Name      => 'container_name',
    Tty       => 1,
    OpenStdin => 1,
    Image     => 'perl',
});

For a remote authority engine use it like that:

use App::Docker::Client;

my %hash = ( authority => '0.0.0.0:5435' );

my $client = App::Docker::Client->new( %hash );

my $hash_ref = $client->get('/containers/<container_id>/json');

To follow logs

*STDOUT->autoflush(1);

my $cv = $client->attach(
    '/containers/<container_id>/attach',
    { stream => 1, logs => 1, stdin => 1, stderr => 1, stdout => 1, tail => 50 },
    \*STDIN,
    \*STDOUT
);
$cv->recv;

AUTHOR

Mario Zieschang, <mziescha at cpan.org>

BUGS

Please report any bugs or feature requests to bug-app-docker-client at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-Docker-Client. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc App::Docker::Client

You can also look for information at:

SEE ALSO

This package was partly inspired by Net::Docker by Peter Stuifzand and WWW::Docker by Shane Utt but everyone has his own client and is near similar.

LICENSE AND COPYRIGHT

Copyright 2017 Mario Zieschang.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.