clc-fork-chef-metal 0.11.beta.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +106 -0
  3. data/LICENSE +201 -0
  4. data/README.md +201 -0
  5. data/Rakefile +6 -0
  6. data/bin/metal +276 -0
  7. data/lib/chef/provider/machine.rb +147 -0
  8. data/lib/chef/provider/machine_batch.rb +130 -0
  9. data/lib/chef/provider/machine_execute.rb +30 -0
  10. data/lib/chef/provider/machine_file.rb +49 -0
  11. data/lib/chef/resource/machine.rb +95 -0
  12. data/lib/chef/resource/machine_batch.rb +20 -0
  13. data/lib/chef/resource/machine_execute.rb +22 -0
  14. data/lib/chef/resource/machine_file.rb +28 -0
  15. data/lib/chef_metal.rb +62 -0
  16. data/lib/chef_metal/action_handler.rb +63 -0
  17. data/lib/chef_metal/add_prefix_action_handler.rb +29 -0
  18. data/lib/chef_metal/chef_machine_spec.rb +64 -0
  19. data/lib/chef_metal/chef_provider_action_handler.rb +72 -0
  20. data/lib/chef_metal/chef_run_data.rb +80 -0
  21. data/lib/chef_metal/convergence_strategy.rb +26 -0
  22. data/lib/chef_metal/convergence_strategy/install_cached.rb +157 -0
  23. data/lib/chef_metal/convergence_strategy/install_msi.rb +56 -0
  24. data/lib/chef_metal/convergence_strategy/install_sh.rb +51 -0
  25. data/lib/chef_metal/convergence_strategy/no_converge.rb +38 -0
  26. data/lib/chef_metal/convergence_strategy/precreate_chef_objects.rb +180 -0
  27. data/lib/chef_metal/driver.rb +267 -0
  28. data/lib/chef_metal/machine.rb +110 -0
  29. data/lib/chef_metal/machine/basic_machine.rb +82 -0
  30. data/lib/chef_metal/machine/unix_machine.rb +276 -0
  31. data/lib/chef_metal/machine/windows_machine.rb +102 -0
  32. data/lib/chef_metal/machine_spec.rb +78 -0
  33. data/lib/chef_metal/recipe_dsl.rb +84 -0
  34. data/lib/chef_metal/transport.rb +87 -0
  35. data/lib/chef_metal/transport/ssh.rb +235 -0
  36. data/lib/chef_metal/transport/winrm.rb +109 -0
  37. data/lib/chef_metal/version.rb +3 -0
  38. metadata +223 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c229a92cb5e105e2be9320f683c3d1acbddd051f
