foreman-architect 0.1.0

data/lib/foreman_vm/foreman_api.rb

@@ -0,0 +1,78 @@
+module ForemanAP
+  # Convenience methods for accessing the REST API of Foreman.
+  #
+  class ForemanAPI 
+
+    require 'logger'
+    require 'net/https'
+    require 'json'
+
+    attr_accessor :log
+
+    # Create an object.
+    # [+uri+] The URI of the Foreman server.
+    # [+user+] The username to login with.
+    # [+password+] The password to login with.
+    def initialize(uri, user, password)
+      @uri = uri
+      @user = user
+      @password = password
+      @log = Logger.new(STDERR)
+    end
+
+    # Send a request to the Foreman API.
+    # [+method+] The HTTP method; can be :post, :put, :get, or :delete
+    # [+path+] The path to the resource, underneath of /api/v2.
+    # [+payload+] The data to provide along with the request.
+    def request(method, path, payload)
+      uri = URI.parse(@uri)
+      path = '/api/v2/' + path
+
+      @log.debug "getting #{path}"
+      # Build the request
+      case method
+      when :post
+        req = Net::HTTP::Post.new(path, initheader = {'Content-Type' =>'application/json'})
+      when :put
+        req = Net::HTTP::Put.new(path, initheader = {'Content-Type' =>'application/json'})
+      when :get
+        req = Net::HTTP::Get.new(path, initheader = {'Content-Type' =>'application/json'})
+      when :delete
+        req = Net::HTTP::Delete.new(path, initheader = {'Content-Type' =>'application/json'})
+      else
+        raise 'Unsuported method'
+      end
+
+      req.basic_auth @user, @password
+      req.body = payload.to_json
+
+      # Submit the request
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE #XXX-FIXME insecure
+      response = http.start { |h| http.request(req) }
+      
+      @log.debug "Response #{response.code} #{response.message}: #{response.body}"
+
+      if response.code != '200'
+        @log.error "Error #{response.code} calling the Foreman API: #{response.body}"
+        raise 'Error calling the Foreman API'
+      end
+
+      return response
+    end
+
+    # Get the ID of a resource in Foreman.
+    # [+path+] The path to the resource, underneath of /api/v2
+    # [+name+] The name to lookup
+    # [+key+] Either 'name' or 'title'. Don't ask why there is a difference.
+    #
+    def get_id(path, name, key='name')
+      raise 'name is required' if name.nil?
+      res = request(:get, "/#{path}?search=#{key}%20=%20\"#{URI.escape(name)}\"", {})
+      id = JSON.parse(res.body)['results'][0]['id']
+      raise 'Unable to get the ID for #{path}/#{key}=#{name}' if id.nil?
+      id
+    end
+  end
+end

data/lib/foreman_vm/getopt.rb

