README.md in kitchen-ec2-0.6.0 vs README.md in kitchen-ec2-0.7.0

- old
+ new

@@ -16,10 +16,50 @@ ## <a name="installation"></a> Installation and Setup Please read the [Driver usage][driver_usage] page for more details. +## <a name="default-config"></a> Default Configuration + +This driver can determine AMI and username login for a select number of +platforms in each region. Currently, the following platform names are +supported: + +```ruby +--- +platforms: +- name: ubuntu-10.04 +- name: ubuntu-12.04 +- name: ubuntu-12.10 +- name: ubuntu-13.04 +- name: centos-6.4 +- name: debian-7.1.0 +``` + +This will effectively generate a configuration similar to: + +```ruby +--- +platforms: +- name: ubuntu-10.04 + driver_config: + image_id: ami-1ab3ce73 + username: ubuntu +- name: ubuntu-12.04 + driver_config: + image_id: ami-2f115c46 + username: ubuntu +# ... +- name: centos-6.4 + driver_config: + image_id: ami-bf5021d6 + username: root +# ... +``` + +For specific default values, please consult [amis.json][amis_json]. + ## <a name="config"></a> Configuration ### <a name="config-az"></a> availability\_zone **Required** The AWS [availability zone][region_docs] to use. @@ -28,23 +68,26 @@ ### <a name="config-aws-access-key-id"></a> aws\_access\_key\_id **Required** The AWS [access key id][credentials_docs] to use. -The default is unset, or `nil`. +The default will be read from the `AWS_ACCESS_KEY` environment variable if set, +or `nil` otherwise. ### <a name="config-aws-secret-access-key"></a> aws\_secret\_access\_key **Required** The AWS [secret access key][credentials_docs] to use. -The default is unset, or `nil`. +The default will be read from the `AWS_SECRET_KEY` environment variable if set, +or `nil` otherwise. ### <a name="config-aws-ssh-key-id"></a> aws\_ssh\_key\_id **Required** The EC2 [SSH key id][key_id_docs] to use. -The default is unset, or `nil`. +The default will be read from the `AWS_SSH_KEY_ID` environment variable if set, +or `nil` otherwise. ### <a name="config-flavor-id"></a> flavor\_id The EC2 [instance type][instance_docs] (also known as size) to use. @@ -59,11 +102,13 @@ ### <a name="config-image-id"></a> image\_id **Required** The EC2 [AMI id][ami_docs] to use. -The default is unset, or `nil`. +The default will be determined by the `aws_region` chosen and the Platform +name, if a default exists (see [amis.json][ami_json]). If a default cannot be +computed, then the default is `nil`. ### <a name="config-port"></a> port The SSH port number to be used when communicating with the instance. @@ -118,11 +163,13 @@ ### <a name="config-username"></a> username The SSH username that will be used to communicate with the instance. -The default is `"root"`. +The default will be determined by the Platform name, if a default exists (see +[amis.json][amis_json]). If a default cannot be computed, then the default is +`"root"`. ## <a name="example"></a> Example The following could be used in a `.kitchen.yml` or in a `.kitchen.local.yml` to override default configuration. @@ -212,9 +259,10 @@ [license]: https://github.com/opscode/kitchen-ec2/blob/master/LICENSE [repo]: https://github.com/opscode/kitchen-ec2 [driver_usage]: http://docs.kitchen-ci.org/drivers/usage [chef_omnibus_dl]: http://www.opscode.com/chef/install/ +[amis_json]: https://github.com/opscode/kitchen-ec2/blob/master/data/amis.json [ami_docs]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html [aws_site]: http://aws.amazon.com/ [credentials_docs]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/SettingUp_CommandLine.html#using-credentials-access-key [fog_gem]: http://fog.io/ [group_docs]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html