Go to file
Mrunal Patel e4563c9bd3 Merge pull request #250 from zhgwenming/master
Make AddRoute() works with a provided source ip address.
2014-11-06 10:06:19 -08: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 Fix vet errors 2014-11-05 15:38:58 -08: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 Remove syncpipe pkg 2014-11-06 00:08:10 +00:00
ipc Add test for ipc private and shared path 2014-10-28 22:13:05 +00:00
label Add new interfaces for label/selinux 2014-10-29 16:39:14 -04:00
mount Mount /dev/mqueue by default 2014-10-28 19:35:35 -04:00
namespaces Remove syncpipe pkg 2014-11-06 00:08:10 +00:00
netlink Merge pull request #250 from zhgwenming/master 2014-11-06 10:06:19 -08:00
network enable hairpin mode on virtual interface bridge port 2014-11-03 23:11:37 -05:00
nsinit Remove syncpipe pkg 2014-11-06 00:08:10 +00:00
sample_configs Sample configuration for ip routing Source Address Selection 2014-11-05 14:35:41 +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
system Fix vet errors 2014-11-05 15:38:58 -08:00
user Move "pkg/user" into libcontainer and add support for GetUserGroupSupplementary to return "Home" too 2014-07-29 10:59:18 -06: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 Move the download of docker to top of dockerfile 2014-10-17 00:00:16 +00: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 Allow IPC namespace to be shared between containers or with the host 2014-10-25 06:16:20 -04: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
api_temp.go Fix nsinit function to get stats from systemd 2014-07-11 12:00:27 -07:00
config.go Allow IPC namespace to be shared between containers or with the host 2014-10-25 06:16:20 -04:00
config_test.go Update api proposal 2014-07-08 11:27:27 -07:00
container.go Unify the errors ProcessConfigInvalid and ConfigInvalid to avoid caller confusion. 2014-09-05 10:08:11 -07:00
error.go Unify the errors ProcessConfigInvalid and ConfigInvalid to avoid caller confusion. 2014-09-05 10:08:11 -07:00
factory.go Add rich errors to the API 2014-09-04 15:01:09 -07:00
process.go Update api proposal 2014-07-08 11:27:27 -07:00
state.go Update cgroups paths in state to be a map with cgroup type as key and path as value. 2014-08-13 23:26:27 +00: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.