class Fog::Compute::Libvirt::Server
Attributes
iso_dir[RW]
The following attributes are only needed when creating a new vm
TODO: Add depreciation warning
iso_file[RW]
The following attributes are only needed when creating a new vm
TODO: Add depreciation warning
network_bridge_name[RW]
network_interface_type[RW]
network_nat_network[RW]
password[RW]
user_data[RW]
volume_allocation[RW]
volume_capacity[RW]
volume_format_type[RW]
volume_name[RW]
volume_path[RW]
volume_pool_name[RW]
volume_template_name[RW]
volumes_path[RW]
xml[R]
Public Class Methods
new(attributes={} )
click to toggle source
Can be created by passing in :xml => “<xml to create domain/server>” or by providing :template_options => {
:name => "", :cpus => 1, :memory_size => 256 , :volume_template }
Calls superclass method
# File lib/fog/libvirt/models/compute/server.rb, line 47 def initialize(attributes={} ) @xml = attributes.delete(:xml) verify_boot_order(attributes[:boot_order]) super defaults.merge(attributes) initialize_nics initialize_volumes @user_data = attributes.delete(:user_data) end
Public Instance Methods
cloud_init_volume_name()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 254 def cloud_init_volume_name "#{name}-cloud-init.iso" end
create_user_data_iso()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 245 def create_user_data_iso generate_config_iso(user_data) do |iso| vol = service.volumes.create(:name => cloud_init_volume_name, :capacity => "#{File.size(iso)}b", :allocation => "0G") vol.upload_image(iso) @iso_file = cloud_init_volume_name @iso_dir = File.dirname(vol.path) if vol.path end end
destroy(options={ :destroy_volumes => false})
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 86 def destroy(options={ :destroy_volumes => false}) poweroff unless stopped? service.vm_action(uuid, :undefine) volumes.each { |vol| vol.destroy } if options[:destroy_volumes] true end
disk_path()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 82 def disk_path volumes.first.path if volumes and volumes.first end
generate_config_iso(user_data, &blk)
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 228 def generate_config_iso(user_data, &blk) Dir.mktmpdir('config') do |wd| generate_config_iso_in_dir(wd, user_data, &blk) end end
generate_config_iso_in_dir(dir_path, user_data, &blk)
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 234 def generate_config_iso_in_dir(dir_path, user_data, &blk) FileUtils.touch(File.join(dir_path, "meta-data")) File.open(File.join(dir_path, 'user-data'), 'w') { |f| f.write user_data } isofile = Tempfile.new(['init', '.iso']).path unless system("genisoimage -output #{isofile} -volid cidata -joliet -rock #{File.join(dir_path, 'user-data')} #{File.join(dir_path, 'meta-data')}") raise Fog::Errors::Error.new("Couldn't generate cloud-init iso disk with genisoimage.") end blk.call(isofile) end
mac()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 78 def mac nics.first.mac if nics && nics.first end
new?()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 56 def new? uuid.nil? end
poweroff()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 99 def poweroff action_status = service.vm_action(uuid, :destroy) reload action_status end
Also aliased as: halt
private_ip_address()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 141 def private_ip_address ip_address(:private) end
public_ip_address()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 145 def public_ip_address ip_address(:public) end
ready?()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 127 def ready? state == "running" end
reboot()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 93 def reboot action_status = service.vm_action(uuid, :reboot) reload action_status end
resume()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 111 def resume action_status = service.vm_action(uuid, :resume) reload action_status end
save()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 60 def save raise Fog::Errors::Error.new('Saving an existing server may create a duplicate') unless new? create_or_clone_volume unless xml or @volumes create_user_data_iso if user_data @xml ||= to_xml self.id = (persistent ? service.define_domain(xml) : service.create_domain(xml)).uuid reload rescue => e raise Fog::Errors::Error.new("Error saving the server: #{e}") end
scp(local_path, remote_path, upload_options = {})
click to toggle source
Transfers a file
# File lib/fog/libvirt/models/compute/server.rb, line 173 def scp(local_path, remote_path, upload_options = {}) requires :ssh_ip_address, :username scp_options = {} scp_options[:password] = password unless self.password.nil? scp_options[:key_data] = [private_key] if self.private_key scp_options[:proxy]= ssh_proxy unless self.ssh_proxy.nil? Fog::SCP.new(ssh_ip_address, username, scp_options).upload(local_path, remote_path, upload_options) end
setup(credentials = {})
click to toggle source
Sets up a new key
# File lib/fog/libvirt/models/compute/server.rb, line 185 def setup(credentials = {}) requires :public_key, :ssh_ip_address, :username credentials[:proxy]= ssh_proxy unless ssh_proxy.nil? credentials[:password] = password unless self.password.nil? credentials[:key_data] = [private_key] if self.private_key commands = [ %Q{mkdir .ssh}, # %{passwd -l #{username}}, #Not sure if we need this here # %{echo "#{Fog::JSON.encode(attributes)}" >> ~/attributes.json} ] if public_key commands << %Q{echo "#{public_key}" >> ~/.ssh/authorized_keys} end # wait for domain to be ready Timeout::timeout(360) do begin Timeout::timeout(8) do Fog::SSH.new(ssh_ip_address, username, credentials.merge(:timeout => 4)).run('pwd') end rescue Errno::ECONNREFUSED sleep(2) retry rescue Net::SSH::AuthenticationFailed, Timeout::Error retry end end Fog::SSH.new(ssh_ip_address, username, credentials).run(commands) end
shutdown()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 105 def shutdown action_status = service.vm_action(uuid, :shutdown) reload action_status end
Also aliased as: stop
ssh(commands)
click to toggle source
Calls superclass method
# File lib/fog/libvirt/models/compute/server.rb, line 149 def ssh(commands) requires :ssh_ip_address, :username ssh_options={} ssh_options[:password] = password unless password.nil? ssh_options[:proxy]= ssh_proxy unless ssh_proxy.nil? super(commands, ssh_options) end
ssh_proxy()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 159 def ssh_proxy begin require 'net/ssh/proxy/command' rescue LoadError Fog::Logger.warning("'net/ssh' missing, please install and try again.") exit(1) end # if this is a direct connection, we don't need a proxy to be set. return nil unless connection.uri.ssh_enabled? user_string= service.uri.user ? "-l #{service.uri.user}" : "" Net::SSH::Proxy::Command.new("ssh #{user_string} #{service.uri.host} nc %h %p") end
start()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 71 def start return true if active? action_status = service.vm_action(uuid, :create) reload action_status end
stopped?()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 123 def stopped? state == "shutoff" end
suspend()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 117 def suspend action_status = service.vm_action(uuid, :suspend) reload action_status end
update_display(attrs = {})
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 217 def update_display attrs = {} service.update_display attrs.merge(:uuid => uuid) reload end
vnc_port()
click to toggle source
can't use deprecate method, as the value is part of the display hash
# File lib/fog/libvirt/models/compute/server.rb, line 223 def vnc_port Fog::Logger.deprecation("#{self.class} => #vnc_port is deprecated, use #display[:port] instead [light_black](#{caller.first})[/]") display[:port] end
volumes()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 136 def volumes # lazy loading of volumes @volumes ||= (@volumes_path || []).map{|path| service.volumes.all(:path => path).first } end
Private Instance Methods
addresses(service_arg=service, options={})
click to toggle source
This retrieves the ip address of the mac address It returns an array of public and private ip addresses Currently only one ip address is returned, but in the future this could be multiple if the server has multiple network interface
# File lib/fog/libvirt/models/compute/server.rb, line 265 def addresses(service_arg=service, options={}) mac=self.mac ip_address = nil nic = self.nics.find {|nic| nic.mac==mac} if !nic.nil? service.networks.all.each do |net| if net.name == nic.network leases = net.dhcp_leases(mac, 0) # Assume the lease expiring last is the current IP address ip_address = leases.sort_by { |lse| lse["expirytime"] }.last["ipaddr"] if !leases.empty? break end end end return { :public => [ip_address], :private => [ip_address] } end
create_or_clone_volume()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 302 def create_or_clone_volume options = {:name => volume_name || default_volume_name} # Check if a disk template was specified if volume_template_name template_volume = service.volumes.all(:name => volume_template_name).first raise Fog::Errors::Error.new("Template #{volume_template_name} not found") unless template_volume begin volume = template_volume.clone("#{options[:name]}") rescue => e raise Fog::Errors::Error.new("Error creating the volume : #{e}") end else # If no template volume was given, let's create our own volume options[:pool_name] = volume_pool_name if volume_pool_name options[:format_type] = volume_format_type if volume_format_type options[:capacity] = volume_capacity if volume_capacity options[:allocation] = volume_allocation if volume_allocation begin volume = service.volumes.create(options) rescue => e raise Fog::Errors::Error.new("Error creating the volume : #{e}") end end @volumes.nil? ? @volumes = [volume] : @volumes << volume end
default_display()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 365 def default_display {:port => '-1', :listen => '127.0.0.1', :type => 'vnc', :password => '' } end
default_iso_dir()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 329 def default_iso_dir "/var/lib/libvirt/images" end
default_volume_name()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 333 def default_volume_name "#{name}.#{volume_format_type || 'img'}" end
defaults()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 337 def defaults { :persistent => true, :cpus => 1, :memory_size => 256 *1024, :name => randomized_name, :os_type => "hvm", :arch => "x86_64", :domain_type => "kvm", :iso_dir => default_iso_dir, :network_interface_type => "network", :network_nat_network => "default", :network_bridge_name => "br0", :boot_order => %w[hd cdrom network], :display => default_display, :cpu => {} } end
initialize_nics()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 288 def initialize_nics if nics nics.map! { |nic| nic.is_a?(Hash) ? service.nics.new(nic) : nic } else self.nics = [service.nics.new({:type => network_interface_type, :bridge => network_bridge_name, :network => network_nat_network})] end end
initialize_volumes()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 296 def initialize_volumes if attributes[:volumes] && !attributes[:volumes].empty? @volumes = attributes[:volumes].map { |vol| vol.is_a?(Hash) ? service.volumes.new(vol) : vol } end end
ip_address(key)
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 284 def ip_address(key) addresses[key].nil? ? nil : addresses[key].first end
verify_boot_order(order = [])
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 356 def verify_boot_order order = [] valid_boot_media = %w[cdrom fd hd network] if order order.each do |b| raise "invalid boot order, possible values are any combination of: #{valid_boot_media.join(', ')}" unless valid_boot_media.include?(b) end end end