chef-metal 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff00a9a5e38faa2766f8b863f1d1e4f388835d9a
+  data.tar.gz: f9c11bf6e500bd3ce30c1584f737e9c325b39ae3
+SHA512:
+  metadata.gz: 65d59f9815c642ef61f3c105ee4b29f65ab4aa13b9995e91600fce8efd6eab67d9b2a00960d74be740b52aa4bb5099dbf44f524811cbbfcb08f93d3e5c5114af
+  data.tar.gz: bd1be86b6d3a40d0d1d4217d8aafc54f797338469546cf1ac18841bfbcc8cc200aa6fabed214f42ee228cd2ea5c77f1c2909fdf88b9611d93efa284732cc6323

data/LICENSE

@@ -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,160 @@
+ChefMetal
+=========
+
+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!
+
+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.
+
+Try It Out
+----------
+
+To give it a spin, get chef 11.8 or greater try this:
+
+    git clone https://github.com/jkeiser/cheffish.git
+    cd cheffish
+    rake install
+    cd ..
+
+    git clone https://github.com/jkeiser/chef-metal.git
+    cd chef-metal
+    rake install
+    
+    cd chef-metal
+    chef-client -z -o myapp::vagrant,myapp::linux,myapp::small
+
+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!).
+
+What Is Chef Metal?
+-------------------
+
+Chef Metal has two major abstractions: the machine resource, and provisioners.
+
+### The `machine` resource
+
+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/priovisioning-independent file that declares the *topology* of your app--your machines and the recipes that will run on them.
+
+The machine resources from the example [myapp::small](https://github.com/jkeiser/chef-metal/blob/master/cookbooks/myapp/recipes/small.rb) are pretty straightforward.  Here's a copy/paste:
+
+```ruby
+machine 'mario' do
+  recipe 'postgresql'
+  recipe 'mydb'
+  tag 'mydb_master'
+end
+
+num_webservers = 1
+
+1.upto(num_webservers) do |i|
+  machine "luigi#{i}" do
+    recipe 'apache'
+    recipe 'mywebapp'
+  end
+end
+```
+
+You will notice the dynamic nature of the number of web servers.  It's all code, your imagination is the limit :)
+
+Provisioners
+------------
+
+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!):
+
+* Acquiring machines from the cloud, creating containers or VMs, or grabbing bare metal
+* Connecting to those machines via ssh, winrm, or other transports
+* Bootstrapping chef onto the machines and converging the recipes you suggested
+
+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.).
+
+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.
+
+### Vagrant
+
+chef-zero comes with a provisioner for Vagrant, an abstraction that covers VirtualBox, VMWare and other Virtual Machine providers. To run it, you can check out the sample recipes with:
+
+```
+chef-client -z -o myapp::vagrant,myapp::linux,myapp::small
+```
+
+The provisioner specification is in myapp::vagrant and myapp::linux [sample recipes](https://github.com/jkeiser/chef-metal/tree/master/cookbooks/myapp/recipes), copy/pasted here for your convenience:
+
+```ruby
+vagrant_cluster "#{ENV['HOME']}/machinetest"
+
+directory "#{ENV['HOME']}/machinetest/repo"
+with_chef_local_server :chef_repo_path => "#{ENV['HOME']}/machinetest/repo"
+
+vagrant_box 'precise64' do
+  url 'http://files.vagrantup.com/precise32.box' 
+end
+```
+
+`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.
+
+`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/jkeiser/chef-metal/blob/master/cookbooks/myapp/recipes/windows.rb).
+
+`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.
+
+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:
+
+```ruby
+machine 'mario' do
+  recipe 'postgresql'
+  recipe 'mydb'
+  tag 'mydb_master'
+end
+
+num_webservers = 1
+
+1.upto(num_webservers) do |i|
+  machine "luigi#{i}" do
+    recipe 'apache'
+    recipe 'mywebapp'
+  end
+end
+```
+
+### Fog (EC2 and friends)
+
+chef-metal also comes with a [Fog](http://fog.io/) provisioner that handles provisioning to Amazon's EC2 and other cloud providers.  (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).
+
+Once your credentials are in, basic usage looks like this:
+
+```
+chef-client -z -o myapp::vagrant,myapp::small
+```
+
+The provisioner definition in `myapp::vagrant` looks like this:
+
+```ruby
+ec2testdir = File.expand_path('~/ec2test')
+
+directory ec2testdir
+
+with_fog_ec2_provisioner # :provider => 'AWS'
+
+with_provisioner_options :image_id => 'ami-5ee70037'
+
+fog_key_pair 'me' do
+  private_key_path "#{ec2testdir}/me"
+  public_key_path "#{ec2testdir}/me.pub"
+end
+```
+
+`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/jkeiser/chef-metal/blob/master/lib/chef_metal/provisioner/fog_provisioner.rb#L21-L32).
+
+`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.
+
+To pass options like ami, you can say something like this:
+
+```ruby
+with_provisioner_options :image_id => 'ami-5ee70037'
+```
+
+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.
+
+Bugs and The Plan
+-----------------
+
+It's early days.  *Please* submit bugs at https://github.com/jkeiser/chef-metal/issues, contact jkeiser on Twitter at @jkeiser2, email at jkeiser@opscode.com
+
+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 :)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+
+task :spec do
+  require File.expand_path('spec/run')
+end

data/lib/chef/provider/fog_key_pair.rb

@@ -0,0 +1,106 @@
+require 'chef/provider/lwrp_base'
+
+class Chef::Provider::FogKeyPair < Chef::Provider::LWRPBase
+
+  use_inline_resources
+
+  def whyrun_supported?
+    true
+  end
+
+  action :create do
+    create_key
+  end
+
+  action :delete do
+    if current_resource_exists?
+      converge_by "delete #{key_description}" do
+        compute.key_pairs.delete(new_resource.name)
+      end
+    end
+  end
+
+  def key_description
+    "#{new_resource.name} on #{new_resource.provisioner.provisioner_url}"
+  end
+
+  def create_key
+    if current_resource_exists?
+      # If the public keys are different, update the server public key
+      if !current_resource.private_key_path
+        if new_resource.allow_overwrite
+          ensure_keys
+        else
+          raise "#{key_description} already exists on the server, but the private key #{new_resource.private_key_path} does not exist!"
+        end
+      else
+        ensure_keys
+      end
+
+      public_key, format = Cheffish::KeyFormatter.decode(IO.read(new_resource.public_key_path))
+      if Cheffish::KeyFormatter.encode(public_key, :format => :fingerprint) != @current_fingerprint
+        if new_resource.allow_overwrite
+          converge_by "update #{key_description} to match local key at #{new_resource.private_key_path}" do
+            compute.import_key_pair(new_resource.name, Cheffish::KeyFormatter.encode(desired_key, :format => :openssh))
+          end
+        else
+          raise "#{key_description} does not match local private key, and allow_overwrite is false!"
+        end
+      end
+    else
+      # Generate the private and/or public keys if they do not exist
+      ensure_keys
+
+      # Create key
+      converge_by "create #{key_description} from local key at #{new_resource.private_key_path}" do
+        compute.import_key_pair(new_resource.name, Cheffish::KeyFormatter.encode(desired_key, :format => :openssh))
+      end
+    end
+  end
+
+  def ensure_keys
+    resource = new_resource
+    Cheffish.inline_resource(self) do
+      private_key resource.private_key_path do
+        public_key_path resource.public_key_path
+        if resource.private_key_options
+          resource.private_key_options.each_pair do |key,value|
+            send(key, value)
+          end
+        end
+      end
+    end
+  end
+
+  def current_resource_exists?
+    @current_resource.action != [ :delete ]
+  end
+
+  def compute
+    new_resource.provisioner.compute
+  end
+
+  def current_public_key
+    current_resource.source_key
+  end
+
+  def load_current_resource
+    if !new_resource.provisioner.kind_of?(ChefMetal::Provisioner::FogProvisioner)
+      raise 'ec2_key_pair only works with fog_provisioner'
+    end
+    @current_resource = Chef::Resource::FogKeyPair.new(new_resource.name)
+    current_key_pair = compute.key_pairs.get(new_resource.name)
+    if current_key_pair
+      @current_fingerprint = current_key_pair.fingerprint
+    else
+      current_resource.action :delete
+    end
+
+    if new_resource.private_key_path && ::File.exist?(new_resource.private_key_path)
+      current_resource.private_key_path new_resource.private_key_path
+    end
+    if new_resource.public_key_path && ::File.exist?(new_resource.public_key_path)
+      current_resource.public_key_path new_resource.public_key_path
+    end
+  end
+end