@@ -0,0 +1,151 @@
+class ForemanVM
+  require 'optparse'
+
+  # Parse command line options
+  #
+  def parse_options
+    optparse = OptionParser.new do |opts|
+      
+      opts.on( '--user USER', 'The username to login to Foreman with') do |arg|
+        @user = arg
+      end
+      
+      opts.on( '--password PASSWORD', 'The password to login to Foreman with') do |arg|
+        @password = arg
+      end
+      
+      opts.on( '--password-file FILE', 'The file containing your Foreman password') do |arg|
+        raise 'File does not exist' unless File.exists? arg
+        @password = `cat #{arg}`.chomp
+      end
+      
+      opts.on( '--foreman-uri URI', 'The URI of the Foreman password') do |arg|
+        @foreman_uri = arg
+        #options['foreman_uri'] = arg
+      end
+      
+      
+      opts.separator ""
+      opts.separator "Specific options for building hosts:"
+      
+      opts.on( '--console', 'Attach to the virtual machine console') do |arg|
+        @buildspec['console'] = true
+        @action = 'console' if @action.nil? #XXX-KLUDGE for testing
+      end
+      
+      opts.on( '--cpus CPUS', 'The number of CPUs to assign to the VM') do |arg|
+        @buildspec['cpus'] = arg
+      end
+      
+      opts.on( '--memory BYTES', 'The amount of memory, in bytes, to assign to the VM') do |arg|
+        @buildspec['memory'] = arg
+      end
+      
+      opts.on( '--domain DOMAIN', 'The DNS domain name to use') do |arg|
+        @buildspec['domain'] = arg
+      end
+      
+      opts.on( '--organization ORG', 'The organization name in Foreman') do |arg|
+        @buildspec['organization'] = arg
+      end
+
+      opts.on( '--owner OWNER', 'The owner name in Foreman') do |arg|
+        @buildspec['owner'] = arg
+      end
+      
+      opts.on( '--hostgroup HOSTGROUP', 'The Foreman hostgroup') do |arg|
+        @buildspec['hostgroup'] = arg
+      end
+      
+      opts.on( '--compute-resource RESOURCE', 'The Foreman compute resource') do |arg|
+        @buildspec['compute_resource'] = arg
+      end
+      
+      opts.on( '--provision-method METHOD', 'The provisioning method (image or network)') do |arg|
+        @buildspec['provision_method'] = arg
+      end
+      
+      opts.on( '--environment ENVIRONMENT', 'The Puppet environment') do |arg|
+        @buildspec['environment'] = arg
+      end
+      
+      opts.on( '--network-interface INTERFACE', 'The network interface') do |arg|
+        @buildspec['network_interface'] = arg
+      end
+      
+      opts.on( '--disk-capacity SIZE', 'The size of the first disk, using M or G suffixes') do |arg|
+        @buildspec['disk_capacity'] = arg
+      end
+      
+      opts.on( '--disk-format FORMAT', 'The format of the disk. Can be raw or qcow2') do |arg|
+        @buildspec['disk_format'] = arg
+      end
+      
+      opts.on( '--storage-pool POOL', 'The storage pool') do |arg|
+        @buildspec['storage_pool'] = arg
+      end
+      
+      opts.on( '--subnet SUBNET', 'The subnet') do |arg|
+        @buildspec['subnet'] = arg
+      end
+      
+      # TODO: some nice header thing
+      
+      opts.separator ""
+      opts.separator "Actions:"
+      
+      opts.on( '--rebuild', 'Rebuild the host') do |arg|
+        @action = 'rebuild'
+      end
+      
+      opts.on( '--create', 'Create the host') do |arg|
+        @action = 'create'
+      end
+
+      opts.on( '--create-storage', 'Create storage and attach it to the host') do |arg|
+        @action = 'create-storage'
+      end
+      
+      
+      opts.on( '--delete', 'Delete the host') do |arg|
+        @action = 'delete'
+      end
+
+      opts.on( '--start', 'Power on the VM') do |arg|
+        @action = 'start'
+      end
+
+      opts.on( '--stop', 'Power off the VM, without doing a graceful shutdown') do |arg|
+        @action = 'stop'
+      end
+
+      opts.on( '--dumpxml', 'Show the libvirt XML virtual machine definition') do |arg|
+        @action = 'dumpxml'
+      end
+
+      opts.on( '--monitor-boot', 'Watch the console of a VM as it boots') do |arg|
+        @action = 'monitor-boot'
+      end
+
+      opts.on( '--enable-libgfapi', 'Enable GlusterFS libgfapi') do |arg|
+        @action = 'enable-libgfapi'
+      end
+
+      opts.on( '--disable-libgfapi', 'Disable GlusterFS libgfapi') do |arg|
+        @action = 'disable-libgfapi'
+      end
+      
+      ## Verbosity (DEBUG, WARN, INFO, etc.)
+      ##log_level="DEBUG"
+      
+      opts.on( '-h', '--help', 'Display this screen' ) do
+        puts opts
+        exit
+      end
+    end
+    
+    optparse.parse!
+
+    ask_password if @password.nil?
+  end
+end

data/lib/foreman_vm/hypervisor.rb

@@ -0,0 +1,96 @@
+module ForemanAP
+  # A host in the cluster that runs a hypervisor.
+  class Hypervisor
+    require 'foreman_vm/storage_pool'
+
+    # The total number of CPUs (physical and virtual)
+    def cpus
+      nodeinfo.cpus
+    end
+
+    # The total amount of memory, in bytes.
+    def memory
+      nodeinfo.memory * 1024		# Convert from KiB
+    end
+
+    # The amount of free memory, in bytes.
+    def free_memory
+      @conn.node_free_memory
+    end
+  
+    # Lookup a storage pool by name.
+    def storage_pool(name)
+      StoragePool.new(@conn, name)
+    end
+  
+    # Return the name of hypervisor
+    def hostname
+      @conn.hostname	
+    end
+
+    # A guest running on the hypervisor
+    #   [+fqdn+] the FQDN of the guest
+    def guest(fqdn)
+       ForemanAP::Domain.new(@conn, fqdn, @foreman_api)
+    end
+      
+    # The names of all the domains defined on the hypervisor.
+    def domains
+      res = []
+    
+      # Active domains
+      @conn.list_domains.each do |domid|
+        dom = @conn.lookup_domain_by_id(domid)
+        res.push dom.name
+      end
+    
+      # Inactive domains
+      @conn.list_defined_domains.each do |domname|
+        res.push domname
+      end
+    
+      res
+    end
+
+    # A list of handles to all the active domains on the hypervisor
+    # TODO - replace #domains with this
+    def domains2
+      res = []
+
+      # Active domains
+      @conn.list_domains.each do |domid|
+        dom = @conn.lookup_domain_by_id(domid)
+        res.push ForemanAP::Domain.new(@conn, dom.name, @foreman_api)
+      end
+
+      res
+    end
+    
+    # Create an object.
+    #
+    # [+uri+] The libvirt URI. Example: qemu+tcp:///host/system
+    # [+user+] The username to login with.
+    # [+passphrase+] The passphrase to login with.
+    def initialize(uri, user, passphrase)
+      @uri = uri
+      @conn = Libvirt::open_auth(@uri, 
+    		[Libvirt::CRED_AUTHNAME, Libvirt::CRED_PASSPHRASE]) do |cred|
+         case cred["type"]
+         when Libvirt::CRED_AUTHNAME 
+           user
+         when Libvirt::CRED_PASSPHRASE
+           passphrase
+         else
+           raise 'Unknown error'
+         end
+      end
+    end
+
+    private
+    
+    # The 'nodeinfo' structure for the connection
+    def nodeinfo
+      @nodeinfo ||= @conn.node_get_info
+    end
+  end
+end

