diff options
| author | Paul Bütow <pbuetow@mimecast.com> | 2018-12-27 09:23:46 +0000 |
|---|---|---|
| committer | Paul Bütow <pbuetow@mimecast.com> | 2018-12-27 09:23:46 +0000 |
| commit | c0786b947a4ee76f917e78cc7fff07b3cde3ec29 (patch) | |
| tree | f215f198fe78f57907bacd355a7570bffa8727bd | |
| parent | 82da58e0b620b6ba85afeb391b423846c1dca7b7 (diff) | |
some tweaks in documentation
| -rw-r--r-- | docs/markdown/installation.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/markdown/installation.md b/docs/markdown/installation.md index 6eb9346..4e95726 100644 --- a/docs/markdown/installation.md +++ b/docs/markdown/installation.md @@ -14,7 +14,7 @@ I/O Riot has been tested on Before proceeding please ensure that the latest CentOS 7 kernel is installed and running on all machines involved. It should also be ensured that the capture machine and the load test machine have the same mount points mounted. This is to ensure that I/O is being replayed on the corresponding data drives on the load test machine. -## Compiling and installing ioriot +## Compiling and installing I/O Riot I/O Riot has to be installed on all machines involved. To install I/O Riot perform the following steps: @@ -38,15 +38,18 @@ sudo make uninstall # Compiling I/O Riot using Docker -In case there is no suitable build host for I/O Riot (e.g. you want to compile everything, including the SystemTap Kernel modules, on a Mac. Or you want to integrate the build process with Jenkins) it is possible to use Docker for that. First of all you have to install Docker Engine. Depending on the system in use the steps may differ. Once Docker is installed you can run for example the following commands to build everything for CentOS 7 and Linux Kernel 3.10.0-957.1.3.el7.x86_64: +It is possible to compile I/O Riot using Docker. The benefit is that it is much easier to get together the required dependencies. Docker build support has been tested on macOS X High Sierra (with Docker Desktop CE from https://www.docker.com) and Fedora Linux 28 (Docker installed from the default repositories). It will work most likely on all other systems with Docker up and running. Keep in mind that we use Docker only to compile I/O Riot and not to operate I/O Riot. + +First of all you have to install a Docker engine. Depending on the system in use the steps involved differ. Please consult the Docker documentation in how to accomplish that. Once Docker is up and running you can run for example the following commands to build everything for CentOS 7 and Linux Kernel 3.10.0-957.1.3.el7.x86_64: ```sh export KERNEL=3.10.0-957.1.3.el7.x86_64 make dockerbuild ``` -That will run for quite a while (depending on the download speed it can take more than 15 minutes!). Afterwards distribute directory ``./docker/opt/ioriot`` to ``/opt/ioriot`` to all boxes with that particular running kernel version. +Keep in mind that ther Kernel version must be a valid kernel version of CentOS 7! + +The above command will fetch a CentOS 7 base image and will install all for the build required packages. Depending on the network speed the whole procedure can take quite a while. I/O Riot will be compiled via Docker to directory ``./docker/opt/ioriot``. That directory can be distributed to ``/opt/ioriot`` to all boxes with that particular running kernel version. -By repeating the steps above it is possible to compile the SystemTap Kernel modules for multiple versions. All the modules will be found seamlessly in ``./docker/opt/ioriot/systemtap``. +By repeating the steps above (setting KERNEL environment variable and running ``make dockerbuild``) it is possible to compile the SystemTap Kernel modules for multiple Kernel versions. All the modules will be found seamlessly in ``./docker/opt/ioriot``. -Docker build support has been tested on macOS X High Sierra and Docker Desktop CE Version 2.0.0.0-mac81 and will work very likely on all other systems with a Docker up and running. |
