chef-metal-ssh 0.0.2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 double-z
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# ChefMetalSsh
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chef-metal-ssh'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chef-metal-ssh
+
+## Usage
+
+		machine "one" do
+		  action :create
+		  converge true
+		  provisioner ChefMetalSsh::SshProvisioner.new
+		  provisioner_options 'target_ip' => '192.168.33.21',
+		                      'ssh_user' => 'vagrant',
+		                      'ssh_connect_options' => {
+		                        'ssh_pass' => 'vagrant'
+		                      }
+		  recipe 'ssh_test::remote1'
+		  notifies :create, 'machine[two]'
+		  notifies :run, 'execute[run_touch1]'
+		end
+
+To test it out, clone the repo:
+
+`git clone https://github.com/double-z/chef-metal-ssh.git`
+
+in the root there is a Vagrantfile with 3 nodes, 1 master and 2 targets. Run:
+
+first run:
+
+`rake build`
+
+from the repo root to build the gem in the repo root `./pkg/` directory. then run:
+
+`vagrant up`
+
+which will bring up all 3 nodes. FYI, nothing will get installed on your local machine in this proces. So then ssh to the master:
+
+`vagrant ssh master`
+
+the repo test directory has a test cookbook and `run_zero` script. its located at `/vagrant/test`
+
+cd into it:
+
+`cd /vagrant/test`
+
+then run:
+
+`bash run_zero install`
+
+this will install the prereqs. then run:
+
+`bash run_zero both`
+
+this will run the `ssh_test::both` recipe which will converge both targets, with target one
+notifying target two. target one will converge the `ssh_test::remote1` recipe, target two the `ssh_test::remote2` recipe.
+
+thats it.
+
+party on wayne.
+
+## Contributing
+
+1. Fork it ( http://github.com/double-z/chef-metal-ssh/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/chef_metal/provisioner_init/ssh_init.rb

@@ -0,0 +1,4 @@
+require 'chef_metal_ssh/ssh_provisioner'
+
+ChefMetal.add_registered_provisioner_class("ssh",
+  ChefMetalSsh::SshProvisioner)

data/lib/chef_metal_ssh.rb

@@ -0,0 +1,2 @@
+require 'chef_metal'
+require 'chef_metal_ssh/ssh_provisioner'

data/lib/chef_metal_ssh/ssh_provisioner.rb

@@ -0,0 +1,232 @@
+require 'chef_metal/provisioner'
+require 'chef_metal/version'
+require 'chef_metal/machine/basic_machine'
+require 'chef_metal/machine/unix_machine'
+require 'chef_metal/convergence_strategy/install_cached'
+require 'chef_metal/transport/ssh'
+
+module ChefMetalSsh
+  # Provisions machines with ssh.
+  class SshProvisioner < ChefMetal::Provisioner
+
+    def initialize(target_host=nil)
+      @target_host = target_host
+    end
+
+    attr_reader :target_host
+
+    # Acquire a machine, generally by provisioning it.  Returns a Machine
+    # object pointing at the machine, allowing useful actions like setup,
+    # converge, execute, file and directory.  The Machine object will have a
+    # "node" property which must be saved to the server (if it is any
+    # different from the original node object).
+    #
+    # ## Parameters
+    # action_handler - the action_handler object that provides context.
+    # node - node object (deserialized json) representing this machine.  If
+    #        the node has a provisioner_options hash in it, these will be used
+    #        instead of options provided by the provisioner.  TODO compare and
+    #        fail if different?
+    #        node will have node['normal']['provisioner_options'] in it with any options.
+    #        It is a hash with this format:
+    #
+    #           -- provisioner_url: ssh:<ssh_path>
+    #           -- target_ip: the IP address of the target machine - IP or FQDN is required
+    #           -- target_fqdn: The Resolvable name of the target machine - IP or FQDN is required
+    #           -- ssh_user: the user to ssh as
+    #           -- ssh_config: options to pass the ssh command. available options are here - https://github.com/net-ssh/net-ssh/blob/master/lib/net/ssh.rb#L61
+    #
+    #        node['normal']['provisioner_output'] will be populated with information
+    #        about the created machine.  For ssh, it is a hash with this
+    #        format:
+    #
+    #           -- provisioner_url: ssh:<ssh_path>
+    #           -- name: container name
+    #
+    def acquire_machine(action_handler, node)
+      # TODO verify that the existing provisioner_url in the node is the same as ours
+
+      # Set up the modified node data
+      provisioner_options = node['normal']['provisioner_options']
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("acquire_machine - provisioner_options.inspect: #{provisioner_options.inspect}")
+      Chef::Log.debug("======================================>")
+
+      if @target_host.nil?
+        target_host  = get_target_connection_method(node)
+        @target_host = target_host
+      end
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("acquire_machine - target_host: #{target_host}")
+      Chef::Log.debug("======================================>")
+
+      # Set up Provisioner Output
+      # TODO - make url the chef server url path? maybe disk path if zero?
+      provisioner_output = node['normal']['provisioner_output'] || {
+        'provisioner_url' =>   "ssh:#{target_host}",
+        'name' => node['name']
+      }
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("acquire_machine - provisioner_output.inspect: #{provisioner_output.inspect}")
+      Chef::Log.debug("======================================>")
+
+      node['normal']['provisioner_output'] = provisioner_output
+
+      # Create machine object for callers to use
+      machine_for(node)
+    end
+
+    # Connect to machine without acquiring it
+    def connect_to_machine(node)
+      if @target_host.nil?
+        target_host  = get_target_connection_method(node)
+        @target_host = target_host
+      end
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("connect_to_machine - target_host: #{target_host}")
+      Chef::Log.debug("======================================>")
+
+      machine_for(node)
+    end
+
+    def delete_machine(action_handler, node)
+      convergence_strategy_for(node).delete_chef_objects(action_handler, node)
+    end
+
+    def stop_machine(action_handler, node)
+      # What to do What to do. 
+      # On one level there's really only one thing to do here,
+      # shellout and halt, or shutdown -h now, 
+      # maybe provide abitily to pass some shutdown options
+      # But be vewwy vewwy careful, you better have console,
+      # or be close to your datacenter
+      true
+    end
+
+    def restart_machine(action_handler, node)
+      # Full Restart, POST BIOS and all
+    end
+
+    def reload_machine(action_handler, node)
+      # Use `kexec` here to skip POST and BIOS and all that noise.
+    end
+
+    # Not meant to be part of public interface
+    def transport_for(node)
+      create_ssh_transport(node)
+    end
+
+    protected
+
+    def get_target_connection_method(node)
+
+      provisioner_options = node['normal']['provisioner_options']
+
+      target_ip   = ''
+      target_ip   = provisioner_options['target_ip'] || nil
+
+      target_fqdn = ''
+      target_fqdn = provisioner_options['target_fqdn'] || nil
+
+      remote_host = ''
+      if @target_host
+        remote_host = @target_host
+      elsif target_ip
+        remote_host = target_ip
+      elsif target_fqdn
+        remote_host = target_fqdn
+      else
+        raise "aint got no target yo, that dog dont hunt"
+      end
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("get_target_connection_method - remote_host: #{remote_host}")
+      Chef::Log.debug("======================================>")
+
+      remote_host
+    end
+
+    def machine_for(node)
+      ChefMetal::Machine::UnixMachine.new(node, transport_for(node), convergence_strategy_for(node))
+    end
+
+    def convergence_strategy_for(node)
+      @convergence_strategy ||= begin
+        ChefMetal::ConvergenceStrategy::InstallCached.new
+      end
+    end
+
+    # Setup Ssh
+    def create_ssh_transport(node)
+      # TODO - verify target_host resolves
+      # Verify Valid IP
+
+      provisioner_options = node['normal']['provisioner_options']
+
+      ##
+      # Ssh Target
+      target_host = ''
+      target_host = @target_host
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("create_ssh_transport - target_host: #{target_host}")
+      Chef::Log.debug("======================================>")
+
+      ##
+      # Ssh Username
+      username    = ''
+      username    = provisioner_options['ssh_user'] || 'vagrant'
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("create_ssh_transport - username: #{username}")
+      Chef::Log.debug("======================================>")
+
+      ##
+      # Ssh Password
+      ssh_pass = ''
+      ssh_pass = provisioner_options['ssh_connect_options']['ssh_pass']
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("create_ssh_transport - ssh_pass: #{ssh_pass}")
+      Chef::Log.debug("======================================>")
+
+      ##
+      # Ssh Main Options
+      ssh_options = {}
+      ssh_options = {
+        # TODO create a user known hosts file
+        #          :user_known_hosts_file => provisioner_options['ssh_connect_options']['UserKnownHostsFile'],
+        #          :paranoid => true,
+        # :auth_methods => [ 'publickey' ],
+        :keys_only => false,
+        :password => ssh_pass
+      }
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("create_ssh_transport - ssh_options: #{ssh_options.inspect}")
+      Chef::Log.debug("======================================>")
+
+
+      ##
+      # Ssh Additional Options
+      options = {}
+      #Enable pty by default
+      options[:ssh_pty_enable] = true
+
+      if username != 'root'
+        options[:prefix] = 'sudo '
+      end
+
+      Chef::Log.debug("======================================>")
+      Chef::Log.debug("create_ssh_transport - options: #{options.inspect}")
+      Chef::Log.debug("======================================>")
+
+      ChefMetal::Transport::SSH.new(target_host, username, ssh_options, options)
+    end
+
+  end
+end

data/lib/chef_metal_ssh/version.rb

@@ -0,0 +1,3 @@
+module ChefMetalSsh
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: chef-metal-ssh
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Zack Zondlo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: &6594860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *6594860
+- !ruby/object:Gem::Dependency
+  name: chef-metal
+  requirement: &6650460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *6650460
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &6649080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: *6649080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &6647280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6647280
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &6077260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6077260
+description: Provisioner for converging servers using ssh ssh in Chef Metal.
+email: zackzondlo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- Rakefile
+- LICENSE.txt
+- README.md
+- lib/chef_metal/provisioner_init/ssh_init.rb
+- lib/chef_metal_ssh.rb
+- lib/chef_metal_ssh/ssh_provisioner.rb
+- lib/chef_metal_ssh/version.rb
+homepage: https://github.com/double-z/chef-metal-ssh
+licenses: []
+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.11
+signing_key: 
+specification_version: 3
+summary: Provisioner for converging servers using ssh ssh in Chef Metal.
+test_files: []