From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

 / 
Footprintless-1.06
River stage one • 3 direct dependents • 3 total dependents
/ Footprintless::Overlay

NAME

Footprintless::Overlay - An overlay manager

VERSION

version 1.06

SYNOPSIS


            

              
              
# Standard way of getting an overlay
use Footprintless;
my $overlay = Footprintless->new()->overlay('overlay');
$overlay->clean();
$overlay->initialize();
$overlay->update();

DESCRIPTION

Overlays are a combination of a directory of static files and a directory of templated files that will be merged to an output directory. This is implemented in Template::Overlay.

ENTITIES

A simple overlay:


            

              
              
overlay => {
    base_dir => "/home/me/foo/base",
    clean => [
        "/opt/tomcat/"
    ],
    hostname => 'localhost',
    key => 'T',
    os => 'linux',
    template_dir => "/home/me/foo/template",
    to_dir => '/opt/foo/tomcat'
}

A more complex example:


            

              
              
foo => {
    hostname => 'test.pastdev.com',
    overlay => {
        'Config::Entities::inherit' => ['hostname', 'sudo_username'],
        base_dir => '/home/me/foo/base',
        clean => [
            '/opt/foo/tomcat/'
        ],
        key => 'T',
        os => 'linux',
        resolver_coordinate => 'foo',
        template_dir => '/home/me/foo/template',
        to_dir => '/opt/foo/tomcat'
    },
    sudo_username => 'developer',
    tomcat => {
        'Config::Entities::inherit' => ['hostname', 'sudo_username'],
        catalina_base => '/opt/foo/tomcat',
        http => {
            port => 20080
        },
        service => {
            action => {
                'kill' => { command_args => 'stop -force' },
                'status' => { use_pid => 1 }
            },
            command => '/opt/foo/tomcat/bin/catalina.sh',
            pid_file => '/opt/foo/tomcat/bin/.catalina.pid',
        },
        shutdown => {
            port => 8505,
            password => $properties->{'foo.tomcat.shutdown.password'},
        },
        trust_store => {
            'Config::Entities::inherit' => ['hostname', 'sudo_username'],
            file => '/opt/foo/tomcat/certs/truststore.jks',
            include_java_home_cacerts => 1,
            password => $properties->{'foo.tomcat.trust_store.password'},
        }
    }
}

CONSTRUCTORS

new($entity, $coordinate)

Constructs a new overlay configured by $entities at $coordinate.

METHODS

clean()

Cleans the overlay. Each path in the clean entity, will be removed from the destination. If the path ends in a /, then after being removed, the directory will be recreated.

initialize()

Will call clean, then overlay on an instance of Template::Overlay configured to this entity.

update()

Will overlay ONLY the templated files. It will not clean, nor copy any files from base_dir like initialize does.

AUTHOR

Lucas Theisen <lucastheisen@pastdev.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Lucas Theisen.

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

SEE ALSO

Please see those modules/websites for more information related to this module.

CONFIGURATION

This module can optionally be configured to use a customized resolver. To do so, configure a resolver factory in your entities:


            

              
              
footprintless => {
    overlay => {
        resolver_factory => 'My::ResolverFactory'
    }
}

The resolver factory must have a new_resolver method that takes a spec and a list of options and returns a Template::Resolver, for example:


            

              
              
sub new_resolver {
    my ($self, $resolver_spec, %resolver_opts) = @_;
    return Template::Resolver->new(
        $resolver_spec,
        %resolver_opts,
        additional_transforms => {
            random => sub {
                my ($resolver_self, $value) = @_;
                return $value . rand();
            }
        });
}