b4a642bc8a
Work around WaitForCommunicator lock race condition |
||
---|---|---|
lib | ||
locales | ||
scripts | ||
spec | ||
tasks | ||
templates | ||
.gitignore | ||
.rspec | ||
.travis.yml | ||
.vimrc | ||
BOXES.md | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
Gemfile | ||
Gemfile.lock | ||
Guardfile | ||
LICENSE.txt | ||
Rakefile | ||
README.md | ||
vagrant-lxc.gemspec | ||
vagrant-spec.config.rb |
vagrant-lxc
This is a Vagrant plugin that allows it to control and provision Linux Containers as an alternative to the built in VirtualBox provider for Linux hosts. Check out this blog post to see it in action.
NOTICE: The master branch is targetting an initial beta for 1.0.0, for the latest stable version of the plugin, please check the 0.8-stable branch.
Features
- Provides the same workflow as the Vagrant VirtualBox provider
- Port forwarding via
redir
As of now, it does not support public / private networks, but private networks will be coming along with the final 1.0.0 release.
Requirements
- Vagrant 1.1+
- lxc 0.7.5+
redir
(if you are planning to use port forwarding)- A kernel != 3.5.0-17.28
The plugin is known to work better and pretty much out of the box on Ubuntu 14.04+
hosts and installing the dependencies on it basically means a apt-get install lxc lxc-templates cgroup-lite redir
and a apt-get update && apt-get dist-upgrade
to upgrade the kernel. For Debian
hosts you'll need to follow the instructions described on the Wiki
and old lxc versions (like 0.7.5 shipped with Ubuntu 12.04 by default) might require
additional configurations to work.
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 or check out this other repo for a set of Vagrant VirtualBox machines ready for vagrant-lxc usage.
NOTE: Some users have been experiencing networking issues and right now you might need to disable checksum offloading as described on this comment
Installation
vagrant plugin install vagrant-lxc
Quick start
vagrant init fgrehm/precise64-lxc
vagrant up --provider=lxc
Set the VAGRANT_DEFAULT_PROVIDER
environmental variable to lxc
in order to
avoid typing --provider=lxc
all the time.
Base boxes
Base boxes can be found on VagrantCloud and some scripts to build your own are available at fgrehm/vagrant-lxc-base-boxes.
If you want to build your own boxes, please have a look at BOXES.md
for more information.
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 'customize ["modifyvm", :id, "--memory", "1024"]' for VirtualBox
lxc.customize 'cgroup.memory.limit_in_bytes', '1024M'
end
end
vagrant-lxc will then write out lxc.cgroup.memory.limit_in_bytes='1024M'
to the
container config file (usually kept under /var/lib/lxc/<container>/config
)
prior to starting it.
For other configuration options, please check the lxc.conf manpages.
Container naming
By default vagrant-lxc will attempt to generate a unique container name
for you. However, if the container name is important to you, you may use the
container_name
attribute to set it explicitly from the provider
block:
Vagrant.configure("2") do |config|
config.vm.define "db" do |node|
node.vm.provider :lxc do |lxc|
lxc.container_name = :machine # Sets the container name to 'db'
lxc.container_name = 'mysql' # Sets the container name to 'mysql'
end
end
end
Backingstore options
Support for setting lxc-create
's backingstore option (-B
and related) can be
specified from the provider block and it defaults to best
, to change it:
Vagrant.configure("2") do |config|
config.vm.provider :lxc do |lxc|
lxc.backingstore = 'lvm' # or 'btrfs',...
# lvm specific options
lxc.backingstore_option '--vgname', 'schroots'
lxc.backingstore_option '--fssize', '5G'
lxc.backingstore_option '--fstype', 'xfs'
end
end
For old versions of lxc (like 0.7.5 shipped with Ubuntu 12.04 by default) that
does not support best
for the backingstore option, changing it to none
is
required and a default for all Vagrant environments can be set from your
~/.vagrant.d/Vagrantfile
using the same provider
block:
Vagrant.configure("2") do |config|
config.vm.provider :lxc do |lxc|
lxc.backingstore = 'none'
end
end
Avoiding sudo
passwords
This plugin requires a lot of sudo
ing since user namespaces
are not supported on mainstream kernels. To work around that, you can use the
vagrant lxc sudoers
command which will create a file under /etc/sudoers.d/vagrant-lxc-<VERSION>
whitelisting all commands required by vagrant-lxc
to run.
If you are interested on what will be generated by that command, please check this code.
vagrant-lxc < 1.0.0 users, please check this Wiki page
More information
Please refer the wiki.
Problems / ideas?
Please review the Troubleshooting wiki page + known bugs list if you have a problem and feel free to use the issue tracker propose new functionality and / or report bugs.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request