chef-provisioning-aws 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77fad1ecfeeb4dabe26c39612eb4c1bde17b8e1a
-  data.tar.gz: 643e9aa5dd7a32eff6c87e5882aeccfc72c971d4
+  metadata.gz: 152994be990de9eda227b6a5be1179acea932c78
+  data.tar.gz: 1c58f8b2be7da9e3a779dae16ba2ff445de4370d
 SHA512:
-  metadata.gz: 274e85302ec8c237728a247f79da29e3a7550ba1a8209fbd26e36fd5fe48f3043fe11cc62f393460790d61b77a78049048febc58bc64783c41ff057d80fd8bf2
-  data.tar.gz: 71cfa5429bec399ce37837713521e3653c8d0f4b10f30f2a726b48327fa40e774255b580e932e986cf0e870d7c532340cce360958ca36e6c3ff491866e00cb28
+  metadata.gz: aba82b6a79304d5786b8b686aad781c18add3fac6b1d52c52b300dffd38ec93b2262cda6be721de582f5382cea04a08435f3a3001bd4857415743713a0ca4e66
+  data.tar.gz: 2e70c7a272b3902b7b8a96a70f4a70a99f9a6ee3d38e1ef3c329efef09f055129d2a97202d00dcc08f6ec0e3d32e171f908dea6eef093de97c853cb37ac9e9f3

data/README.md

@@ -18,6 +18,39 @@ because users can look at the resource model.
 TODO: document `aws_object` and `get_aws_object` and how you can get the aws object for a base
 chef-provisioning resource like machine or load_balancer
 
+## aws_key_pair
+
+You can specify an existing key pair to upload by specifying the following:
+
+```ruby
+aws_key_pair 'my-aws-key' do
+  private_key_path "~boiardi/.ssh/my-aws-key.pem"
+  public_key_path "~boiardi/.ssh/my-aws-key.pub"
+  overwrite false # Set to true if you want to regenerate this each chef run
+end
+```
+
+## aws_launch_configuration
+
+In the AWS SDK V1, you must specify `key_pair` instead of `key_name` when specifying the key name to use for machines in the auto scaling group.  This is fixed in V2 and uses `key_name` like machines do.
+
+```ruby
+aws_launch_configuration 'example-windows-launch-configuration' do
+  image 'example-windows-image'
+  instance_type 't2.medium'
+  options security_groups: 'example-windows-sg',
+    key_pair: 'my-key-name',
+    ebs_optimized: false,
+    detailed_instance_monitoring: false,
+    iam_instance_profile: 'example-windows-role',
+    user_data: <<-EOF
+<powershell>
+# custom powershell code goes here, executed at instance creation time
+</powershell>
+  EOF
+end
+```
+
 ## aws_vpc
 
 If you specify `internet_gateway true` the VPC will create and manage its own internet gateway.
@@ -66,11 +99,9 @@ If you `:purge` a VPC and it has `aws_route_table[ref-route]` in it, the data ba
 `ref-route` is not automatically destroyed.  Purge is most useful for testing to ensure no objects
 are left that AWS can charge for.
 
-## aws_key_pair
-
-TODO - document how to specify an existing local key 
+# Machine Options
 
-## Machine Options
+TODO - Finish documenting these
 
 You can pass machine options that will be used by `machine`, `machine_batch` and `machine_image` to
 configure the machine.  These are all the available options:
