Module undine_tar
In: /vagrant/modules/undine_tar/lib/puppet/parser/functions/get_uri_filename.rb
/vagrant/modules/undine_tar/lib/puppet/parser/functions/is_absolute_uri.rb
/vagrant/modules/undine_tar/manifests/archive.pp
/vagrant/modules/undine_tar/manifests/init.pp
/vagrant/modules/undine_tar/lib/puppet/parser/functions/get_uri_filename.rb
/vagrant/modules/undine_tar/lib/puppet/parser/functions/is_absolute_uri.rb
/vagrant/modules/undine_tar/manifests/archive.pp
/vagrant/modules/undine_tar/manifests/init.pp

Defines

archive   archive  

Plugins

get_uri_filename   is_absolute_uri   get_uri_filename   is_absolute_uri  

Classes and Modules

Class undine_tar::undine_tar

Defines

archive( $src_password => 'undef', $src_path, $path => 'title', $src_username => 'undef', $gzip => 'false' )

Define: archive

The archive defined type is responsible for the retrieval and extraction of tar archives in Undine. It supports retrieval from the local environment or remote hosts (via wget) to a destination directory on the VM, where it is optionally extracted (as if using tar -xzf <tarball>).

When retrieving archives via wget, support is also included for basic auth.

Parameters

path
The destination directory on the local VM. Defaults to the resource title.
src_path
The source path from which to retrieve files. Can either be a local directory or an absolute URI compatible with wget.
src_username
Optional. The username to use when authenticating to the remote host using basic auth.
src_password
Optional. The password to use when authenticating to the remote host using basic auth.
gzip
Optional. Whether to use gzip decompression for the source archive. Defaults to FALSE.

Examples

Simple local usage.

  undine_tar::archive { '/path/to/dest':
    src_path => '/path/to/my/src/archive.tar',
  }

Usage via wget via basic auth, with gzip support.

  undine_tar::archive { '/path/to/dest':
    src_path => 'http://example.com/path/to/my/archive.tar.gz',
    src_username => 'jsmith',
    src_password => 'correcthorsebatterystaple',
    gzip => true,
  }
archive( $src_password => 'undef', $src_path, $path => 'title', $src_username => 'undef', $gzip => 'false' )

Define: archive

The archive defined type is responsible for the retrieval and extraction of tar archives in Undine. It supports retrieval from the local environment or remote hosts (via wget) to a destination directory on the VM, where it is optionally extracted (as if using tar -xzf <tarball>).

When retrieving archives via wget, support is also included for basic auth.

Parameters

path
The destination directory on the local VM. Defaults to the resource title.
src_path
The source path from which to retrieve files. Can either be a local directory or an absolute URI compatible with wget.
src_username
Optional. The username to use when authenticating to the remote host using basic auth.
src_password
Optional. The password to use when authenticating to the remote host using basic auth.
gzip
Optional. Whether to use gzip decompression for the source archive. Defaults to FALSE.

Examples

Simple local usage.

  undine_tar::archive { '/path/to/dest':
    src_path => '/path/to/my/src/archive.tar',
  }

Usage via wget via basic auth, with gzip support.

  undine_tar::archive { '/path/to/dest':
    src_path => 'http://example.com/path/to/my/archive.tar.gz',
    src_username => 'jsmith',
    src_password => 'correcthorsebatterystaple',
    gzip => true,
  }

[Validate]