Go to file
Michael Crosby 31327166e5 Rename OOM to NotifyOOM
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-02-11 15:09:54 -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 Rename Fs fields to fs 2015-02-11 11:20:08 -08:00
configs Add state method to return container's runtime state 2015-02-11 14:45:07 -08:00
devices Rename Fs fields to fs 2015-02-11 11:20:08 -08:00
integration Refactor network and veth creation 2015-02-11 13:33:58 -08: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
netlink Merge remote-tracking branch 'origin/master' into api 2015-01-28 14:37:40 +03:00
nsenter Refactor init actions into separate types 2015-02-11 11:20:08 -08:00
nsinit Rename OOM to NotifyOOM 2015-02-11 15:09:54 -08:00
sample_configs Rename Fs fields to fs 2015-02-11 11:20:08 -08:00
selinux Fix vet errors 2014-11-05 15:38:58 -08:00
stacktrace Refactor init actions into separate types 2015-02-11 11:20:08 -08:00
system Refactor init actions into separate types 2015-02-11 11:20:08 -08:00
user Merge remote-tracking branch 'origin/master' into api 2015-01-28 14:37:40 +03:00
utils Move environment configuration to Process 2015-02-11 11:20:09 -08:00
vendor/src/github.com Vendors glog dependency for the api branch. 2015-01-14 20:01:05 -05: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
.gitignore Remove Wait() on container interface 2015-02-03 10:50:18 -08:00
CONTRIBUTING.md Rename the file as per github convention. 2014-10-22 17:39:52 -04:00
Dockerfile Merge remote-tracking branch 'origin/master' into api 2015-01-28 14:37:40 +03:00
LICENSE Add licensing information 2014-06-09 16:16:58 -07:00
MAINTAINERS Merge remote-tracking branch 'origin/master' into api 2015-01-28 14:37:40 +03:00
MAINTAINERS_GUIDE.md Require two LGTMs for non-maintainer changes. 2014-06-18 10:22:33 -07:00
Makefile Merge remote-tracking branch 'origin/master' into api 2015-01-28 14:37:40 +03:00
NOTICE Add licensing information 2014-06-09 16:16:58 -07:00
PRINCIPLES.md Rename Fs fields to fs 2015-02-11 11:20:08 -08:00
README.md Add new API examples to readme 2015-02-11 11:20:27 -08:00
ROADMAP.md Merge remote-tracking branch 'origin/master' into api 2015-01-28 14:37:40 +03:00
SPEC.md Merge remote-tracking branch 'origin/master' into api 2015-01-28 14:37:40 +03:00
console.go Remove console package and add Console type 2015-02-11 11:20:09 -08:00
container.go Rename OOM to NotifyOOM 2015-02-11 15:09:54 -08:00
error.go Refactor init actions into separate types 2015-02-11 11:20:08 -08: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_capabilities.go Fully remove security package 2015-02-11 11:20:09 -08:00
linux_console.go Remove console package and add Console type 2015-02-11 11:20:09 -08:00
linux_container.go Rename OOM to NotifyOOM 2015-02-11 15:09:54 -08:00
linux_container_test.go Add state method to return container's runtime state 2015-02-11 14:45:07 -08:00
linux_factory.go Add state method to return container's runtime state 2015-02-11 14:45:07 -08:00
linux_factory_test.go Add state method to return container's runtime state 2015-02-11 14:45:07 -08:00
linux_init.go Refactor network and veth creation 2015-02-11 13:33:58 -08:00
linux_network.go Refactor network and veth creation 2015-02-11 13:33:58 -08:00
linux_process.go Refactor network and veth creation 2015-02-11 13:33:58 -08:00
linux_rootfs.go Refactor network and veth creation 2015-02-11 13:33:58 -08:00
linux_setns_init.go Move Cwd and User to Process 2015-02-11 11:20:09 -08:00
linux_standard_init.go Refactor network and veth creation 2015-02-11 13:33:58 -08:00
linux_userns_init.go Remove restrict package 2015-02-11 11:20:09 -08:00
linux_userns_sidecar_init.go Refactor network and veth creation 2015-02-11 13:33:58 -08:00
notify_linux.go Refactor parent processes into types 2015-02-11 11:20:09 -08:00
notify_linux_test.go Refactor parent processes into types 2015-02-11 11:20:09 -08:00
process.go Move Cwd and User to Process 2015-02-11 11:20:09 -08:00
stats.go Remove network package 2015-02-11 11:20:09 -08:00
update-vendor.sh Vendors glog dependency for the api branch. 2015-01-14 20:01:05 -05:00

