github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Merge pull request #5850 from thaJeztah/runc_build_docs

Browse Source 
BUILDING.md: remove some bits about building runc
This commit is contained in:
Phil Estes 2021-08-10 13:09:08 -04:00 committed by GitHub
commit 37f2c7ca8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 38 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
BUILDING.md
View File

@ -32,9 +32,9 @@ git clone https://github.com/containerd/containerd
For proper results, install the `protoc` release into `/usr/local` on your build system. For example, the following commands will download and install the 3.11.4 release for a 64-bit Linux host: For proper results, install the `protoc` release into `/usr/local` on your build system. For example, the following commands will download and install the 3.11.4 release for a 64-bit Linux host:
``` ```sh
$ wget -c https://github.com/protocolbuffers/protobuf/releases/download/v3.11.4/protoc-3.11.4-linux-x86_64.zip wget -c https://github.com/protocolbuffers/protobuf/releases/download/v3.11.4/protoc-3.11.4-linux-x86_64.zip
$ sudo unzip protoc-3.11.4-linux-x86_64.zip -d /usr/local sudo unzip protoc-3.11.4-linux-x86_64.zip -d /usr/local
``` ```
`containerd` uses [Btrfs](https://en.wikipedia.org/wiki/Btrfs) it means that you `containerd` uses [Btrfs](https://en.wikipedia.org/wiki/Btrfs) it means that you
@ -46,38 +46,20 @@ need to satisfy these dependencies in your system:
At this point you are ready to build `containerd` yourself! At this point you are ready to build `containerd` yourself!
## Build runc ## Runc
`runc` is the default container runtime used by `containerd` and is required to Runc is the default container runtime used by `containerd` and is required to
run containerd. While it is okay to download a runc binary and install that on run containerd. While it is okay to download a `runc` binary and install that on
the system, sometimes it is necessary to build runc directly when working with the system, sometimes it is necessary to build runc directly when working with
container runtime development. You can skip this step if you already have the container runtime development. Make sure to follow the guidelines for versioning
correct version of `runc` installed. in [RUNC.md](/docs/RUNC.md) for the best results.
`runc` requires `libseccomp`. You may need to install the missing dependencies:
* CentOS/Fedora: `yum install libseccomp libseccomp-devel`
* Debian/Ubuntu: `apt-get install libseccomp libseccomp-dev`
For the quick and dirty installation, you can use the following:
```
git clone https://github.com/opencontainers/runc
cd runc
make
sudo make install
```
Make sure to follow the guidelines for versioning in [RUNC.md](/docs/RUNC.md) for the
best results.
## Build containerd ## Build containerd
`containerd` uses `make` to create a repeatable build flow. It means that you `containerd` uses `make` to create a repeatable build flow. It means that you
can run: can run:
``` ```sh
cd containerd cd containerd
make make
``` ```
@ -86,7 +68,7 @@ This is going to build all the project binaries in the `./bin/` directory.
You can move them in your global path, `/usr/local/bin` with: You can move them in your global path, `/usr/local/bin` with:
```sudo ```sh
sudo make install sudo make install
``` ```
@ -99,7 +81,7 @@ Note: if you set one of these vars, set them to the same values on all make stag
If you want to prepend an additional prefix on actual installation (eg. packaging or chroot install), If you want to prepend an additional prefix on actual installation (eg. packaging or chroot install),
you can pass it via `DESTDIR` variable: you can pass it via `DESTDIR` variable:
```sudo ```sh
sudo make install DESTDIR=/tmp/install-x973234/ sudo make install DESTDIR=/tmp/install-x973234/
``` ```
@ -112,7 +94,7 @@ Older releases was using `DESTDIR` for a different purpose that is similar to `P
When making any changes to the gRPC API, you can use the installed `protoc` When making any changes to the gRPC API, you can use the installed `protoc`
compiler to regenerate the API generated code packages with: compiler to regenerate the API generated code packages with:
```sudo ```sh
make generate make generate
``` ```
@ -139,7 +121,7 @@ Please refer to [RUNC.md](/docs/RUNC.md) for the currently supported version of
You can build static binaries by providing a few variables to `make`: You can build static binaries by providing a few variables to `make`:
```sudo ```sh
make EXTRA_FLAGS="-buildmode pie" \ make EXTRA_FLAGS="-buildmode pie" \
EXTRA_LDFLAGS='-linkmode external -extldflags "-fno-PIC -static"' \ EXTRA_LDFLAGS='-linkmode external -extldflags "-fno-PIC -static"' \
BUILDTAGS="netgo osusergo static_build" BUILDTAGS="netgo osusergo static_build"
@ -153,12 +135,12 @@ make EXTRA_FLAGS="-buildmode pie" \
The following instructions assume you are at the parent directory of containerd source directory. The following instructions assume you are at the parent directory of containerd source directory.
## Build containerd ## Build containerd in a container
You can build `containerd` via a Linux-based Docker container. You can build `containerd` via a Linux-based Docker container.
You can build an image from this `Dockerfile`: You can build an image from this `Dockerfile`:
``` ```dockerfile
FROM golang FROM golang
RUN apt-get update && \ RUN apt-get update && \
@ -183,7 +165,8 @@ You are now ready to [build](#build-containerd):
make && make install make && make install
``` ```
## Build containerd and runc ## Build containerd and runc in a container
To have complete core container runtime, you will need both `containerd` and `runc`. It is possible to build both of these via Docker container. To have complete core container runtime, you will need both `containerd` and `runc`. It is possible to build both of these via Docker container.
You can use `git` to checkout `runc`: You can use `git` to checkout `runc`:
@ -199,7 +182,6 @@ FROM golang
RUN apt-get update && \ RUN apt-get update && \
apt-get install -y libbtrfs-dev libseccomp-dev apt-get install -y libbtrfs-dev libseccomp-dev
``` ```
In our Docker container we will build `runc` build, which includes In our Docker container we will build `runc` build, which includes
@ -268,6 +250,7 @@ go test -v -run . -test.root
``` ```
Example output from directly running `go test` to execute the `TestContainerList` test: Example output from directly running `go test` to execute the `TestContainerList` test:
```sh ```sh
sudo go test -v -run "TestContainerList" . -test.root sudo go test -v -run "TestContainerList" . -test.root
INFO[0000] running tests against containerd revision=f2ae8a020a985a8d9862c9eb5ab66902c2888361 version=v1.0.0-beta.2-49-gf2ae8a0 INFO[0000] running tests against containerd revision=f2ae8a020a985a8d9862c9eb5ab66902c2888361 version=v1.0.0-beta.2-49-gf2ae8a0

46
docs/RUNC.md
View File

@ -1,5 +1,7 @@
# Runc version requirements for containerd
containerd is built with OCI support and with support for advanced features containerd is built with OCI support and with support for advanced features
provided by [runc](https://github.com/opencontainers/runc). provided by the [runc container runtime](https://github.com/opencontainers/runc).
Development (`-dev`) and pre-releases of containerd may depend features in `runc` Development (`-dev`) and pre-releases of containerd may depend features in `runc`
that have not yet been released, and may require a specific runc build. The version 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`](..
If you encounter any runtime errors, make sure your runc is in sync with the If you encounter any runtime errors, make sure your runc is in sync with the
commit or tag provided in that file. commit or tag provided in that file.
## building If you do not have the correct version of `runc` installed, you can refer to the
["building" section in the runc documentation](https://github.com/opencontainers/runc#building)
to learn how to build `runc` from source.
> For more information on how to clone and build runc also refer to the runc runc builds have [SELinux](https://en.wikipedia.org/wiki/Security-Enhanced_Linux),
> building [documentation](https://github.com/opencontainers/runc#building). [AppArmor](https://en.wikipedia.org/wiki/AppArmor), and [seccomp](https://en.wikipedia.org/wiki/seccomp)
support enabled by default.
Before building runc you may need to install additional build dependencies, which Note that "seccomp" can be disabled by passing an empty `BUILDTAGS` make
will vary by platform. For example, you may need to install `libseccomp` e.g. variable, but is highly recommended to keep enabled.
`libseccomp-dev` for Ubuntu.
From within your `opencontainers/runc` repository run: Use the output of the `runc --version` output to verify if your version of runc
has seccomp enabled. For example:
```bash
make && sudo make install
```
Starting with runc 1.0.0-rc93, the "selinux" and "apparmor" buildtags have been
removed, and runc builds have SELinux, AppArmor, and seccomp support enabled
by default. Note that "seccomp" can be disabled by passing an empty `BUILDTAGS`
make variable, but is highly recommended to keep enabled.
By default, runc is compiled with kernel-memory limiting support enabled. This
functionality is deprecated in kernel 5.4 and up, and is known to be broken on
RHEL7 and CentOS 7 3.10 kernels. For these kernels, we recommend disabling kmem
support using the `nokmem` build-tag. When doing so, be sure to set the `seccomp`
build-tag to enable seccomp support, for example:
```sh ```sh
make BUILDTAGS='nokmem seccomp' && make install $ runc --version
runc version 1.0.1
commit: v1.0.1-0-g4144b638
spec: 1.0.2-dev
go: go1.16.6
libseccomp: 2.4.4
``` ```
For details about the `nokmem` build-tag, refer to the discussion on [opencontainers/runc#2594](https://github.com/opencontainers/runc/pull/2594).
For further details on building runc, refer to the [build instructions in the runc README](https://github.com/opencontainers/runc#building).