Permalink
Browse files

COOK-819, fix doc bug in aws readme

  • Loading branch information...
1 parent ac41963 commit f1accf97ac29b01f5fd1d164993b2563a84472b4 @jtimberman jtimberman committed Nov 10, 2011
Showing with 1 addition and 8 deletions.
  1. +1 −8 aws/README.md
View
9 aws/README.md
@@ -6,15 +6,13 @@ This cookbook provides libraries, resources and providers to configure and manag
* EBS Volumes (`ebs_volume`)
* Elastic IPs (`elastic_ip`)
----
Requirements
============
Requires Chef 0.7.10 or higher for Lightweight Resource and Provider support. Chef 0.8+ is recommended. While this cookbook can be used in `chef-solo` mode, to gain the most flexibility, we recommend using `chef-client` with a Chef Server.
An Amazon Web Services account is required. The Access Key and Secret Access Key are used to authenticate with EC2.
----
AWS Credentials
===============
@@ -40,7 +38,6 @@ And to access the values:
We'll look at specific usage below.
----
Recipes
=======
@@ -55,7 +52,6 @@ The default recipe installs the `right_aws` RubyGem, which this cookbook require
The `gem_package` is created as a Ruby Object and thus installed during the Compile Phase of the Chef run.
----
Libraries
=========
@@ -65,7 +61,6 @@ The cookbook has a library module, `Opscode::AWS::Ec2`, which can be included wh
This is needed in any providers in the cookbook. Along with some helper methods used in the providers, it sets up a class variable, `ec2` that is used along with the access and secret access keys
----
Resources and Providers
=======================
@@ -110,7 +105,6 @@ Attribute Parameters:
* `timeout` - connection timeout for EC2 API.
----
Usage
=====
@@ -165,15 +159,14 @@ Then to set up the Elastic IP on a system:
aws_elastic_ip "eip_load_balancer_production" do
aws_access_key aws['aws_access_key_id']
aws_secret_access_key aws['aws_secret_access_key']
- lb ip_info['public_ip']
+ ip ip_info['public_ip']
action :associate
end
This will use the loaded `aws` and `ip_info` databags to pass the required values into the resource to configure. Note that when associating an Elastic IP to an instance, connectivity to the instance will be lost because the public IP address is changed. You will need to reconnect to the instance with the new IP.
You can also store this in a role as an attribute or assign to the node directly, if preferred.
----
License and Author
==================

0 comments on commit f1accf9

Please sign in to comment.