3rdparty/modules/staging/README.md

   1 # Staging module for Puppet
   2
   3 Manages staging directory, along with download/extraction of compressed files.
   4
   5 [![Build Status](https://secure.travis-ci.org/nanliu/puppet-staging.png?branch=master)](http://travis-ci.org/nanliu/puppet-staging)
   6
   7 WARNING: Version 0.2.0 no longer uses hiera functions. The same behavior should be available in Puppet 3.0.
   8
   9 NOTE: Version 1.0.0 will be the last feature release. New functionality such as checksum will be implemented in a type/provider module [puppet-archive](https://www.github.com/nanliu/puppet-archive).
  10
  11 ## Usage
  12
  13 Specify a different default staging path (must be declared before using resource):
  14 ```puppet
  15 class { 'staging':
  16   path  => '/var/staging',
  17   owner => 'puppet',
  18   group => 'puppet',
  19 }
  20 ```
  21
  22 Staging files from various sources:
  23 ```puppet
  24 staging::file { 'sample':
  25   source => 'puppet://modules/staging/sample',
  26 }
  27
  28 staging::file { 'apache-tomcat-6.0.35':
  29   source => 'http://apache.cs.utah.edu/tomcat/tomcat-6/v6.0.35/bin/apache-tomcat-6.0.35.tar.gz',
  30 }
  31 ```
  32
  33 Staging and extracting files:
  34 ```puppet
  35 staging::file { 'sample.tar.gz':
  36   source => 'puppet:///modules/staging/sample.tar.gz'
  37 }
  38
  39 staging::extract { 'sample.tar.gz':
  40   target  => '/tmp/staging',
  41   creates => '/tmp/staging/sample',
  42   require => Staging::File['sample.tar.gz'],
  43 }
  44 ```
  45
  46 Deploying a file (combining staging and extract):
  47 ```puppet
  48 staging::deploy { 'sample.tar.gz':
  49   source => 'puppet:///modules/staging/sample.tar.gz',
  50   target => '/usr/local',
  51 }
  52 ```
  53
  54 Staging files currently support the following source:
  55
  56 * http(s)://
  57 * puppet://
  58 * ftp://
  59 * s3:// (requires aws cli to be installed and configured.)
  60 * local (though this doesn't serve any real purpose.)
  61
  62 ## Contributor
  63
  64 * Adrien Thebo
  65 * gizero
  66 * Harald Skoglund
  67 * Hunter Haugen
  68 * Justin Clayton
  69 * Owen Jacobson
  70 * Reid Vandewiele