ironfan 3.1.0.rc1

data/.gitignore

@@ -0,0 +1,51 @@
+## OS
+.DS_Store
+Icon?
+nohup.out
+
+## EDITORS
+\#*
+.#*
+*~
+*.swp
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+
+## COMPILED
+a.out
+*.o
+*.pyc
+*.so
+
+## OTHER SCM
+.bzr
+.hg
+.svn
+
+## PROJECT::GENERAL
+coverage
+rdoc
+doc
+pkg
+.yardoc
+
+## PROJECT::SPECIFIC
+.rvmrc
+.vendor
+.bundle
+Gemfile.lock
+
+.rake_test_cache
+metadata.json
+.chef
+*.pem
+.rvmrc
+vendor/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--drb

data/CHANGELOG.md

@@ -0,0 +1,130 @@
+# v3.1.0-rc1
+
+* 'ClusterChef has been renamed 'Ironfan'
+* The 'Metachef' cookbook has been renamed 'Silverware'
+* The 'Minidash' cookbook has been renamed 'Minidash'
+
+Please be sure you do a 
+
+    knife cookbook delete metachef minidash
+    knife cookbook upload --all
+
+These renames unfortunately hit every cookbook that depends on (what is now) silverware.
+
+__________________________________________________________________________
+__________________________________________________________________________
+
+## v3.0.14: 
+
+Big important change:
+
+# Ironfan is now Ironfan
+
+Due to a polite request from outside, we are changing this project's name to not include the word 'Chef'.
+
+It's now 'Ironfan', after Princess Iron Fan from the legend of Sun Wukong (Voyage to the West). The monkey hero Sun Wukong could not reach his destination without the help of the Princess's Iron Fan. The project helps you fan out across big iron in the sky -- and "You Can't Do B.I. without a Big Ironfan".
+
+This weekend (2/18) everything in the ironfan family of everything will get regex-replaced as ironfan. We'll track both gems for the next push or so, but new versions of the gem will not be released after Feb 2012.
+
+Other improvements/fixes:
+
+* knife cluster proxy now accepts additional hosts to direct to proxy -- set Chef::Config[:cluster_proxy_patterns] to an array of additional glob-style strings. Use this with the route53 support for fun and profit - if your machines look like foo-server-0-internal.whatupchimpy.com, add Chef::Config[:cluster_proxy_patterns] = '*internal.whatupchimpy.com*' to your knife-org.rb -- now you can browse securely to the private interface of any machine your target can.
+* FIX #76 -- `knife cluster kick` runs chef-client if the service is stopped. Fixes #76 . Also knife ssh will at its end show a bright red list of machines whose commands exited with a non-zero exit code -- useful when 1 out of 30 machines fails a knife cluster kick.
+* A limited number of commands (ssh, show, kill) now run with no requirement of cloud anything (Relates to #28). Also worked around an annoying incompatibility with chef 0.10.8 (clients have a 'name') vs 0.10.40-and-prev (clients have a 'clientname'.
+* examples all live in `ironfan-homebase` now.
+* When you `knife cluster stop` a node, it sets `node[:state]` to 
+* the cookbook linter now has its own project: [ironfan-scrubby](https://github.com/infochimps-labs/ironfan-scrubby). Along the way, 
+  - some ability to cycle comments from the attributes file into node attribute docs in the `metadata.rb`.
+  - added helpful links to the `README.md` template
+* minor fix to the new `authorized_by` calls
+
+## v3.0.11: We Raid at Dawn
+
+* You can now assemble raid groups in the cluster definition:
+  - node metadata instructing the volumes recipe to build the raid volume
+  - marks the component volumes as non-mountable, in the appropriate raid group, etc
+* Changed the order of `cluster_role` and `facet_role` in the run list. It now goes:
+  - `:first`  roles (cluster then facet)
+  - `:normal` roles (cluster then facet)
+  - special roles: `cluster_role` then `facet_role`
+  - `:last` roles (cluster then facet)
+* knife cluster launch uses ClusterBootstrap, not knife's vanilla bootstrap.
+* can now do group('group_that_wants').authorized_by_group('group_that_grants') so that in cluster A I can request access to cluster B without gaining its group myself.
+* push the organization (if set) into the node metadata
+
+## v3.0.10: Cloud fixes
+
+* security groups are now created/updated in knife cluster sync. This can't help you apply then to a node afer launch though -- nothing can, the API doesn't allow it.
+* clusters now all refer to an AMI named `ironfan-natty` by default, and to customizable roles `org_base`, `org_final` and `org_users` (where `org_base` has a role_implication for membership in the systemwide `org_base` security group)
+* default facet instances is now 1 who knows why it wasn't always 1.
+* minor linting of cluster before launching it
+* bump to latest versions of oneiric AMIs thx @redbeard
+* bootstrap fixes, oneiric support, more from @gchpaco
+
+
+## v3.0.6: schism of cookbooks and tools
+
+* cookbooks all now live in [their own repo](https://github.com/infochimps-labs/ironfan-homebase), organized according to opscode standard.
+* gem is now split into `ironfan` (the libraries) and `ironfan-knife` (the chef plugins)
+* private_key was passing its block to super, with bad results
+
+## Changes from v2 => v3 [2011 October]
+
+**The below-described changes are still in progress**
+
+_________
+
+Ironfan underwent a major upgrade with the last several commits.
+
+* the `ironfan` tools -- the DSL, knife plugins, and bootstrap scripts -- have been split out of the  [ironfan repo](http://github.com/infochimps-labs/ironfan) into a [separate repo](http://github.com/infochimps-labs/ironfan-tools).
+* The tools are now available as a gem -- `gem install ironfan`
+* Cleaned up the code
+* Standardized clusters & roles
+* Standardized cookbooks
+
+### Ironfan DSL Changes
+
+The following behaviors have been removed:
+
+* `use` -- **BREAKING** Was supposed to let me import another cluster definition into the one calling use. However, it didn't work as advertised, was clutter-y and was actively unpopular (issue #6). 
+  - Until the usage of derived clusters becomes clear, say `merge!` on a hash instead.
+  - We do default settings for you.
+  - We *don't* put in any default roles (as the old `use :defaults` did).
+
+* `cloud` -- **BREAKING** a bare `cloud` statement is meaningless: the *attributes* may be abstract, but the *values* are different for every provider. 
+  - Anywhere you used to say `cloud`, say `ec2`: eg `ec2.flavor('t1.micro')` instead of `cloud.flavor('t1.micro')`.
+
+* `chef_attributes` -- **BREAKING** replaced by `facet_role.override_attributes`, `facet_role.default_attributes` (or those methods on `cluster_role`.)
+
+* `cluster_role_implication` -- **BREAKING** now called role_implications, brought in by default.
+
+* `cluster.mounts_ephemeral_volumes` is now `cloud.mount_ephemerals`; it is not done by default.
+
+### Knife Changes
+
+Several knife scripts saw name changes to their params. If you have external scripts that call `knife cluster XXX` please update them. No futher changes to parameters are expected.
+
+* `knife cluster kill` **only asks you once** whether to kill things -- there's no more `--really` flag.
+* Standalone args now all properly have `--whatever` and `--no-whatever` forms.
+* **BREAKING** The sync and kill commands both agree that `--chef` and `--cloud` are how to restrict their attention.
+
+
+### Cookbook-affecting changes
+
+* Standardized on `node[:cluster_name]`, `node[:facet_name]` and `node[:facet_index]` as the way to refer to the cluster, facet and server parts of a node's name. This replaces the way-too-many names for these: `node[:ironfan][:facet]` and `node[:cluster_role]` (use `node[:facet_name]`), `node[:ironfan][:index]` and `node[:cluster_role_index]` (use `node[:facet_index]`) .
+* Ironfan family of cookbooks were updated accordingly.
+
+#### hadoop_cluster cookbook
+
+* The bootstrap recipes are gone. They may come back, but for now the dance is:
+  - bring up the cluster ; by default the service state for all the daemons is [:disable, :stop].
+  - run the `/etc/hadoop/conf/bootstrap_hadoop_namenode.sh` to format your HDFS
+  - move the service state to '[:enable, :start]' and re-run chef client
+  
+
+#### Deprecated cookbooks
+
+You must add `"#{ironfan_path}/deprecated-cookbooks"` to your cookbook_path in knife.rb if you would like to keep using
+
+* `cluster_ebs_volumes` -- use `mountable_volumes` instead.
+

data/Gemfile

@@ -0,0 +1,26 @@
+source "http://rubygems.org"
+
+gem 'chef',          "~> 0.10.4"
+gem 'fog',           "~> 1.1.1"
+gem 'formatador',    "~> 0.2.1"
+gem 'gorillib',      "~> 0.1.7"
+
+group :development do
+  gem 'bundler',     "~> 1"
+  gem 'jeweler',     "~> 1.6"
+  gem 'rspec',       "~> 2.5"
+  gem 'yard',        "~> 0.6"
+  gem 'configliere', "~> 0.4.8"
+end
+
+group :test do
+  gem 'spork',       ">= 0.9.0", :platform => :mri
+  gem 'rcov',        ">= 0.9.9", :platform => :ruby_18
+  gem 'simplecov',   ">= 0.5",   :platform => :ruby_19
+  gem 'watchr',      "~> 0.7"
+end
+
+group :support do
+  gem 'pry'
+  gem 'grit'
+end

data/LICENSE.md

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,328 @@
+# ironfan
+
+Infrastructure as code: describe and orchestrate whole clusters of cloud or virtual machines. 
+
+## Walkthrough
+
+Here's a very simple cluster:
+
+```ruby
+Ironfan.cluster 'webapp_demo' do
+  cloud(:ec2) do
+    flavor              't1.micro'
+  end
+
+  role                  :base_role
+  role                  :chef_client
+  role                  :ssh
+
+  # The database server
+  facet :dbnode do
+    instances           1
+    role                :mysql_server
+
+    cloud do
+      flavor           'm1.large'
+      backing          'ebs'
+    end
+  end
+
+  # A throwaway facet for development.
+  facet :webnode do
+    instances           2
+    role                :nginx_server
+    role                :awesome_webapp
+  end
+end
+```
+
+This code defines a cluster named demosimple. A cluster is a group of servers united around a common purpose, in this case to serve a scalable web application.
+
+The webapp_demo cluster has two 'facets' -- dbnode and webnode. A facet is a subgroup of interchangeable servers that provide a logical set of systems: in this case, the systems that store the website's data and those that render it.
+
+The dbnode facet has one server, which will be named `webapp_demo-dbnode-0`; the webnode facet has two servers, `webapp_demo-webnode-0` and `webapp_demo-webnode-1`.
+
+Each server inherits the appropriate behaviors from its facet and cluster. All the servers in this cluster have the `base_role`, `chef_client` and `ssh` roles. The dbnode machines additionally house a MySQL server, while the webnodes have an nginx reverse proxy for the custom `webapp_demo_webapp`.
+
+As you can see, the dbnode facet asks for a different flavor of machine (`m1.large`) than the cluster default (`t1.micro`). Settings in the facet override those in the server, and settings in the server override those of its facet. You economically describe only what's significant about each machine.
+
+### Cluster-level tools
+
+
+```
+$ knife cluster show webapp_demo
+
+  +--------------------+-------+------------+-------------+--------------+---------------+-----------------+----------+--------------+------------+------------+
+  | Name               | Chef? | InstanceID | State       | Public IP    | Private IP    | Created At      | Flavor   | Image        | AZ         | SSH Key    |
+  +--------------------+-------+------------+-------------+--------------+---------------+-----------------+----------+--------------+------------+------------+
+  | webapp_demo-dbnode-0   | yes   | i-43c60e20 | running     | 107.22.6.104 | 10.88.112.201 | 20111029-204156 | t1.micro | ami-cef405a7 | us-east-1a | webapp_demo    |
+  | webapp_demo-webnode-0  | yes   | i-1233aef1 | running     | 102.99.3.123 | 10.88.112.123 | 20111029-204156 | t1.micro | ami-cef405a7 | us-east-1a | webapp_demo    |
+  | webapp_demo-webnode-1  | yes   | i-0986423b | not running |              |               |                 |          |              |            |            |
+  +--------------------+-------+------------+-------------+--------------+---------------+-----------------+----------+--------------+------------+------------+
+
+
+```
+
+The commands available are
+* list -- lists known clusters
+* show -- show the named servers
+* launch -- launch server
+* bootstrap  
+* sync       
+* ssh        
+* start/stop       
+* kill       
+* kick -- trigger a chef-client run on each named machine, tailing the logs until the run completes
+
+
+### Advanced clusters remain simple
+
+Let's say that app is truly awesome, and the features and demand increases. This cluster adds an [ElasticSearch server](http://elasticsearch.org) for searching, a haproxy loadbalancer, and spreads the webnodes across two availability zones.
+
+```ruby
+Ironfan.cluster 'webserver_demo_2' do
+  cloud(:ec2) do
+    image_name          "maverick"
+    flavor              "t1.micro"
+    availability_zones  ['us-east-1a']
+  end
+
+  # The database server
+  facet :dbnode do
+    instances           1
+    role                :mysql_server
+    cloud do
+      flavor           'm1.large'
+      backing          'ebs'
+    end
+
+    volume(:data) do
+      size              20
+      keep              true                        
+      device            '/dev/sdi'                  
+      mount_point       '/data'              
+      snapshot_id       'snap-a10234f'             
+      attachable        :ebs
+    end
+  end
+
+  facet :webnode do
+    instances           6
+    cloud.availability_zones  ['us-east-1a', 'us-east-1b']
+
+    role                :nginx_server
+    role                :awesome_webapp
+    role                :elasticsearch_client
+
+    volume(:server_logs) do
+      size              5                           
+      keep              true                        
+      device            '/dev/sdi'                  
+      mount_point       '/server_logs'              
+      snapshot_id       'snap-d9c1edb1'             
+    end
+  end
+
+  facet :esnode do
+    instances           1
+    role                "elasticsearch_data_esnode"
+    role                "elasticsearch_http_esnode"
+    cloud.flavor        "m1.large"
+  end
+
+  facet :loadbalancer do
+    instances           1
+    role                "haproxy"
+    cloud.flavor        "m1.xlarge"
+    elastic_ip          "128.69.69.23"
+  end
+  
+  cluster_role.override_attributes({
+    :elasticsearch => {
+      :version => '0.17.8',
+    },
+  })
+end
+```
+
+The facets are described and scale independently. If you'd like to add more webnodes, just increase the instance count. If a machine misbehaves, just terminate it. Running `knife cluster launch webapp_demo webnode` will note which machines are missing, and launch and configure them appropriately.
+
+Ironfan speaks naturally to both Chef and your cloud provider. The esnode's `cluster_role.override_attributes` statement will be synchronized to the chef server, pinning the elasticsearch version across the clients and server.. Your chef roles should focus system-specific information; the cluster file lets you see the architecture as a whole.
+
+With these simple settings, if you have already [set up chef's knife to launch cloud servers](http://wiki.opscode.com/display/chef/Launch+Cloud+Instances+with+Knife), typing `knife cluster launch demosimple --bootstrap` will (using Amazon EC2 as an example):
+
+* Synchronize to the chef server:
+  - create chef roles on the server for the cluster and each facet.
+  - apply role directives (eg the homebase's `default_attributes` declaration).
+  - create a node for each machine
+  - apply the runlist to each node 
+* Set up security isolation:
+  - uses a keypair (login ssh key) isolated to that cluster
+  - Recognizes the `ssh` role, and add a security group `ssh` that by default opens port 22.
+  - Recognize the `nfs_server` role, and adds security groups `nfs_server` and `nfs_client`
+  - Authorizes the `nfs_server` to accept connections from all `nfs_client`s. Machines in other clusters that you mark as `nfs_client`s can connect to the NFS server, but are not automatically granted any other access to the machines in this cluster. Ironfan's opinionated behavior is about more than saving you effort -- tying this behavior to the chef role means you can't screw it up. 
+* Launches the machines in parallel:
+  - using the image name and the availability zone, it determines the appropriate region, image ID, and other implied behavior. 
+  - passes a JSON-encoded user_data hash specifying the machine's chef `node_name` and client key. An appropriately-configured machine image will need no further bootstrapping -- it will connect to the chef server with the appropriate identity and proceed completely unattended.
+* Syncronizes to the cloud provider:
+  - Applies EC2 tags to the machine, making your console intelligible: ![AWS Console screenshot](https://github.com/infochimps-labs/ironfan/raw/version_3/notes/aws_console_screenshot.jpg)
+  - Connects external (EBS) volumes, if any, to the correct mount point -- it uses (and applies) tags to the volumes, so they know which machine to adhere to. If you've manually added volumes, just make sure they're defined correctly in your cluster file and run `knife cluster sync {cluster_name}`; it will paint them with the correct tags.
+  - Associates an elastic IP, if any, to the machine
+* Bootstraps the machine using knife bootstrap
+
+---------------------------------------------------------------------------
+
+## Getting Started
+
+This assumes you have installed chef, have a working chef server, and have an AWS account. If you can run knife and use the web browser to see your EC2 console, you can start here. If not, see the instructions below.
+
+### Setup
+
+```ruby
+bundle install
+```
+
+### Your first cluster
+
+Let's create a cluster called 'demosimple'. It's, well, a simple demo cluster.
+
+#### Create a simple demo cluster
+
+Create a directory for your clusters; copy the demosimple cluster and its associated roles from ironfan:
+
+```ruby
+        mkdir -p $CHEF_REPO_DIR/clusters
+        cp ironfan/clusters/{defaults,demosimple}.rb ./clusters/
+        cp ironfan/roles/{big_package,nfs_*,ssh,base_role,chef_client}.rb  ./roles/
+```
+
+Lastly, add the `cookbooks`, `site-cookbooks`, and `meta-cookbooks` directories
+from ironfan to the `cookbooks_path` in your knife.rb, and push everything
+to the chef server. (see below for details).
+
+#### knife cluster launch
+
+Hooray! You're ready to launch a cluster:
+
+```ruby
+    knife cluster launch demosimple homebase --bootstrap
+```
+
+It will kick off a node and then bootstrap it. You'll see it install a whole bunch of things. Yay.
+
+__________________________________________________________________________
+
+## Philosophy
+
+Some general principles of how we use chef.
+
+* *Chef server is never the repository of truth* -- it only mirrors the truth.
+  - a file is tangible and immediate to access
+* Specifically, we want truth to live in the git repo, and be enforced by the chef server. *There is no truth but git, and chef is its messenger*.
+  - this means that everything is versioned, documented and exchangeable.
+* *Systems, services and significant modifications cluster should be obvious from the `clusters` file*.  I don't want to have to bounce around nine different files to find out which thing installed a redis:server.
+  - basically, the existence of anything that opens a port should be obvious when I look at the cluster file.
+* *Roles define systems, clusters assemble systems into a machine*.
+  - For example, a resque worker queue has a redis, a webserver and some config files -- your cluster should invoke a @whatever_queue@ role, and the @whatever_queue@ role should include recipes for the component services.
+  - the existence of anything that opens a port _or_ runs as a service should be obvious when I look at the roles file.
+* *include_recipe considered harmful* Do NOT use include_recipe for anything that a) provides a service, b) launches a daemon or c) is interesting in any way. (so: @include_recipe java@ yes; @include_recipe iptables@ no.) You should note the dependency in the metadata.rb. This seems weird, but the breaking behavior is purposeful: it makes you explicitly state all dependencies.
+* It's nice when *machines are in full control of their destiny*.
+  - initial setup (elastic IP, attaching a drive) is often best enforced externally
+  - but machines should be ablt independently assert things like load balancer registration that that might change at any point in the lifetime.
+* It's even nicer, though, to have *full idempotency from the command line*: I can at any time push truth from the git repo to the chef server and know that it will take hold.
+
+__________________________________________________________________________
+
+## Advanced Superpowers
+
+#### Auto-vivifying machines (no bootstrap required!)
+
+On EC2, you can make a machine that auto-vivifies -- no bootstrap necessary. Burn an AMI that has the `config/client.rb` file in /etc/chef/client.rb. It will use the ec2 userdata (passed in by knife) to realize its purpose in life, its identity, and the chef server to connect to; everything happens automagically from there. No parallel ssh required!
+
+#### EBS Volumes
+
+Define a `snapshot_id` for your volumes, and set `create_at_launch` true.
+
+__________________________________________________________________________
+
+
+## Extended Installation Notes
+
+#### Set up Knife on your local machine, and a Chef Server in the cloud
+
+If you already have a working chef installation you can skip this section.
+
+To get started with knife and chef, follow the "Chef Quickstart,":http://wiki.opscode.com/display/chef/Quick+Start We use the hosted chef service and are very happy, but there are instructions on the wiki to set up a chef server too. Stop when you get to "Bootstrap the Ubuntu system" -- cluster chef is going to make that much easier.
+
+* [Launch Cloud Instances with Knife](http://wiki.opscode.com/display/chef/Launch+Cloud+Instances+with+Knife)
+* [EC2 Bootstrap Fast Start Guide](http://wiki.opscode.com/display/chef/EC2+Bootstrap+Fast+Start+Guide)
+
+#### Cloud setup
+
+Next,
+
+* sign up for an AWS account
+* Follow the "Knife with AWS quickstart": on the opscode wiki.
+
+Right now cluster chef works well with AWS.  If you're interested in modifying it to work with other cloud providers, "see here":https://github.com/infochimps-labs/ironfan/issues/28 or get in touch.
+
+#### Knife setup
+
+In your `.chef/knife.rb`, modify the cookbook path to include ironfan's `cookbooks`, `meta-cookbooks` and `site-cookbooks`, and to add settings for `ironfan_path`, `cluster_path` and `keypair_path`. Here's mine:
+
+```
+        current_dir = File.dirname(__FILE__)
+        organization  = 'CHEF_ORGANIZATION'
+        username      = 'CHEF_USERNAME'
+
+        # The full path to your ironfan installation
+        ironfan_path File.expand_path("#{current_dir}/../ironfan")
+        # The list of paths holding clusters
+        cluster_path      [ File.expand_path("#{current_dir}/../clusters") ]
+        # The directory holding your cloud keypairs
+        keypair_path      File.expand_path(current_dir)
+
+        log_level                :info
+        log_location             STDOUT
+        node_name                username
+        client_key               "#{keypair_path}/#{username}.pem"
+        validation_client_name   "#{organization}-validator"
+        validation_key           "#{keypair_path}/#{organization}-validator.pem"
+        chef_server_url          "https://api.opscode.com/organizations/#{organization}"
+        cache_type               'BasicFile'
+        cache_options( :path => "#{ENV['HOME']}/.chef/checksums" )
+
+        # The first things have lowest priority (so, site-cookbooks gets to win)
+        cookbook_path            [
+          "#{ironfan_path}/cookbooks",      # std cookbooks from opscode/cookbooks
+          "#{ironfan_path}/meta-cookbooks", # coordinate services among cookbooks
+          "#{ironfan_path}/site-cookbooks", # infochimps' collection of cookbooks
+          "#{current_dir}/../cookbooks",         
+          "#{current_dir}/../site-cookbooks",    # your internal cookbooks
+        ]
+
+        # If you primarily use AWS cloud services:
+        knife[:ssh_address_attribute] = 'cloud.public_hostname'
+        knife[:ssh_user] = 'ubuntu'
+
+        # Configure bootstrapping
+        knife[:bootstrap_runs_chef_client] = true
+        bootstrap_chef_version   "~> 0.10.0"
+
+        # AWS access credentials
+        knife[:aws_access_key_id]      = "XXXXXXXXXXX"
+        knife[:aws_secret_access_key]  = "XXXXXXXXXXXXX"
+```
+
+#### Push to chef server
+
+To send all the cookbooks and role to the chef server, visit your ironfan directory and run:
+
+```ruby
+        cd $CHEF_REPO_DIR
+        mkdir -p $CHEF_REPO_DIR/site-cookbooks
+        knife cookbook upload --all
+        for foo in roles/*.rb ; do knife role from file $foo & sleep 1 ; done
+```
+
+You should see all the cookbooks defined in ironfan/cookbooks (ant, apt, ...) listed among those it uploads.