awscli Cookbook

Installs the AWS Command Line Interface tools and provides a set of LWRPs for use within chef cookbooks.

Benefits

The benefits of using the awscli are as follows:
* awscli is maintained by Amazon and is updated as new APIs and Services are released
* support for IAM profiles works out of the box
* automatically take advantage of features like multi-threaded download that are built into the CLI tools
* no native compilation of dependencies is necessary

Requirements

• Chef 11.6 or higher

Supported Platforms

• Ubuntu 12.04, 14.04
• CentOS 6.4, 6.5
• Amazon 2014.03

Attributes

All attributes are located under node['awscli']
<table>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Example</th>
<th>Default</th>
</tr>
<tr>
<td>version</td>
<td>The version of awscli to install</td>
<td>1.4.0</td>
<td>1.4.4</td>
</tr>
<tr>
<td>virtualenv</td>
<td>Pytdon virtualenv you would like to install awscli into</td>
<td>/home/ubuntu/my_ve</td>
<td>nil</td>
</tr>
</table>

Recipes

default

Installs the awscli tools.

Resources/Providers

awscli_s3_file

Actions

<table>
<tr>
<th>Action</th>
<th>Description</th>
</tr>
<tr>
<td>:get</td>
<td>Download a file from an s3 bucket</td>
</tr>
</table>

Attribute Parameters

<table>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>aws_access_key_id</td>
<td>AWS API Access Key ID</td>
<td>nil</td>
</tr>
<tr>
<td>aws_secret_access_key</td>
<td>AWS API Secret Access Key</td>
<td>nil</td>
</tr>
<tr>
<td>path</td>
<td>Location to store downloaded file</td>
<td>name attribute</td>
<tr>
<tr>
<td>bucket</td>
<td>S3 bucket name</td>
<td></td>
<tr>
<tr>
<td>key</td>
<td>S3 Key name to download</td>
<td></td>
<tr>
<tr>
<td>checksum</td>
<td>Sha256 checksum to validate download</td>
<td>nil</td>
<tr>
<tr>
<td>region</td>
<td>AWS endpoint region</td>
<td>us-east-1</td>
<tr>
<tr>
<td>timeout</td>
<td>Number of seconds to wait for download to complete</td>
<td>900</td>
<tr>
</table>

Usage Examples

# Provide all credential information to download file and store it to /tmp/testfile
awscli_s3_file '/tmp/testfile' do
  aws_access_key_id 'YOUR_ACCESS_KEY_ID'
  aws_secret_access_key 'YOUR_SECRET_ACCESS_KEY'
  region 'us-west-2'
  bucket 'my-test-bucket'
  key 'my_large_file.gz'
  checksum '37f9405a23d1e53082dbe9ea0ef19ec8791c778a6ecd0b02a6c1af2cf9bd4847'
  timeout 1200
end

# Do not pass any credentials to provider because our instance is on EC2 and uses an IAM Profile
awscli_s3_file '/tmp/testfile' do
  bucket 'my-test-bucket'
  key 'my_large_file.gz'
end

Testing

In order to run the integration tests for this cookbook, you must have a valid AWS account and go through a few setup steps.
Please note, you may incure AWS fees when executing the kitchen integration tests.

Local Configuration

The testing suites are setup to use environment variables to pass in end user specific information.

Variables used by .kitchen.yml

These variables are used to setup the test_get and profile_test_get (kitchen-ec2 only) suites. Kitchen will setup proper
node attributes based on these variables. See the .kitchen.yml file for information on which variables are set.

export TEST_AWS_ACCESS_KEY_ID=
export TEST_AWS_SECRET_ACCESS_KEY=
export TEST_AWS_REGION=
export TEST_BUCKET=
export TEST_KEY=
export TEST_CHECKSUM=

Variables used by .kitchen.cloud.yml

The .kitchen.cloud.yml file is used to test within EC2. In order to use it, you must configure proper AWS security credentials
as well as a few other settings. Take a look at .kitchen.cloud.yml to see which specific kitchen-ec2 variables are set from
these environment variables.

export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
export AWS_KEYPAIR_NAME=
export AWS_REGION=
export AWS_AVAILABILITY_ZONE=
export EC2_SSH_KEY_PATH=
export AWS_EC2_AMI=
export AWS_IAM_PROFILE=

AWS Configuration

test_get suite dependencies

The following items need to be setup properly in order to use the test_get suite.

• AWS S3 Bucket containing a test file
• AWS IAM Account with at least GetObject access to the bucket setup in the previous step
• AWS IAM Account API keys for the account setup in the previous step

profile_test_get suite dependencies

The following items need to be setup properly in order to use the profile_test_get suite.

• AWS S3 Bucket containing a test file
• AWS IAM Role/Profile with at least GetObject access to the bucket setup in the previous step
• AWS IAM Account API Keys for an account with enough access to run an EC2 instance

Executing the integration tests

The test_get suite will download the file by
providing the credentials configured via the environment. Those files
will then be verified against the checksum you set via
TEST_CHECKSUM. If the checksum does not match the downloaded file,
the tests will fail.

Note: kitchen-ec2 profile support is waiting for a release. If you would like to test with
IAM profiles, you will need to build the kitchen-ec2 gem from source.

The profile_test_get suite is only available when using the
kitchen-ec2 driver. The .kitchen.cloud.yml file is configured to use
the kitchen-ec2 driver. To enable this file, set the
KITCHEN_LOCAL_YAML environment variable to the path for the
.kitchen.cloud.yml file.

• IAM Role Documentation: http://docs.aws.amazon.com/IAM/latest/UserGuide/role-usecase-ec2app.html
• kitchen-ec2 plugin repository: https://github.com/test-kitchen/kitchen-ec2

Contributing

1. Fork the repository on Github: https://help.github.com/articles/fork-a-repo

2. Clone the repository locally:

   $ git clone http://github.com/awslabs/awscli-cookbook

3. Create a named feature branch:

   $ cd awscli-cookbook
   $ git checkout -b [new feature branch]

4. Add your change(s)

5. Write tests for your change(s):

   Please add tests for your changes. This helps prevent regressions in the future.

6. Install the gem dependencies:

   bundle install

7. Run the integration and spec tests to ensure they all pass:

   bundle exec rake integration

8. Run the style tests to ensure they all pass:

   bundle exec rake style

9. Update the README.md with new information if applicable.

10. Commit and push your changes up to your feature branch

11. Submit a Pull Request

License and Authors

• Author:: Nick Downs (ndowns@amazon.com)

Copyright 2014 Amazon Web Services

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.