File	Date	Author	Commit
debian	2011-02-22	Jiro SEKIBA	[476ec6] fix a bug that upstart image won't debianized p...
doc	2010-05-30	Jiro SEKIBA	[720819] modify debian/changelog entry
etc	2010-04-30	Jiro SEKIBA	[ae2c75] Initial commit
examples	2010-04-30	Jiro SEKIBA	[ae2c75] Initial commit
sfc	2011-02-22	Jiro SEKIBA	[476ec6] fix a bug that upstart image won't debianized p...
usr	2010-07-18	Jiro SEKIBA	[78bd0d] sshd tty allocation hack
LICENSE	2010-04-30	Jiro SEKIBA	[59992b] add LICENSE and copyright notice
Makefile	2010-07-18	Jiro SEKIBA	[3705d7] move: libsfc-test.so install directory
README	2010-04-30	Jiro SEKIBA	[ae2c75] Initial commit
sfc-archive	2010-06-08	Jiro SEKIBA	[9f0cf1] add an option to sfc-buildpackage to exclude us...
sfc-buildpackage	2010-06-20	Jiro SEKIBA	[825302] add package base file selector/unselector
sfc-create	2011-02-22	Jiro SEKIBA	[f75024] fix typo
sfc-deploy	2010-05-25	Jiro SEKIBA	[e92043] add destination parameter for sfc-deploy
sfc-destroy	2011-02-22	Jiro SEKIBA	[f75024] fix typo
sfc-execute	2011-02-22	Jiro SEKIBA	[f75024] fix typo
sfc-info	2010-05-30	Jiro SEKIBA	[b6bb94] add sfc-info
sfc-ls	2010-04-30	Jiro SEKIBA	[59992b] add LICENSE and copyright notice
sfc-mount	2010-04-30	Jiro SEKIBA	[59992b] add LICENSE and copyright notice
sfc-start	2010-04-30	Jiro SEKIBA	[59992b] add LICENSE and copyright notice
sfc-stop	2011-02-22	Jiro SEKIBA	[f75024] fix typo
sfc-umount	2010-04-30	Jiro SEKIBA	[59992b] add LICENSE and copyright notice

Read Me

                   Small Ftootprint Container(SFC) tools

- Introduction
SFC tools is a set of tools to create, execute and manage containers
based on LXC.  In addtion to the LXC, SFC manages file set of containers
by stackable filesystem like unionfs.  By this, you can create containers
with own filesystem from a single file set.

SFC will read lxc configuration file as its configureation and
create containers according to the configuration. 

Differences from LXC is following:

* create stackable filesystem for root filesystem.
  With this functionality, you can create many containers from
  single set of root filesystem.
* detect files which requires to run containers
  If you run sfc container with test mode, sfc will detect which files
  are acutually used to run application.  You'll collect those files
  later on.  You can use and/or distribute the file set as a base of
  concrete application fileset.
* modify init/upstart base files
  Some files are requited to modify or create for container specific
  initialization to start a container with /sbin/init.
  SFC will modify and create proper scripts for container initialization.

With those functionality, you can create host filesystem base container
with filesystem seperation.

- Prerequisite
SFC is written in ruby script base, targeted system is ubuntu for now.
To run SFC, you require:

 * ruby
 * libinotify-ruby
 * lxc
 * unionfs-fuse 

- Usage
sfc-* commands are similar to lxc-* commands.
following commads are available for now.

 * sfc-create - create container
 * sfc-start - start container
 * sfc-stop - stop container
 * sfc-destroy - destroy container 
 * sfc-execute - execute specified command in a container
 * sfc-ls - list sfc containers
 * sfc-archive - archive files used in a specfied container 
 * sfc-deploy - deploy filesystem in specified manged directroy
 * sfc-mount - mount filesystem for specified container
 * sfc-umount - unmount filesystem for specified container