Skip to content

Commit 9cc179a

Browse files
thaJeztahthaJeztah
committed
BUILDING.md: remove some bits about building runc
Refer users to runc's documentation instead of duplicating the instructions. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 42b57cc commit 9cc179a

2 files changed

Lines changed: 24 additions & 50 deletions

File tree

‎BUILDING.md‎

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -46,31 +46,13 @@ need to satisfy these dependencies in your system:
4646

4747
At this point you are ready to build `containerd` yourself!
4848

49-
## Build runc
49+
## Runc
5050

51-
`runc` is the default container runtime used by `containerd` and is required to
52-
run containerd. While it is okay to download a runc binary and install that on
51+
Runc is the default container runtime used by `containerd` and is required to
52+
run containerd. While it is okay to download a `runc` binary and install that on
5353
the system, sometimes it is necessary to build runc directly when working with
54-
container runtime development. You can skip this step if you already have the
55-
correct version of `runc` installed.
56-
57-
`runc` requires `libseccomp`. You may need to install the missing dependencies:
58-
59-
* CentOS/Fedora: `yum install libseccomp libseccomp-devel`
60-
* Debian/Ubuntu: `apt-get install libseccomp libseccomp-dev`
61-
62-
63-
For the quick and dirty installation, you can use the following:
64-
65-
```
66-
git clone https://github.com/opencontainers/runc
67-
cd runc
68-
make
69-
sudo make install
70-
```
71-
72-
Make sure to follow the guidelines for versioning in [RUNC.md](/docs/RUNC.md) for the
73-
best results.
54+
container runtime development. Make sure to follow the guidelines for versioning
55+
in [RUNC.md](/docs/RUNC.md) for the best results.
7456

7557
## Build containerd
7658

‎docs/RUNC.md‎

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
# Runc version requirements for containerd
2+
13
containerd is built with OCI support and with support for advanced features
2-
provided by [runc](https://github.com/opencontainers/runc).
4+
provided by the [runc container runtime](https://github.com/opencontainers/runc).
35

46
Development (`-dev`) and pre-releases of containerd may depend features in `runc`
57
that have not yet been released, and may require a specific runc build. The version
@@ -14,35 +16,25 @@ or higher than the version of runc described in [`script/setup/runc-version`](..
1416
If you encounter any runtime errors, make sure your runc is in sync with the
1517
commit or tag provided in that file.
1618

17-
## building
18-
19-
> For more information on how to clone and build runc also refer to the runc
20-
> building [documentation](https://github.com/opencontainers/runc#building).
21-
22-
Before building runc you may need to install additional build dependencies, which
23-
will vary by platform. For example, you may need to install `libseccomp` e.g.
24-
`libseccomp-dev` for Ubuntu.
19+
If you do not have the correct version of `runc` installed, you can refer to the
20+
["building" section in the runc documentation](https://github.com/opencontainers/runc#building)
21+
to learn how to build `runc` from source.
2522

26-
From within your `opencontainers/runc` repository run:
23+
runc builds have [SELinux](https://en.wikipedia.org/wiki/Security-Enhanced_Linux),
24+
[AppArmor](https://en.wikipedia.org/wiki/AppArmor), and [seccomp](https://en.wikipedia.org/wiki/seccomp)
25+
support enabled by default.
2726

28-
```bash
29-
make && sudo make install
30-
```
31-
32-
Starting with runc 1.0.0-rc93, the "selinux" and "apparmor" buildtags have been
33-
removed, and runc builds have SELinux, AppArmor, and seccomp support enabled
34-
by default. Note that "seccomp" can be disabled by passing an empty `BUILDTAGS`
35-
make variable, but is highly recommended to keep enabled.
27+
Note that "seccomp" can be disabled by passing an empty `BUILDTAGS` make
28+
variable, but is highly recommended to keep enabled.
3629

37-
By default, runc is compiled with kernel-memory limiting support enabled. This
38-
functionality is deprecated in kernel 5.4 and up, and is known to be broken on
39-
RHEL7 and CentOS 7 3.10 kernels. For these kernels, we recommend disabling kmem
40-
support using the `nokmem` build-tag. When doing so, be sure to set the `seccomp`
41-
build-tag to enable seccomp support, for example:
30+
Use the output of the `runc --version` output to verify if your version of runc
31+
has seccomp enabled. For example:
4232

4333
```sh
44-
make BUILDTAGS='nokmem seccomp' && make install
34+
$ runc --version
35+
runc version 1.0.1
36+
commit: v1.0.1-0-g4144b638
37+
spec: 1.0.2-dev
38+
go: go1.16.6
39+
libseccomp: 2.4.4
4540
```
46-
47-
For details about the `nokmem` build-tag, refer to the discussion on [opencontainers/runc#2594](https://github.com/opencontainers/runc/pull/2594).
48-
For further details on building runc, refer to the [build instructions in the runc README](https://github.com/opencontainers/runc#building).

0 commit comments

Comments
 (0)