Go to file
Michael Crosby 6ab3ef56f4 Update imports for new repository path 2014-06-10 08:14:16 -07:00
apparmor Move libcontainer deps into libcontainer 2014-06-09 15:52:12 -07:00
cgroups Update imports for new repository path 2014-06-10 08:14:16 -07:00
console Update imports for new repository path 2014-06-10 08:14:16 -07:00
devices Ensure all dev nodes are copied for privileged 2014-05-30 18:39:11 -07:00
label Update imports for new repository path 2014-06-10 08:14:16 -07:00
mount Update imports for new repository path 2014-06-10 08:14:16 -07:00
namespaces Update imports for new repository path 2014-06-10 08:14:16 -07:00
netlink Move libcontainer deps into libcontainer 2014-06-09 15:52:12 -07:00
network Update imports for new repository path 2014-06-10 08:14:16 -07:00
nsinit Update imports for new repository path 2014-06-10 08:14:16 -07:00
security Update imports for new repository path 2014-06-10 08:14:16 -07:00
selinux Update imports for new repository path 2014-06-10 08:14:16 -07:00
utils Refactor and improve libcontainer and driver 2014-02-24 21:11:52 -08:00
LICENSE Add licensing information 2014-06-09 16:16:58 -07:00
MAINTAINERS Adding Rohit Jnagal and Victor Marmol to pkg/libcontainer maintainers. 2014-05-01 15:51:38 -07:00
NOTICE Add licensing information 2014-06-09 16:16:58 -07:00
README.md Add licensing information 2014-06-09 16:16:58 -07:00
TODO.md Update libcontainer readme and todo list 2014-03-13 15:18:08 -07:00
container.go Update imports for new repository path 2014-06-10 08:14:16 -07:00
container.json Merge pull request #6097 from timthelion/consistentdevices 2014-05-31 03:34:52 +03:00
container_test.go Merge pull request #6097 from timthelion/consistentdevices 2014-05-31 03:34:52 +03:00
types.go Add the rest of the caps so that they are retained in privilged mode 2014-05-19 16:43:31 +00:00
types_linux.go Improve libcontainer namespace and cap format 2014-05-05 12:34:21 -07:00
types_test.go Avoid "invalid memory address or nil pointer dereference" panic 2014-04-10 22:07:29 +09:00

README.md

libcontainer - reference implementation for containers

background

libcontainer specifies configuration options for what a container is. It provides a native Go implementation for using Linux namespaces with no external dependencies. libcontainer provides many convenience functions for working with namespaces, networking, and management.

container

A container is a self contained directory that is able to run one or more processes without affecting the host system. The directory is usually a full system tree. Inside the directory a container.json file is placed with the runtime configuration for how the processes should be contained and ran. Environment, networking, and different capabilities for the process are specified in this file. The configuration is used for each process executed inside the container.

See the container.json file for what the configuration should look like.

Using this configuration and the current directory holding the rootfs for a process, one can use libcontainer to exec the container. Running the life of the namespace, a pid file is written to the current directory with the pid of the namespaced process to the external world. A client can use this pid to wait, kill, or perform other operation with the container. If a user tries to run a new process inside an existing container with a live namespace, the namespace will be joined by the new process.

You may also specify an alternate root place where the container.json file is read and where the pid file will be saved.

nsinit

nsinit is a cli application used as the reference implementation of libcontainer. It is able to spawn or join new containers giving the current directory. To use nsinit cd into a Linux rootfs and copy a container.json file into the directory with your specified configuration.

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

nsinit exec /bin/bash

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

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

Code and documentation copyright 2014 Docker, inc. Code released under the Apache 2.0 license. Docs released under Creative commons.