Introduction

Linux Containers (LXC) is a lightweight system virtualization that uses resource isolation instead of the hardware emulation approach used by KVM and Xen. For users who do not require full OS virtualization as provided by KVM and Xen, container technologies such as LXC provide an attractive performant solution for virtualization.

Cloudstack currently does not support containers such as LXC and OpenVZ.

Purpose

This docoument contains the design specification for LXC support in Cloudstack.

References

Feature Specification

LXC will be implemented as a hypervisor in Cloudstack and will be a first class citizen to the other hypervisors such as Xen, KVM, VMWare. As such, a user will be able to select LXC as the hypervisor for all areas a hypervisor is selectable and where the system resources have been met.

Guest VM creation

Similar to KVM, LXC virtual machines will be created using libvirt. The libvirt domain xml will include two additional elements needed for LXC: <init> and <filesystem>.

<domain type='lxc'>
  <os>
    <type arch='x86_64'>exe</type>
    <!-- specifies the startup script -->
    <init>/sbin/init</init>
  </os>
  <devices>
    <!-- specifies the directory containing the root filesystem -->
    <filesystem type='mount'>
      <source dir='/mnt/primary/edb596f6-42fb-499d-8ded-8834aff52d75'/>
      <target dir='/'/>
    </filesystem>
  </devices>
</domain>

LXC Templates

Downloadable LXC template images should be stored as either tar.gz or tar formats. The SecondaryStorage VM will download and store the template as a tar file.

bash$ find /export/secondary -type f
/export/secondary/template/tmpl/1/10/template.properties
/export/secondary/template/tmpl/1/10/402b0be5-b840-3fef-b292-d330f3bf809a.tar

During the creation of the first VM for an LXC template, the management server will send a PrimaryStorageDownload command to the agent on the LXC host. This command makes a copy of the template from from secondary storage onto primary storage. This copy is used as a base for creating all LXC images for the cluster and is not used directly to run a VM. The copy operation from secondary storage to primary storage will unpack the tar file into the destination template directory.

bash$ ls -ld /mnt/primary/*
dr-xr-xr-x. 23 root root      4096 Jan 25 11:33 /mnt/primary/2cc4e71e-2e4b-4987-a48e-dfae08e0d767

bash$ ls /mnt/primary/2cc4e71e-2e4b-4987-a48e-dfae08e0d767
bin   cgroup  etc   lib    media  opt   root  selinux  sys  usr
boot  dev     home  lib64  mnt    proc  sbin  srv      tmp  var

After a copy of the template is available on primary storage, the management server will send a CreateCommand to the LXC host to create a disk from the template. This involves a recursive copy of the template directory to the root directory for the VM.

bash$ ls -ld /mnt/primary/*
     4 dr-xr-xr-x. 23 root root      4096 Jan 25 11:33 2cc4e71e-2e4b-4987-a48e-dfae08e0d767
     4 drwxr--r--. 23 root root      4096 Jan 25 13:27 edb596f6-42fb-499d-8ded-8834aff52d75

Secondary storage

LXC template images will be stored in TAR format. See LXC Templates section for details on how the image is unpacked.

Primary storage

Available storage options for LXC primary storage are NFS and SharedMountPoint

System VMs

Each of the different hypervisors currently have their own System VMs. These system VM images are used to run the console proxy VM and the secondary storage VM.

One proposal is to make the console proxy optional and run the secondary storage daemon on baremetal (next ot the management server)

API

TODO: investigate

Development/testing setup

Assuming you are familiar with setting up a development environment, here are additional things to note: