openvz 1.1

data/COPYING

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2010, 2011 R.I.Pienaar
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/openvz.rb

@@ -0,0 +1,21 @@
+#
+# OpenVZ API
+#
+module OpenVZ
+
+    autoload :Log,         "openvz/log"
+    autoload :Shell,       "openvz/shell"
+    autoload :Inventory,   "openvz/inventory"
+    autoload :Vendor,      "openvz/vendor"
+    autoload :Container,   "openvz/container"
+    autoload :Util,        "openvz/util"
+    autoload :ConfigHash,  "openvz/confighash"
+
+    VERSION = "1.1"
+    
+    def self.version
+        VERSION
+    end
+
+    OpenVZ::Vendor.load_vendored
+end

data/lib/openvz/confighash.rb

@@ -0,0 +1,45 @@
+require 'observer'
+
+module OpenVZ
+
+    class ConfigHash
+
+        include Observable
+
+        def initialize(data={})
+          @data = {}
+          update!(data)
+        end
+        
+        def update!(data)
+          data.each do |key, value|
+            self[key] = value
+          end
+        end
+        
+        def [](key)
+          @data[key.to_sym]
+        end
+        
+        def []=(key, value)
+            if @data[key] != value
+                if value.class == Hash
+                  @data[key.to_sym] = Config.new(value)
+                else
+                  @data[key.to_sym] = value
+                end
+                # Notify observers
+                changed
+                notify_observers(key, value)
+            end
+        end
+        
+        def method_missing(sym, *args)
+          if sym.to_s =~ /(.+)=$/
+            self[$1] = args.first
+          else
+            self[sym]
+          end
+        end
+    end
+end

data/lib/openvz/container.rb

@@ -0,0 +1,341 @@
+module OpenVZ
+    # OpenVZ::Container
+    #
+    # @author Stefan Schlesinger
+    # @attribute rw config
+    #
+    # @example Sample Usage
+    #   c = Container.new("999")
+    #   c.start
+    #   c.stop
+    #   c.restart
+    #   c.mount
+    #   c.umount
+    #   c.destroy
+    #
+    # @example Configration Access
+    #   c = Container.new("999")
+    #   puts c.config.privvmpages
+    #   c.config.privvmpages = "123:123"
+    #
+    # @example Container Creation
+    #   c = Container.new("999")
+    #   c.create( :ostemplate => "debian-6.0-bootstrap", :config => "vps.unlimited" )
+    #   c.debootstrap( :dist => "squeeze", :mirror => "http://ftp.at.debian.org" )
+    #   c.cp_into(:src => "/etc/resolv.conf", :dest => "/etc/resolv.conf")
+    #   c.start
+    #   c.command("hostname -f")
+    class Container
+
+        attr_accessor :config
+
+        class StatemachineError < StandardError;end
+        class Config            < ::OpenVZ::ConfigHash ; end
+
+
+        def initialize(ctid=false)
+            @ctid       = ctid
+            @vzctl      = "/usr/sbin/vzctl"
+            @configfile = "/etc/vz/conf/#{ctid}.conf"
+
+            @config     = Config.new(load_config_file)
+            @config.add_observer(self)
+        end
+
+
+        # Start a container
+        #
+        def start
+            cmd = "#{@vzctl} start #{@ctid}"
+            execute(cmd)
+        end
+
+
+        # Stop a container
+        #
+        def stop
+            cmd = "#{@vzctl} stop #{@ctid}"
+            execute(cmd)
+        end
+
+
+        # Restart a container
+        #
+        def restart
+            cmd = "#{@vzctl} restart #{@ctid}"
+            execute(cmd)
+        end
+
+
+        # Mount a container
+        #
+        def mount
+            cmd = "#{@vzctl} mount #{@ctid}"
+            execute(cmd)
+        end
+
+
+        # Umount a container
+        #
+        def umount
+            cmd = "#{@vzctl} umount #{@ctid}"
+            execute(cmd)
+        end
+
+
+        # Destroy a container
+        #
+        def destroy
+            cmd = "#{@vzctl} destroy #{@ctid}"
+            execute(cmd)
+        end
+
+
+        # Update one or multiple Container properties and keep the configration
+        # object up to date
+        #
+        # @param [Hash] The options to update, eg. `{ :privvmpages => '123:123' }`
+        def set(options = {})
+            # Construct a set command
+            cmd = "#{@vzctl} set #{@ctid} --save"
+    
+            options.each do |opt,val|
+                cmd << " --#{opt}"
+                cmd << " #{val}"
+            end
+
+            execute(cmd)
+
+            # Each time we update a setting, reload the configuration.
+            @config.load(@ctid)
+        end
+
+
+        # Create a new empty instance from a template.
+        #
+        # @example Create a new empty container from a template.
+        #   The following example will create a container, from an empty
+        #   template, which can be used to bootstrap the whole installation
+        #   later on. It will as well apply the vps.unlimited template config.
+        #
+        #   container.create(:ostemplate => "debian-6.0-bootstrap", :config => "vps.unlimited")
+        #
+        # @param [Hash] options you want to pass to the create statement.
+        def create(options={})
+            unless options[:ostemplate]
+                # We need at least a valid ostemplate
+                raise ArgumentError, "Create requires argument :ostemplate."
+            end
+
+            cmd = "#{@vzctl} create #{@ctid}"
+
+            options.each do |opt,val|
+                cmd << " --#{opt}"
+                cmd << " #{val}"
+            end
+
+            execute(cmd)
+
+            Log.debug("Reading new container configuration file: #{@configfile}")
+            @config     = Config.new(load_config_file)
+            @config.add_observer(self)
+        end
+
+
+        # Bootstrap a Debian container, this requires /usr/sbin/debootstrap to
+        # be installed. Executing this function usually takes a while.
+        #
+        # @example Debootstrap a container object.
+        #   container.debootstrap(:dist => "squeeze", :mirror => "http://cdn.debian.net/debian")
+        #
+        # @example Debootstrap a container, include and exclude certain packages.
+        #   container.debootstrap(
+        #       :dist    => "squeeze",
+        #       :mirror  => "http://cdn.debian.net/debian",
+        #       :include => "libreadline6,screen,file,less,dnsutils,tcpdump,vim-nox,puppet,facter",
+        #       :exclude => "dhcp-client,dhcp3-client,dhcp3-common,dmidecode,gcc-4.2-base,module-init-tools,tasksel,tasksel-data,libdb4.4,libsasl2-2,libgnutls26,libconsole,libgnutls13,libtasn1-3,liblzo2-2,libopencdk10,libgcrypt11",
+        #   )
+        #
+        # @param [Hash] options you want to pass to the bootstrapping tool.
+        def debootstrap(options={})
+            cmd  = "/usr/sbin/debootstrap"
+
+            options.each do |opt,val|
+                unless opt.to_s =~ /dist|dest|mirror/
+                    cmd << " --#{opt} #{val}"
+                end
+            end
+
+            cmd << " #{options[:dist]}"
+            cmd << " #{@config.ve_private}"
+            cmd << " #{options[:mirror]}"
+
+            execute(cmd)
+
+            # FIXME - Remove gettys from inititab automatically. We
+            # Need a searchandreplace function first... :-)
+            #
+            # Util.searchandreplace( "#{@config.ve_private}/etc/inittab",
+            #                        "/^(?!#)(.*\/sbin\/getty)/", 
+            #                        '#\1')
+        end
+
+
+        # Copy a file from the hardware node into the container.
+        #
+        # @example Copy resolv.conf
+        #     container.cp_into(
+        #          :src => '/etc/resolv.conf',
+        #          :dst => '/etc/resolv.conf'
+        #     )
+        #
+        # @param [Hash] define
+        def cp_into(options={})
+            cmd = "/bin/cp #{options[:src]} #{@config.ve_private}/#{options[:dst]}"
+            execute(cmd)
+        end
+
+
+        # Run a shell command within the container.
+        #
+        # @example Update the package sources.
+        #    container.command("aptitude update")
+        #
+        # @param [String] Command to be executed.
+        def command(command)
+            cmd = "#{@vzctl} exec2 #{@ctid} "
+            cmd << command
+            execute(cmd)
+        end
+
+
+        # Return the current machine status string.
+        # 
+        # @example
+        #   puts container.status()
+        #   exist mounted running
+        def status
+            cmd = "#{@vzctl} status #{@ctid}"
+            status = execute(cmd).split(/\s/)
+            Log.debug("Container (#{@ctid}) status requested: #{status}")
+            status.drop(2)
+        end
+
+
+
+        ####
+        #### Helper methods
+        ####
+
+
+        def state_require(*opts)
+            current_state = status
+            if current_state & opts
+                puts "req: #{opts.join("-")}, cur: #{current_state.join("-")}"
+                return true
+            else
+              raise StateMachineError, "Required container status not met for this action. req: #{opts.join("-")}, cur: #{current_state.join("-")}"
+            end
+        end
+
+
+        # Check whether current_state == :require||:validate
+        #
+        def state(mode, action)
+            current_state = self.status()
+
+            if current_state & @statemachine_options[action.to_sym][mode.to_sym]
+                return true
+            end
+
+            raise StateMachineError,
+               "Required container status not met. req: #{@state_control[:action]}, cur: #{state}"
+        end
+
+
+        # Notify Method! :-) Config objects will notify, as soon as they are changed.
+        #
+        def update(key, value)
+            set(key.to_sym => value)
+        end
+
+
+        # Load the container configration file.
+        #
+        def load_config_file
+            data = {}
+            if File.exists?(@configfile)
+                File.open(@configfile, "r").each_line do |line|
+                    # strip blank spaces, tabs etc. off the lines
+                    line.gsub!(/\s*$/, "")
+        
+                    if (line =~ /^([^=]+)="([^=]*)"$/)
+                        key = $1.downcase
+                        val = $2
+        
+                        case key
+                            when /^ve_(private|root)$/
+                                data[key] = val.gsub!(/\$VEID/, @ctid)
+                            else
+                                data[key] = val
+                        end
+                    end
+                end
+            end
+            data
+        end
+
+
+        # TODO: implement :-)
+        #
+        # NETIF="ifname=eth0,
+        #        bridge=vzbr303,
+        #        mac=02:01:79:15:03:02,
+        #        host_ifname=veth17915.303,
+        #        host_mac=12:01:79:15:03:02"
+        #def load_net_config
+        #    if @config.netif ### DOES THAT WORK?
+        #        str = @config.netif
+
+        #        if str =~ /ifname=([^,]+),bridge=([^,]+),mac=([^,]+),host_ifname=([^,]+),host_mac=([^,]+)/
+        #            @net.ifname      = $1
+        #            @net.bridge      = $2
+        #            @net.mac         = $3
+        #            @net.host_ifname = $4
+        #            @net.host_mac    = $5
+        #            @net.type        = "bridged"
+        #            ### MISSING: IP, SUBNET, GATEWAY within VM
+        #        end
+        #    end
+        #end
+
+        # This will give us a nicer object feeling and dynamically
+        # exposes variables to the outside.
+        #
+        # @examples Setting and getting a variable
+        # container.config.ipaddress = 1.2.3.4
+        #
+        #
+        #def method_missing(sym, *args)
+        #  if sym.to_s =~ /(.+)=$/
+        #    self[$1] = args.first
+        #  else
+        #    self[sym]
+        #  end
+        #end
+
+
+        # Execute a System Command
+        def execute(cmd)
+
+            Log.debug("#{cmd}")
+
+            s = Shell.new("#{cmd}", :cwd => "/tmp")
+            s.runcommand
+            if s.status.exitstatus != 0
+                raise "Cannot execute: '#{cmd}'. Return code: #{s.status.exitstatus}. Stderr: #{s.stderr}"
+            end
+            s.stdout
+        end
+    end
+end