Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

s3

This module uses unicorns to fetch files from s3.
Project URLRSS FeedReport issues

14,376 downloads

14,376 latest version

3.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.0 (latest)
released Apr 2nd 2015
This version is compatible with:
  • Puppet Enterprise >3.2.0 <4.0.0
  • Puppet >3.0.0 <4.0.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'malnick-s3', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add malnick-s3
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install malnick-s3 --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

malnick/s3 — version 0.1.0 Apr 2nd 2015

#puppet-s3

Build Status Puppet Forge

Table of Contents

  1. Overview
  2. Setup
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Overview

This module presents a type and provider for fetching files from amazon s3 using IAM profiles.

Setup

gem install aws-sdk => version 2

If you've already installed version and rely on it you'll have to look into the rdoc for the SDK since V2 is reverse breaking to V1.

Mainly:

Upgrading - Client Classes - Versioned client classes removed, e.g. Aws::S3::Client::V20060301.new is now Aws::S3::Client. new The :api_version constructor option is no longer accepted.

Upgrading - Aws Module - Helper methods on Aws for client classes deprecated; For example, calling Aws.s3 will generate a deprecation warning. Use Aws::S3::Client.new instead. Helpers will be removed as of v2.0.0 final.

More information can be found here

Usage

Put the classes, types, and resources for customizing, configuring, and doing the fancy stuff with your module here.

Reference

Types

Currently this module has a single type and provider 's3'. The 's3' resource is instanciated as such:

s3 { '/path/to/file/on/my/local/filesystem':
    # Required paramters:
    ensure              => present,
    source              => '/bucket/path/to/object',
    access_key_id       => 'mysecret',
    secret_access_key   => 'anothersecret',
    # Optional parameters:
    region              => 'us-west-1', # Defaults to us-east-1
}

This provider is 'psudo-idempotent' in that the exists? method, on each run, has to pull down the S3 object in order to compare it to the one of the local filesystem.

In order to do this comparison it creates a temp file in the same path as the file on the local filesystem and pulls down the S3 resource. It then compares the MD5 checksum of each resource, the local file and the S3 object. If this returns true, the filesystem is not written to; if it returns false, the new resource is written.

Currently, on each run, the S3 object is actually pulled down twice since exists? and create methods both grab the object. This isn't great for performance and I would like to update this in future versions.

Limitations

The S3 type and provider rely on aws-sdk 'version -> 2'. There is a feature which the provider is :confined to that will post-pone S3 resources until the gems for the aws-sdk are present on the local filesystem. Ensure to include s3 in your catalogue so those gems get installed.

Todo

  • Better &more testing.
  • Better checking to determine if a file must be downloaded or not

Development

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Contributors

Individual contributors can be found at: [https://github.com/malnick/puppet-s3/graphs/contributors]