tag	529171efe9a8f3bc79696dc112dddd2c2c4e3f56
tagger	Aleksa Sarai <asarai@suse.de>	Tue Mar 21 20:25:48 2017
object	75f8da7c889acc4509a0cf6f0d3a8f9584778375

v1.0.0~rc3

Features:

+ Add slice management support to the systemd cgroup driver. Checks are
  done to make sure that systemd supports the feature. #1084
+ Support for readonly mount labels. #1112
+ Add a tmpcopyup mount extension for tmpfs mounts that are mounted over
  already existing directories, allowing for the contents of a volume to
  be copied up transparently. #845
* Switch our pivot_root usage to no longer require temporary
  directories, improving the state of containters running in entirely
  readonly contexts. #1125 #1148
+ Allow updating of rt_period_us and rt_runtime_us in cpuacct cgroup.
+ Reimplement console handling to use AF_UNIX sockets such that the
  console is created inside the container's (namespaced) devpts
  instance, solving a wide variety of historical pty bugs with runC.
  #1018 #1356
* Support overlayfs in mounts. #1314
+ Support creating devices with types 'p' and 'u'. #1321
+ Add --preserve-fds=N to create and run commands. #1320
+ Add pre-dump and parent-path to checkpoint. #1001
+ Update to runtime-spec v1.0.0-rc5. #1370

Fixes:

* Remove check for binding to /. #1090
* Ensure we log to logrus on command errors. #1089
* Don't enable kmem limits if they're not specified in the config. #1095
* Handle cases where specs.Resources.* members would cause null
  dereferences. #1111 #1116
* Fix bugs in the GetProcessStartTime implementation. #1136
* Make sysctl config validation checks handle network namespaces more
  gracefully. #1138 #1149
* Guarantee correct namespace creation ordering. This is part of the
  rootless container patchset, and is also required in certain SELinux
  setups. #977
* Stop screwing around with '\n' in console output. #1146
* Fix cpuset.cpu_exclusive handling. #1194
* Sync HookState with the OCI specification. #1201
* Split remounting mountpoints and bindmounts, resolving issues with
  mount options being dropped in certain cases. #1222
* Fix leftover cgroup directory issue. #1196
* Handle config.Devices and config.MaskPaths in checkpoint. #1110.
* Don't create combined cgroup subsystem names. #1268
* Ignore cgroupv2 mountpoints, fixing issues with systemd v232. #1266
* Race condition when synchronising with children and grandchildren in
  nsexec.c. #1237
* Fix state checks to no longer depend on _LIBCONTAINER being present in
  the environment, fixing both bugs as well as being part of the
  rootless container patchset. #1317
* Fix systemd-notify when using different PID namespaces, and allow
  detach+notify socket. #1308
* Don't fchown when inheriting stdio, which is necessary for rootless
  containers in certain scenarios. #1354
* Fix cpu.cfs_quota_us being changed when systemd is reloaded. #1344
* Add devices to whitelist for LXD, to make runC under LXC/LXD work
  better. #1327
* Many improvements to testing. #1121 #1131 #1132 #1147

Security:

* Several fixes for CVE-2016-9962. 5d93fed3d27f #1274

Thanks to all of the contributors that made this release possible:

* Qiang Huang <h.huangqiang@huawei.com>
* Aleksa Sarai <asarai@suse.de>
* Mrunal Patel <mrunalp@gmail.com>
* Michael Crosby <crosbymichael@gmail.com>
* Wang Long <long.wanglong@huawei.com>
* Daniel, Dao Quang Minh <dqminh89@gmail.com>
* rajasec <rajasec79@gmail.com>
* Zhang Wei <zhangwei555@huawei.com>
* Steven Hartland <steven.hartland@multiplay.co.uk>
* Giuseppe Scrivano <gscrivan@redhat.com>
* Shukui Yang <yangshukui@huawei.com>
* Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
* Daniel Dao <dqminh89@gmail.com>
* CuiHaozhi <cuihaozhi@chinacloud.com.cn>
* Antonio Murdaca <runcom@redhat.com>
* Xianglin Gao <xlgao@zju.edu.cn>
* Lei Jitang <leijitang@huawei.com>
* Justin Cormack <justin.cormack@docker.com>
* Dan Walsh <dwalsh@redhat.com>
* Daniel Martí <mvdan@mvdan.cc>
* Ce Gao <ce.gao@outlook.com>
* allencloud <allen.sun@daocloud.io>
* Alexander Morozov <lk4d4math@gmail.com>
* yupeng <yu.peng36@zte.com.cn>
* Yuanhong Peng <pengyuanhong@huawei.com>
* Yong Tang <yong.tang.github@outlook.com>
* xuxinkun <xuxinkun@gmail.com>
* Xianlu Bird <xianlubird@gmail.com>
* William Martin <wmartin@pivotal.io>
* Wentao Zhang <zhangwentao234@huawei.com>
* Vivek Goyal <vgoyal@redhat.com>
* Samuel Ortiz <sameo@linux.intel.com>
* rainrambler <wanganyu@outlook.com>
* Mohammad Arab <boynux@gmail.com>
* Michal Rostecki <michal@kinvolk.io>
* Máximo Cuadros <mcuadros@gmail.com>
* Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
* Ian Campbell <ian.campbell@docker.com>
* Harry Zhang <harryz@hyper.sh>
* Fengtu Wang <wangfengtu@huawei.com>
* Eric Paris <eparis@redhat.com>
* Derek Carr <decarr@redhat.com>
* Deng Guangxing <dengguangxing@huawei.com>
* CuiHaozhi <61755280@qq.com>
* Crazykev <crazykev@zju.edu.cn>
* Chris Aniszczyk <caniszczyk@gmail.com>
* Casey Callendrello <c1@caseyc.net>
* Carlton-Semple <carlton.semple@ibm.com>
* Brian Goff <cpuguy83@gmail.com>
* Andrew Vagin <avagin@openvz.org>

