foreman-architect 0.1.0

data/lib/foreman_vm/buildspec.rb

@@ -0,0 +1,48 @@
+module ForemanAP
+  # A build specification 
+  class BuildSpec 
+
+    # Short hostname
+    attr_accessor :name
+    # DNS domain name
+    attr_accessor :domain
+    # Number of CPUs
+    attr_accessor :cpus
+    # Amount of memory
+    attr_accessor :memory
+    # Amount of disk space. Multiple disks can be separated with a comma.
+    attr_accessor :disk_capacity
+    # The disk format; either raw or qcow2
+    attr_accessor :disk_format
+    # The libvirt storage pool
+    attr_accessor :storage_pool
+    # Network interface
+    attr_accessor :network_interface
+
+    # Generate output suitable for feeding into the Foreman API
+    def to_foreman_api
+      rec = {}
+      rec['compute_attributes'] = {}
+      rec['compute_attributes']['volumes_attributes'] = disk_capacity_to_api
+      rec
+    end
+
+  private
+
+  # Get the Foreman API equivalent for disk capacity
+  def disk_capacity_to_api
+    res = {}
+    disks = @disk_capacity
+    volume_id = 0
+    disks.split(',').each do |disk_size|
+      res[volume_id.to_s] = {
+        'capacity' => disk_size,
+        'pool_name' => @storage_pool,
+        'format_type' => @disk_format,
+      }
+      volume_id += 1
+    end
+    res
+  end
+  end
+end

data/lib/foreman_vm/cluster.rb

@@ -0,0 +1,83 @@
+module ForemanAP
+  # A cluster of hypervisors.
+  class Cluster
+  
+  # Return a handle to the guest domain
+  # [+fqdn+] the FQDN of the guest
+  def guest(fqdn)
+    host = member(find(fqdn)) or raise 'Guest not found'
+    host.guest(fqdn)
+  end
+
+  # Return name of best hypervisor
+  # [+name+] The name of the guest to be added
+  # [+memory+] The total size of the guest in Bytes
+  def best_fit(name, memory)
+    alloc = ForemanAP::Allocator.new
+    @members.each do |hostname|
+      host = member(hostname)
+      alloc.add_host(host.hostname, host.free_memory, host.domains)   
+    end
+    alloc.add_guest(name, memory)
+  end
+
+    # DEPRECATED - avoid using these
+    attr_accessor :user, :password
+
+    # A list of the names of all members of the cluster.
+    attr_reader :members
+
+    # Return a list of all Hypervisor objects in the cluster
+    # TODO: replace #members with this function
+    def members2
+      @hv.values
+    end
+    
+    # The name of the hypervisor that contains a given virtual machine.
+    # [+vm+] The name of the virtual machine.
+    def find(vm)
+      @members.each do |host|
+        #puts host
+        #puts @hv[host].free_memory
+        #puts @hv[host].domains.join("\n")
+        if @hv[host].domains.include? vm
+          return host
+        end
+      end
+      return nil
+    end
+  
+    # A handle to the ForemanAP::Hypervisor object for a member of the cluster.
+    # [+name+] The name of the hypervisor.
+    def member(name)
+     unless @hv.include? name
+       raise ArgumentError, "hypervisor #{name} is not defined"
+     end 
+     @hv[name]
+    end
+
+    # Migrate a virtual machine from one host to another (FIXME - UNIMPLEMENTED)
+    # [+guest+] The name of the guest
+    # [+destination+] The target hypervisor
+    def migrate(guest, destination)
+      # TODO: the equivalent of this:
+      # virsh migrate $vm qemu+ssh://${target}-san.brontolabs.local/system --verbose --persistent --undefinesource --live --timeout 60
+      raise 'STUB'
+    end
+    
+    # Create an object.
+    # [+members+] A list of names of hypervisors to be members.
+    # [+user+] The libvirtd username.
+    # [+password+] The libvirtd password.
+    def initialize(members, user, password)
+      @members = members
+      @hv = {}
+      @user = user
+      @password = password
+      @members.each do |fqdn|
+        uri = 'qemu+tcp://' + fqdn + '/system'
+        @hv[fqdn] = Hypervisor.new(uri, @user, @password)
+      end
+    end
+  end
+end

data/lib/foreman_vm/config.rb

