vagrant-lxc-ng/README.md

vagrant-lxc

LXC provider for Vagrant 1.1+

This is a Vagrant plugin that allows it to control and provision Linux Containers as an alternative to the built in Vagrant VirtualBox provider for Linux hosts.

Check out this blog post to see the plugin in action and find out more about it.

Features

• Vagrant's up, halt, reload, destroy, ssh, provision and package
• Shared folders
• Provisioning with any built-in Vagrant provisioner
• Port forwarding
• Setting container's host name

Please refer to the closed issues and the changelog for most up to date information.

Requirements

• Vagrant 1.1+
• lxc 0.7.5+
• redir (if you are planning to use port forwarding)
• A bug-free kernel

The plugin is known to work better and pretty much out of the box on Ubuntu 12.04+ hosts and installing the dependencies on it basically means a apt-get install lxc redir and a apt-get update && apt-get dist-upgrade to upgrade the kernel.

Some manual steps are required to set up a Linode machine prior to using this plugin, please check https://github.com/fgrehm/vagrant-lxc/wiki/Usage-on-Linode for more information. The same applies to Debian hosts and documentation will be provided soon.

If you are on a Mac or Windows machine, you might want to have a look at this blog post for some ideas on how to set things up: http://the.taoofmac.com/space/HOWTO/Vagrant or use use the same Ubuntu 12.10 VirtualBox machine I use for development.

Installation

vagrant plugin install vagrant-lxc

Usage

After installing, add a base box using any name you want, for example:

vagrant box add quantal64 http://dl.dropbox.com/u/13510779/lxc-quantal-amd64-2013-07-08.box

Then create a Vagrantfile that looks like the following, changing the box name to the one you've just added:

Vagrant.configure("2") do |config|
  config.vm.box = "quantal64"
end

And finally run vagrant up --provider=lxc.

If you are using Vagrant 1.2+ you can also set VAGRANT_DEFAULT_PROVIDER environmental variable to lxc in order to avoid typing --provider=lxc all the time.

Advanced configuration

If you want, you can modify container configurations from within your Vagrantfile using the provider block:

Vagrant.configure("2") do |config|
  config.vm.box = "quantal64"
  config.vm.provider :lxc do |lxc|
    # Same effect as as 'customize ["modifyvm", :id, "--memory", "1024"]' for VirtualBox
    lxc.customize 'cgroup.memory.limit_in_bytes', '1024M'
  end
end

This will make vagrant-lxc pass in -s lxc.cgroup.memory.limit_in_bytes=1024M to lxc-start when booting containers. This will override any previously value set from container's configuration file that is usually kept under /var/lib/lxc/<container-name>/config.

For other configuration options, please check lxc.conf manpages.

Base boxes

Please check the wiki for a list of pre built base boxes and information on how to build your own.

Current limitations

• The plugin does not detect forwarded ports collision, right now you are responsible for taking care of that.
• There is a hell lot of sudos involved and this will probably be around until user namespaces are supported or I'm able to handle #90
• Does not tell you if dependencies are not met (will probably just throw up some random error)
• • bunch of other core features and some known bugs

More information

Please refer the wiki for more information.

Problems / ideas?

Please review the Troubleshooting wiki page + known bugs list if you have a problem and feel free to use the issue tracker to ask questions, propose new functionality and / or report bugs.

Similar projects

• vagabond - "a tool integrated with Chef to build local nodes easily"
• vagueant - "vaguely like Vagrant for linux containers (lxc)"

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request