Add lxc provider and tests

This commit adds initial support for lxc
container management.

Author: blkperl

README.markdown

@@ -6,14 +6,15 @@ Puppet Module to manage virtual machines. Provides a the type: `virt`.
 
 ### virt
 
-Manage virtual environments. [Xen] [1], [KVM] [2], and [OpenVZ] [3] hypervisors are supported, which of the first three uses [libvirt] [4] as provider.
-This module is the result of my work at GSoC 2010. I thank [Reliant Security] [5] for funding the OpenVZ provider development.
+Manage virtual environments. [Xen] [1], [KVM] [2], [OpenVZ] [3], and [LXC] [4] hypervisors are supported, which of the first three uses [libvirt] [5] as provider.
+This module is the result of my work at GSoC 2010. I thank [Reliant Security] [6] for funding the OpenVZ provider development.
 
   [1]: http://xen.org "Xen® Hypervisor"
   [2]: http://www.linux-kvm.org/  "Kernel Based Virtual Machin"
   [3]: http://wiki.openvz.org/  "OpenVZ"
-  [4]: http://www.libvirt.org/ "The Virtualization API"
-  [5]: http://reliantsecurity.com/  "Reliant Security"
+  [4]: http://lxc.sourceforge.net/  "LXC"
+  [5]: http://www.libvirt.org/ "The Virtualization API"
+  [6]: http://reliantsecurity.com/  "Reliant Security"
 
 **Autorequires:** If Puppet is managing Xen or KVM guests, the virt resource will autorequire `libvirt` library.
 
@@ -38,6 +39,24 @@ Note that some values can be specified as an array of values:
       interfaces  => ["eth0", "eth1"]
     }
 
+LXC Example:
+
+    virt { 'lxc1':
+      ensure      => running,
+      os_template => 'ubuntu',
+      provider    => 'lxc'
+    }
+
+    # clone from lxc1
+    virt { 'lxc2':
+      ensure   => running,
+      clone    => 'lxc1',
+      snapshot => true,
+      provider => 'lxc',
+      require  => Virt['lxc1']
+    }
+
+
 #### Features
 
 - *disabled*: The provider can disable guest start.
@@ -54,29 +73,32 @@ Note that some values can be specified as an array of values:
 - *manages_devices*: The provider can give the guest an access to a device.
 - *manages_users*: The provider manage guest's users and passwords.
 - *manages_behaviour*: The provider manage the quest's behaviour for reboot, crash and shutdown.
-- *initial_config*: The provider can receive a config file with default values for VE creation.
+- *initial_config*: The provider can receive a config file with default values for VE or lxc creation.
 - *storage_path*: The provider can set the path to storage and mount VE files.
-
-
-Features \ Provider  | libvirt | openvz |
--------------------- | ------- | ------ |
-disabled             |         |  *X*   |
-cpu_fair             |         |  *X*   |
-disk_quota           |         |  *X*   |
-pxe                  |   *X*   |        |
-iptables             |         |  *X*   |
-graphics             |   *X*   |        |
-clocksync            |   *X*   |        |
-boot_params          |   *X*   |        |
-manages_resources    |         |  *X*   |
-manages_capabilities |         |  *X*   |
-manages_features     |         |  *X*   |
-manages_devices      |         |  *X*   |
-manages_users        |         |  *X*   |
-manages_behaviour    |   *X*   |        |
-initial_config       |         |  *X*   |
-storage_path         |         |  *X*   |
-
+- *cloneable*: The provider can create clones of other instances
+- *backingstore*: The provider can use a backingstore such as lvm or btrfs
+
+
+Features \ Provider  | libvirt | openvz | lxc   |
+-------------------- | ------- | ------ | ------|
+disabled             |         |  *X*   |       |
+cpu_fair             |         |  *X*   |       |
+disk_quota           |         |  *X*   |       |
+pxe                  |   *X*   |        |       |
+iptables             |         |  *X*   |       |
+graphics             |   *X*   |        |       |
+clocksync            |   *X*   |        |       |
+boot_params          |   *X*   |        |       |
+manages_resources    |         |  *X*   |       |
+manages_capabilities |         |  *X*   |       |
+manages_features     |         |  *X*   |       |
+manages_devices      |         |  *X*   |       |
+manages_users        |         |  *X*   |       |
+manages_behaviour    |   *X*   |        |       |
+initial_config       |         |  *X*   |  *X*  |
+storage_path         |         |  *X*   |       |
+cloneable            |         |        |  *X*  |
+backingstore         |         |        |  *X*  |
 
 #### Parameters
 