README.md

libcontainer - reference implementation for containers Build Status

Libcontainer provides a native Go implementation for creating containers with namespaces, cgroups, capabilities, and filesystem access controls. It allows you to manage the lifecycle of the container performing additional operations after the container is created.

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.

Using libcontainer

To create a container you first have to initialize an instance of a factory that will handle the creation and initialization for a container.

Because containers are spawned in a two step process you will need to provide arguments to a binary that will be executed as the init process for the container. To use the current binary that is spawning the containers and acting as the parent you can use os.Args[0] and we have a command called init setup.

initArgs := []string{os.Args[0], "init"}

root, err := libcontainer.New("/var/lib/container", initArgs)
if err != nil {
    log.Fatal(err)
}

Once you have an instance of the factory created we can create a configuration struct describing how the container is to be created. A sample would look similar to this:

config := &configs.Config{
    Rootfs: rootfs,
    Capabilities: []string{
        "CHOWN",
        "DAC_OVERRIDE",
        "FSETID",
        "FOWNER",
        "MKNOD",
        "NET_RAW",
        "SETGID",
        "SETUID",
        "SETFCAP",
        "SETPCAP",
        "NET_BIND_SERVICE",
        "SYS_CHROOT",
        "KILL",
        "AUDIT_WRITE",
    },
    Namespaces: configs.Namespaces([]configs.Namespace{
        {Type: configs.NEWNS},
        {Type: configs.NEWUTS},
        {Type: configs.NEWIPC},
        {Type: configs.NEWPID},
        {Type: configs.NEWNET},
    }),
    Cgroups: &configs.Cgroup{
        Name:            "test-container",
        Parent:          "system",
        AllowAllDevices: false,
        AllowedDevices:  configs.DefaultAllowedDevices,
    },

    Devices:  configs.DefaultAutoCreatedDevices,
    Hostname: "testing",
    Networks: []*configs.Network{
        {
            Type:    "loopback",
            Address: "127.0.0.1/0",
            Gateway: "localhost",
        },
    },
    Rlimits: []configs.Rlimit{
        {
            Type: syscall.RLIMIT_NOFILE,
            Hard: uint64(1024),
            Soft: uint64(1024),
        },
    },
}

Once you have the configuration populated you can create a container:

container, err := root.Create("container-id", config)

To spawn bash as the initial process inside the container and have the processes pid returned in order to wait, signal, or kill the process:

process := &libcontainer.Process{
    Args:   []string{"/bin/bash"},
    Env:    []string{"PATH=/bin"},
    User:   "daemon",
    Stdin:  os.Stdin,
    Stdout: os.Stdout,
    Stderr: os.Stderr,
}

pid, err := container.Start(process)
if err != nil {
    log.Fatal(err)
}


// wait for the process to finish.
wait(pid)

// destroy the container.
container.Destroy()

Additional ways to interact with a running container are:

// return all the pids for all processes running inside the container.
processes, err := container.Processes() 

// get detailed cpu, memory, io, and network statistics for the container and 
// it's processes.
stats, err := container.Stats()


// pause all processes inside the container.
container.Pause()

// resume all paused processes.
container.Resume()

nsinit

nsinit is a cli application which demonstrates the use of libcontainer.
It is able to spawn new containers or join existing containers. A root filesystem must be provided for use along with a container configuration file.

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 --tty /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.