mbailey-ruby-xen 0.0.2 → 0.0.3

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.0.3 / 2008-09-21
+
+* fleshed out :backup class
+* Xen::Commands are now easily called by backgroundjob (bj)
+
 === 0.0.2 / 2008-09-11
 
 * Broke out classes into separate files

data/Manifest.txt

@@ -8,9 +8,11 @@ test/test_ruby-xen.rb
 lib/ruby-xen/domain.rb
 lib/xen/backup.rb
 lib/xen/command.rb
-lib/xen/config.rb
-lib/xen/slice.rb
+lib/xen/config_file.rb
 lib/xen/host.rb
-lib/xen/image.rb
 lib/xen/instance.rb
-lib/templates/domu.cfg.erb
+lib/xen/lvm.rb
+lib/xen/slice.rb
+lib/xen/xen_tools_conf.rb
+lib/templates/domu.cfg.erb
+lib/templates/xen-tools.conf.erb

data/README.rdoc

@@ -1,6 +1,4 @@
-= ruby-xen
-
-# Warning! Not ready yet - project started Sep 2008
+= ruby-xen (born sep 2008 - still immature!)
 
 http://github.com/mbailey/ruby-xen
 

data/lib/ruby-xen.rb

@@ -1,3 +1,36 @@
+class ValidationFailed < StandardError; end
+
+
+module Xen
+  # General configuration for ruby-xen
+  
+  # Location of Xen config files
+  XEN_DOMU_CONFIG_DIR = '/etc/xen'
+  # XEN_DOMU_CONFIG_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '/spec/fixtures/xen_domu_configs'))
+  
+  # We don't want out library to hit Xen too often (premature optimization perhaps?)
+  # so we keep information about Xen instances in an object. Specify how long before
+  # the object expires.
+  INSTANCE_OBJECT_LIFETIME = 5 # seconds
+  
+  # General location for config file templates
+  TEMPLATE_DIR = File.expand_path(File.dirname(__FILE__) + '/../lib/templates')
+  
+  # Extension for Xen domU config files
+  CONFIG_FILE_EXTENSION = '.cfg'
+  
+  # Directory for backups of system images
+  BACKUP_DIR='/var/xen_images'
+  
+  # File extension for backups
+  BACKUP_FILE_EXT = '.tar'
+  
+  TEMPLATES_BASE = File.join(File.dirname(__FILE__), 'templates')
+  
+  XEN_TOOLS_CONFIG_FILE = '/etc/xen-tools/xen-tools.conf'
+  
+end
+
 class Array #:nodoc:
   # Extracts options from a set of arguments. Removes and returns the last
   # element in the array if it's a hash, otherwise returns a blank hash.
@@ -13,21 +46,44 @@ class Array #:nodoc:
   end
 end
 
-module Xen
-  # Location of Xen config files
-  XEN_DOMU_CONFIG_DIR = '/etc/xen'
-  # XEN_DOMU_CONFIG_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '/spec/fixtures/xen_domu_configs'))
-  
-  # We don't want out library to hit Xen too often (premature optimization perhaps?)
-  # so we keep information about Xen instances in an object. Specify how long before
-  # the object expires.
-  INSTANCE_OBJECT_LIFETIME = 1
-  
-  TEMPLATE_DIR = File.expand_path(File.dirname(__FILE__) + '/../lib/templates')
+class Hash #:nodoc:
+  # Converts a Hash into an array of key=val formatted strings
+  #
+  # puts { :nics => 2, :vcpus => 1, :memory => 64, :dhcp => true }.to_args 
+  #
+  # produces:
+  #
+  # ["--memory=64", "--nics=2", "--vcpus=1", "--dhcp"]
+  def to_args
+    collect{|k,v| (v.to_s == 'true') ? "--#{k.to_s}" : "--#{k.to_s}=#{v}"}
+  end
+end
+
+class String
   
-  # Extension for Xen domU config files
-  CONFIG_FILE_EXTENSION = '.cfg'
+  # Convert string to megabytes
+  def to_megabytes
+    gigabytes = /(gb|gig|gigabytes?)/i
+    megabytes = /(mb|meg|megabytes?)/i
+    kilobytes = /(kb|kilobytes?)/i
+    bytes = /bytes?/i
+    
+    if index(gigabytes)
+      return sub(gigabytes,'').to_i * 1024
+    elsif index(megabytes)
+      return sub(megabytes,'').to_i
+    elsif index(kilobytes)
+      return sub(kilobytes,'').to_i / 1024
+    elsif index(bytes)
+      return sub(bytes,'').to_i / (1024*1024)
+    else
+      return self.to_i
+    end
+  end
   
+end
+
+module Xen
   # DRY up some classes (children of Slice) with some module funkiness.
   module Parentable
     # Returns the parent Slice object (d) for a sub-object. 
@@ -39,7 +95,7 @@ module Xen
     #   i.object_id == s.instance.object_id # true
     #
     def slice
-      d = Xen::Slice.new(name)
+      d = Xen::Slice.new(:name => name)
       # Insert the current object into the newly created Slice's attributes
       d.instance_variable_set("@#{self.class.to_s.sub('Xen::','').downcase}", self)
       d