@@ -78,9 +109,52 @@ configure the machine.  These are all the available options:
 ```ruby
 with_machine_options({
   bootstrap_options: {
-    key_name: 'ref-key-pair',
+    # http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Resource.html#create_instances-instance_method
+    # lists the available options.  The below options are the default
+    image_id: "ami-5915e11d", # default for us-west-1
+    instance_type: "t2.micro",
+    key_name: "chef_default", # If not specified, this will be used and generated
+    key_path: "~/.chef/keys/chef_default", # only necessary if storing keys some other location
+    user_data: "...", # Only defaulted on Windows instances to start winrm
+  },
+  convergence_options: {
+    chef_version: "12.4.1",
+    prerelease: "false",
+    chef_client_timeout: 120*60, # Default: 2 hours
+    chef_config: "log_level :debug\\n", # String containing additional text to inject into client.rb
+    chef_server: "http://my.chef.server/", # TODO could conflict with https://github.com/chef/chef-provisioning#pointing-boxes-at-chef-servers
+    bootstrap_proxy: "http://localhost:1234",
+    ssl_verify_mode: :verify_peer,
+    client_rb_path: "/etc/chef/client.rb", # <- DEFAULT, overwrite if necessary
+    client_pem_path: "/etc/chef/client.pem", # <- DEFAULT, overwrite if necessary
+    allow_overwrite_keys: false, # If there is an existing client.pem this needs to be true to overwrite it
+    private_key_options: {}, # TODO ????? Something to do with creating node object
+    source_key: "", # ?????
+    source_key_pass_phrase: "", # ?????
+    source_key_path: "", # ?????
+    public_key_path: "", # ?????
+    public_key_format: "", # ?????
+    admin: "", # ?????
+    validator: "", # ?????
+    ohai_hints: { :ec2 => { :key => :value } }, # Map from hint file name to file contents, this would create /etc/chef/ohai/hints/ec2.json
+    # The following are only available for Linux machines
+    install_sh_url: "https://www.chef.io/chef/install.sh", # <- DEFAULT, overwrite if necessary
+    install_sh_path: "/tmp/chef-install.sh", # <- DEFAULT, overwrite if necessary
+    install_sh_arguments: "-P chef-dk", # Additional commands to pass to install.sh
+    # The following are only available for Windows machines
+    install_msi_url: "foo://bar.com"
+  },
+  ssh_options: {
     ...
   },
+  cached_installer: false, # ???
+  aws_tags: { :key1 => "value", "key2" => "value"},
+  source_dest_check: false, # Specifies whether to enable an instance launched in a VPC to perform NAT
+  is_windows: false, # set to true if using a Windows AMI
+  ssh_username: "ubuntu",
+  ssh_gateway: "localhost"
+  sudo: true,
+  use_private_ip_for_ssh: false, # If set to true, we will access the instance with its private_ip (usually requires VPN access)
   ...
 })
 ```
