Go to file
Michael Crosby f6ada60a68 Merge pull request #48 from crosbymichael/add-oom-event
Add oom notify event
2014-06-25 11:56:28 -07:00
apparmor Move libcontainer deps into libcontainer 2014-06-09 15:52:12 -07:00
cgroups Merge pull request #48 from crosbymichael/add-oom-event 2014-06-25 11:56:28 -07:00
console Update imports for new repository path 2014-06-10 08:14:16 -07:00
devices Use lstat to check device symlinks 2014-06-16 14:51:02 -07:00
label Update imports for new repository path 2014-06-10 08:14:16 -07:00
mount Add tests and sample files for selinux and apparmor 2014-06-24 18:11:52 -07:00
namespaces Remove generic context and replace with fields 2014-06-24 17:31:03 -07:00
netlink Move libcontainer deps into libcontainer 2014-06-09 15:52:12 -07:00
network Fix cross compile for network and node pkgs 2014-06-23 16:23:51 -07:00
nsinit Rename Container -> Config. 2014-06-23 17:08:15 -07:00
sample_configs Add tests and sample files for selinux and apparmor 2014-06-24 18:11:52 -07:00
security Added DropCapabilities() and DropBoundingSet() API to libcontainer. 2014-06-23 18:36:38 +00:00
selinux Update imports for new repository path 2014-06-10 08:14:16 -07:00
utils Fix invalid fd race 2014-06-16 10:26:18 +02:00
.travis.yml Update travis to run unit tests 2014-06-17 16:12:36 -07:00
CONTRIBUTORS_GUIDE.md Replacing docker-dev with libcontainer mailing list. 2014-06-19 09:10:07 -07:00
LICENSE Add licensing information 2014-06-09 16:16:58 -07:00
MAINTAINERS Add Tianon as the .travis.yml maintainer 2014-06-12 13:01:30 -06:00
MAINTAINERS_GUIDE.md Require two LGTMs for non-maintainer changes. 2014-06-18 10:22:33 -07:00
NOTICE Add licensing information 2014-06-09 16:16:58 -07:00
PRINCIPLES.md Grammatical improvements 2014-06-13 11:14:29 +01:00
README.md Fix nit on wording 2014-06-20 14:46:45 -07:00
ROADMAP.md Correct links to libcontainer issues 2014-06-13 12:06:05 +01:00
container.go Remove generic context and replace with fields 2014-06-24 17:31:03 -07:00
container_test.go Add tests and sample files for selinux and apparmor 2014-06-24 18:11:52 -07:00

README.md

libcontainer - reference implementation for containers

Note on API changes:

Please bear with us while we work on making the libcontainer API stable and something that we can support long term. We are currently discussing the API with the community, therefore, if you currently depend on libcontainer please pin your dependency at a specific tag or commit id. Please join the discussion and help shape the API.

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 run. 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 sample_configs folder for examples of what the container 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.

Future

See the roadmap.

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

Hacking on libcontainer

First of all, please familiarise yourself with the libcontainer Principles.

If you're a contributor or aspiring contributor, you should read the Contributors' Guide.

If you're a maintainer or aspiring maintainer, you should read the Maintainers' Guide and "How can I become a maintainer?" in the Contributors' Guide.