Created README.md

README.md

@@ -0,0 +1,86 @@
+chef-provisioning-examples
+==========================
+
+Set of examples to start gradually with [Chef Provisioning](https://github.com/opscode/chef-provisioning)
+
+## Requirements
+
+* Ruby installed (tested with version 2.1.5)
+* Bundler installed (tested with version 1.7.8)
+* VirtualBox installed (tested with version 4.3.10)
+
+(no I am not using ChefDK, but prefer going throug Bundler... Will explain why in a next iteration of this doc)
+
+This was all tested (Vagrant and AWS setups) on OS X Yosemite (10.10.1). I also tested the AWS setup from an Ubuntu precise64 vm using Vagrant on my mac.
+
+## Setup for AWS usage
+
+### AWS credentials
+
+Added AWS credentials in `~/.aws` as per http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files but putting everything in the `~/.aws/config` file.
+
+In my case :
+
+```
+[default]
+region = eu-west-1a
+aws_access_key_id=your_key
+aws_secret_access_key=your_other_key
+```
+
+For more info, Chef doc at https://github.com/opscode/chef-provisioning/blob/master/docs/blogs/2012-05-22-new-driver-interface.html.markdown#using-metal-today-aws)
+
+### AWS private Key
+
+All the info available in the Chef doc at https://github.com/opscode/chef-provisioning/blob/master/docs/blogs/2012-05-22-new-driver-interface.html.markdown#using-metal-today-aws
+
+I add `my_aws_key.pem` in `~/.chef/keys/`
+
+## Before you can launch the examples
+
+### Launch Bundler to install all the required gems
+
+This is done with:
+
+`$ bundle install`
+
+### Get the cookbooks with Berkshelf
+
+This is done with:
+
+`$ berks install && berks vendor cookbooks`
+
+## Launch the examples with Vagrant setup 
+
+This is done with (pick your choice, and if there are new recipes not mentioned here, well use them by copying the examples below!!!):
+
+```
+$ bundle exec chef-client -z vagrant_setup.rb simplest_machine.rb
+$ bundle exec chef-client -z vagrant_setup.rb single_machine_converging.rb
+$ bundle exec chef-client -z vagrant_setup.rb whatever_new_recipe.rb
+```
+
+You destroy all created machines with:
+
+```
+$ bundle exec chef-client -z vagrant_setup.rb destroy_all.rb
+```
+
+## Launch the examples with AWS setup 
+
+Same as for the Vagrant setup but by replacing `vagrant_setup.rb` with `aws_setup.rb`.
+
+For instance:
+
+```
+$ bundle exec chef-client -z vagrant_setup.rb simplest_machine.rb
+$ bundle exec chef-client -z vagrant_setup.rb destroy_all.rb
+```
+
+## TO DO
+
+* Explain what happened: 
+  * `nodes` directory created
+  * `clients` directory created
+  * `local-mode-cache` and `vms` directories created in `.chef/` (and not `~/.chef/` since we are using the `.chef/knife.rb` file)
+* Explain why using a `.chef/knife.rb` file where it could be skipped