doc: add build acrn in docker tutorial

Add a tutorial about how to build acrn in docker.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
This commit is contained in:
Lei, Lu 2019-09-10 09:59:02 +08:00 committed by wenlingz
parent 456709c6e7
commit 68975ba7fa
3 changed files with 162 additions and 0 deletions

View File

@ -26,6 +26,7 @@ Configuration Tutorials
tutorials/using_partition_mode_on_up2
tutorials/using_sdc2_mode_on_nuc
tutorials/using_hybrid_mode_on_nuc
tutorials/building_acrn_in_docker
User VM Tutorials
*****************

5
doc/tutorials/Dockerfile Normal file
View File

@ -0,0 +1,5 @@
FROM clearlinux:latest
RUN swupd bundle-add os-clr-on-clr os-core-dev python3-basic
RUN pip3 install kconfiglib
WORKDIR /workspace

View File

@ -0,0 +1,156 @@
.. _building-acrn-in-docker:
Building ACRN in Docker
#######################
In this tutorial, we will introduce how to build ACRN in Clear Linux Docker image.
Install Docker
**************
#. Install Docker according to `Docker installation instructions <https://docs.docker.com/install/>`_.
#. If you are behind HTTP or HTTPS proxy server, follow the
`HTTP/HTTPS proxy instructions <https://docs.docker.com/config/daemon/systemd/#httphttps-proxy>`_
to set up HTTP/HTTPS proxy to pull Docker image and
`Configure Docker to use a proxy server <https://docs.docker.com/network/proxy/>`_
to set up HTTP/HTTPS proxy for the Docker container.
#. Docker requires root privileges by default.
Follow these `additional steps <https://docs.docker.com/install/linux/linux-postinstall/>`_
to enable a non-root user.
.. note::
It is not required to perform these post-installation steps. If you choose
not to, please add `sudo` in front of every `docker` command in this tutorial.
Get Docker Image
****************
This tutorial presents two ways to get Clear Linux Docker image to build ACRN.
Build Docker Image from Dockerfile
==================================
#. Download `Dockerfile <https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/doc/tutorials/Dockerfile>`_
to your development machine
#. Build Docker image
.. code-block:: none
$ docker build -t clearlinux-acrn-builder:latest -f <path/to/Dockerfile> .
if you are behind HTTP or HTTPS proxy server, use this command instead:
.. code-block:: none
$ docker build --build-arg HTTP_PROXY=http://<proxy_host>:<proxy_port> \
--build-arg HTTPS_PROXY=https://<proxy_host>:<proxy_port> \
-t clearlinux-acrn-builder:latest -f <path/to/Dockerfile> .
Get Docker Image from Docker Hub
================================
You can instead, pull a pre-built Docker image from Docker Hub
to your development machine, using this command:
.. code-block:: none
$ docker pull acrn/clearlinux-acrn-builder:latest
Build ACRN from Source in Docker
********************************
#. Clone the acrn-hypervisor repo
.. code-block:: none
$ mkdir -p ~/workspace && cd ~/workspace
$ git clone https://github.com/projectacrn/acrn-hypervisor
$ cd acrn-hypervisor
#. Build acrn-hypervisor with default configuration (Software Defined Cockpit [SDC] configuration)
For the docker image build from Dockerfile, use the command to build:
.. code-block:: none
$ docker run -u`id -u`:`id -g` --rm -v $PWD:/workspace \
clearlinux-acrn-builder:latest bash -c "make clean && make"
For the docker image downloaded from Docker Hub, use the command to build:
.. code-block:: none
$ docker run -u`id -u`:`id -g` --rm -v $PWD:/workspace \
acrn/clearlinux-acrn-builder:latest bash -c "make clean && make"
The build artifacts are found in the `build` directory.
Build ACRN Service VM Kernel in Docker
**************************************
#. Clone the acrn-kernel repo
.. code-block:: none
$ mkdir -p ~/workspace && cd ~/workspace
$ git clone https://github.com/projectacrn/acrn-kernel
$ cd acrn-kernel
#. Build ACRN Service VM kernel
For the docker image built from Dockerfile, use the command to build:
.. code-block:: none
$ cp kernel_config_sos .config
$ docker run -u`id -u`:`id -g` --rm -v $PWD:/workspace \
clearlinux-acrn-builder:latest \
bash -c "make clean && make olddefconfig && make && make modules_install INSTALL_MOD_PATH=out/"
For the docker image downloaded from Docker Hub, use the command to build:
.. code-block:: none
$ cp kernel_config_sos .config
$ docker run -u`id -u`:`id -g` --rm -v $PWD:/workspace \
acrn/clearlinux-acrn-builder:latest \
bash -c "make clean && make olddefconfig && make && make modules_install INSTALL_MOD_PATH=out/"
The commands build the bootable kernel image as ``arch/x86/boot/bzImage``,
and loadable kernel modules under the ``./out/`` folder.
Build ACRN User VM PREEMPT_RT Kernel in Docker
**********************************************
#. Clone the preempt-rt kernel repo
.. code-block:: none
$ mkdir -p ~/workspace && cd ~/workspace
$ git clone -b 4.19/preempt-rt https://github.com/projectacrn/acrn-kernel preempt-rt
$ cd preempt-rt
#. Build ACRN User VM PREEMPT_RT kernel
For the docker image built from Dockerfile, use the command to build:
.. code-block:: none
$ cp x86-64_defconfig .config
$ docker run -u`id -u`:`id -g` --rm -v $PWD:/workspace \
acrn/clearlinux-acrn-builder:latest \
bash -c "make clean && make olddefconfig && make && make modules_install INSTALL_MOD_PATH=out/"
For the docker image downloaded from Docker Hub, use the command to build:
.. code-block:: none
$ cp x86-64_defconfig .config
$ docker run -u`id -u`:`id -g` --rm -v $PWD:/workspace \
acrn/clearlinux-acrn-builder:latest \
bash -c "make clean && make olddefconfig && make && make modules_install INSTALL_MOD_PATH=out/"
The commands build the bootable kernel image as ``arch/x86/boot/bzImage``,
and loadable kernel modules under the ``./out/`` folder.