glenux/vagrant-lxc-ng
glenux/vagrant-lxc-ng
1
0
Fork 0
Code Issues 4 Pull requests Projects 1 Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Fabio Rehm 2013-03-14 20:26:40 -03:00
parent c6ec597182
commit 83c9bf7530
1 changed files with 18 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
README.md
View file

@ -2,25 +2,12 @@
[![Build Status](https://travis-ci.org/fgrehm/vagrant-lxc.png?branch=master)](https://travis-ci.org/fgrehm/vagrant-lxc) [![Build Status](https://travis-ci.org/fgrehm/vagrant-lxc.png?branch=master)](https://travis-ci.org/fgrehm/vagrant-lxc)
Highly experimental, soon to come, Linux Containers support for the unreleased Highly experimental Linux Containers support for Vagrant 1.1.
Vagrant 1.1.
Please refer to the [closed issues](https://github.com/fgrehm/vagrant-lxc/issues?labels=&milestone=&page=1&state=closed) Please refer to the [closed issues](https://github.com/fgrehm/vagrant-lxc/issues?labels=&milestone=&page=1&state=closed)
to find out whats currently supported. to find out whats currently supported.
## Vagrant 1.1 is out!
Yeah, I know :) I just need to remove the vendorized vagrant code that I used to
get started and turn this into a real plugin. I'll do that ASAP.
## WARNING
Please keep in mind that although I'm already using this on my laptop, this is
"almost alpha" software and things might go wrong.
## Dependencies ## Dependencies
LXC, `bsdtar` and `fping` packages and a Kernel [higher than 3.5.0-17.28](#im-unable-to-restart-containers), LXC, `bsdtar` and `fping` packages and a Kernel [higher than 3.5.0-17.28](#im-unable-to-restart-containers),
@ -43,7 +30,6 @@ sudo apt-get install lxc bsdtar fping
## Current limitations ## Current limitations
* Ruby >= 1.9.3 only, patches for 1.8.7 are welcome
* Port forwarding does not work [yet](https://github.com/fgrehm/vagrant-lxc/issues/4) * Port forwarding does not work [yet](https://github.com/fgrehm/vagrant-lxc/issues/4)
* A hell lot of `sudo`s * A hell lot of `sudo`s
* Only a [single ubuntu box supported](boxes), I'm still [figuring out what should go * Only a [single ubuntu box supported](boxes), I'm still [figuring out what should go
@ -55,20 +41,13 @@ sudo apt-get install lxc bsdtar fping
## Usage ## Usage
For now you'll need to install the gem from sources: Make sure you have [Vagrant 1.1](http://downloads.vagrantup.com/tags/v1.1.0) and run:
``` ```
git clone git://github.com/fgrehm/vagrant-lxc.git --recurse vagrant plugin install vagrant-lxc
cd vagrant-lxc
bundle install
bundle exec rake install
``` ```
Since Vagrant 1.1 has not been released yet and to avoid messing up with you After that you can create a `Vagrantfile` like the one below and run `vagrant up --provider=lxc`:
current Vagrant installation, I've vendored Vagrant's sources from the master
and made it available from [`vagrant-lxc`](bin/vagrant-lxc). So after installing
`vagrant-lxc`, create a `Vagrantfile` like the one below and run
`vagrant-lxc up --provider=lxc`:
```ruby ```ruby
Vagrant.configure("2") do |config| Vagrant.configure("2") do |config|
@ -114,7 +93,7 @@ To build the provided quantal64 box:
``` ```
bundle exec rake boxes:quantal64:build bundle exec rake boxes:quantal64:build
vagrant-lxc box add quantal64 boxes/output/lxc-quantal64.box vagrant box add quantal64 boxes/output/lxc-quantal64.box
``` ```
@ -126,17 +105,17 @@ project you can run the commands below from the host machine to get a container
ready for development: ready for development:
```sh ```sh
bundle install
cd development
cp Vagrantfile.1.1 Vagrantfile
# Required in order to allow nested containers to be started # Required in order to allow nested containers to be started
sudo apt-get install apparmor-utils sudo apt-get install apparmor-utils
sudo aa-complain /usr/bin/lxc-start sudo aa-complain /usr/bin/lxc-start
bundle exec vagrant-lxc up lxc --provider=lxc bundle install
bundle exec vagrant-lxc ssh lxc cd development
ln -s Vagrantfile.1.1 Vagrantfile
bundle exec vagrant up lxc --provider=lxc
bundle exec vagrant ssh lxc
``` ```
That should result in a container ready to be `bundle exec vagrant-lxc ssh`ed. That should result in a container ready to be `bundle exec vagrant ssh`ed.
Once you've SSH into the guest container, you'll be already on the project's root. Once you've SSH into the guest container, you'll be already on the project's root.
Keep in mind that you'll probably need to run `sudo aa-complain /usr/bin/lxc-start` Keep in mind that you'll probably need to run `sudo aa-complain /usr/bin/lxc-start`
on the host whenever you want to hack on it, otherwise you won't be able to on the host whenever you want to hack on it, otherwise you won't be able to
@ -147,7 +126,7 @@ start nested containers there to try things out.
``` ```
cd development cd development
cp Vagrantfile.1.0 Vagrantfile ln -s Vagrantfile.1.0 Vagrantfile
vagrant up vagrant up
vagrant reload vagrant reload
vagrant ssh vagrant ssh
@ -157,21 +136,21 @@ vagrant ssh
``` ```
cd development cd development
cp Vagrantfile.1.1 Vagrantfile ln -s Vagrantfile.1.1 Vagrantfile
bundle exec vagrant-lxc up vbox bundle exec vagrant up vbox
bundle exec vagrant-lxc reload vbox bundle exec vagrant reload vbox
bundle exec vagrant-lxc ssh vbox bundle exec vagrant ssh vbox
``` ```
## Protips ## Protips
If you want to find out more about what's going on under the hood on vagrant, If you want to find out more about what's going on under the hood on vagrant,
prepend `VAGRANT_LOG=debug` to your `vagrant-lxc` commands. For `lxc-start`s prepend `VAGRANT_LOG=debug` to your `vagrant` commands. For `lxc-start`s
debugging set `LXC_START_LOG_FILE`: debugging set `LXC_START_LOG_FILE`:
``` ```
LXC_START_LOG_FILE=/tmp/lxc-start.log VAGRANT_LOG=debug vagrant-lxc up LXC_START_LOG_FILE=/tmp/lxc-start.log VAGRANT_LOG=debug vagrant up
``` ```
This will output A LOT of information on your terminal and some useful information This will output A LOT of information on your terminal and some useful information
@ -180,15 +159,6 @@ about `lxc-start` to `/tmp/lxc-start.log`.
## Help! ## Help!
### I've accidentaly ran `vagrant-lxc` on a Vagrant 1.0 project and I can't use it anymore
That happened to me before so here's how to recover:
```
rm -rf .vagrant
mv .vagrant.v1* .vagrant
```
### I'm unable to restart containers! ### I'm unable to restart containers!
It happened to me quite a few times in the past and it seems that it is related It happened to me quite a few times in the past and it seems that it is related