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.
- Provides the same workflow as the Vagrant VirtualBox provider
- Port forwarding via
- Private networking via
- Vagrant 1.5+ (tested with 1.7.2)
- lxc 0.7.5+
- tar 1.27 (the lxc-template script uses the --xattrs option)
redir(if you are planning to use port forwarding)
brctl(if you are planning to use private networks, on Ubuntu this means
apt-get install bridge-utils)
- 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
(older LXC versions like 0.7.5 shipped with Ubuntu 12.04 by default might require
additional configurations to work). For setting up other
types of hosts please have a look at the Wiki.
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.
vagrant plugin install vagrant-lxc
vagrant init fgrehm/precise64-lxc vagrant up --provider=lxc
More information about skipping the
--provider argument can be found at the
"DEFAULT PROVIDER" section of Vagrant docs
If you want to build your own boxes, please have a look at
for more information.
You can modify container configurations from within your Vagrantfile using the provider block:
Vagrant.configure("2") do |config| config.vm.box = "fgrehm/trusty64-lxc" 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
prior to starting it.
For other configuration options, please check the lxc.conf manpages.
Private Networks [EXPERIMENTAL]
On its current state, there is a requirement for setting the bridge name that will be created and will allow your machine to comunicate with the container
Vagrant.configure("2") do |config| config.vm.network "private_network", ip: "192.168.2.100", lxc__bridge_name: 'vlxcbr1' end
Will create a new
veth device for the container and will set up (or reuse)
vlxcbr1 bridge between your machine and the
veth device. Once the last
vagrant-lxc container attached to the bridge gets
vagrant halted, the plugin
will delete the bridge.
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
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
_Please note that there is a 64 chars limit and the container name will be trimmed down to that to ensure we can always bring the container up.
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', 'overlayfs', ... # 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
required and a default for all Vagrant environments can be set from your
~/.vagrant.d/Vagrantfile using the same
Vagrant.configure("2") do |config| config.vm.provider :lxc do |lxc| lxc.backingstore = 'none' end end
This plugin requires a lot of
sudoing since user namespaces
is not supported yet. To work around that, you can use the
vagrant lxc sudoers
command which will create a file under
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
Please refer the wiki.
Problems / ideas?
- 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