lxc: High level Haskell bindings to LXC (Linux containers).

[ bsd3, library, system ] [ Propose Tags ]

The library provides Haskell LXC API, wrapping bindings-lxc package.

[Skip to Readme]


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Versions [RSS] 0.1, 0.1.1, 0.2, 0.3, 0.3.1,, 0.3.2
Change log CHANGELOG.md
Dependencies base (>=4.7 && <5), bindings-lxc (>=0.2 && <0.3), mtl, transformers (>=0.2) [details]
License BSD-3-Clause
Author Nickolay Kudasov
Maintainer nickolay.kudasov@gmail.com
Category System
Home page https://github.com/fizruk/lxc
Bug tracker https://github.com/fizruk/lxc/issues
Source repo head: git clone https://github.com/fizruk/lxc.git -b master
Uploaded by NickolayKudasov at 2016-01-21T00:55:57Z
Distributions NixOS:0.3.2
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 4513 total (16 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-01-21 [all 1 reports]

Readme for lxc-0.3.2

[back to package description]


Hackage package Build Status

High level Haskell bindings to LXC (Linux containers).

The library provides Haskell LXC API, wrapping bindings-lxc package.


Before installation make sure you have LXC installed on your system with header files and static library.

Although there is lxc-dev package in standard Ubuntu repositories, you might want to use ppa:ubuntu-lxc/stable repository instead:

$ sudo apt-get install software-properties-common python-software-properties
$ sudo add-apt-repository ppa:ubuntu-lxc/stable
$ sudo apt-get update
$ sudo apt-get install lxc-dev


Get the latest stable version from Hackage:

$ cabal install lxc

or clone this repository:

$ git clone https://github.com/fizruk/lxc.git
$ cd lxc
$ cabal install


Haddock documentation is available at http://fizruk.github.io/lxc/docs/


Most of container-related functions (e.g. start, attach, destroy) perform in a LXC monad. To run LXC a computation you need to specify a container using withContainer function. When working with a single container it might be handy to have an alias like this:

let containerName = withContainer (Container "container-name" configPath)

You can start using Haskell LXC API bindings similar to a command line tool from GHCi:

$ ghci
>>> import System.LXC
>>> let trusty = withContainer (Container "trusty" Nothing)
>>> trusty $ create "download" Nothing Nothing [] ["-d", "ubuntu", "-r", "trusty", "-a", "amd64"]
Using image from local cache
Unpacking the rootfs

You just created an Ubuntu container (release=trusty, arch=amd64, variant=default)
The default username/password is: ubuntu / ubuntu
To gain root privileges, please use sudo.

>>> trusty $ start False []
>>> trusty state
>>> trusty $ attachRunWait defaultAttachOptions "echo" ["echo", "Hello, world!"]
Hello, world!
Just ExitSuccess
>>> trusty stop
>>> Just trustySnapC <- trusty $ clone (Just "trusty-snap") Nothing [CloneSnapshot] Nothing Nothing Nothing []
>>> let trustySnap = withContainer trustySnapC
>>> trustySnap $ start False []
>>> trustySnap getInterfaces
>>> trustySnap $ getIPs "eth0" "inet" 0
>>> trustySnap $ shutdown (-1)
>>> trustySnap state

For more examples, please see examples/ folder.


Contributions and bug reports are welcome!

Please feel free to contact me via GitHub or on the #haskell IRC channel on irc.freenode.net.

-Nickolay Kudasov