knife-docker 0.0.1

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,34 @@
+# Knife Docker
+
+## Description
+A [knife] (http://docs.opscode.com/knife.html) plugin to create and delete
+[Docker] (http://docker.io) containers to be managed by Chef.
+
+## Installation
+Make sure you are running Chef, which can be installed via:
+
+    gem install chef
+
+This plugin is distributed as a Ruby Gem. To install it, run:
+
+    gem install knife-docker
+    
+Depending on your system's configuration, you may need to run this command
+with root/administrator privileges.
+
+Make sure you are able to create/list/stop Docker containers. Please see 
+[the Docker documentation] (https://www.docker.io/gettingstarted/) for more information. 
+
+## Examples
+      # Create and bootstrap a Debian container over ssh
+      $ knife docker create -I emarocca/wheezy
+
+      # Create a Debian container, bootstrap it, and apply the specified roles/recipes
+      $ knife docker create -I emarocca/wheezy -r 'recipe[postgresql::server]'
+
+      # Delete a container with id 3ebc494961fa and purge it from the Chef server
+      $ knife docker delete 3ebc494961fa --purge
+
+Use the --help option to read more about each subcommand. Eg:
+
+    knife docker create --help

data/lib/chef/knife/docker_create.rb

@@ -0,0 +1,131 @@
+#
+# Author:: Emanuele Rocca (<ema@linux.it>)
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+
+module ChefDocker
+  class DockerCreate < Chef::Knife
+
+    deps do
+      require 'chef/knife/bootstrap'
+      Chef::Knife::Bootstrap.load_deps
+    end
+
+    banner "knife docker create (options)"
+    
+    option :_image,
+      :short => "-I IMAGE",
+      :long => "--image IMAGE",
+      :description => "The Docker container image to use"
+
+    option :chef_node_name,
+      :short => "-N NAME",
+      :long => "--node-name NAME",
+      :description => "The Chef node name for your new node"
+
+    option :ssh_user,
+      :short => "-x USERNAME",
+      :long => "--ssh-user USERNAME",
+      :description => "The ssh username",
+      :default => 'root'
+
+    option :ssh_password,
+      :short => "-P PASSWORD",
+      :long => "--ssh-password PASSWORD",
+      :description => "The ssh password"
+
+    option :ssh_port,
+      :long => "--ssh-port PORT",
+      :description => "The ssh port. Default is 22",
+      :default => '22'
+
+    option :distro,
+      :short => "-d DISTRO",
+      :long => "--distro DISTRO",
+      :description => "Bootstrap a distro using a template",
+      :proc => Proc.new { |d| Chef::Config[:knife][:distro] = d },
+      :default => "chef-full"
+
+    option :template_file,
+      :long => "--template-file TEMPLATE",
+      :description => "Full path to location of template to use",
+      :proc => Proc.new { |t| Chef::Config[:knife][:template_file] = t },
+      :default => false
+
+    option :run_list,
+      :short => "-r RUN_LIST",
+      :long => "--run-list RUN_LIST",
+      :description => "Comma separated list of roles/recipes to apply",
+      :proc => lambda { |o| o.split(/[\s,]+/) },
+      :default => []
+
+    option :identity_file,
+      :short => "-i IDENTITY_FILE",
+      :long => "--identity IDENTITY_FILE",
+      :description => "SSH identity file for authentication"
+
+    def locate_config_value(key)
+      key = key.to_sym
+      config[key] || Chef::Config[:knife][key]
+    end
+
+    def run
+      unless config[:_image]
+        ui.error("Please provide a valid Docker container image (-I)")
+        show_usage
+        exit 1
+      end
+
+      # start a new container with sshd
+      id = `docker run -d -p #{config[:ssh_port]} #{config[:_image]} /usr/sbin/sshd -D`
+
+      unless $?.exitstatus == 0
+        ui.error("Cannot create container")
+        exit 1
+      end
+
+      # get container IP
+      container_info = `docker inspect #{id}`
+      ip = container_info.match(/"IPAddress": "(?<ip>[\d\.]+)"/)['ip']
+
+      # containers boot *very* fast, but it might happen that we try to
+      # bootstrap before SSH is up. Let's wait a second.
+      sleep 1
+
+      bootstrap_container(ip, id.rstrip).run
+    end
+
+    def bootstrap_container(fqdn, id)
+      bootstrap = Chef::Knife::Bootstrap.new
+      bootstrap.name_args = [fqdn]
+      bootstrap.config[:run_list] = config[:run_list]
+      bootstrap.config[:ssh_user] = locate_config_value(:ssh_user)
+      bootstrap.config[:ssh_password] = locate_config_value(:ssh_password)
+      bootstrap.config[:ssh_port] = config[:ssh_port]
+      bootstrap.config[:identity_file] = config[:identity_file]
+      bootstrap.config[:chef_node_name] = config[:chef_node_name] || id
+      bootstrap.config[:bootstrap_version] = config[:bootstrap_version]
+      bootstrap.config[:distro] = locate_config_value(:distro)
+      bootstrap.config[:use_sudo] = true unless config[:ssh_user] == 'root'
+      bootstrap.config[:use_sudo_password] = true if bootstrap.config[:use_sudo]
+      bootstrap.config[:template_file] = locate_config_value(:template_file)
+      bootstrap.config[:environment] = locate_config_value(:environment)
+
+      bootstrap
+    end
+  end
+end

data/lib/chef/knife/docker_delete.rb

@@ -0,0 +1,80 @@
+#
+# Author:: Emanuele Rocca (<ema@linux.it>)
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+require 'chef/node'
+require 'chef/api_client'
+
+module ChefDocker
+  class DockerDelete < Chef::Knife
+
+    banner "knife docker delete CONTAINER_ID(s) (options)"
+
+    option :_purge,
+        :short => "-P",
+        :long => "--purge",
+        :boolean => true,
+        :default => false,
+        :description => "Destroy corresponding node and client on the Chef Server"
+
+    def run
+      if @name_args.length == 0
+        ui.error("Please provide at least one container id")
+        show_usage
+        exit 1
+      end
+
+      running_containers = []
+
+      `docker ps`.split(/\n/).each do |c|
+        match = c.match(/^(?<id>[\d\w]{12})\s/)
+        if match
+          running_containers.push match['id']
+        end
+      end
+
+      @name_args.each do |name|
+        unless running_containers.include? name
+          ui.warn("Container #{name} does not exist")
+          next
+        end
+
+        delete name
+      end
+    end
+
+    def destroy_item(klass, name, type_name)
+      begin
+        object = klass.load(name)
+        object.destroy
+        ui.warn("Deleted #{type_name} #{name}")
+      rescue Net::HTTPServerException
+        ui.warn("Could not find a #{type_name} named #{name} to delete!")
+      end
+    end
+
+    def delete(container)
+      `docker stop #{container}`
+      `docker rm #{container}`
+
+      if config[:_purge]
+        destroy_item(Chef::Node, container, "node")
+        destroy_item(Chef::ApiClient, container, "client")
+      end
+    end
+  end
+end

data/lib/knife-docker/version.rb

@@ -0,0 +1,6 @@
+module Knife
+  module Docker
+    VERSION = "0.0.1"
+    MAJOR, MINOR, TINY = VERSION.split('.')
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: knife-docker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Emanuele Rocca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Chef's Knife plugin to create and bootstrap Docker containers
+email: ema@linux.it
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/knife-docker/version.rb
+- lib/chef/knife/docker_delete.rb
+- lib/chef/knife/docker_create.rb
+homepage: http://github.com/ema/knife-docker
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Chef's Knife plugin to create and bootstrap Docker containers
+test_files: []