4
+ data.tar.gz: aeed9e2cf4740182b8091ff446a9cb0bbbc56ea3
5
+ SHA512:
6
+ metadata.gz: a11e30995c1f7e74914cf875fef68ca58a86b3953473bd77fd0e7efb56defb1d40cbec52d5a79ac12dba4673bc44fb153cd7b4ed122b85c36e7851c8364fb33e
7
+ data.tar.gz: 36496bc2ac754cad82abfa77e7386a107fa2ff7ad982c6ac14beecf54f53f132280ebcce9e0ff982cb432855549264b448f7a308c1e9bb8bbc211d588d8b0c4c
data/CHANGELOG.md ADDED
@@ -0,0 +1,106 @@
1
+ # Chef Metal Changelog
2
+
3
+ ## 0.11.beta.5 (5/28/2014)
4
+
5
+ - fix issue setting Hosted Chef ACLs on nodes
6
+ - fix single-machine converge crash
7
+
8
+ ## 0.11.beta.2 (5/27/2014)
9
+
10
+ - Bring in cheffish-0.5.beta.2
11
+
12
+ ## 0.11.beta (5/23/2014)
13
+
14
+ - New Driver interface (see docs/ and blogs/ directories for documentation)
15
+
16
+ ## 0.10.2 (5/2/2014)
17
+
18
+ - Fix crash with add_provisioner_options when provisioner_options is not yet set
19
+
20
+ ## 0.10.1 (5/2/2014)
21
+
22
+ - Fix a crash when uploading files in a machine batch
23
+
24
+ ## 0.10 (5/1/2014)
25
+
26
+ - Parallelism!
27
+ - All machines by default will be created in parallel just before the first "machine" definition. They will attempt to run all the way to converge. If they fail, add "with_machine_batch 'mybatch', :setup"
28
+ - Use "with_machine_batch 'mybatch'" before any machines if you want tighter control. Actions include :delete, :acquire, :setup, and :converge.
29
+ - Parallelizableness: chef-metal now stores data in the run_context instead of globally, so that it can be run multiple times in parallel. This capability is not yet being used.
30
+
31
+ ## 0.9.4 (4/23/2014)
32
+
33
+ - Preserve provisioner_output in machine resource (don't destroy it!!)
34
+
35
+ ## 0.9.3 (4/13/2014)
36
+
37
+ - SSH: Treat EHOSTUNREACH as "machine not yet available" (helps with AWS)
38
+
39
+ ## 0.9.2 (4/13/2014)
40
+
41
+ - Timeout stability fixes (makes EC2 a little stabler for some AMIs)
42
+
43
+ ## 0.9.1 (4/11/2014)
44
+
45
+ - Make write_file and upload_file create parent directory
46
+
47
+ ## 0.9 (4/9/2014)
48
+
49
+ - Add `files` and `file` attributes to the `machine` resource
50
+ - Fix `machine_execute` resource (@irvingpop)
51
+ - Fix `machine :converge` action (thanks @double-z)
52
+ - Make chef-client timeout longer by default (2 hours)
53
+ - Make chef_client_timeout a configurable option for all convergence strategies and provisioner_options
54
+ - Add `metal cp` command
55
+
56
+ ## 0.8.2 (4/9/2014)
57
+
58
+ - Add timeout support to execute
59
+ - Fix machine_file resource
60
+ - Add ohai_hints DSL to machine resource (@xorl)
61
+
62
+ ## 0.8.1 (4/9/2014)
63
+
64
+ - Bug: error! was not raising an error in the SSH and WinRM transports
65
+ - Transports: stream output automatically when in debug
66
+ - Support the :read_only execute hint (for Docker)
67
+ - Add more metal command lines (converge, update, delete)
68
+ - Add ChefMetal.connect_to_machine(machine_name) method to get Machine object for a node name
69
+
70
+ ## 0.8 (4/8/2014)
71
+
72
+ - New machine_execute resource! (irving@getchef.com)
73
+ - Experimental "metal" command line: metal execute NODENAME COMMAND ARGS
74
+ - Transport: Add ability to stream execute() for better nested chef-client debugging
75
+
76
+ ## 0.7 (4/5/2014)
77
+
78
+ - Change transport interface: add ability to rewrite URL instead of forwarding ports
79
+
80
+ ## 0.6 (4/4/2014)
81
+
82
+ - Vagrant and Fog provisioners moved to their own gems (chef-metal-vagrant and chef-metal-fog)
83
+ - Support for Hosted and Enterprise Chef (https://github.com/dafyddcrosby)
84
+
85
+ ## 0.5 (4/3/2014)
86
+
87
+ * Provisioner interface changes designed to allow provisioners to be used outside of Chef (doubt@getchef.com)
88
+ * All Provisioner and Machine methods now take "action_handler" instead of "driver." It uses the ActionHandler interface described in action_handler.rb. In short:
89
+ - driver.run_context -> action_handler.recipe_context
90
+ - driver.updated_by_last_action(true) -> action_handler.updated!
91
+ - driver.converge_by -> action_handler.perform_action
92
+ - driver.cookbook_name -> driver.debug_name
93
+ * Convergence strategy: delete_chef_objects() -> cleanup_convergence()
94
+ * Ability to get back to a machine from a node (another Provisioner interface change) (doubt@getchef.com):
95
+ * Provisioners must create a file named `chef_metal/provisioner_init/<scheme>_init.rb`. It will be required when a node is encountered with that scheme. It should call ChefMetal.add_registered_provisioner_class(<scheme>, <provisioner class name>). For the provisioner_url `fog:AWS:21348723432`, the scheme is "fog" and the file is `chef_metalprovisioner_init/fog_init.rb`. It should call `ChefMetal.add_registered_provisioner_class('fog', ChefMetal::Provisioner::FogProvisioner)`.
96
+ * Provisioner classes must implement the class method `inflate(node)`, which should create a Provisioner instance appropriate to the given `node` (generally by looking at `node['normal']['provisioner_output']`)
97
+ * New `NoConverge` convergence strategy that creates a node but does not install Chef or converge.
98
+ * Support for machine_file `group`, `owner` and `mode` attributes (@irvingpop)
99
+ * SSH transport (ryan@segv.net): try to enable pty when possible (increases chance of successful connection). Set options[:ssh_pty_enable] to `false` to turn this off. Set `true` to force it (and fail if we can't get it)
100
+
101
+ ## 0.4 (3/29/2014)
102
+
103
+ * EC2: Make it possible for multiple IAM users to converge chef-metal on the same account
104
+ * Openstack: Openstack support via the Fog driver! (@cstewart87)
105
+ * EC2: Add :use_private_ip_for_ssh option, and use private ip by default if public IP does not exist. (@xorl, @dafyddcrosby)
106
+ * RHEL/Centos: fix platform detection and installation
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,201 @@
1
+ Chef Metal
2
+ ==========
3
+
4
+ This library solves the problem of repeatably creating machines and infrastructures in Chef. It has a plugin model that lets you write bootstrappers for your favorite infrastructures, including VirtualBox, EC2, LXC, bare metal, and many more!
5
+
6
+ Currently, chef-metal supports vagrant, Unixes/ssh, and Windows/winrm with real chef-servers or with automagical chef-zero tunneling. Fog and Docker support (to cover EC2 and LXC) are next up. Further out, we'd like to extend support to image factories (using the machine resource to produce images) and PXE support.
7
+
8
+ Try It Out
9
+ ----------
10
+
11
+ To give it a spin, get chef 11.8 or greater try this:
12
+
13
+ git clone https://github.com/opscode/cheffish.git
14
+ cd cheffish
15
+ rake install
16
+ cd ..
17
+
18
+ git clone https://github.com/opscode/chef-metal.git
19
+ cd chef-metal
20
+ rake install
21
+
22
+ cd chef-metal
23
+ chef-client -z -o myapp::vagrant,myapp::linux,myapp::small
24
+
25
+ This will create two vagrant precise64 linux boxes, "mario" and "luigi1", in `~/machinetest`, bootstrapped to an empty runlist. For Windows, you can replace `myapp::linux` with `myapp::windows`, but you'll need your own Windows vagrant box to do that (licensing!).
26
+
27
+ What Is Chef Metal?
28
+ -------------------
29
+
30
+ Chef Metal has two major abstractions: the machine resource, and provisioners.
31
+
32
+ ### The `machine` resource
33
+
34
+ You declare what your machines do (recipes, tags, etc.) with the `machine` resource, the fundamental unit of Chef Metal. You will typically declare `machine` resources in a separate, OS/provisioning-independent file that declares the *topology* of your app--your machines and the recipes that will run on them.
35
+
36
+ The machine resources from the example [myapp::small](https://github.com/opscode/chef-metal/blob/master/cookbooks/myapp/recipes/small.rb) are pretty straightforward. Here's a copy/paste:
37
+
38
+ ```ruby
39
+ machine 'mario' do
40
+ recipe 'postgresql'
41
+ recipe 'mydb'
42
+ tag 'mydb_master'
43
+ end
44
+
45
+ num_webservers = 1
46
+
47
+ 1.upto(num_webservers) do |i|
48
+ machine "luigi#{i}" do
49
+ recipe 'apache'
50
+ recipe 'mywebapp'
51
+ end
52
+ end
53
+ ```
54
+
55
+ You will notice the dynamic nature of the number of web servers. It's all code, your imagination is the limit :)
56
+
57
+ Kitchen
58
+ -------
59
+
60
+ Chef Metal also works with Test Kitchen, allowing you to test entire clusters, not just machines! The repository for the kitchen-metal gem is https://github.com/doubt72/kitchen-metal.
61
+
62
+ Provisioners
63
+ ------------
64
+
65
+ Provisioners handle the real work of getting those abstract definitions into real, physical form. They handle the following tasks, idempotently (you can run the resource again and again and it will only create the machine once--though it may notice things are wrong and fix them!):
66
+
67
+ * Acquiring machines from the cloud, creating containers or VMs, or grabbing bare metal
68
+ * Connecting to those machines via ssh, winrm, or other transports
69
+ * Bootstrapping chef onto the machines and converging the recipes you suggested
70
+
71
+ The provisioner API is separated out so that new provisioners can be made with minimal effort (without having to rewrite ssh, tunneling, bootstrapping, and OS support). But to the user, they appear as a single thing, so that the machine acquisition can use its smarts to autodetect the other bits (transports, OS's, etc.).
72
+
73
+ Provisioners save their data in the Chef node itself, so that they will be accessible to everyone who is using the Chef server to manage the nodes.
74
+
75
+ Provisioners each have their own repository. Current provisioners:
76
+
77
+ **Cloud:**
78
+ - [FOG: EC2, DigitalOcean, OpenStack, etc.](https://github.com/opscode/chef-metal-fog)
79
+
80
+ **Virtualization:**
81
+ - [Vagrant: VirtualBox, VMWare Fusion, etc.](https://github.com/opscode/chef-metal-vagrant)
82
+
83
+ **Containers:**
84
+ - [LXC](https://github.com/opscode/chef-metal-lxc)
85
+ - [Docker](https://github.com/opscode/chef-metal-docker)
86
+
87
+ **Bare Metal:**
88
+ - [SSH (no PXE)](https://github.com/double-z/chef-metal-ssh)
89
+
90
+ ### Vagrant
91
+
92
+ chef-zero comes with a provisioner for Vagrant, an abstraction that covers VirtualBox, VMWare and other Virtual Machine drivers. To run it, you can check out the sample recipes with:
93
+
94
+ ```
95
+ chef-client -z -o myapp::vagrant,myapp::linux,myapp::small
96
+ ```
97
+
98
+ The provisioner specification is in myapp::vagrant and myapp::linux [sample recipes](https://github.com/opscode/chef-metal/tree/master/cookbooks/myapp/recipes), copy/pasted here for your convenience:
99
+
100
+ ```ruby
101
+ vagrant_cluster "#{ENV['HOME']}/machinetest"
102
+
103
+ directory "#{ENV['HOME']}/machinetest/repo"
104
+ with_chef_local_server :chef_repo_path => "#{ENV['HOME']}/machinetest/repo"
105
+
106
+ vagrant_box 'precise64' do
107
+ url 'http://files.vagrantup.com/precise32.box'
108
+ end
109
+ ```
110
+
111
+ `vagrant_cluster` declares a directory where all the vagrant definitions will be stored, and uses `with_provisioner` internally to tell Chef Metal that this is the provisioner we want to use for machines.
112
+
113
+ `vagrant_box` makes sure a particular vagrant box exists, and lets you specify `provisioner_options` for things like port forwarding, OS definitions, and any other vagrant-isms. A more complicated vagrant box, with provisioner options, can be found in [myapp::windows](https://github.com/opscode/chef-metal/blob/master/cookbooks/myapp/recipes/windows.rb).
114
+
115
+ `with_chef_local_server` is a generic directive that creates a chef-zero server pointed at the given repository. nodes, clients, data bags, and all data will be stored here on your provisioner machine if you do this. You can use `with_chef_server` instead if you want to point at OSS, Hosted or Enterprise Chef, and if you don't specify a Chef server at all, it will use the one you are running chef-client against. Keep in mind when using `with_chef_server` and running `chef-client -z` on your workstation that you will also need to set the client name and signing key for the chef server. If you've already got knife.rb set up, then something like this will correctly create a client for the chef server on instance using your knife.rb configuration:
116
+
117
+ ```ruby
118
+ require 'chef/config'
119
+
120
+ with_chef_server "https://chef-server.example.org", {
121
+ :client_name => Chef::Config[:node_name],
122
+ :signing_key_filename => Chef::Config[:client_key]
123
+ }
124
+ ```
125
+
126
+ Typically, you declare these in separate files from your machine resources. Chef Metal picks up the provisioners you have declared, and uses them to instantiate the machines you request. The actual machine definitions, in this case, are in `myapp::small`, and are generic--you could use them against EC2 as well:
127
+
128
+ ```ruby
129
+ machine 'mario' do
130
+ recipe 'postgresql'
131
+ recipe 'mydb'
132
+ tag 'mydb_master'
133
+ end
134
+
135
+ num_webservers = 1
136
+
137
+ 1.upto(num_webservers) do |i|
138
+ machine "luigi#{i}" do
139
+ recipe 'apache'
140
+ recipe 'mywebapp'
141
+ end
142
+ end
143
+ ```
144
+
145
+ ### Fog (EC2 and friends)
146
+
147
+ chef-metal also comes with a [Fog](http://fog.io/) provisioner that handles provisioning to Amazon's EC2 and other cloud drivers. (Only EC2 has been tested so far.) Before you begin, you will need to put your AWS credentials in ~/.aws/config in the format [mentioned in Option 1 here](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#d0e726).
148
+
149
+ Once your credentials are in, basic usage looks like this:
150
+
151
+ ```
152
+ chef-client -z -o myapp::ec2,myapp::small
153
+ ```
154
+
155
+ The provisioner definition in `myapp::ec2` looks like this:
156
+
157
+ ```ruby
158
+ ec2testdir = File.expand_path('~/ec2test')
159
+
160
+ directory ec2testdir
161
+
162
+ with_fog_ec2_provisioner # :driver => 'AWS'
163
+
164
+ with_provisioner_options :image_id => 'ami-5ee70037'
165
+
166
+ fog_key_pair 'me' do
167
+ private_key_path "#{ec2testdir}/me"
168
+ public_key_path "#{ec2testdir}/me.pub"
169
+ end
170
+ ```
171
+
172
+ `with_fog_ec2_provisioner` tells chef-metal to use the Fog provisioner against EC2. If you specify your credentials in `~/.aws/config`, you don't *have* to specify anything else; it will use the Fog defaults. You may pass a hash of parameters to `with_fog_ec2_provisioner` that is described [here](https://github.com/opscode/chef-metal/blob/master/lib/chef_metal/provisioner/fog_provisioner.rb#L21-L32).
173
+
174
+ `fog_key_pair` creates a new key pair (if the files do not already exist) and automatically tells the Provisioner to use it to bootstrap subsequent machines. The private/public key pair will be automatically authorized to log on to the instance on first boot.
175
+
176
+ To pass options like ami, you can say something like this:
177
+
178
+ ```ruby
179
+ with_provisioner_options :image_id => 'ami-5ee70037'
180
+ ```
181
+
182
+ If you need to pass bootstrapping options on a per-machine basis, you can do that as well by doing something like the following:
183
+
184
+ ```ruby
185
+ machine "Ubuntu_64bit" do
186
+ action :create
187
+ provisioner_options 'bootstrap_options' => {
188
+ 'image_id' => 'ami-59a4a230',
189
+ 'flavor_id' => 't1.micro'
190
+ }
191
+ end
192
+ ```
193
+
194
+ You will notice that we are still using `myapp::small` here. Machine definitions are generally provisioner-independent. This is an important feature that allows you to spin up your clusters in different places to create staging, test or miniature dev environments.
195
+
196
+ Bugs and The Plan
197
+ -----------------
198
+
199
+ It's early days. *Please* submit bugs at https://github.com/opscode/chef-metal/issues, contact jkeiser on Twitter at @jkeiser2, email at jkeiser@opscode.com
200
+
201
+ If you are interested in the Plan for Chef Metal, you can peruse our [Trello board](https://trello.com/b/GcSzW0GM/chef-metal)! Please add suggestions there, vote or comment on issues that are important to you, and feel free to contribute by picking up a card. Chat with me (jkeiser@opscode.com) if you would like some context on how to go about implementing a card, or just go hog wild and submit a PR :)