Difference between revisions of "Installation"
Jump to navigation
Jump to search
Franklin Yu (talk | contribs) (→Other deps: correct the package names) |
m (→Other stuff) |
||
| (63 intermediate revisions by 11 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <code>criu</code> is an utility to checkpoint/restore a process tree. This page describes how to | + | <code>criu</code> is an utility to checkpoint/restore a process tree. This page describes how to get CRIU binary on your box. |
== Installing from packages == | == Installing from packages == | ||
| − | + | Many distributions provide ready-to-use [[packages]]. If no, or the CRIU version you want is not yet there, you will need to get CRIU sources and compile it. | |
| − | == Obtaining CRIU | + | == Obtaining CRIU sources == |
| − | You can download the source code as a release tarball or sync the [https://github.com/ | + | You can download the source code as a [https://download.openvz.org/criu/ release tarball] or sync the [https://github.com/checkpoint-restore/criu git repository]. If you plan to modify CRIU sources (e.g. to [[How to submit patches|contribute the code back]]) the latter way is highly recommended. The latest and greatest sources are: {{Latest release}} |
| − | == | + | == Installing build dependencies == |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Compiler and C Library === | === Compiler and C Library === | ||
| − | CRIU is mostly written in C and the build system is based on Makefiles. Thus just install standard <code>gcc</code> and <code>make</code> packages (on Debian | + | CRIU is mostly written in C and the build system is based on Makefiles. Thus just install standard <code>gcc</code> and <code>make</code> packages (on Debian use <code>[https://packages.debian.org/build-essential build-essential]</code>). |
| − | |||
| − | |||
| − | + | For building with [[32bit tasks C/R]] support you will need <code>libc6-dev-i386, gcc-multilib</code> instead of <code>gcc</code>. | |
| − | + | [[ARM crosscompile|Cross-compilation for ARM]] is also possible. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Protocol Buffers === | === Protocol Buffers === | ||
| − | CRIU uses the [https://developers.google.com/protocol-buffers/ Google Protocol Buffers] to read and write [[images] | + | CRIU uses the [https://developers.google.com/protocol-buffers/ Google Protocol Buffers] to read and write [[images]]. The <code>protoc</code> tool is used at build time and CRIU is linked with the <code>libprotobuf-c.so</code>. Also [[CRIT]] uses python bindings and the <code>descriptor.proto</code> file which typically provided by a distribution's protobuf development package. |
| − | |||
| − | |||
| − | |||
| − | + | ; RPM packages | |
| − | + | : <code>protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python </code> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ; Deb packages | |
| − | + | : <code>libprotobuf-dev libprotobuf-c-dev protobuf-c-compiler protobuf-compiler python3-protobuf</code> | |
| − | + | Optionally, you may [[build protobuf]] from sources. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | === Other stuff === | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* <code>pkg-config</code> to check on build library dependencies. | * <code>pkg-config</code> to check on build library dependencies. | ||
| − | * <code> | + | * <code>python-ipaddress</code> is used by CRIT to pretty-print IP addresses and is also required by zdtm.py |
| − | * <code> | + | * <code>libbsd-devel</code> (RPM) / <code>libbsd-dev</code> (DEB) If available, CRIU will be compiled with <code>setproctitle()</code> support and set verbose process titles on service workers. |
| − | + | * <code>iproute2</code> version 3.5.0 or higher is needed for dumping network namespaces. The latest one can be cloned from [http://git.kernel.org/?p=linux/kernel/git/shemminger/iproute2.git;a=summary iproute2]. It should be compiled and a path to ip set as the [[environment variables|<code>CR_IP_TOOL</code> variable]] | |
| − | + | * <code>nftables</code> (RPM) / <code>libnftables-dev</code> (DEB) If available, CRIU will be compiled with nftables C/R support | |
| − | * | + | * <code>libcap-devel</code> (RPM) / <code>libcap-dev</code> (DEB) - Require |
| − | * <code> | + | * <code>libnet-devel libnl3-devel</code> (RPM) / <code>libnet1-dev</code> (DEB) / <code>libnl-3-dev libnet-dev</code> (Ubuntu) - Require |
| − | * | + | * <code>libaio-devel</code> (RPM) / <code>libaio-dev</code> (DEB) is needed to run tests |
| − | * | + | * <code>gnutls-devel</code> (RPM) / <code>libgnutls28-dev</code> (DEB), if available, CRIU will be compiled with [[TLS]] support |
| − | + | * <code>python2-future</code> or <code>python3-future</code> is now needed for zdtm.py tests launcher | |
| − | + | * <code>libdrm-devel</code> (RPM) / <code>libdrm-dev</code> (DEB) If available, CRIU will be compiled with support for AMD GPUs. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | * | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | For APT use the <code>--no-install-recommends</code> parameter is to avoid asciidoc pulling in a lot of dependencies. | |
| + | Also read about [[ZDTM test suite]] if you will run CRIU tests, those sources need other deps. | ||
| − | == Building | + | == Building the tool == |
| − | + | Simply run <code>make</code> in the CRIU source directory. This is the standard way, but there are some options available. | |
| − | Simply run <code>make</code> in the CRIU source directory. | ||
| − | + | # There's a ''docker-build'' target in Makefile which builds CRIU in Ubuntu Docker container. Just run <code>make docker-build</code> and that's it. | |
| + | # CRIU has functionality that is either optional or behaves differently depending on the kernel CRIU is running on. By default build process includes maximum of it, but this behavior [[configuring|can be changed]]. | ||
| + | # You may [[Manual build deps|specify build dependencies by hands]] | ||
| − | + | == Installing == | |
| − | + | CRIU works perfectly even when run from the sources directory (with the <code>./criu/criu</code> command), but if you want to have in standard paths run <code>make install</code>. You may need to install <code>asciidoc</code> and <code>xmlto</code> packages to make install-man work. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | CRIU works perfectly even when run from the sources directory (with the | ||
| − | |||
| − | You may need to install | ||
| − | |||
| − | |||
== Checking That It Works == | == Checking That It Works == | ||
| − | + | Linux kernel v3.11 or newer is required, with some specific config options turned on. Various advanced CRIU features might require even newer kernel. So the first thing to do is to [[Checking the kernel|check the kernel]] by running <code>criu check</code>. At the end it should say "Looks OK", if it doesn't the messages on the screen explain what functionality is missing. If your distribution does not provide needed kernel, you might want to [[Linux kernel|compile one yourself]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | You can then try running the [[ZDTM Test Suite]] which sits in the <code> | + | You can then try running the [[ZDTM Test Suite]] which sits in the <code>test/zdtm/</code> directory. |
== Further reading == | == Further reading == | ||
| − | + | * [[Usage]] | |
| + | * [[Advanced usage]] | ||
| + | * [[:Category:HOWTO]] | ||
[[Category:HOWTO]] | [[Category:HOWTO]] | ||
| + | [[Category:Editor help needed]] | ||
Latest revision as of 01:56, 30 September 2023
criu is an utility to checkpoint/restore a process tree. This page describes how to get CRIU binary on your box.
Installing from packages[edit]
Many distributions provide ready-to-use packages. If no, or the CRIU version you want is not yet there, you will need to get CRIU sources and compile it.
Obtaining CRIU sources[edit]
You can download the source code as a release tarball or sync the git repository. If you plan to modify CRIU sources (e.g. to contribute the code back) the latter way is highly recommended. The latest and greatest sources are:
| Tarball: | criu-4.0.tar.gz |
| Version: | 4.0 "CRIUDA" |
| Released: | 20 Sep 2024 |
| GIT tag: | v4.0 |
Installing build dependencies[edit]
Compiler and C Library[edit]
CRIU is mostly written in C and the build system is based on Makefiles. Thus just install standard gcc and make packages (on Debian use build-essential).
For building with 32bit tasks C/R support you will need libc6-dev-i386, gcc-multilib instead of gcc.
Cross-compilation for ARM is also possible.
Protocol Buffers[edit]
CRIU uses the Google Protocol Buffers to read and write images. The protoc tool is used at build time and CRIU is linked with the libprotobuf-c.so. Also CRIT uses python bindings and the descriptor.proto file which typically provided by a distribution's protobuf development package.
- RPM packages
protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python
- Deb packages
libprotobuf-dev libprotobuf-c-dev protobuf-c-compiler protobuf-compiler python3-protobuf
Optionally, you may build protobuf from sources.
Other stuff[edit]
pkg-configto check on build library dependencies.python-ipaddressis used by CRIT to pretty-print IP addresses and is also required by zdtm.pylibbsd-devel(RPM) /libbsd-dev(DEB) If available, CRIU will be compiled withsetproctitle()support and set verbose process titles on service workers.iproute2version 3.5.0 or higher is needed for dumping network namespaces. The latest one can be cloned from iproute2. It should be compiled and a path to ip set as theCR_IP_TOOLvariablenftables(RPM) /libnftables-dev(DEB) If available, CRIU will be compiled with nftables C/R supportlibcap-devel(RPM) /libcap-dev(DEB) - Requirelibnet-devel libnl3-devel(RPM) /libnet1-dev(DEB) /libnl-3-dev libnet-dev(Ubuntu) - Requirelibaio-devel(RPM) /libaio-dev(DEB) is needed to run testsgnutls-devel(RPM) /libgnutls28-dev(DEB), if available, CRIU will be compiled with TLS supportpython2-futureorpython3-futureis now needed for zdtm.py tests launcherlibdrm-devel(RPM) /libdrm-dev(DEB) If available, CRIU will be compiled with support for AMD GPUs.
For APT use the --no-install-recommends parameter is to avoid asciidoc pulling in a lot of dependencies.
Also read about ZDTM test suite if you will run CRIU tests, those sources need other deps.
Building the tool[edit]
Simply run make in the CRIU source directory. This is the standard way, but there are some options available.
- There's a docker-build target in Makefile which builds CRIU in Ubuntu Docker container. Just run
make docker-buildand that's it. - CRIU has functionality that is either optional or behaves differently depending on the kernel CRIU is running on. By default build process includes maximum of it, but this behavior can be changed.
- You may specify build dependencies by hands
Installing[edit]
CRIU works perfectly even when run from the sources directory (with the ./criu/criu command), but if you want to have in standard paths run make install. You may need to install asciidoc and xmlto packages to make install-man work.
Checking That It Works[edit]
Linux kernel v3.11 or newer is required, with some specific config options turned on. Various advanced CRIU features might require even newer kernel. So the first thing to do is to check the kernel by running criu check. At the end it should say "Looks OK", if it doesn't the messages on the screen explain what functionality is missing. If your distribution does not provide needed kernel, you might want to compile one yourself.
You can then try running the ZDTM Test Suite which sits in the test/zdtm/ directory.