ruby bindings for liblxc
Find a file
2016-01-19 15:59:16 -08:00
debian Version 1.2.0 2014-06-13 14:38:05 -03:00
ext/lxc Raise errors for attach options 2014-09-24 10:43:18 -03:00
lib make sure to raise the exception 2016-01-19 15:59:16 -08:00
test Adding early nil return in config_item (when value is empty). 2014-06-06 10:31:39 +02:00
.gitignore add bundler support 2013-12-16 12:30:12 -08:00
.travis.yml Update Travis configuration 2015-02-23 18:41:18 -05:00
Gemfile add bundler support 2013-12-16 12:30:12 -08:00
LICENSE Standardizing project structure 2013-12-06 14:59:02 -02:00
Rakefile Add (still incomplete) RDoc. 2013-12-27 15:44:24 -02:00
README.md Update README.md 2015-03-06 12:22:51 +08:00
ruby-lxc.gemspec Adding rdoc dependencies for ruby 1.8 2014-06-09 21:45:28 +02:00

Ruby-LXC

Build Status

Introduction

Ruby-LXC is a Ruby binding for liblxc. It allows the creation and management of Linux Containers from Ruby scripts.

Build and installation

Assuming a current installation of LXC is available, to install Ruby-LXC simply run the commands below

sudo apt-get install ruby-dev lxc-dev

bundle install
bundle exec rake compile
bundle exec rake gem
gem install pkg/ruby-lxc-1.2.0.gem

or just add this to your Gemfile

gem "ruby-lxc", github: "lxc/ruby-lxc", require: "lxc"

Usage

  • Container lifecycle management (create, start, stop and destroy containers)
require 'lxc'
c = LXC::Container.new('foo')
c.create('ubuntu') # create a container named foo with ubuntu template
c.start
# attach to a running container
c.attach do
  LXC.run_command('ifconfig eth0')
end
c.stop
c.destroy
  • Container inspection
c.name
c.config_path
c.config_item('lxc.cap.drop')
c.cgroup_item('memory.limit_in_bytes')
c.init_pid
c.interfaces
c.ip_addresses
c.state
  • Additional state changing operations (freezing, unfreezing and cloning containers)
c.freeze
c.unfreeze
c.reboot
c.shutdown
  • Clone a container
# clone foo into bar. Parent container has to be frozen or stopped.
clone = c.clone('bar')
  • Wait for a state change
# wait until container goes to STOPPED state, else timeout after 10 seconds
c.wait(:stopped, 10)

Check the provided rdoc documentation for a full list of methods. You can generate it running

rake rdoc