LXC Ruby Wrapper Build Status

Ruby library to manage linux containers (lxc) via ruby dsl or HTTP api.

HTTP api support is coming soon.

Installation

As for now this gem is not released yet, so use gem install task:

rake build
rake install

Usage

NOTE Works only with LXC >= 0.7.5

You should have LXC already installed on your system before using the library.

Example:

require 'lxc'

# Check if all lxc binaries are installed
LXC.installed?

# Get LXC version
LXC.version

# Get current LXC configuration
LXC.config

# Get a list of all containers
LXC.containers

# Get a single container by name
LXC.container('name')

Container instance is a simple abstaction for lxc's container tools:

c = LXC.container('foo')

# Get current status of container
c.status # => {:state => 'RUNNING', :pid => 1234}

# Check if container exists?
# this is needed since lxc does not raise any errors if container is
# not present in the system, and returns the same result as if container
# is actually stopped
c.exists? # => true

# Status helpers
c.running? # => true
c.frozen?  # => false

# Start and stop containers
c.start  # => {:state => 'RUNNING', :pid => 1234}
c.stop   # => {:state => 'STOPPED', :pid => -1}

# Free and unfreeze (also returns current status)
c.freeze
c.unfreeze

# Destroy container
c.destroy # => true

To create a new container:

c = LXC::Container.new('foo')
c.create(path_to_lxc_config)

This method invokes lxc-create -n NAME -f CONFIG command. It DOES NOT create any rootfs images or configures anything.

LXC Server

This library includes a HTTP API implementation for container management.

To start server:

lxc-server

Or view more options:

Usage: lxc-server [options]
    -v, --version                    Show version
    -b, --bind INTERFACE             Bind server to interface (default: 0.0.0.0)
    -p, --port PORT                  Start server on port (default: 27000)

API Endpoints:

GET /                  # Get current time
GET /version           # Current gem version
GET /lxc_version       # Installed LXC version
GET /containers        # Get container list 
GET /containers/:name  # Get a single container information

Container operations:

POST /container/:name/create
POST /container/:name/destroy
POST /container/:name/start 
POST /container/:name/stop
POST /container/:name/freeze
POST /container/:name/unfreeze

Testing

To run the test suite execute:

rake test

License

Copyright (c) 2012 Dan Sosedoff.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.