@@ -175,6 +197,16 @@ For OpenVZ provider, available values are:
 * `ubuntu-10.10`: Ubuntu 10.10
 * `ubuntu-11.04`: Ubuntu 11.04
 
+For LXC provider, available values on Ubuntu Precise are:
+
+* `busybox`
+* `debian`
+* `fedora`
+* `opensuse`
+* `sshd`
+* `ubuntu`
+* `ubuntu-cloud`
+
 Also, you can use a custom value with your custom template name. Example: `my-customized-ubuntu-10` or `fedora-mycompany`.
 
 When using OpenVZ provider, the template for the new guest will be automaticaly downloaded if don't already exists. It will download from official OpenVZ repository or from URL specified at `tmpl_repo` parameter.
@@ -186,6 +218,7 @@ Available providers are:
 
 * **openvz**: Guest management for OpenVZ guests. Supported features: `disabled`, `cpu_fair`, `disk_quota`, `iptables`, `manages_resources`, `manages_capabilities`, `manages_features`, `manages_devices` and `manages_users`.
 * **libvirt**: Guest management for Xen and KVM guests. Note that you will need to install the `libvirt` Ruby library. Supported features: `pxe`, `graphics`, `clocksync`, `boot_params` and `manages_behaviour`
+* **lxc**: Guest management for LXC guests. Supported features: `cloneable`, `initial_config`, `backingstore`
 
 ##### virt_type
 
@@ -196,6 +229,8 @@ Available values:
 * `xen_paravirt`: This guest should be a paravirtualized guest. It requires hardware virtualization support
 * `kvm`: When installing a QEMU guest, make use of the KVM or KQEMU kernel acceleration capabilities if available. Use of this option is recommended unless a guest OS is known to be incompatible with the accelerators.
 * `openvz`: When defining an OpenVZ guest, the `os_template` paramenter must be defined.
+* `lxc`: When defining an lxc guest, the `os_template` paramenter must be defined.
+
 The values `xen_fullyvirt`, `xen_paravirt` and `kvm` will use libvirt as provider. `openvz` will use the `openvz` provider.
 
 ##### xml_file
@@ -216,8 +251,14 @@ Requires features `storage_path`.
 
 ##### configfile
 
+OpenVZ:
+
 If specified, values from example configuration file `/etc/vz/conf/ve-<VALUE>.conf-sample` are put into the container configuration file. If this container configuration file already exists, it will be removed.
 
+LXC:
+
+Specify the configuration file to configure the virtualization and isolation functionalities for the container
+
 Requires features `initial_config`.
 
 ##### user
@@ -452,6 +493,24 @@ Valid values are: `vmguarpages`, `physpages`, `oomguarpages`, `lockedpages`, `pr
 
 Requires features `resources_management`.
 
+##### clone
+
+Clone a different container to be the base image for this container
+
+Requires features `cloneable`.
+
+##### snapshot
+
+Make the new rootfs a snapshot of the cloned container
+
+Requires features `cloneable`.
+
+##### backingstore
+
+bacckingstore' is one of 'none', 'lvm', or 'btrfs'
+
+Requires features `backingstore`.
+
 ----------------
 
 

lib/puppet/provider/virt/lxc.rb

@@ -0,0 +1,108 @@
+Puppet::Type.type(:virt).provide :lxc do
+    desc 'Manages Linux containers'
+
+    commands :lxccreate   => 'lxc-create',
+             :lxcdestroy  => 'lxc-destroy',
+             :lxcclone    => 'lxc-clone',
+             :lxcinfo     => 'lxc-info',
+             :lxcstart    => 'lxc-start',
+             :lxcstop     => 'lxc-stop',
+             :lxcfreeze   => 'lxc-freeze',
+             :lxcunfreeze => 'lxc-unfreeze'
+
+    has_features :cloneable
+    has_features :backingstore
+    has_features :initial_config
+
+    def install
+      args = ['-n', @resource[:name]]
+      args.push('-t', @resource[:os_template])
+      if !@resource[:backingstore].nil?
+         args.push('-B', @resource[:backingstore])
+      end
+      if !@resource[:configfile].nil?
+         args.push('-f', @resource[:configfile])
+      end
+      if !@resource[:clone].nil?
+        clone
+      else
+        lxccreate(*args)
+      end
+    end
+
+    def clone
+      args = ['-o', @resource[:clone]]
+      args.push('-n', @resource[:name])
+      if @resource[:snapshot]
+         args.push('-s')
+      end
+      lxcclone(*args)
+    end
+
+    def setpresent
+      install
+    end
+
+    def start
+      if !exists?
+        install
+      elsif status == :freeze
+        unfreeze
+      end
+      lxcstart('-n', @resource[:name], '-d')
+    end
+
+    def stop
+      if !exists?
+        install
+      end
+      lxcstop('-n', @resource[:name])
+    end
+
+    def freeze
+      if !exists?
+        install
+        start
+      end
+      lxcfreeze('-n', @resource[:name])
+    end
+
+    def unfreeze
+      lxcunfreeze('-n', @resource[:name])
+    end
+
+    def destroy
+      lxcdestroy('-n', @resource[:name], '-f')
+    end
+
+    # FIXME: This path should be configurable
+    def exists?
+      if File.exists? "/var/lib/lxc/#{@resource[:name]}"
+        true
+      else
+        false
+      end
+    end
+
+    # lxc-info returns stopped if the container
+    # doesn't exist
+    def status
+      stat = lxcinfo('-n', @resource[:name])
+      if !exists?
+        :absent
+      elsif exists? and resource[:ensure].to_s == 'installed'
+        :installed
+      elsif stat.include?("STOPPED")
+        return :stopped
+      else
+        stat = stat.split(" ")[1].downcase.to_sym
+      end
+    end
+
+    # FIXME
+    def cpus
+      1
+    end
+
+end
+

lib/puppet/type/virt.rb

@@ -45,11 +45,17 @@ module Puppet
 			"Support parameters for the guest boot."
 
 		feature :initial_config,
-			"Config file with default values for VE creation"
+			"Config file with default values for VE or LXC creation"
 
 		feature :storage_path,
 			"Sets the path to storage VE files"
 
+		feature :cloneable,
+			"Linux container template name"
+
+		feature :backingstore,
+			"'backingstore' is one of 'none', 'lvm', or 'btrfs"
+
 		# A base class for numeric Virt parameters validation.
 		class VirtNumericParam < Puppet::Property
 
@@ -124,6 +130,10 @@ def munge_boolean(value)
 				provider.purge
 			end
 
+			newvalue(:freeze) do
+				provider.freeze
+			end
+
 			defaultto(:running)
 
 			def retrieve
@@ -172,8 +182,9 @@ def retrieve
 		newparam(:configfile, :required_features => :initial_config) do
 			desc "If specified, values from example configuration file /etc/vz/conf/ve-<VALUE>.conf-sample are put into the container configuration file. If this container configuration file already exists, it will be removed."
 
+      # FIXME: VZ validation interferes with lxc configfiles
 			validate do |file|
-				unless File.file? "/etc/vz/conf/ve-#{file}.conf-sample"
+				unless File.file? "#{file}" #"/etc/vz/conf/ve-#{file}.conf-sample"
 					raise ArgumentError, "Config file \"#{file}\" does not exist."
 				end
 			end
@@ -287,6 +298,27 @@ def insync?(current)
 
 		# Installation method
 
+    newparam(:backingstore, :requires_feature => :backingstore) do
+      desc 'backingstore is one of none, lvm, or btrfs'
+      newvalues(:none, :lvm, :btrfs)
+    end
+
+    newparam(:clone, :requires_feature => :cloneable) do
+      desc 'Name of container to clone'
+    end
+
+    newparam(:snapshot, :requires_feature => :cloneable) do
+      desc 'make the new rootfs a snapshot of the original'
+      newvalues(:true)
+      newvalues(:false)
+
+      munge do |value|
+        @resource.munge_boolean(value)
+      end
+
+      defaultto(:false)
+    end
+
 		# URL repository to download OpenVZ Templates
 		newparam(:tmpl_repo) do
 			desc "URL repository to download OpenVZ Templates.

manifests/lxc.pp

@@ -0,0 +1,7 @@
+class virt::lxc {
+
+  package { 'lxc':
+    ensure => installed,
+  }
+
+}

tests/lxc.pp

@@ -0,0 +1,16 @@
+include virt::lxc
+
+virt { 'container1':
+  ensure      => running,
+  os_template => 'ubuntu',
+  provider    => 'lxc'
+}
+
+# clone from container1
+virt { 'container2':
+  ensure   => running,
+  clone    => 'container1',
+  snapshot => true,
+  provider => 'lxc'
+}
+