@@ -88,9 +162,102 @@ with_machine_options({
 This options hash can be supplied to either `with_machine_options` or directly into the `machine_options`
 attribute.
 
-## Looking up AWS objects
+# Load Balancer Options
+
+You can configure the ELB options by setting `with_load_balancer_options` or specifying them on each `load_balancer` resource.
+
+```ruby
+machine 'test1'
+m2 = machine 'test2'
+load_balancer "my_elb" do
+  machines ['test1', m2]
+  load_balancer_options({
+    subnets: subnets,
+    security_groups: [load_balancer_sg],
+    listeners: [
+      {
+          instance_port: 8080,
+          protocol: 'HTTP',
+          instance_protocol: 'HTTP',
+          port: 80
+      },
+      {
+          instance_port: 8080,
+          protocol: 'HTTPS',
+          instance_protocol: 'HTTP',
+          port: 443,
+          ssl_certificate_id: "arn:aws:iam::360965486607:server-certificate/cloudfront/foreflight-2015-07-09"
+      }
+    ]
+  })
+```
+
+The available parameters for `load_balancer_options` can be viewed at http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/ELB/Client.html#create_load_balancer-instance_method .
+
+NOTES:
+
+1. You can specify either `ssl_certificate_id` or `server_certificate` in a listener but the value to both parameters should be the ARN of an existing IAM::ServerCertificate object.
+2. Instead of specifying `tags` in the `load_balancer_options`, you should specify `aws_tags`.  See the note on [tagging base resources](https://github.com/chef/chef-provisioning-aws#base-resources).
+
+# Specifying a Chef Server
+
+See [Pointing Boxes at Chef Servers](https://github.com/chef/chef-provisioning/blob/master/README.md#pointing-boxes-at-chef-servers)
+
+# Tagging Resources
+
+## Aws Resources
+
+All resources which extend Chef::Provisioning::AWSDriver::AWSResourceWithEntry support the ability
+to add tags, except AwsEipAddress.  AWS does not support tagging on AwsEipAddress.  To add a tag
+to any aws resource, us the `aws_tags` attribute and provide it a hash:
+
+```ruby
+aws_ebs_volume 'ref-volume' do
+  aws_tags company: 'my_company', 'key_as_string' => :value_as_symbol
+end
+
+aws_vpc 'ref-vpc' do
+  aws_tags 'Name' => 'custom-vpc-name'
+end
+```
+
+The hash of tags can use symbols or strings for both keys and values.  The tags will be converged
+idempotently, meaning no write will occur if no tags are changing.
+
+We will not touch the `'Name'` tag UNLESS you specifically pass it.  If you do not pass it, we
+leave it alone.
+
+## Base Resources
+
+Because base resources from chef-provisioning do not have the `aws_tag` attribute, they must be
+tagged in their options:
+
+```ruby
+machine 'ref-machine-1' do
+  machine_options :aws_tags => {:marco => 'polo', :happyhappy => 'joyjoy'}
+end
+
+machine_batch "ref-batch" do
+  machine 'ref-machine-2' do
+    machine_options :aws_tags => {:marco => 'polo', :happyhappy => 'joyjoy'}
+    converge false
+  end
+  machine 'ref-machine-3' do
+    machine_options :aws_tags => {:othercustomtags => 'byebye'}
+    converge false
+  end
+end
+
+load_balancer 'ref-elb' do
+  load_balancer_options :aws_tags => {:marco => 'polo', :happyhappy => 'joyjoy'}
+end
+```
+
+See `docs/examples/aws_tags.rb` for further examples.
+
+# Looking up AWS objects
 
-### \#aws\_object
+## \#aws\_object
 
 All chef-provisioning-aws resources have a `aws_object` method that will return the AWS object.  The AWS
 object won't exist until the resource converges, however.  An example of how to do this looks like:
@@ -131,7 +298,7 @@ end
 Note the use of the `lazy` attribute modifier.  This is necessary because when the resources are compiled
 the aws_objects do not exist yet, so we must wait to reference them until the converge phase.
 
-### \#lookup\_options
+## \#lookup\_options
 
 You have access to the aws object when necessary, but often it isn't needed.  The above example is better
 written as:
@@ -168,7 +335,7 @@ perform [lookup_options](https://github.com/chef/chef-provisioning-aws/blob/mast
 This tries to turn elements with names like `vpc`, `security_group_ids`, `machines`, `launch_configurations`,
 `load_balancers`, etc. to the correct AWS object.
 
-### Looking up chef-provisioning resources
+## Looking up chef-provisioning resources
 
 The base chef-provisioning resources (machine, machine_batch, load_balancer, machine_image) don't
 have the `aws_object` method defined on them because they are not `AWSResource` classes.  To
@@ -216,55 +383,3 @@ you!
 If you find the tests leaving behind resources during normal conditions (IE, not when there is an
 unexpected exception) please file a bug.  Most objects can be cleaned up by deleting the `test_vpc`
 from within the AWS browser console.
-
-# Tagging Resources
-
-## Aws Resources
-
-All resources which extend Chef::Provisioning::AWSDriver::AWSResourceWithEntry support the ability
-to add tags, except AwsEipAddress.  AWS does not support tagging on AwsEipAddress.  To add a tag
-to any aws resource, us the `aws_tags` attribute and provide it a hash:
-
-```ruby
-aws_ebs_volume 'ref-volume' do
-  aws_tags company: 'my_company', 'key_as_string' => :value_as_symbol
-end
-
-aws_vpc 'ref-vpc' do
-  aws_tags 'Name' => 'custom-vpc-name'
-end
-```
-
-The hash of tags can use symbols or strings for both keys and values.  The tags will be converged
-idempotently, meaning no write will occur if no tags are changing.
-
-We will not touch the `'Name'` tag UNLESS you specifically pass it.  If you do not pass it, we
-leave it alone.
-
-## Base Resources
-
-Because base resources from chef-provisioning do not have the `aws_tag` attribute, they must be
-tagged in their options:
-
-```ruby
-machine 'ref-machine-1' do
-  machine_options :aws_tags => {:marco => 'polo', :happyhappy => 'joyjoy'}
-end
-
-machine_batch "ref-batch" do
-  machine 'ref-machine-2' do
-    machine_options :aws_tags => {:marco => 'polo', :happyhappy => 'joyjoy'}
-    converge false
-  end
-  machine 'ref-machine-3' do
-    machine_options :aws_tags => {:othercustomtags => 'byebye'}
-    converge false
-  end
-end
-
-load_balancer 'ref-elb' do
-  load_balancer_options :aws_tags => {:marco => 'polo', :happyhappy => 'joyjoy'}
-end
-```
-
-See `docs/examples/aws_tags.rb` for further examples.

data/lib/chef/provider/aws_dhcp_options.rb

@@ -12,7 +12,7 @@ class Chef::Provider::AwsDhcpOptions < Chef::Provisioning::AWSDriver::AWSProvide
 
     converge_by "create new dhcp_options #{new_resource.name} in #{region}" do
       dhcp_options = new_resource.driver.ec2.dhcp_options.create(options)
-      Retryable.retryable(:tries => 15, :sleep => 1, :on => AWS::EC2::Errors::InvalidDhcpOptionsID::NotFound) do
+      retry_with_backoff(AWS::EC2::Errors::InvalidDhcpOptionsID::NotFound) do
         dhcp_options.tags['Name'] = new_resource.name
       end
       dhcp_options

data/lib/chef/provider/aws_ebs_volume.rb

@@ -36,7 +36,10 @@ class Chef::Provider::AwsEbsVolume < Chef::Provisioning::AWSDriver::AWSProvider
     volume = nil
     converge_by "create new #{new_resource} in #{region}" do
       volume = new_resource.driver.ec2.volumes.create(initial_options)
-      volume.tags['Name'] = new_resource.name
+      retry_with_backoff(AWS::EC2::Errors::InvalidVolumeID::NotFound) do
+        volume.tags['Name'] = new_resource.name
+      end
+      volume
     end
 
     converge_by "wait for new #{new_resource} in #{region} to become available" do

data/lib/chef/provider/aws_network_acl.rb

@@ -20,7 +20,7 @@ class Chef::Provider::AwsNetworkAcl < Chef::Provisioning::AWSDriver::AWSProvider
       Chef::Log.debug("VPC: #{options[:vpc]}")
 
       network_acl = new_resource.driver.ec2.network_acls.create(options)
-      Retryable.retryable(:tries => 15, :sleep => 1, :on => AWS::EC2::Errors::InvalidNetworkAclID::NotFound) do
+      retry_with_backoff(AWS::EC2::Errors::InvalidNetworkAclID::NotFound) do
         network_acl.tags['Name'] = new_resource.name
       end
       network_acl

data/lib/chef/provider/aws_network_interface.rb

@@ -36,7 +36,10 @@ class Chef::Provider::AwsNetworkInterface < Chef::Provisioning::AWSDriver::AWSPr
     eni = nil
     converge_by "create new #{new_resource} in #{region}" do
       eni = new_resource.driver.ec2.network_interfaces.create(options)
-      eni.tags['Name'] = new_resource.name
+      retry_with_backoff(AWS::EC2::Errors::InvalidNetworkInterfaceID::NotFound) do
+        eni.tags['Name'] = new_resource.name
+      end
+      eni
     end
 
     converge_by "wait for new #{new_resource} in #{region} to become available" do
@@ -149,7 +152,7 @@ class Chef::Provider::AwsNetworkInterface < Chef::Provisioning::AWSDriver::AWSPr
     end
     eni
   end
-    
+
   def wait_for_eni_status(eni, expected_status)
     initial_status = eni.status
     log_callback = proc {

data/lib/chef/provider/aws_route_table.rb

@@ -23,7 +23,7 @@ class Chef::Provider::AwsRouteTable < Chef::Provisioning::AWSDriver::AWSProvider
 
     converge_by "create new route table #{new_resource.name} in VPC #{new_resource.vpc} (#{vpc.id}) and region #{region}" do
       route_table = new_resource.driver.ec2.route_tables.create(options)
-      Retryable.retryable(:tries => 15, :sleep => 1, :on => AWS::EC2::Errors::InvalidRouteTableID::NotFound) do
+      retry_with_backoff(AWS::EC2::Errors::InvalidRouteTableID::NotFound) do
         route_table.tags['Name'] = new_resource.name
       end
       route_table

data/lib/chef/provider/aws_sqs_queue.rb

@@ -4,12 +4,8 @@ class Chef::Provider::AwsSqsQueue < Chef::Provisioning::AWSDriver::AWSProvider
 
   def create_aws_object
     converge_by "create new SQS queue #{new_resource.name} in #{region}" do
-      # TODO need timeout here.
-      begin
+      retry_with_backoff(AWS::SQS::Errors::QueueDeletedRecently) do
         new_resource.driver.sqs.queues.create(new_resource.name, new_resource.options || {})
-      rescue AWS::SQS::Errors::QueueDeletedRecently
-        sleep 5
-        retry
       end
     end
   end

data/lib/chef/provider/aws_subnet.rb

@@ -32,8 +32,10 @@ class Chef::Provider::AwsSubnet < Chef::Provisioning::AWSDriver::AWSProvider
 
     converge_by "create new subnet #{new_resource.name} with CIDR #{cidr_block} in VPC #{new_resource.vpc} (#{options[:vpc]}) in #{region}" do
       subnet = new_resource.driver.ec2.subnets.create(cidr_block, options)
-      subnet.tags['Name'] = new_resource.name
-      subnet.tags['VPC'] = new_resource.vpc
+      retry_with_backoff(AWS::EC2::Errors::InvalidSubnetID::NotFound) do
+        subnet.tags['Name'] = new_resource.name
+        subnet.tags['VPC'] = new_resource.vpc
+      end
       subnet
     end
   end

data/lib/chef/provider/aws_vpc.rb

@@ -5,6 +5,8 @@ require 'retryable'
 
 class Chef::Provider::AwsVpc < Chef::Provisioning::AWSDriver::AWSProvider
 
+  class NeverObtainedExistence < RuntimeError; end
+
   def action_create
     vpc = super
 
@@ -165,8 +167,8 @@ class Chef::Provider::AwsVpc < Chef::Provisioning::AWSDriver::AWSProvider
       if !current_ig
         converge_by "attach new Internet Gateway to VPC #{vpc.id}" do
           current_ig = AWS.ec2(config: vpc.config).internet_gateways.create
-          Retryable.retryable(:tries => 15, :sleep => 1, :matching => /never obtained existence/) do
-            raise "internet gateway for VPC #{vpc.id} never obtained existence" unless current_ig.exists?
+          retry_with_backoff(NeverObtainedExistence) do
+            raise NeverObtainedExistence.new("internet gateway for VPC #{vpc.id} never obtained existence") unless current_ig.exists?
           end
           action_handler.report_progress "create Internet Gateway #{current_ig.id}"
           current_ig.tags['OwnedByVPC'] = vpc.id

data/lib/chef/provisioning/aws_driver/aws_provider.rb

@@ -276,7 +276,7 @@ class AWSProvider < Chef::Provider::LWRPBase
     expected_status = [expected_status].flatten
     current_status = aws_object.status
 
-    Retryable.retryable(:tries => tries, :sleep => sleep, :on => StatusTimeoutError) do |retries, exception|
+    Retryable.retryable(:tries => tries, :sleep => sleep) do |retries, exception|
       action_handler.report_progress "waited #{retries*sleep}/#{tries*sleep}s for #{aws_object.id} status to change to #{expected_status.inspect}..."
       begin
         current_status = aws_object.status
@@ -301,7 +301,7 @@ class AWSProvider < Chef::Provider::LWRPBase
     expected_states = [expected_states].flatten
     current_state = aws_object.state
 
-    Retryable.retryable(:tries => tries, :sleep => sleep, :on => StatusTimeoutError) do |retries, exception|
+    Retryable.retryable(:tries => tries, :sleep => sleep) do |retries, exception|
       action_handler.report_progress "waited #{retries*sleep}/#{tries*sleep}s for #{aws_object.id} state to change to #{expected_states.inspect}..."
       begin
         current_state = aws_object.state
@@ -313,5 +313,12 @@ class AWSProvider < Chef::Provider::LWRPBase
     end
   end
 
+  # Retry a block with an doubling backoff time (maximum wait of 10 seconds).
+  # @param retry_on [Exception] An exception to retry on, defaults to RuntimeError
+  #
+  def retry_with_backoff(retry_on = RuntimeError, &block)
+    Retryable.retryable(:tries => 10, :sleep => lambda { |n| [2**n, 10].min }, :on => retry_on, &block)
+  end
+
 end
 end

data/lib/chef/provisioning/aws_driver/driver.rb

@@ -254,7 +254,8 @@ module AWSDriver
                   listener.delete
                   actual_elb.listeners.create(desired_listener)
                 end
-              elsif listener.server_certificate != desired_listener[:server_certificate]
+              elsif ! server_certificate_eql?(listener.server_certificate,
+                                              server_cert_from_spec(desired_listener))
                 # Server certificate is mutable - if no immutable changes required a full recreate, update cert
                 perform_action.call("    update server certificate from #{listener.server_certificate} to #{desired_listener[:server_certificate]}") do
                   listener.server_certificate = desired_listener[:server_certificate]
@@ -360,6 +361,34 @@ module AWSDriver
       end
     end
 
+    # Compare two server certificates by casting them both to strings.
+    #
+    # The parameters should either be a String containing the
+    # certificate ARN, or a IAM::ServerCertificate object.
+    def server_certificate_eql?(cert1, cert2)
+      server_cert_to_string(cert1) == server_cert_to_string(cert2)
+    end
+
+    def server_cert_to_string(cert)
+      if cert.respond_to?(:arn)
+        cert.arn
+      else
+        cert
+      end
+    end
+
+    # Retreive the server certificate from a listener spec, prefering
+    # the server_certificate key.
+    def server_cert_from_spec(spec)
+      if spec[:server_certificate]
+        spec[:server_certificate]
+      elsif spec[:ssl_certificate_id]
+        spec[:ssl_certificate_id]
+      else
+        nil
+      end
+    end
+
     def ready_load_balancer(action_handler, lb_spec, lb_options, machine_spec)
     end
 
@@ -626,7 +655,7 @@ EOD
 
       if machine_options[:is_windows]
         Chef::Log.debug "Setting WinRM userdata..."
-        bootstrap_options[:user_data] = user_data
+        bootstrap_options[:user_data] = user_data if bootstrap_options[:user_data].nil?
       else
         Chef::Log.debug "Non-windows, not setting userdata"
       end

data/lib/chef/provisioning/aws_driver/version.rb

@@ -1,7 +1,7 @@
 class Chef
 module Provisioning
 module AWSDriver
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end
 end
 end

data/lib/chef/resource/aws_cache_cluster.rb

@@ -1,6 +1,9 @@
 require 'chef/provisioning/aws_driver/aws_resource'
 require 'chef/resource/aws_security_group'
 
+# AWS Elasticache Cluster
+#
+# @see http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/ElastiCache/Client/V20140930.html#create_cache_cluster-instance_method
 class Chef::Resource::AwsCacheCluster < Chef::Provisioning::AWSDriver::AWSResource
   # Note: There isn't actually an SDK class for Elasticache.
   aws_sdk_type AWS::ElastiCache
@@ -9,17 +12,59 @@ class Chef::Resource::AwsCacheCluster < Chef::Provisioning::AWSDriver::AWSResour
   # for information on possible values for each attribute. Values are passed
   # straight through to AWS, with the exception of security_groups, which
   # may contain a reference to a Chef aws_security_group resource.
+
+
+  # Cluster Name
+  #
+  # @param :cluster_name [String] unique name for a cluster
   attribute :cluster_name, kind_of: String, name_attribute: true
+
+  # Availability Zone
+  #
+  # @param :az_mode [String] Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. This parameter is only supported for Memcached cache clusters. If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
   attribute :az_mode, kind_of: String
+
+  # Preferred Availability Zone
+  #
+  # @param :preferred_availability_zone [String] preferred availability zone of the cache cluster
   attribute :preferred_availability_zone, kind_of: String
+
+  # Preferred Availability Zones
+  #
+  # @param :preferred_availability_zones [String, Array] One or more preferred availability zones
   attribute :preferred_availability_zones,
             kind_of: [ String, Array ],
             coerce: proc { |v| [v].flatten }
+
+
+  # Number of Nodes
+  #
+  # @param :number_nodes [Integer] Number of nodes in the cache
   attribute :number_nodes, kind_of: Integer, default: 1
+
+  # Node type
+  #
+  # @param :node_type [String] AWS node type for each cache cluster node
   attribute :node_type, kind_of: String, required: true
+
+  # Engine
+  #
+  # @param :engine [String] Valid values are `memcached` or `redis`
   attribute :engine, kind_of: String, required: true
+
+  # Engine Version
+  #
+  # @param :engine_version [String] The version number of the cache engine to be used for this cache cluster. 
   attribute :engine_version, kind_of: String, required: true
+
+  # Subnet Group Name
+  #
+  # @param :subnet_group_name [String] Cache cluster aws_cache_subnet_group
   attribute :subnet_group_name, kind_of: String
+
+  # Security Groups
+  #
+  # @param :security_groups [String, Array, AwsSecurityGroup, AWS::EC2::SecurityGroup] one or more VPC security groups associated with the cache cluster.
   attribute :security_groups,
             kind_of: [ String, Array, AwsSecurityGroup, AWS::EC2::SecurityGroup ],
             required: true,

data/lib/chef/resource/aws_cache_replication_group.rb

@@ -1,6 +1,8 @@
 require 'chef/provisioning/aws_driver/aws_resource'
 require 'chef/resource/aws_security_group'
 
+# AWS Elasticache Replication Group
+# @see See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/ElastiCache/Client/V20140930.html#create_replication_group-instance_method
 class Chef::Resource::AwsCacheReplicationGroup < Chef::Provisioning::AWSDriver::AWSResource
   # Note: There isn't actually an SDK class for Elasticache.
   aws_sdk_type AWS::ElastiCache
@@ -9,18 +11,58 @@ class Chef::Resource::AwsCacheReplicationGroup < Chef::Provisioning::AWSDriver::
   # for information on possible values for each attribute. Values are passed
   # straight through to AWS, with the exception of security_groups, which
   # may contain a reference to a Chef aws_security_group resource.
+
+  # Group Name
+  #
+  # @param :group_name [String] Elasticache replication group name.
   attribute :group_name, kind_of: String, name_attribute: true
+
+  # Replication group description
+  #
+  # @param :description [String] Elasticache replication group description.
   attribute :description, kind_of: String, required: true
+
+  # Automatic failover
+  #
+  # @param :automatic_failover [Boolean] Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
   attribute :automatic_failover, kind_of: [TrueClass, FalseClass], default: false
+
+  # Number of cache clusters
+  #
+  # @param :number_cache_clusters [Integer] Number of cache clusters.
   attribute :number_cache_clusters, kind_of: Integer, default: 2
+
+  # Node type
+  #
+  # @param :node_type [String] AWS node type for each replication group.
   attribute :node_type, kind_of: String, required: true
+
+  # Engine
+  #
+  # @param :engine [String] Valid values are `memcached` or `redis`.
   attribute :engine, kind_of: String, required: true
+
+  # Engine Version
+  #
+  # @param :engine_version [String] The version number of the cache engine.
   attribute :engine_version, kind_of: String, required: true
+
+  # Subnet group name
+  #
+  # @param :subnet_group_name [String] Cache cluster aws_cache_subnet_group.
   attribute :subnet_group_name, kind_of: String
+
+  # Security Groups
+  #
+  # @param
   attribute :security_groups,
             kind_of: [ String, Array, AwsSecurityGroup, AWS::EC2::SecurityGroup ],
             required: true,
             coerce: proc { |v| [v].flatten }
+
+  # Group Name
+  #
+  # @param
   attribute :preferred_availability_zones,
             kind_of: [ String, Array ],
             coerce: proc { |v| [v].flatten }

data/lib/chef/resource/aws_cache_subnet_group.rb

@@ -1,6 +1,8 @@
 require 'chef/provisioning/aws_driver/aws_resource'
 require 'chef/resource/aws_subnet'
 
+# AWS Elasticache Subnet Group
+# @see http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/ElastiCache/Client/V20140930.html#create_cache_subnet_group-instance_method
 class Chef::Resource::AwsCacheSubnetGroup < Chef::Provisioning::AWSDriver::AWSResource
   # Note: There isn't actually an SDK class for Elasticache.
   aws_sdk_type AWS::ElastiCache, id: :group_name
@@ -9,8 +11,20 @@ class Chef::Resource::AwsCacheSubnetGroup < Chef::Provisioning::AWSDriver::AWSRe
   # for information on possible values for each attribute. Values are passed
   # straight through to AWS, with the exception of subnets, which
   # may contain a reference to a Chef aws_subnet resource.
+
+  # Group Name
+  #
+  # @param :group_name [String] The name of the cache subnet group to be used for the replication group.
   attribute :group_name, kind_of: String, name_attribute: true
+
+  # Description
+  #
+  # @param :description [String] Subnet group description.
   attribute :description, kind_of: String, required: true
+
+  # Subnets
+  #
+  # @param :subnets [ String, Array, AwsSubnet, AWS::EC2::Subnet ] One or more subnets in the subnet group.
   attribute :subnets,
             kind_of: [ String, Array, AwsSubnet, AWS::EC2::Subnet ],
             required: true,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-provisioning-aws
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - John Ewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-17 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef