tag | 064ac08a4b9fc2b3ff2cce93890962db8c953dbc | |
---|---|---|
tagger | Kir Kolyshkin <kolyshkin@gmail.com> | Wed Jun 26 17:59:56 2024 |
object | f2d2ee5e45af3c9b38dfd639ac92f43c3055ce4e |
runc v1.2.0-rc.2 -- "TRUE or FALSE, it's a problem!" This is the second release candidate for the 1.2.0 branch of runc. It includes all patches and bugfixes included in runc 1.1 patch releases (up to and including 1.1.13). A fair few new features have been added, and some changes have been made which may affect users. Please help us thoroughly test this release candidate before we release 1.2.0. Breaking: * runc now requires a minimum of Go 1.20 to compile. If building with Go 1.22, make sure to use 1.22.4 or later version (#4233). * libcontainer/cgroups users who want to manage cgroup devices need to explicitly import libcontainer/cgroups/devices. (#3452, #4248) Added: * CI: add actuated-arm64. (#4142, #4276, #4252) Fixed: * cgroup v2: do not set swap to 0 or unlimited when it's not available. (#4188) * Set the default value of CpuBurst to nil instead of 0. (#4210, #4211) * libct/cg: write unified resources line by line. (#4186) * libct.Start: fix locking, do not allow a second container init. (#4271) * Fix tests in debian testing (mount_sshfs.bats). (#4245) * Fix codespell warnings. (#4291) * libct/cg/dev: fix TestSetV1Allow panic. (#4295) * tests/int/scheduler: require smp. (#4298) Changed: * libct/cg/fs: don't write cpu_burst twice on ENOENT. (#4259) * Allow overriding VERSION value in Makefile. (#4269) * Make trimpath optional. (#3908) * Remove unused system.Execv. (#4268) * Stop blacklisting Go 1.22+, drop Go < 1.21 support, use Go 1.22 in CI. (#4292) * Improve some error messages for runc exec. (#4320) * ci/gha: bump golangci-lint[-action]. (#4255) * tests/int/tty: increase the timeout. (#4260) * [ci] use go mod instead of go get in spec.bats. (#4264) * tests/int/checkpoint: rm double logging. (#4251) * ci/gha: bump golangci-lint-action from 5 to 6. (#4275) * .cirrus.yml: rm FIXME from rootless fs on CentOS 7. (#4279) * vendor: golang.org/x/net@v0.24.0. (#4280) * Dockerfile: bump Debian to 12, Go to 1.21. (#4296) * ci: pin codespell. (#4301) * ci: workaround for centos stream 8 being EOLed. (#4304) * ci/cirrus: rm centos stream 8. (#4307) * ci/gha: switch to ubuntu 24.04. (#4286) * Vagrantfile.fedora: bump to F40. (#4256, #4285)
commit | f2d2ee5e45af3c9b38dfd639ac92f43c3055ce4e | [log] [tgz] |
---|---|---|
author | lifubang <lifubang@acmcoder.com> | Mon Jun 10 00:56:27 2024 |
committer | lfbzhm <lifubang@acmcoder.com> | Wed Jun 26 12:03:03 2024 |
tree | 6fc38a5dca6f8f5793b20694cf9aeccdc8ccd6c7 | |
parent | 095e9e5c025fdc907a057a81f9f8a29e6c433ece [diff] |
VERSION: release 1.2.0-rc.2 Signed-off-by: lifubang <lifubang@acmcoder.com>
runc
is a CLI tool for spawning and running containers on Linux according to the OCI specification.
You can find official releases of runc
on the release page.
All releases are signed by one of the keys listed in the runc.keyring
file in the root of this repository.
The reporting process and disclosure communications are outlined here.
A third party security audit was performed by Cure53, you can see the full report here.
runc
only supports Linux. It must be built with Go version 1.21 or higher.
NOTE: if building with Go 1.22.x, make sure to use 1.22.4 or a later version (see issue #4233 for more details).
In order to enable seccomp support you will need to install libseccomp
on your platform.
e.g.
libseccomp-devel
for CentOS, orlibseccomp-dev
for Ubuntu
# 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
You can also use go get
to install to your GOPATH
, assuming that you have a github.com
parent folder already created under src
:
go get github.com/opencontainers/runc cd $GOPATH/src/github.com/opencontainers/runc make sudo make install
runc
will be installed to /usr/local/sbin/runc
on your system.
runc
supports optional build tags for compiling support of various features, with some of them enabled by default (see BUILDTAGS
in top-level Makefile
).
To change build tags from the default, set the BUILDTAGS
variable for make, e.g. to disable seccomp:
make BUILDTAGS=""
Build Tag | Feature | Enabled by Default | Dependencies |
---|---|---|---|
seccomp | Syscall filtering using libseccomp . | yes | libseccomp |
!runc_nodmz | Reduce memory usage for CVE-2019-5736 protection by using a small C binary, see memfd-bind for more details. runc_nodmz disables this experimental feature and causes runc to use a different protection mechanism which will further increases memory usage temporarily during container startup. To enable this feature you also need to set the RUNC_DMZ=true environment variable. | yes |
The following build tags were used earlier, but are now obsoleted:
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"
You can run a specific integration test by setting the TESTPATH
variable.
# make test TESTPATH="/checkpoint.bats"
You can run a specific rootless integration test by setting the ROOTLESS_TESTPATH
variable.
# make test ROOTLESS_TESTPATH="/checkpoint.bats"
You can run a test using your container engine's flags by setting CONTAINER_ENGINE_BUILD_FLAGS
and CONTAINER_ENGINE_RUN_FLAGS
variables.
# make test CONTAINER_ENGINE_BUILD_FLAGS="--build-arg http_proxy=http://yourproxy/" CONTAINER_ENGINE_RUN_FLAGS="-e http_proxy=http://yourproxy/"
runc
uses Go Modules for dependencies management. Please refer to Go Modules for how to add or update new dependencies.
# Update vendored dependencies make vendor # Verify all dependencies make verify-dependencies
Please note that runc is a low level tool not designed with an end user in mind. It is mostly employed by other higher level container software.
Therefore, unless there is some specific use case that prevents the use of tools like Docker or Podman, it is not recommended to use runc directly.
If you still want to use runc, here's how.
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
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.
# run as root 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 below (see more details about runc terminal handling). 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": { "bounding": [ "CAP_AUDIT_WRITE", "CAP_KILL", "CAP_NET_BIND_SERVICE" ], "effective": [ "CAP_AUDIT_WRITE", "CAP_KILL", "CAP_NET_BIND_SERVICE" ], "inheritable": [ "CAP_AUDIT_WRITE", "CAP_KILL", "CAP_NET_BIND_SERVICE" ], "permitted": [ "CAP_AUDIT_WRITE", "CAP_KILL", "CAP_NET_BIND_SERVICE" ], "ambient": [ "CAP_AUDIT_WRITE", "CAP_KILL", "CAP_NET_BIND_SERVICE" ] }, "rlimits": [ { "type": "RLIMIT_NOFILE", "hard": 1024, "soft": 1024 } ], "noNewPrivileges": true },
Now we can go through the lifecycle operations in your shell.
# run as root 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 allows higher level systems to augment the containers creation logic with setup of various settings after the container is created and/or before it is deleted. For example, the container's network stack is commonly set up after create
but before start
.
runc
has the ability to run containers without root privileges. This is called rootless
. You need to pass some parameters to runc
in order to run rootless containers. See below and compare with the previous version.
Note: In order to use this feature, “User Namespaces” must be compiled and enabled in your kernel. There are various ways to do this depending on your distribution:
CONFIG_USER_NS=y
is set in your kernel configuration (normally found in /proc/config.gz
)echo 1 > /proc/sys/kernel/unprivileged_userns_clone
echo 28633 > /proc/sys/user/max_user_namespaces
Run the following commands as an ordinary user:
# Same as the first example mkdir ~/mycontainer cd ~/mycontainer mkdir rootfs docker export $(docker create busybox) | tar -C rootfs -xvf - # The --rootless parameter instructs runc spec to generate a configuration for a rootless container, which will allow you to run the container as a non-root user. runc spec --rootless # The --root parameter tells runc where to store the container state. It must be writable by the user. runc --root /tmp/runc run mycontainerid
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
The code and docs are released under the Apache 2.0 license.