@@ -47,10 +103,28 @@ module Xen
   end
 end
 
+class String
+  def underscorize
+    self.sub("-", "__")
+  end
+  def ununderscorize
+    self.sub("__", "-")
+  end
+end
+
+# We want to use Rails's stringify_keys
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/reverse_merge"
+class Hash #:nodoc:
+  include ActiveSupport::CoreExtensions::Hash::Keys
+  include ActiveSupport::CoreExtensions::Hash::ReverseMerge
+end
+
 require "#{File.dirname(__FILE__)}/xen/backup"
 require "#{File.dirname(__FILE__)}/xen/command"
-require "#{File.dirname(__FILE__)}/xen/config"
-require "#{File.dirname(__FILE__)}/xen/slice"
+require "#{File.dirname(__FILE__)}/xen/config_file"
 require "#{File.dirname(__FILE__)}/xen/host"
-require "#{File.dirname(__FILE__)}/xen/image"
-require "#{File.dirname(__FILE__)}/xen/instance"
+require "#{File.dirname(__FILE__)}/xen/instance"
+require "#{File.dirname(__FILE__)}/xen/slice"
+require "#{File.dirname(__FILE__)}/xen/xen_tools_conf"
+require "#{File.dirname(__FILE__)}/xen/lvm"

data/lib/templates/domu.cfg.erb

@@ -37,4 +37,4 @@ on_poweroff = '<%= on_poweroff %>'
 on_reboot   = '<%= on_reboot %>'
 on_crash    = '<%= on_crash %>'
 
-extra = '<%= extra %>'
+extra = '<%= extra %>'

data/lib/templates/xen-tools.conf.erb

