Go to file
Andrey Vagin 6dd7552537 new-api: implement fs and systemd cgroup managers
Signed-off-by: Andrey Vagin <avagin@openvz.org>
2015-01-15 00:43:13 +03:00
apparmor Update a few build tags to be more generic, add a couple more SETNS constants, and update Travis with a bunch of fixes/tweaks (including removing the nonfunctional cross-compile stuff for now) 2014-07-17 02:24:49 -06:00
cgroups new-api: implement fs and systemd cgroup managers 2015-01-15 00:43:13 +03:00
configs libcontainer: move State in the configs package 2014-12-19 12:32:34 +03:00
console Fix an endian bug for the ioctl argument 2014-10-23 07:06:09 +09:00
devices Mount /dev/mqueue by default 2014-10-28 19:35:35 -04:00
integration libcontinaer: use new API in integration tests 2014-12-19 14:48:16 +03:00
label Add call to label to allow it to tell kernel how to label created files 2014-11-20 17:39:39 -05:00
mount Mount /dev/mqueue by default 2014-10-28 19:35:35 -04:00
namespaces new-api: implement fs and systemd cgroup managers 2015-01-15 00:43:13 +03:00
netlink Merge pull request #278 from milosgajdos83/macvtap 2014-12-02 15:16:51 -08:00
network Change namespaces config to include path for setns 2014-12-03 12:00:43 -08:00
nsinit new-api: execute a process inside an existing container 2014-12-25 18:44:10 +03:00
sample_configs Change namespaces config to include path for setns 2014-12-03 12:00:43 -08:00
security Migrate selinux system xattr calls and prctl calls 2014-07-14 16:55:49 -07:00
selinux Fix vet errors 2014-11-05 15:38:58 -08:00
stacktrace Add stacktrace package for collection of stacktraces 2014-12-05 15:24:42 -08:00
system Add support for ppc64, ppc64le, s390x 2014-11-21 14:18:48 +00:00
user user: add unit tests for GetExecUser 2014-11-07 11:07:21 +11:00
utils Add integration test pkg 2014-10-17 23:25:30 +00:00
vendor/src/github.com Run update-vendor.sh to vendor our deps 2014-08-04 17:24:17 -06:00
xattr ErrNotSupportedPlatform is undefined define it 2014-10-24 11:36:30 -07:00
.drone.yml Fix GOPATH after Drone mucks with it 2014-11-05 15:29:55 -07:00
CONTRIBUTING.md Rename the file as per github convention. 2014-10-22 17:39:52 -04:00
Dockerfile Update the path to project from hack 2014-11-14 15:43:19 -08:00
LICENSE Add licensing information 2014-06-09 16:16:58 -07:00
MAINTAINERS Remove travis.yml 2014-11-05 22:36:10 +00:00
MAINTAINERS_GUIDE.md Require two LGTMs for non-maintainer changes. 2014-06-18 10:22:33 -07:00
Makefile Makefile: get the glog package 2014-12-17 07:39:18 +03: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 Remove travis.yml 2014-11-05 22:36:10 +00:00
ROADMAP.md Correct links to libcontainer issues 2014-06-13 12:06:05 +01:00
SPEC.md Add container spec 2014-12-01 16:42:01 -05:00
container.go libcontainer: move State in the configs package 2014-12-19 12:32:34 +03:00
error.go linux_container: ct.Destroy() returns error if CT isn't stopped 2014-12-16 09:19:12 +03:00
error_test.go Add testing for linux factory Load 2014-12-05 15:24:42 -08:00
factory.go libcontainer: move Config in a separate package 2014-12-19 12:32:34 +03:00
generic_error.go Add testing for linux factory Load 2014-12-05 15:24:42 -08:00
generic_error_test.go Add testing for linux factory Load 2014-12-05 15:24:42 -08:00
linux_container.go new-api: implement fs and systemd cgroup managers 2015-01-15 00:43:13 +03:00
linux_container_test.go new-api: implement fs and systemd cgroup managers 2015-01-15 00:43:13 +03:00
linux_factory.go new-api: implement fs and systemd cgroup managers 2015-01-15 00:43:13 +03:00
linux_factory_test.go libcontainer: move State in the configs package 2014-12-19 12:32:34 +03:00
process.go process: use io.Reader instead of io.WriteCloser for standard fds 2014-12-19 14:48:16 +03:00
types.go Do not mark any network stats as 'omitempty' since the value '0' is legal for those stats. 2014-07-23 22:12:23 +00:00
update-vendor.sh Add "update-vendor.sh" script and vendor our current deps (minus Docker, since that'd make a circle) 2014-08-04 17:24:11 -06:00

README.md

libcontainer - reference implementation for containers Build Status

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 execution environment that shares the kernel of the host system and which is (optionally) isolated from other containers in the system.

libcontainer may be used to execute a process in a container. If a user tries to run a new process inside an existing container, the new process is added to the processes executing in the container.

Root file system

A container runs with a directory known as its root file system, or rootfs, mounted as the file system root. The rootfs is usually a full system tree.

Configuration

A container is initially configured by supplying configuration data when the container is created.

nsinit

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

To use nsinit, cd into a Linux rootfs and copy a container.json file into the directory with your specified configuration. 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.

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

nsinit exec /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 place where the container.json file is read and where the state.json file will be saved.

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.