runc/nsinit
Qiang Huang c06f92353f fix README.md for nsinit
Cut the long lines and add `--config` to the `nsinit exec` command.
And some grammar fix.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-04-01 13:50:48 +08:00
..
Makefile nsinit: Add Makefile 2014-12-16 09:18:48 +03:00
README.md fix README.md for nsinit 2015-04-01 13:50:48 +08:00
config.go mount: Take out the base mounts and move them to the config. 2015-03-17 14:03:28 -04:00
exec.go Remove --create from nsinit and make it default 2015-03-11 11:46:11 -07:00
init.go Update console and mount handling for user namespaces 2015-02-17 21:37:02 -08:00
main.go Remove default log 2015-03-12 12:00:01 -07:00
oom.go Fix compilation with golang 1.3(uid/gid mappings is unsupported) 2015-02-12 13:28:07 -08:00
pause.go Refactory container interface 2015-01-31 20:51:12 -08:00
state.go Implement nsinit state command 2015-02-11 18:49:28 -08:00
stats.go Implement nsinit state command 2015-02-11 18:49:28 -08:00
tty.go Move tty configuration to Process 2015-02-25 15:04:43 -08:00
utils.go Remove --create from nsinit and make it default 2015-03-11 11:46:11 -07:00

README.md

nsinit

nsinit is a cli application which demonstrates the use of libcontainer.
It is able to spawn new containers or join existing containers.

How to build?

First add the libcontainer/vendor into your GOPATH. It's because libcontainer vendors all its dependencies, so it can be built predictably.

export GOPATH=$GOPATH:/your/path/to/libcontainer/vendor

Then get into the nsinit folder and get the imported file. Use make command to make the nsinit binary.

cd libcontainer/nsinit
go get
make

We have finished compiling the nsinit package, but a root filesystem must be provided for use along with a container configuration file.

Choose a proper place to run your container. For example we use /busybox.

mkdir /busybox 
curl -sSL 'https://github.com/jpetazzo/docker-busybox/raw/buildroot-2014.11/rootfs.tar' | tar -xC /busybox

Then you may need to write a configuration file named container.json in the /busybox folder. Environment, networking, and different capabilities for the container are specified in this file. The configuration is used for each process executed inside the container.

See the sample_configs folder for examples of what the container configuration should look like.

cp libcontainer/sample_configs/minimal.json /busybox/container.json
cd /busybox

You can customize container.json per your needs. After that, nsinit is ready to work.

To execute /bin/bash in the current directory as a container just run the following as root:

nsinit exec --tty --config container.json /bin/bash

If you wish to spawn another process inside the container while your current bash session is running, run the same command again to get another bash shell (or change the command). If the original process (PID 1) dies, all other processes spawned inside the container will be killed and the namespace will be removed.

You can identify if a process is running in a container by looking to see if state.json is in the root of the directory.

You may also specify an alternate root directory from where the container.json file is read and where the state.json file will be saved.