@@ -0,0 +1,55 @@
+module ForemanAP
+  # Parse the configuration file and provide configuration variables.
+  #
+  class Config
+  
+    require 'yaml'
+    
+    # The user account to login to Foreman as.
+    attr_reader :foreman_user
+    # The password to login to Foreman with.
+    attr_reader :foreman_password
+    # The URI of the Foreman server.
+    attr_reader :foreman_uri
+    # The user account to login to libvirtd as.
+    attr_reader :libvirt_user
+    # The password to login to libvirtd with.
+    attr_reader :libvirt_password
+    # DEPRECATED -- do not use
+    attr_reader :foreground
+    # DEPRECATED -- do not use
+    attr_reader :reap_buried_jobs
+    # A list of all hypervisors in the cluster.
+    attr_reader :hypervisors
+    # The name of the shared storage pool to use on all hypervisors.
+    attr_reader :storage_pool
+    # The FQDN of the GlusterFS server
+    attr_reader :glusterfs_server
+    # The email address of the support team to contact if something goes wrong.
+    attr_reader :support_contact_email
+    
+    # Create an object
+    # [+conffile+] the path to the configuration file.
+    def initialize(conffile = nil)
+      if conffile.nil?
+        confdir = File.dirname(__FILE__) + '/../../conf'
+        conffile = confdir + '/worker.yaml'
+      end
+      config = {
+        :foreground => true,
+        :reap_buried_jobs => true,
+      }
+      case conffile.kind_of?
+      when String
+        config.merge!(YAML.load_file(conffile))
+      when Hash
+        config.merge! conffile
+      else
+        raise ArgumentError
+      end
+
+      config.each { |k,v| instance_variable_set("@#{k}", v) }
+      config
+    end
+  end
+end

data/lib/foreman_vm/console.rb

@@ -0,0 +1,83 @@
+module ForemanAP
+
+  # Functions related viewing to the virtual machine console
+  # 
+  class ConsoleViewer
+  
+    require 'cgi'
+    require 'pty'
+    require 'timeout'
+    
+    # If true, output will be formatted for HTML display.
+    attr_accessor :html
+    
+    # Create an object.
+    # [+cluster+] a ForemanAP::Cluster object.
+    #
+    def initialize(cluster)
+      @cluster = cluster
+      @html = false
+      @autoclose = nil
+    end
+
+    # Specify a pattern that will cause the console to be automatically
+    # closed when it is found in the output.
+    #
+    #   Example:  / login:/
+    #   
+    def autoclose=(pattern)
+      raise 'Regular expression expected' unless pattern.class == Regexp
+      @autoclose = pattern
+    end
+
+    # Attach to the serial console of the virtual machine.
+    #
+    def attach(guest)
+      host = @cluster.find(guest)
+      puts "Connecting to the serial console of #{guest} via #{host}... "
+      print '<pre>' if @html
+      ENV['LIBVIRT_AUTH_FILE'] = File.dirname(__FILE__) + '/../../conf/auth.conf'
+    begin
+      PTY.spawn("virsh -c qemu+tcp://#{host}/system console #{guest}") do |stdin, stdout, pid|
+      begin
+        # Regularly try to flush the output in a different thread
+        # This allows us to detect when the client hangs up even if
+        # the main thread is blocked trying to read from the VM console.
+        if @html
+          t = Thread.new {
+            while true
+              $stdout.flush or raise 'client has disconnected'
+              sleep(5)
+            end
+          }
+          t.abort_on_exception = true
+        end
+ 
+        stdout.write ""
+        stdout.flush
+
+        stdin.each do |line| 
+          if @html
+            # TODO: translate ANSI colors into HTML colors
+            print CGI::escapeHTML(line).chomp
+          else
+            print line
+          end
+          $stdout.flush or exit(0)
+          if @autoclose and line =~ @autoclose
+            puts "(the console was automatically closed)"
+            exit 0
+          end
+        end
+        rescue Errno::EIO
+          puts "Errno:EIO error, but this probably just means " +
+                "that the process has finished giving output"
+        end
+      end
+      rescue PTY::ChildExited
+        puts "The child process exited!"
+      end
+      print '</pre>' if @html
+    end
+  end  
+end

data/lib/foreman_vm/domain.rb

@@ -0,0 +1,192 @@
+module ForemanAP
+  # A virtual machine or container, i.e. a "domain" within libvirt
+  #
+  class Domain
+
+    require 'rexml/document'
+
+    # Return the hostname of the domain
+    def name
+      @dom.name
+    end
+
+    # Return the amount of memory allocated to the domain, in bytes
+    def memory
+      # Convert from KiB to bytes
+      @dom.info.max_mem.to_i * 1024
+    end
+
+    # Return the number of vCPUs allocated to the domain
+    def vcpu_count
+      @dom.info.nr_virt_cpu
+    end
+
+    # Add a storage volume that uses libgfapi.
+    #  
+    # [+volume_name+] The name of the volume.
+    # [+host_name+] The FQDN or IP address of the GlusterFS server.
+    # [+device_id+] The position the disk appears on the SCSI bus, starting at one.
+    def add_libgfapi_volume(volume_name, host_name, device_id)
+      # Determine the target disk name.
+      target_dev = 'vd' + ('a'..'z').to_a[device_id - 1]
+
+      disk_xml = REXML::Document.new "
+    <disk type='network' device='disk'>
+      <driver name='qemu' type='raw' cache='none'/>
+      <source protocol='gluster' name='#{volume_name}'>
+        <host name='#{host_name}' port='0'/>
+      </source>
+      <target dev='#{target_dev}' bus='virtio'/>
+      <alias name='virtio-disk#{device_id}'/>
+    </disk>
+      "
+      
+      # Modify the domain XML to insert the disk
+      domain_xml = REXML::Document.new(@dom.xml_desc)
+      #puts 'OLD: ' + domain_xml.to_s
+      domain_xml.elements.each('domain/devices') do |ele|
+        ele.add_element(disk_xml.root)
+      end
+      #puts 'NEW: ' + domain_xml.to_s
+
+      @dom.undefine
+      @dom = @conn.define_domain_xml(domain_xml.to_s)
+    end
+
+    # Start (power on) the domain
+    def start
+      @dom.create
+    end
+
+    # Create an object.
+    # [+conn+] A connection to libvirtd on a hypervisor
+    # [+name+] The name of the domain 
+    # [+foreman_api+] A handle to a ForemanAP::ForemanAPI object.
+    def initialize(conn, name, foreman_api)
+      @conn = conn
+      @dom = conn.lookup_domain_by_name(name)
+      @foreman_api = foreman_api
+    end
+  end
+end
+
+#--
+###### LEGACY STUFF BELOW HERE
+
+class ForemanVM
+
+def snapshot_list
+  virsh("snapshot-list #{self.fqdn}")
+end
+  
+# Create a snapshot of the virtual machine
+#
+def snapshot_create
+  raise 'the VM must be powered down before taking a snapshot' \
+     if domstate != 'running'
+  raise 'a snapshot already exists' if snapshot_list =~ /shutoff/
+  virsh("snapshot-create #{fqdn}")
+end
+
+# Revert a virtual machine back to a snapshot
+#
+def snapshot_revert
+  raise 'a snapshot does not exist' if snapshot_list =~ /shutoff/
+  stop
+  virsh("snapshot-revert #{fqdn} --current")
+end
+
+# Delete a virtual machine snapshot
+#
+def snapshot_delete
+  virsh("snapshot-delete #{fqdn} --current")
+end
+
+# Power off the virtual machine
+# 
+def stop
+  if domstate != 'shut off'
+    virsh("destroy #{self.fqdn}")
+  end
+end
+
+
+# Get the state of the domain
+# 
+def domstate
+  virsh("domstate #{self.fqdn}").chomp.chomp
+end
+
+# Power on the virtual machine
+# 
+def start
+  if domstate != 'running'
+    virsh("start #{self.fqdn}")
+  end
+end
+
+
+def dumpxml
+  puts virsh("dumpxml --security-info #{self.fqdn}")
+end
+
+# Modify the VM definition to stop using libgfapi
+#
+def disable_libgfapi
+
+  self.stop
+
+  require 'rexml/document'
+  doc = REXML::Document.new(virsh("dumpxml --security-info #{self.fqdn}"))
+  
+  # Convert the file-backed disk into a libgfapi disk
+  doc.elements.each('domain/devices/disk') do |ele|
+   ele.attributes['type'] = 'file'
+  end
+  doc.elements.each('domain/devices/disk') do |ele|
+   ele.delete_element('source')
+   ele.add_element('source', {'file'=>"/gvol/images/#{self.fqdn}-disk1", 'protocol' => 'gluster'})
+  end
+  
+  virsh("undefine #{self.fqdn}")
+  virsh("define /dev/stdin >/dev/null 2>&1", doc.to_s)
+end
+
+# Modify the VM definition to use libgfapi
+# +glusterfs_server+ the FQDN of the GlusterFS server
+def enable_libgfapi(glusterfs_server)
+  require 'rexml/document'
+  doc = REXML::Document.new(virsh("dumpxml --security-info #{self.fqdn}"))
+  
+  raise 'cannot enable libgfapi while the VM is running' if domstate == 'running'
+  
+  # When cloning or copying, no need to boot from the network
+  if @buildspec['_clone'] or @buildspec['_copy']
+    doc.delete_element "/domain/os/boot[@dev='network']"
+  end
+
+  # Set cache=none just in case
+  # Set the disk type, just in case
+  doc.elements.each('domain/devices/disk/driver') do |ele|
+   ele.attributes['cache'] = 'none'
+   ele.attributes['type'] = @buildspec['disk_format']
+  end
+  
+  # Convert the file-backed disk into a libgfapi disk
+  doc.elements.each('domain/devices/disk') do |ele|
+   ele.attributes['type'] = 'network'
+  end
+  diskcount = 1  # XXX-KLUDGE: we should actually look at the disk filename
+  doc.elements.each('domain/devices/disk') do |ele|
+   ele.delete_element('source')
+   ele.add_element('source', {'name'=>"gvol/images/#{self.fqdn}-disk#{diskcount}", 'protocol' => 'gluster'})
+   diskcount += 1
+  end
+  doc.elements.each('domain/devices/disk/source') do |ele|
+   ele.add_element('host', {'name'=>glusterfs_server, 'transport'=>'tcp', 'port'=>'0'})
+  end
+  
+  virsh("undefine #{self.fqdn}")
+  virsh("define /dev/stdin >/dev/null 2>&1", doc.to_s)
+end
+end