Git Product home page Git Product logo

lxc-ruby's Introduction

lxc-ruby

Ruby wrapper for Linux Containers tools.

Build Status

Requirements

Supported LXC versions:

  • 0.7.5
  • 0.8.0
  • 0.9.0
  • 1.0.0

For testing purposes you can use Vagrant with VirtualBox. Most of the functionality was tested on 64-bit Ubuntu 12.04. Additional boxes could be found here.

Installation

Add it to your Gemfile:

gem 'lxc-ruby'

Or install it manually:

gem install lxc-ruby

Usage

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.state  # => 'running'
c.pid    # => 1234
c.status # => <LXC::Status @state='running' @pid=123456>

# 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.stopped? # => false
c.frozen?  # => false

# Start and stop containers
c.start # will be started in daemonized mode
c.stop

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

# Destroy container
c.destroy # => true

Container metrics:

# Get container memory usage (in bytes)
c.memory_usage
c.memory_limit

# Get container cpu shares and usage (in seconds)
c.cpu_shares # => 1024
c.cpu_usage  # => 4312.08

# Get running processes
c.processes
# =>
#[{"pid"=>"27404",
#   "user"=>"root",
#   "cpu"=>"0.0",
#   "memory"=>"0.1",
#   "command"=>"/sbin/init",
#   "args"=>""}]

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.

Running with sudo

By default LXC does not allow to run its command under unprivileged user. There are two ways to make it work:

Using sudo

LXC.use_sudo = true

Using lxc-setcap

If you want to make container usable by non-root users, run lxc-setcap as root, and some capabilities will be set so that normal users will be able to use the container utils. This is not done by default, though, and you have to explicitly allow it.

Testing

To run the test suite execute:

rake test

License

The MIT License (MIT)

Copyright (c) 2012-2014 Dan Sosedoff, [email protected]

lxc-ruby's People

Contributors

sosedoff avatar ranjib avatar nysa avatar beanieboi avatar hh avatar

Watchers

rosa maria palacios juncosa avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.