cookbook 's3_dir', '= 1.4.2'
s3_dir (10) Versions 1.4.2 Follow1
Installs/Configures s3_dir
cookbook 's3_dir', '= 1.4.2', :supermarket
knife supermarket install s3_dir
knife supermarket download s3_dir
s3_dir
This cookbook leverages the s3_file cookbook to recursively download all of the files in a specified S3 “directory.” It uses the et_fog cookbook cookbook to retrieve a listing of said “directories”.
Usage
Firstly, you will need to include et_fog in your recipe in order to install the Fog library in Chef, e.g.:
include_recipe 'et_fog'
s3_dir Resource
s3_dir '/local/path' do bucket 's3.bucket.name' dir 's3_directory' owner 'root' group 'root' mode '0755' recursive true region 'us-east-1' access_key_id 'ACCESS_KEY' secret_access_key 'SECRET_ACCESS_KEY' end
-
name- The local path where the files should be downloaded to -
bucket- The S3 bucket name you want to download from -
dir- The directory within the bucket where the files will come from -
owner- What you want the local file/directory owner to be set to. Defaults toroot. -
group- What you want the local file/directory group to be set to. Defaults toroot. -
mode- File permissions. Created directories will inherit these permissions plus executability. Defaults to '0755' -
recursive- Whether parent directories ofnameshould be created recursively -
region- AWS Region. Defaults tous-east-1. -
access_key_id- AWS Access Key ID -
secret_access_key- AWS Secret Key
AWS Permissions
The following minimum AWS permissions are required for s3_dir to work:
"Action": [ "s3:GetBucketLocation", "s3:GetObject", "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::bucket-name", "arn:aws:s3:::bucket-name/*" ]
However it is recommended that you request a more permissive set of permissions so as to avoid unpredictable edge cases:
"Action": [ "s3:Get*",, "s3:List*" ], "Resource": [ "arn:aws:s3:::bucket-name", "arn:aws:s3:::bucket-name/*" ]
Contributing
- Fork the repository on Github
- Create a named feature branch (i.e.
add-new-recipe) - Write your change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request
License and Authors
Author:: EverTrue, Inc. (devops@evertrue.com)
Dependent cookbooks
| s3_file ~> 2.5 |
| et_fog ~> 1.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
s3_dir CHANGELOG
v1.4.2 (2015-11-18)
- Fix recursive directory creation (h/t to @alex-pekurovsky & @eherot)
- Update the testing harnesses to bring it more up-to-date
- Update gems
- Better caching of Travis testing resources
v1.4.1 (2014-10-21)
- Update ChefSpec matchers to follow deprecations
- Update gems
- Refactor Travis config
- Update Serverspec spec_helper to work w/ Serverspec v2
v1.4.0 (2014-10-01)
- Move test code to its own embedded cookbook
- Allow alternate regions
v1.3.0 (2014-08-26)
- Add non-us-east-1 region support
v1.2.3 (2014-08-26)
- Fix the way we parse directory listings so that arrays stop turning up empty
v1.2.2 (2014-08-15)
- Several changes to get Travis-CI working in full-convergence mode.
v1.2.1 (2014-08-14)
- Fix the unit tests to match the code
v1.2.0 (2014-08-14)
- Do all testing with mock instead of depending on a private external s3 bucket.
v1.1.0 (2014-07-21)
- README cleanup
- LICENSE and maintainer info clarified
- Clean up testing situation
- ChefSpec test
- Serverspec integration tests
- Fix FC016 by adding a default action to LWRP
- Fix dependency on et_fog to properly resolve
- Add default values for
s3_dirattributes - Fix issue with mode attribute and implicit conversion b/t strings/integers
v1.0.1 (2014-06-23)
- Real README
- File mode parsing to make directories
v0.1.0 (2014-06-23)
- Initial release of s3_dir
Foodcritic Metric
1.4.2 passed this metric
1.4.2 passed this metric