@@ -0,0 +1,289 @@
+<% 
+  # This is like a Rails Helper and belongs somewhere else
+  def comment_if_blank(attribute)
+    instance_variable_get('@'+ attribute.to_s) ? '' : '# '
+  end
+
+  def render_config(name, default)
+	"#{comment_if_blank(name)}#{name.to_s.ununderscorize} = #{instance_variable_get('@'+ name.to_s) || default}"
+  end
+%>
+##
+#  /etc/xen-tools/xen-tools.conf
+##
+#
+#  This is the global configuration file for the scripts included
+# within the xen-tools package.
+#
+#  For more details please see:
+#
+#        http://xen-tools.org/
+#
+##
+
+
+##
+#
+# File Format
+# -----------
+#
+#  Anything following a '#' character is ignored as a comment.
+#
+#  Otherwise the format of this file "key = value".  The value of
+# any keys in this file may be constructed via the output of a command.
+#
+#  For example:
+#
+#         kernel = /boot/vmlinuz-`uname -r`
+#
+##
+
+
+
+#
+##
+#  Output directory for storing loopback images.
+#
+#  If you choose to use loopback images, which are simple to manage but
+# slower than LVM partitions, then specify a directory here and uncomment
+# the line.
+#
+#  New instances will be stored in subdirectories named after their
+# hostnames.
+# 
+##
+<%= render_config :dir, '/home/xen' %>
+#
+
+#
+##
+#
+# If you don't wish to use loopback images then you may specify an 
+# LVM volume group here instead
+#
+##
+<%= render_config :lvm, 'skx-vg' %>
+
+
+#
+##
+#
+#  Installation method.
+#
+#  There are four distinct methods which you may to install a new copy
+# of Linux to use in your Xen guest domain:
+#
+#   - Installation via the debootstrap command.
+#   - Installation via the rpmstrap command.
+#   - Installation via the rinse command.
+#   - Installation by copying a directory containing a previous installation.
+#   - Installation by untarring a previously archived image.
+#
+#  NOTE That if you use the "untar", or "copy" options you should ensure
+# that the image you're left with matches the 'dist' setting later in
+# this file.
+#
+#
+##
+#
+# 
+# install-method = [ debootstrap | rinse | rpmstrap | copy | tar ]
+#
+#
+<%= render_config :install__method, 'debootstrap' %>
+#
+# If you're using the "copy", or "tar" installation methods you must
+# need to specify the source location to copy from, or the source
+# .tar file to unpack.
+#
+# You may specify that with a line such as:
+#
+# install-source = /path/to/copy
+# install-source = /some/path/img.tar
+#
+#
+<%= render_config :install__source, '/some/path/img.tar' %>
+
+#
+##
+#  Command definitions.
+##
+#
+# The "rinse", and "rpmstrap" commands are hardwired into 
+# the script, but if you wish to modify the commands which are executed
+# when installing new systems by a "copy", "debootstrap", or "tar" method
+# you can do so here:
+#
+# (This allows you to install from a .tar.bz file, rather than a plain
+# tar file, use cdebootstrap, etc.)
+#
+# install-method=copy:
+<%= render_config :copy__cmd, '/bin/cp -a $src/* $dest' %>
+#
+# install-method=debootstrap:
+<%= render_config :debootstrap__cmd, '/usr/sbin/debootstrap' %>
+#
+# install-method=tar:
+<%= render_config :tar__cmd, '/bin/tar --numeric-owner -xvf $src' %>
+#
+#
+
+
+
+#
+##
+#  Disk and Sizing options.
+##
+#
+<%= render_config :size, '4Gb' %> # Disk image size.
+<%= render_config :memory, '128Mb' %> # Memory size.
+<%= render_config :swap, '256Mb' %> # Swap size.
+<%= render_config :noswap, '1' %> # Don't use swap at all for the new system.
+<%= render_config :fs, 	'ext3' %> # Use the EXT3 filesystem for the disk image.
+<%= render_config :dist, 'etch' %> # Default distribution to install.
+<%= render_config :image, 'sparse' %> # Specify sparse vs. full disk images.
+
+#
+#  Currently supported and tested distributions include:
+#
+# via Debootstrap:
+#
+#  Debian:
+#   sid, sarge, etch, lenny.
+#
+#  Ubuntu:
+#   edgy, feisty, dapper.
+#
+# via Rinse:
+#   centos-4, centos-5.
+#   fedora-core-4, fedora-core-5, fedora-core-6, fedora-core-7
+#
+#
+
+
+
+##
+# Networking setup values.
+##
+
+#
+# Uncomment and adjust these network settings if you wish to give your
+# new instances static IP addresses.
+#
+<%= render_config :gateway, '192.168.1.1' %>
+<%= render_config :netmask, '255.255.255.0' %>
+<%= render_config :broadcast, '192.168.1.255' %>
+#
+# Uncomment this if you wish the images to use DHCP
+#
+<%= render_config :dhcp, 1 %>
+
+
+##
+# Misc options
+##
+
+#
+# Uncomment the following line if you wish to disable the caching
+# of downloaded .deb files when using debootstrap to install images.
+#
+<%= render_config :cache, 'no' %>
+#
+
+#
+# Uncomment the following line if you wish to interactively setup
+# a new root password for images.
+#
+<%= render_config :passwd, 1 %>
+
+#
+# If you'd like all accounts on your host system which are not present
+# on the guest system to be copied over then uncomment the following line.
+#
+<%= render_config :accounts, 1 %>
+#
+
+#
+# Default kernel and ramdisk to use for the virtual servers
+#
+<%= render_config :kernel, '/boot/vmlinuz-`uname -r`' %>
+<%= render_config :initrd, '/boot/initrd.img-`uname -r`' %>
+
+#
+#  The architecture to use when using debootstrap, rinse, or rpmstrap.
+#
+#  This is most useful on 64 bit host machines, for other systems it
+# doesn't need to be used.
+#
+<%= render_config :arch, '[i386|amd64]' %>
+#
+
+#
+# The default mirror for debootstrap to install Debian-derived distributions
+#
+# mirror = http://ftp.us.debian.org/debian/
+
+#
+# A mirror suitable for use when installing the Dapper release of Ubuntu.
+#
+# mirror = http://archive.ubuntu.com/ubuntu/
+
+<%= render_config :mirror, 'http://archive.ubuntu.com/ubuntu/' %>
+
+
+#
+#  If you like you could use per-distribution mirrors, which will
+# be more useful if you're working in an environment where you want
+# to regularly use multiple distributions:
+#
+# mirror_sid=http://ftp.us.debian.org/debian
+# mirror_sarge=http://ftp.us.debian.org/debian
+# mirror_etch=http://ftp.us.debian.org/debian
+# mirror_dapper=http://archive.ubuntu.com/ubuntu
+# mirror_edgy=http://archive.ubuntu.com/ubuntu
+# mirror_feisty=http://archive.ubuntu.com/ubuntu
+# mirror_gutsy=http://archive.ubuntu.com/ubuntu
+
+
+#
+#  Filesystem options for the different filesystems we support.
+#
+<%= render_config :ext3_options, 'noatime,nodiratime,errors=remount-ro' %>
+<%= render_config :ext2_options, 'noatime,nodiratime,errors=remount-ro' %>
+<%= render_config :xfs_options,  'defaults' %>
+<%= render_config :reiser_options, 'defaults' %>
+
+#
+#  Uncomment if you wish newly created images to boot once they've been
+# created.
+#
+<%= render_config :boot, '1' %>
+
+
+#
+#  If you're using a newer version of the Xen guest kernel you will
+# need to make sure that you use 'xvc0' for the guest serial device,
+# and 'xvdX' instead of 'sdX' for serial devices.
+#
+#  You may specify the things to use here:
+#
+# serial_device = tty1 #default
+# serial_device = xvc0
+#
+# disk_device = sda  #default
+# disk_device = xvda
+#
+
+
+#
+#  Here we specify the output directory which the Xen configuration
+# files will be written to, and the suffix to give them.
+#
+#  Historically xen-tools have created configuration files in /etc/xen,
+# and given each file the name $hostname.cfg.  If you want to change
+# that behaviour you may do so here.
+#
+#
+<%= render_config :output, '/etc/xen' %>
+<%= render_config :extension, '.cfg' %>
+#