libcontainer

README

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 convience 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.

Sample container.json file:

{
    "hostname": "koye",
    "tty": true,
    "environment": [
        "HOME=/",
        "PATH=PATH=$PATH:/bin:/usr/bin:/sbin:/usr/sbin",
        "container=docker",
        "TERM=xterm-256color"
    ],
    "namespaces": [
        "NEWIPC",
        "NEWNS",
        "NEWPID",
        "NEWUTS",
        "NEWNET"
    ],
    "capabilities": [
        "SETPCAP",
        "SYS_MODULE",
        "SYS_RAWIO",
        "SYS_PACCT",
        "SYS_ADMIN",
        "SYS_NICE",
        "SYS_RESOURCE",
        "SYS_TIME",
        "SYS_TTY_CONFIG",
        "MKNOD",
        "AUDIT_WRITE",
        "AUDIT_CONTROL",
        "MAC_OVERRIDE",
        "MAC_ADMIN",
        "NET_ADMIN"
    ],
    "networks": [{
            "type": "veth",
            "context": {
                "bridge": "docker0",
                "prefix": "dock"
            },
            "address": "172.17.0.100/16",
            "gateway": "172.17.42.1",
            "mtu": 1500
        }
    ],
    "cgroups": {
        "name": "docker-koye",
        "parent": "docker",
        "memory": 5248000
    }
}

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 an 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.

Documentation

Index

• Variables
• type Capabilities
  • func (c Capabilities) Contains(capp string) bool
• type Capability
  • func GetCapability(key string) *Capability
  • func (c *Capability) MarshalJSON() ([]byte, error)
  • func (c *Capability) String() string
  • func (c *Capability) UnmarshalJSON(src []byte) error
• type Container
• type Context
• type Namespace
  • func GetNamespace(key string) *Namespace
  • func (ns *Namespace) MarshalJSON() ([]byte, error)
  • func (ns *Namespace) String() string
  • func (ns *Namespace) UnmarshalJSON(src []byte) error
• type Namespaces
  • func (n Namespaces) Contains(ns string) bool
• type Network

Variables

var (
	ErrUnkownNamespace  = errors.New("Unknown namespace")
	ErrUnkownCapability = errors.New("Unknown capability")
	ErrUnsupported      = errors.New("Unsupported method")
)

Types

type Capabilities

type Capabilities []*Capability

func (Capabilities) Contains

func (c Capabilities) Contains(capp string) bool

Contains returns true if the specified Capability is in the slice

type Capability

type Capability struct {
	Key   string
	Value capability.Cap
}

func GetCapability

func GetCapability(key string) *Capability

func (*Capability) MarshalJSON

func (c *Capability) MarshalJSON() ([]byte, error)

func (*Capability) String

func (c *Capability) String() string

func (*Capability) UnmarshalJSON

func (c *Capability) UnmarshalJSON(src []byte) error

type Container

type Container struct {
	Hostname     string          `json:"hostname,omitempty"`      // hostname
	ReadonlyFs   bool            `json:"readonly_fs,omitempty"`   // set the containers rootfs as readonly
	NoPivotRoot  bool            `json:"no_pivot_root,omitempty"` // this can be enabled if you are running in ramdisk
	User         string          `json:"user,omitempty"`          // user to execute the process as
	WorkingDir   string          `json:"working_dir,omitempty"`   // current working directory
	Env          []string        `json:"environment,omitempty"`   // environment to set
	Tty          bool            `json:"tty,omitempty"`           // setup a proper tty or not
	Namespaces   Namespaces      `json:"namespaces,omitempty"`    // namespaces to apply
	Capabilities Capabilities    `json:"capabilities,omitempty"`  // capabilities to drop
	Networks     []*Network      `json:"networks,omitempty"`      // nil for host's network stack
	Cgroups      *cgroups.Cgroup `json:"cgroups,omitempty"`       // cgroups
	Context      Context         `json:"context,omitempty"`       // generic context for specific options (apparmor, selinux)
}

Container defines configuration options for how a container is setup inside a directory and how a process should be executed

type Context

type Context map[string]string

Context is a generic key value pair that allows arbatrary data to be sent

type Namespace

type Namespace struct {
	Key   string
	Value int
	File  string
}

func GetNamespace

func GetNamespace(key string) *Namespace

func (*Namespace) MarshalJSON

func (ns *Namespace) MarshalJSON() ([]byte, error)

func (*Namespace) String

func (ns *Namespace) String() string

func (*Namespace) UnmarshalJSON

func (ns *Namespace) UnmarshalJSON(src []byte) error

type Namespaces

type Namespaces []*Namespace

func (Namespaces) Contains

func (n Namespaces) Contains(ns string) bool

Contains returns true if the specified Namespace is in the slice

type Network

type Network struct {
	Type    string  `json:"type,omitempty"`    // type of networking to setup i.e. veth, macvlan, etc
	Context Context `json:"context,omitempty"` // generic context for type specific networking options
	Address string  `json:"address,omitempty"`
	Gateway string  `json:"gateway,omitempty"`
	Mtu     int     `json:"mtu,omitempty"`
}

Network defines configuration for a container's networking stack

The network configuration can be omited from a container causing the container to be setup with the host's networking stack