Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mark-5/perl-mesos

Perl bindings for Apache Mesos
https://github.com/mark-5/perl-mesos

perl

Last synced: 3 months ago
JSON representation

Perl bindings for Apache Mesos

Lists

README 

        
=pod



=head1 NAME



Mesos - perl bindings for Apache Mesos



=for html 



=head1 DESCRIPTION



This is a collection of perl bindings for Apache Mesos. This requires having the mesos shared library installed, in order to link against(much like python's mesos library).



=head2 Dispatchers



Mesos uses Mesos::Dispatchers for communicating with the underlying C++ drivers. If a dispatcher does not require any arguments, the short name may be passed, and the dispatcher will be automatically constructed. If a dispatcher is not explicitly passed, Mesos::Dispatcher::AnyEvent will be used.



    my $driver = Mesos::SchedulerDriver->new(

        dispatcher => 'AnyEvent',

        %args,

    );



=over 4



=item AnyEvent



Mesos writes to a Unix pipe with an attached AnyEvent I/O watcher. This means that perl callbacks for watchers will be executed by the AnyEvent event loop.



=item Interrupt



Mesos uses Async::Interrupt callbacks. This means the perl interpreter will be safely interrupted(waits for the current op to finish) in order to execute the corresponding perl callback. See Async::Interrupt for more details on how callbacks are executed. Be aware that this does not interrupt system calls(such as select) and XS code. This means if your code is blocking on a select(such as during an AnyEvent recv), the interrupt callback will not execute until the call has finished.



=item IOAsync



Mesos writes to a Unix pipe with an attached IO::Async::Handle.



The IOAsync dispatcher requires an IO::Async::Loop, and needs to be constructed manually



    my $loop = IO::Async::Loop->new;

    my $disp = Mesos::Dispatcher::IOAsync->new(loop => $loop);

    my $driver = Mesos::SchedulerDriver->new(

        dispatcher => $disp,

        %args,

    );



=item Mojo



Mesos writes to a Unix pipe with an attached Mojo::Reactor watcher.



=item POE



Mesos writes to a Unix pipe with an attached POE::Session.



=back



=head2 Logging



Logging is controlled by the PERL_MESOS_TRACE environmental variable. Valid logging levels are ERROR, WARNING, and INFO, which can be referred to by numbers 1, 2, and 3 respectively). PERL_MESOS_TRACE can alse be set to $level=$dir, which will write log files to $dir.



=head2 Protobuf Messages



Frameworks, masters, and slaves all communicate using google protocol buffers. The Mesos module handles protobuf messages using the Google::ProtocolBuffers library, which is what's used to generate the message classes in Mesos::Messages from resources/mesos.proto. It is encouraged to look over Google::ProtocolBuffers documentation before using Mesos.



The Mesos module ships with message classes generated from v0.20.0. Messages are still backwards compatible with previous versions, but please make sure to check the mesos.proto file from your Mesos installation, to see what fields are and are not allowed.



=head2 Internal POSIX Threads



The Apache Mesos library is multithreaded, which is problematic when dealing with perl. The solution Mesos currently goes with is to create C++ proxy classes, which registers callbacks that send notifications event handlers.



Launching internal POSIX threads also means that Mesos drivers are not fork safe, and only exec and POSIX::_exit can be guaranteed to work safely in the child process after forking. One should definitely not call any driver code in the child process after forking.



=head1 SYNOPSIS



    package MyScheduler {

        use Moo;

        extends 'Mesos::Scheduler';

        use Mesos::Messages; # load protobuf messages



        sub resourceOffers {

                my ($self, $driver, $offers) = @_;

                for my $offer (@$offers) {

                    my $task = Mesos::TaskInfo->new({

                        # task_id is a Mesos::TaskID message

                        task_id   => Mesos::TaskID->new({value => "a unique id"}),

                        slave_id  => $offer->slave_id,

                        name      => "does something cool",

                        # executor is a Mesos::ExecutorInfo message

                        # Google::ProtocolBuffers will let you pass the constructor args

                        #  and will instantiate the message for you

                        executor  => {

                            executor_id => {value => "does cool tasks"},

                            command     => {value => "/path/to/executor"},

                        },

                        resources => [

                            {name => "cpus", type => Mesos::Value::Type::SCALAR, scalar => {value => 1}},

                            {name => "mem",  type => Mesos::Value::Type::SCALAR, scalar => {value => 32}},

                        ],

                    });

                    $driver->launchTasks([$offer->{id}], [$task]);

                }

        }

    };



    use Mesos::SchedulerDriver;

    my $driver = Mesos::SchedulerDriver->new(

        master    => "mesoshost:5050",

        framework => {user => "mesos user", name => "awesome framework"},

        scheduler => MyScheduler->new,

    );

    $driver->run;



=head1 INSTALL



First make sure the apache mesos library is installed. This is easiest either with your native package manager, or with a package from L.



Make sure Google Protocol Buffers headers are installed, and the version is compatible with your Mesos installation.



Next just install like any other Module::Build distribution with C



Note that Mesos before v0.20 has issues with include headers not being very smart(L). Compiling against these earlier versions requires explicitly including the directory for mesos headers. By default Makefile.PL will check /usr/local/include/mesos, otherwise you may need to specify an include path using the PERL_MESOS_INCLUDE env var.



If the Mesos library/headers are installed in non-standard locations, you will need to specify these paths using the PERL_MESOS_LIB and PERL_MESOS_INCLUDE env vars.



=head1 CAVEATS



Be aware that Mesos drivers are not able to talk to remote servers from behind a NAT. Drivers are required to start an http server that the mesos master will send post requests to.



=head1 TODO



=over 4



=item maybe work on pure perl drivers



=back



=head1 SEE ALSO

 

More information about Apache Mesos, projects using Mesos, or the underlying Mesos drivers can be found at the Apache Mesos project's L or L. 



=head1 AUTHOR



Mark Flickinger [email protected]



=head1 LICENSE



This software is licensed under the same terms as Perl itself.



=cut