Forge Home

s3cmd

s3cmd module

18,401 downloads

10,378 latest version

4.3 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.1 (latest)
  • 0.1.0
  • 0.0.2
  • 0.0.1
released Oct 24th 2015
This version is compatible with:
  • Puppet Enterprise >=2.7.0 <5.0.0
  • Puppet >=2.7.0 <5.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'golja-s3cmd', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add golja-s3cmd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install golja-s3cmd --version 0.1.1

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

golja/s3cmd — version 0.1.1 Oct 24th 2015

#s3cmd puppet module

##Overview

Install s3cmd on Ubuntu/Debian/RedHat/CentOS/Amazon AMI from OS repo or in RedHat/CentOS case from the s3tools repository.

Tested with Travis

Build Status

##Installation

 $ puppet module install golja/s3cmd

##Usage

###Install s3cmd package

include '::s3cmd'

###Create .s3cfg configuration for user root

s3cmd::config {'root':
  aws_access_key => 'AUIAJYSJQT5WQ5S7EISQ',
  aws_secret_key  => 'Kd24SfkdcQfsS4294MSKAS432',
}

###Parameters

####s3cmd

#####ensure

Valid value present/absent

####s3cmd::config

#####aws_access_key

REQUIRED - AWS key with S3 privileges to modify data in the S3

#####aws_secret_key

REQUIRED - AWS secret key

#####ensure

Remove or install the s3cmd config file. Possible values present or absent Default: present

#####bucket_location

AWS S3 supports the following buckets: US, EU or eu-west-1, us-west-1 (Oregon), us-west-1 (N California), ap-southeast-1 (Singapore), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo) and sa-east-1 (Sao Paulo). Default: US

#####use_https

If use HTTPS protocol for communication with Amazon S3. Default: True

#####encryption_passphrase

Encryption password is used to protect your files from reading by unauthorized persons while in transfer to S3. Default: undef

#####user

system username which defines the .s3cfg file location. Default: $title

#####home_dir

Overwrites the default home dir of the user in case you are not using /home or /root for root. Default: undef

#####path_to_gpg

Path to GPG if encryption is enabled. Default: /usr/bin/gpg

#####proxy_host

Proxy server. Default: undef

#####proxy_port

Proxy port. Default: undef

Supported Platforms

  • Debian Wheezy
  • Ubuntu 12+
  • RedHat 5/6
  • CentOS 5/6
  • Amazon AMI

License

See LICENSE file