data/lib/foreman_vm/storage_pool.rb

@@ -0,0 +1,104 @@
+module ForemanAP
+  # A storage pool containing disk volumes.
+  class StoragePool
+    require 'foreman_vm/volume'
+  
+    # Scan the pool for changes. This is useful for pools that are shared
+    # across multiple hosts in a cluster.
+    def refresh
+      @sph.refresh
+      true
+    end
+  
+    # Lookup a volume by +name+, and return an object handle.
+    def volume(name)
+      Volume.new(@sph, name)
+    end
+  
+    # Create a new object.
+    #
+    # [+conn+] A libvirt connection handle.
+    # [+name+] The name of the storage pool.
+    #
+    def initialize(conn, name)
+      @sph = conn.lookup_storage_pool_by_name(name)
+    end
+
+    # Create a new volume within the storage pool.
+    # [+path+] the full path to the volume
+    # [+capacity+] the disk capacity, in bytes
+    #
+    def create_volume(path,capacity)
+      xml = "<volume>
+               <name>#{File.basename(path)}</name>
+               <key>#{path}</key>
+               <source>
+               </source>
+               <capacity unit='bytes'>#{capacity}</capacity>
+               <allocation unit='bytes'>197120</allocation>
+               <target>
+                 <path>#{path}</path>
+                 <format type='raw'/>
+                 <permissions>
+                   <mode>0660</mode>
+                   <owner>107</owner>
+                   <group>107</group>
+                 </permissions>
+               </target>
+             </volume>
+      "
+      #TODO: @log.debug "creating volume: #{xml}"
+      @sph.create_volume_xml(xml)
+     end
+  end
+end
+
+#--
+## Legacy code below here
+
+class ForemanVM
+ 
+# Copy an existing disk volume to reduce the build time
+# 
+def copy_volume
+  delete_volume
+
+  virsh "vol-clone --pool #{@buildspec['storage_pool']} --vol #{@buildspec['_disk_backing_file']} --newname #{fqdn()}-disk1"
+end
+
+# Clone an existing disk volume to reduce the build time
+# 
+def clone_volume
+  delete_volume
+
+  # BUG: We would like to do this, but it creates the file owned by root:root
+  #virsh "vol-create-as --pool #{@buildspec['storage_pool']} --name #{fqdn()}-disk1 --capacity 30G --format qcow2 --backing-vol #{@buildspec['_disk_backing_file']} --backing-vol-format qcow2"
+  #
+  # WORKAROUND: use an XML volume definition to set the owner/group
+  #  
+  xml = "<volume>
+  <name>#{fqdn}-disk1</name>
+  <key>/gvol/images/#{fqdn}-disk1</key>
+  <source>
+  </source>
+  <capacity unit='bytes'>32212254720</capacity>
+  <allocation unit='bytes'>197120</allocation>
+  <target>
+    <path>/gvol/images/#{fqdn}-disk1</path>
+    <format type='qcow2'/>
+    <permissions>
+      <mode>0660</mode>
+      <owner>107</owner>
+      <group>107</group>
+    </permissions>
+  </target>
+  <backingStore>
+    <path>#{@buildspec['_disk_backing_file']}</path>
+    <format type='qcow2'/>
+  </backingStore>
+</volume>
+"
+  @log.debug "creating volume: #{xml}"
+  virsh("vol-create --pool gvol --file /dev/stdin >/dev/null", xml)
+end
+end

data/lib/foreman_vm/util.rb

@@ -0,0 +1,18 @@
+# Miscellaneous utility functions
+module FVMUtil
+  # Given an FQDN, return the shortname
+   def shortname(fqdn)
+    fqdn.sub(/\..*/, '') 
+  end
+
+  # Given an amount in bytes, return the human-readable version in GiB
+  def gigabytes(s)
+    if s.to_i < 1073741824
+      mb = s.to_f / 1024 / 1024
+      sprintf '%0.0f MiB', mb
+    else
+      gb = s.to_f / 1024 / 1024 / 1024
+      sprintf '%0.0f GiB', gb
+    end
+  end 
+end