beezly/puppet-archive

Puppet Archive

Table of Contents

1. Overview
2. Module Description
3. Setup
4. Usage
5. Reference
6. Limitations

Overview

This module manages download and deployment of archive files.

Module Description

This module uses types and providers to download and manage compress files, with optional lifecycle functionality such as checksum, extraction, and cleanup. The benefits over existing modules such as puppet-staging:

• Implemented via types and provider instead of exec resource.
• Follows 302 redirect and propagate download failure.
• Optional checksum verification of archive files.
• Automatic dependency to parent directory.
• Support Windows file extraction via 7zip.
• Able to cleanup archive files after extraction.

Setup

The module requires faraday/faraday_middleware gems on the puppet master, which are typically present because they are a dependency of r10k. This dependency is managed by specifying 'include ::archive'.

Usage

include 'archive'

archive { '/tmp/jta-1.1.jar':
  ensure        => present,
  extract       => true,
  extract_path  => '/tmp',
  source        => 'http://central.maven.org/maven2/javax/transaction/jta/1.1/jta-1.1.jar',
  checksum      => '2ca09f0b36ca7d71b762e14ea2ff09d5eac57558',
  checksum_type => 'sha1',
  creates       => '/tmp/javax',
  cleanup       => true,
}

Reference

Classes

• archive: install faraday/faraday_middleware gem, and 7zip package (Windows only).
• archive::staging: install gem/package dependencies and creates staging directory for backwards compatibility. Use the archive class instead if you do not need the staging directory.

Define Resources

• archive::artifactory: archive wrapper for JFrog Artifactory files with checksum.
• archive::go: archive wrapper for GO Continuous Delivery files with checksum.

Resources

archive { '/tmp/jta-1.1.jar':
  ensure        => present,
  source        => 'http://central.maven.org/maven2/javax/transaction/jta/1.1/jta-1.1.jar',
  checksum      => '2ca09f0b36ca7d71b762e14ea2ff09d5eac57558',
  checksum_type => 'sha1',
  extract       => true,
  extract_path  => '/tmp',
  creates       => '/tmp/javax',
  cleanup       => true,
}

Limitations

The archive::artifactory and archive::go resource need the faraday_middleware gem, and network access to the artifactory/go server to obtain the archive checksum. This gem is installed as a dependency for r10k, or otherwise this dependency should be installed as part of the puppet master initial deployment and configuration.