commit	75f8da7c889acc4509a0cf6f0d3a8f9584778375	[log] [tgz]
author	Mrunal Patel <mrunalp@gmail.com>	Mon Mar 20 20:04:45 2017
committer	Mrunal Patel <mrunalp@gmail.com>	Tue Mar 21 02:26:03 2017
tree	5871025042c685273b7f25facb5136d76e851ff5
parent	3f3dbc50c1f8503a421961af38d9ebf082e0f40b [diff]

Bump up runc version to v1.0.0-rc3

Signed-off-by: Mrunal Patel <mrunalp@gmail.com>

VERSION[diff]

1 file changed

tree: 5871025042c685273b7f25facb5136d76e851ff5

README.md

runc

Introduction

runc is a CLI tool for spawning and running containers according to the OCI specification.

Releases

runc depends on and tracks the runtime-spec repository. We will try to make sure that runc and the OCI specification major versions stay in lockstep. This means that runc 1.0.0 should implement the 1.0 version of the specification.

You can find official releases of runc on the release page.

Security

If you wish to report a security issue, please disclose the issue responsibly to security@opencontainers.org.

Building

runc currently supports the Linux platform with various architecture support. It must be built with Go version 1.6 or higher in order for some features to function properly.

In order to enable seccomp support you will need to install libseccomp on your platform.

e.g. libseccomp-devel for CentOS, or libseccomp-dev for Ubuntu

Otherwise, if you do not want to build runc with seccomp support you can add BUILDTAGS="" when running make.

# create a 'github.com/opencontainers' in your GOPATH/src
cd github.com/opencontainers
git clone https://github.com/opencontainers/runc
cd runc

make
sudo make install

runc will be installed to /usr/local/sbin/runc on your system.

Build Tags

runc supports optional build tags for compiling support of various features. To add build tags to the make option the BUILDTAGS variable must be set.

make BUILDTAGS='seccomp apparmor'

Build Tag	Feature	Dependency
seccomp	Syscall filtering	libseccomp
selinux	selinux process and mount labeling
apparmor	apparmor profile support	libapparmor
ambient	ambient capability support	kernel 4.3

Running the test suite

runc currently supports running its test suite via Docker. To run the suite just type make test.

make test

There are additional make targets for running the tests outside of a container but this is not recommended as the tests are written with the expectation that they can write and remove anywhere.

You can run a specific test case by setting the TESTFLAGS variable.

# make test TESTFLAGS="-run=SomeTestFunction"

Dependencies Management

runc uses vndr for dependencies management. Please refer to vndr for how to add or update new dependencies.

Using runc

Creating an OCI Bundle

In order to use runc you must have your container in the format of an OCI bundle. If you have Docker installed you can use its export method to acquire a root filesystem from an existing Docker container.

# create the top most bundle directory
mkdir /mycontainer
cd /mycontainer

# create the rootfs directory
mkdir rootfs

# export busybox via Docker into the rootfs directory
docker export $(docker create busybox) | tar -C rootfs -xvf -

After a root filesystem is populated you just generate a spec in the format of a config.json file inside your bundle. runc provides a spec command to generate a base template spec that you are then able to edit. To find features and documentation for fields in the spec please refer to the specs repository.

runc spec

Running Containers

Assuming you have an OCI bundle from the previous step you can execute the container in two different ways.

The first way is to use the convenience command run that will handle creating, starting, and deleting the container after it exits.

cd /mycontainer

runc run mycontainerid

If you used the unmodified runc spec template this should give you a sh session inside the container.

The second way to start a container is using the specs lifecycle operations. This gives you more power over how the container is created and managed while it is running. This will also launch the container in the background so you will have to edit the config.json to remove the terminal setting for the simple examples here. Your process field in the config.json should look like this below with "terminal": false and "args": ["sleep", "5"].

        "process": {
                "terminal": false,
                "user": {
                        "uid": 0,
                        "gid": 0
                },
                "args": [
                        "sleep", "5"
                ],
                "env": [
                        "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
                        "TERM=xterm"
                ],
                "cwd": "/",
                "capabilities": [
                        "CAP_AUDIT_WRITE",
                        "CAP_KILL",
                        "CAP_NET_BIND_SERVICE"
                ],
                "rlimits": [
                        {
                                "type": "RLIMIT_NOFILE",
                                "hard": 1024,
                                "soft": 1024
                        }
                ],
                "noNewPrivileges": true
        },

Now we can go though the lifecycle operations in your shell.

cd /mycontainer

runc create mycontainerid

# view the container is created and in the "created" state
runc list

# start the process inside the container
runc start mycontainerid

# after 5 seconds view that the container has exited and is now in the stopped state
runc list

# now delete the container
runc delete mycontainerid

This adds more complexity but allows higher level systems to manage runc and provides points in the containers creation to setup various settings after the container has created and/or before it is deleted. This is commonly used to setup the container‘s network stack after create but before start where the user’s defined process will be running.

Supervisors

runc can be used with process supervisors and init systems to ensure that containers are restarted when they exit. An example systemd unit file looks something like this.

[Unit]
Description=Start My Container

[Service]
Type=forking
ExecStart=/usr/local/sbin/runc run -d --pid-file /run/mycontainerid.pid mycontainerid
ExecStopPost=/usr/local/sbin/runc delete mycontainerid
WorkingDirectory=/mycontainer
PIDFile=/run/mycontainerid.pid

[Install]
WantedBy=multi-user.target