knife-hmc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bcc750013a4018b14ffe0bcc02c18db42f31df1
+  data.tar.gz: fb803c448f5e835d188638363b02f95412428bdb
+SHA512:
+  metadata.gz: 7f87452613f678c89917a6a51fec584cfd6788456ee1216053a7238786533de1722571904833aa8e4f019a13102ea8f5f412db116065bb2b8e8843e5542ccfcb
+  data.tar.gz: ccc414ceeae6e6b383f47f7435dccff86b27308b67bc39ea72db89aea1c3fca4a9cacf87572d8df3613effb8318fe4c6a2ee72f6960efa1ac25f2b7567cf7fe8

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## V0.0.1
+* initial version (unreleased)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knife-hmc.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+© Copyright IBM Corporation 2014.
+
+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,103 @@
+# Knife::Hmc
+
+A Chef Knife plugin for creating, deleting, bootstrapping, and managing LPARs and P series virtual infrastructure.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knife-hmc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knife-hmc
+
+## Configuration
+Add the path to the chef-client AIX installable on your Chef Server to your `knife.rb` file
+to add support for Chef bootstrapping an AIX node as a part of 'knife hmc server create'.
+
+```ruby
+log_level                :info
+log_location             STDOUT
+node_name                'node'
+client_key               '/path/to/key.pem'
+validation_client_name   'some-validator'
+validation_key           '/path/to/validator.pem'
+chef_server_url          'https://example.com/organizations/org'
+syntax_check_cache_path  '/path/to/syntax_check_cache'
+knife[:chef_client_aix_path] = "<CHEF SERVER LOCAL PATH TO AIX BINARY>"
+```
+
+## Usage
+
+See `knife hmc SUBCOMMAND --help` for help on usage. Here are subcommands that usage help
+can be provided for:
+
+```ruby
+knife hmc server create --help
+knife hmc server delete --help
+knife hmc server config --help
+knife hmc server list --help
+
+knife hmc image list --help
+
+knife hmc disk list --help
+knife hmc disk add --help
+knife hmc disk remove --help
+```
+
+EXAMPLES:
+
+
+```bash
+# look at all the LPARs on a frame or in an environment
+user@local> knife hmc server list --hmc_host testhmc.us.ibm.com --hmc_user hscroot --hmc_pass passw0rd \
+[--frame FRAME]
+```
+
+```bash
+# LPAR creation and BOS install with the minimum arguments
+user@local> knife hmc server create --hmc_host testhmc.us.ibm.com --hmc_user hscroot --hmc_pass passw0rd \
+--frame test_frame \
+--lpar test_lpar \
+--primary_vio test_vio1 \
+--secondary_vio test_vio2 \
+--des_proc 2.0 \
+--des_vcpu 2 \
+--des_mem 2048 \
+--nim_host testnim.us.ibm.com \
+--nim_user root \
+--nim_pass passw0rd \
+--image image_name \
+--ip_address lpar_ip \
+--size 90 \
+--vlan_id vlan \
+--register_node chef_server_url \
+--bootstrap_pass passw0rd
+```
+
+```bash
+# List all of the images that an environment's
+# NIM can deploy
+user@local> knife hmc image list --nim_host testnim.us.ibm.com --nim_user root --nim_pass passw0rd
+```
+
+```bash
+# List all of this disks
+# that a VIO pair has access to
+user@local> knife hmc disk list --hmc_host testhmc.us.ibm.com --hmc_user hscroot --hmc_pass passw0rd \
+--primary_vio test_vio_1 \
+--secondary_vio test_vio_2 \
+--frame test_frame \
+[--lpar test_lpar_name | --available | --used]
+```
+
+#### Legal stuff
+Use of this software requires runtime dependencies.  Those dependencies and their respective software licenses are listed below.
+
+* [net-ssh](https://github.com/net-ssh/net-ssh/) - LICENSE: [MIT](https://github.com/net-ssh/net-ssh/blob/master/LICENSE.txt)
+* [net-scp](https://github.com/net-ssh/net-scp/) - LICENSE: [MIT](https://github.com/net-ssh/net-scp/blob/master/LICENSE.txt)

data/Rakefile

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

data/knife-hmc.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife-hmc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knife-hmc"
+  spec.version       = Knife::Hmc::VERSION
+  spec.authors       = ["John J. Rofrano,Christopher M. Wood, John F. Hutchinson"]
+  spec.email         = ["rofrano@us.ibm.com, woodc@us.ibm.com, jfhutchi@us.ibm.com"]
+  spec.summary       = %q{IBM Hardware Management Console support for Chef's Knife Command}
+  spec.description   = "Knife plugin for use with IBM Hardware Management Console"
+  spec.homepage      = "http://github.com/pseries/knife-hmc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("rbvppc", "~> 1.0.0")
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.required_ruby_version = '>= 2.1.0'
+end

data/lib/chef/knife/hmc_base.rb

@@ -0,0 +1,131 @@
+#
+# Authors: Christopher M Wood (<woodc@us.ibm.com>)
+#          John F Hutchinson (<jfhutchi@us.ibm.com>) 
+# © Copyright IBM Corporation 2015.
+#
+# LICENSE: MIT (http://opensource.org/licenses/MIT)
+# 
+
+require 'knife-hmc/version'
+
+class Chef
+  class Knife
+    module HmcBase
+      
+      # :nodoc:
+      #####################################################
+      #  included
+      #####################################################
+      def self.included(includer)
+        includer.class_eval do
+
+          deps do
+            require 'chef/json_compat'
+            require 'chef/knife'
+            require 'readline'
+            require 'rbvppc'
+            require 'netaddr'
+            Chef::Knife.load_deps
+          end
+
+          option :hmc_host,
+                 :short => "-h HOST",
+                 :long => "--hmc_host HOST",
+                 :description => "The fully qualified domain name of the HMC host",
+                 :proc => Proc.new { |key| Chef::Config[:knife][:hmc_host] = key }
+
+          option :hmc_username,
+                 :short => "-U USERNAME",
+                 :long => "--hmc_user USERNAME",
+                 :description => "The username for the HMC",
+                 :proc => Proc.new { |key| Chef::Config[:knife][:hmc_username] = key }
+
+          option :hmc_password,
+                 :short => "-P PASSWORD",
+                 :long => "--hmc_pass PASSWORD",
+                 :description => "The password for hmc",
+                 :proc => Proc.new { |key| Chef::Config[:knife][:hmc_password] = key }
+
+        end
+      end
+
+      #####################################################
+      #  tcp_ssh_alive
+      #  Returns true if the hostname specified is
+      #  accepting SSH connections. Returns false otherwise
+      #####################################################
+      def tcp_ssh_alive(hostname,port=22)
+        tcp_socket = TCPSocket.new(hostname, port)
+        readable = IO.select([tcp_socket], nil, nil, 5)
+        if readable
+          Chef::Log.debug("sshd accepting connections on #{hostname}, banner is #{tcp_socket.gets}")
+          true
+        else
+          false
+        end
+        
+        rescue Errno::ETIMEDOUT
+          false
+        rescue Errno::EPERM
+          false
+        rescue Errno::ECONNREFUSED
+          sleep 2
+          false
+        rescue Errno::EHOSTUNREACH, Errno::ENETUNREACH
+          sleep 2
+          false
+        ensure
+          tcp_socket && tcp_socket.close
+      end
+
+      #####################################################
+      #  validate!
+      #####################################################
+      def validate!(keys=[:hmc_host, :hmc_username, :hmc_password])
+        errors = []
+
+        keys.each do |k|
+          pretty_key = k.to_s.gsub(/_/, ' ').gsub(/\w+/){ |w| (w =~ /(ssh)|(aws)/i) ? w.upcase  : w.capitalize }
+          if Chef::Config[:knife][k].nil? and config[k].nil?
+            errors << "You did not provide a valid '#{pretty_key}' value."
+          end
+        end
+
+        if errors.each{|e| ui.error(e)}.any?
+          exit 1
+        end
+      end
+
+      #####################################################
+      #  validate - no exit on errors
+      #####################################################
+      def validate(keys)
+        errors = []
+
+        keys.each do |k|
+          pretty_key = k.to_s.gsub(/_/, ' ').gsub(/\w+/){ |w| (w =~ /(ssh)|(aws)/i) ? w.upcase  : w.capitalize }
+          if Chef::Config[:knife][k].nil? and config[k].nil?
+            errors << "You did not provide a valid '#{pretty_key}' value."
+          end
+        end
+
+        if errors.empty?
+          return true
+        else
+          return false
+        end
+      end
+
+      #####################################################
+      #  get config
+      #####################################################
+      def get_config(key)
+        key = key.to_sym
+        rval = config[key] || Chef::Config[:knife][key] || $default[key]
+        Chef::Log.debug("value for config item #{key}: #{rval}")
+        rval
+      end
+
+    end
+  end
+end

data/lib/chef/knife/hmc_disk_add.rb

@@ -0,0 +1,116 @@
+#
+# Authors: Christopher M Wood (<woodc@us.ibm.com>)
+#          John F Hutchinson (<jfhutchi@us.ibm.com>) 
+# © Copyright IBM Corporation 2015.
+#
+# LICENSE: MIT (http://opensource.org/licenses/MIT)
+# 
+
+require 'chef/knife/hmc_base'
+
+class Chef
+  class Knife
+    class HmcDiskAdd < Knife
+
+      include Knife::HmcBase
+
+      banner "knife hmc disk add (options)"
+
+      option :frame_name,
+        :short => "-f NAME",
+        :long => "--frame NAME",
+        :description => "Name of the Host in which the LPAR resides."
+
+      option :lpar_name,
+        :short => "-l NAME",
+        :long => "--lpar",
+        :description => "Name of LPAR you wish to delete."
+
+      option :vio1_name,
+        :short => "-p NAME",
+        :long => "--primary_vio NAME",
+        :description => "Name of the primary vio."
+
+      option :vio2_name,
+        :short => "-s NAME",
+        :long => "--secondary_vio NAME",
+        :description => "Name of the secondary vio."  
+
+      option :size,
+        :short => "-S SIZE",
+        :long => "--size_in_GB SIZE",
+        :description => "The size in GB you require, will find the size requested or larger."
+
+      option :volume_group,
+        :short => "-g NAME",
+        :long => "--volume_group NAME",
+        :description => "Name of volume group disk will be used in. If rootvg is passed then script will find a single LUN vs multiple smaller luns to fit request."
+
+      def run
+   		  Chef::Log.debug("Adding disk...")
+
+        validate!([:frame_name,:lpar_name,:vio2_name,:vio1_name,:size])
+
+        hmc = Hmc.new(get_config(:hmc_host), get_config(:hmc_username) , {:password => get_config(:hmc_password)}) 
+        hmc.connect
+
+        #Populate hash to make LPAR object
+        lpar_hash = hmc.get_lpar_options(get_config(:frame_name),get_config(:lpar_name))
+        #Create LPAR object based on hash, and VIO objects
+        lpar = Lpar.new(lpar_hash)
+        vio1 = Vio.new(hmc, get_config(:frame_name), get_config(:vio1_name))
+        vio2 = Vio.new(hmc, get_config(:frame_name), get_config(:vio2_name))
+
+        #Get vSCSI Information
+        lpar_vscsi = lpar.get_vscsi_adapters
+        first_slot = nil
+        second_slot = nil
+        adapter_cnt = 0
+
+        if lpar_vscsi.empty? == true
+          #Add vSCSI Adapters
+          lpar.add_vscsi(vio1)
+          lpar.add_vscsi(vio2)
+          lpar_vscsi = lpar.get_vscsi_adapters
+        else
+          lpar_vscsi.each do |adapter|
+            if adapter.remote_lpar_name == vio1.name
+              first_slot = adapter.remote_slot_num
+              adapter_cnt += 1
+            elsif adapter.remote_lpar_name == vio2.name
+              second_slot = adapter.remote_slot_num
+              adapter_cnt += 1
+            end
+          end 
+
+          if first_slot.nil? or second_slot.nil? or adapter_cnt != 2
+            #Could not determine which vSCSIs to use
+            error = "Unable to determine which vSCSI adapters to use"
+            puts "#{error}"
+            ui.error(error)
+            exit 1         
+          end
+        end  
+        
+        #Find the vHosts
+        first_vhost = vio1.find_vhost_given_virtual_slot(lpar_vscsi[0].remote_slot_num)
+        second_vhost = vio2.find_vhost_given_virtual_slot(lpar_vscsi[1].remote_slot_num)
+        
+        #Check for volume group flag and add LUN to LPAR
+        if validate([:volume_group])
+          if get_config(:volume_group).to_s.downcase == "rootvg"
+            vio1.map_single_disk_by_size(first_vhost,vio2,second_vhost,get_config(:size).to_i)
+            puts "Successfully attached LUN to #{get_config(:lpar_name)}"        
+          else
+            vio1.map_by_size(first_vhost,vio2,second_vhost,get_config(:size).to_i)
+            puts "Successfully attached LUN(s) to #{get_config(:lpar_name)}"  
+          end
+        else
+          vio1.map_by_size(first_vhost,vio2,second_vhost,get_config(:size).to_i)
+          puts "Successfully attached LUN(s) to #{get_config(:lpar_name)}" 
+        end       
+        hmc.disconnect        
+      end
+    end
+  end
+end

data/lib/chef/knife/hmc_disk_list.rb

@@ -0,0 +1,173 @@
+#
+# Authors: Christopher M Wood (<woodc@us.ibm.com>)
+#          John F Hutchinson (<jfhutchi@us.ibm.com>) 
+# © Copyright IBM Corporation 2015.
+#
+# LICENSE: MIT (http://opensource.org/licenses/MIT)
+# 
+
+require 'chef/knife/hmc_base'
+
+class Chef
+  class Knife
+    class HmcDiskList < Knife
+
+      include Knife::HmcBase
+
+      banner "knife hmc disk list -r VIONAME1 -s VIONAME2 -f FRAMENAME [-l LPARNAME | -a | -x]"
+
+      option :primary_vio,
+             :short => "-r VIONAME",
+             :long => "--primary_vio VIONAME",
+             :description => "The LPAR name of the Primary VIO"
+
+      option :secondary_vio,
+             :short => "-s VIONAME",
+             :long => "--secondary_vio VIONAME",
+             :description => "The LPAR name of the Secondary VIO"
+
+      option :frame,
+             :short => "-f FRAMENAME",
+             :long => "--frame FRAMENAME",
+             :description => "The name of the Frame in which the VIOs reside"
+
+      option :lpar,
+             :short => "-l LPARNAME",
+             :long => "--lpar LPARNAME",
+             :description => "The name of the LPAR whose disks should be listed (optional)"
+
+      option :only_available,
+             :short => "-a",
+             :long => "--available",
+             :boolean => true,
+             :default => false,
+             :description => "List ONLY the available disks in this VIO pair (optional)"
+
+      option :only_used,
+             :short => "-x",
+             :long => "--used",
+             :boolean => true,
+             :default => false,
+             :description => "List ONLY the used disks in this VIO pair (optional)"
+
+
+      def run
+   		  Chef::Log.debug("Listing disks...")
+
+        validate!
+        hmc = Hmc.new(get_config(:hmc_host), get_config(:hmc_username) , {:password => get_config(:hmc_password)}) 
+        hmc.connect
+
+        validate!([:primary_vio,:secondary_vio,:frame])
+
+        frame = get_config(:frame)
+        primary_vio_name = get_config(:primary_vio)
+        secondary_vio_name = get_config(:secondary_vio)
+
+        #Make Vio objects for the two VIOs
+        primary_vio = Vio.new(hmc,frame,primary_vio_name)
+        secondary_vio = Vio.new(hmc,frame,secondary_vio_name)
+
+        #Arrays that will hold the disks to list
+        vio1_disks = []
+        vio2_disks = []
+
+        if validate([:lpar])
+          #Show only disks attached to the specified LPAR
+          lpar_name = get_config(:lpar)
+          options_hash = hmc.get_lpar_options(frame,lpar_name)
+          lpar = Lpar.new(options_hash)
+
+          #Get the vSCSIs from this LPAR and determine the virtual adapter
+          #slots used by each VIO
+          vscsi_adapters = lpar.get_vscsi_adapters
+          primary_vio_slot = nil
+          secondary_vio_slot = nil
+          adapter_cnt=0
+          vscsi_adapters.each do |adapter|
+            if adapter.remote_lpar_name == primary_vio.name
+              primary_vio_slot = adapter.remote_slot_num
+              adapter_cnt += 1
+            elsif adapter.remote_lpar_name == secondary_vio.name
+              secondary_vio_slot = adapter.remote_slot_num
+              adapter_cnt += 1
+            end             
+          end
+
+          if primary_vio_slot.nil? or secondary_vio_slot.nil? or adapter_cnt != 2
+            #Could not determine which vSCSIs to use
+            error = "Unable to determine which vSCSI adapters have storage attached to it from #{primary_vio_name} and #{secondary_vio_name}\n" +
+                    "Cannot list disks attached to #{lpar_name}"
+            puts "#{error}"
+            ui.error(error)           
+            exit 1            
+          end
+
+          #Find the vhosts that hold this LPARs disks
+          primary_vhost = primary_vio.find_vhost_given_virtual_slot(primary_vio_slot)
+          secondary_vhost = secondary_vio.find_vhost_given_virtual_slot(secondary_vio_slot)
+
+          #Get the names (known to the VIOs) of the disks attached to the LPAR
+          vio1_disks = primary_vio.get_attached_disks(primary_vhost)
+          vio2_disks = secondary_vio.get_attached_disks(secondary_vhost)        
+        elsif get_config(:only_available)
+          #Show only available disks
+          vio1_disks = primary_vio.available_disks
+          vio2_disks = secondary_vio.available_disks
+        elsif get_config(:only_used)
+          #Show only used disks
+          vio1_disks = primary_vio.used_disks
+          vio2_disks = secondary_vio.used_disks
+        else
+          #None of :lpar, :only_available, and :only_used options were specified.
+          #Show used *and* available disks
+          vio1_disks = primary_vio.available_disks + primary_vio.used_disks
+          vio2_disks = secondary_vio.available_disks + secondary_vio.used_disks
+        end
+
+        #List the disks populated in vio1_disks and vio2_disks
+        print_header
+
+        vio1_disks.each do |v1_disk|
+          vio2_disks.each do |v2_disk|
+            if v1_disk == v2_disk
+              print_line(v1_disk,v2_disk)
+            end
+          end
+        end
+        
+        hmc.disconnect
+        
+      end
+
+      ##################################################
+      # print_header
+      # => Prints table header for disk list
+      ##################################################
+      def print_header
+        if validate([:lpar])
+          puts "Listing information on all disks attached to #{get_config(:lpar)}\n"
+        elsif get_config(:only_available)
+          puts "Listing only available disks on this VIO Pair\n"
+        elsif get_config(:only_used)
+          puts "Listing only used disks on this VIO Pair\n"
+        else
+          puts "Listing all disks on this VIO Pair\n"
+        end
+
+        printf "%-20s %10s %20s %20s\n", "PVID", "Size (MB)", "Name (on #{get_config(:primary_vio)})", "Name (on #{get_config(:secondary_vio)})"
+        printf "-----------------------------------------------------------------------------------------\n"
+      end
+
+      ##################################################
+      # print_line
+      # => Prints a single line of the output table
+      #    given two Lun objects representing the same
+      #    disk on a pair of VIOs
+      ##################################################
+      def print_line(vio1_disk,vio2_disk)
+        printf "%-20s %10s %20s %20s\n", vio1_disk.pvid, "#{vio1_disk.size_in_mb} MB", vio1_disk.name, vio2_disk.name
+      end
+    end
+  end
+end