Grammatical edits to Run Kata Containers doc

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
This commit is contained in:
Deb Taylor
2020-01-28 10:15:20 -05:00
committed by deb-intel
parent 88dfd8d447
commit 8896ba25b5

View File

@@ -8,14 +8,16 @@ This tutorial describes how to install, configure, and run `Kata Containers
Kata Containers leverage the ACRN hypervisor instead of QEMU which is used by Kata Containers leverage the ACRN hypervisor instead of QEMU which is used by
default. Refer to the `Kata Containers with ACRN default. Refer to the `Kata Containers with ACRN
<https://drive.google.com/file/d/1ZrqM5ouWUJA0FeIWhU_aitEJe8781rpe/view?usp=sharing>`_ <https://drive.google.com/file/d/1ZrqM5ouWUJA0FeIWhU_aitEJe8781rpe/view?usp=sharing>`_
presentation from a previous ACRN Project Technical Community Meeting for more presentation from a previous ACRN Project Technical Community Meeting for
details on Kata Containers and how the integration with ACRN has been done. more details on Kata Containers and how the integration with ACRN has been
done.
Pre-Requisites Prerequisites
************** **************
#. Refer to the :ref:`ACRN supported hardware <hardware>`. #. Refer to the :ref:`ACRN supported hardware <hardware>`.
#. For a default prebuilt ACRN binary in the E2E package, you must have 4 CPU cores or enable "CPU Hyper-Threading” in order to have 4 CPU threads for 2 CPU cores. #. For a default prebuilt ACRN binary in the E2E package, you must have 4
CPU cores or enable "CPU Hyper-Threading" in order to have 4 CPU threads for 2 CPU cores.
#. Follow :ref:`these instructions <kbl-nuc-sdc>` to set up the ACRN Service VM. #. Follow :ref:`these instructions <kbl-nuc-sdc>` to set up the ACRN Service VM.
@@ -31,36 +33,36 @@ Install Docker
Install Kata Containers Install Kata Containers
*********************** ***********************
The Kata Containers installation from Clear Linux's official repository does not The Kata Containers installation from Clear Linux's official repository does
work with ACRN at the moment, we therefore install Kata Containers using the not work with ACRN at the moment. Therefore, you must install Kata
`manual installation <https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md>`_ Containers using the `manual installation <https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md>`_ instructions (using a ``rootfs`` image).
instructions (using a ``rootfs`` image).
#. Install the build dependencies #. Install the build dependencies.
.. code-block:: none .. code-block:: none
$ sudo swupd bundle-add go-basic devpkg-elfutils $ sudo swupd bundle-add go-basic devpkg-elfutils
#. Install Kata Containers #. Install Kata Containers.
At a high level, the `manual installation <https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md>`_ At a high level, the `manual installation <https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md>`_
steps are: steps are:
#. Build and install the Kata runtime #. Build and install the Kata runtime.
#. Create and install a ``rootfs`` #. Create and install a ``rootfs``.
#. Build and install the Kata Containers kernel #. Build and install the Kata Containers kernel.
#. Build and install the Kata proxy #. Build and install the Kata proxy.
#. Build and install the Kata shim #. Build and install the Kata shim.
Configure Kata on ACRN Configure Kata on ACRN
********************** **********************
With the core components installed on the system, the next step is to configure After the core components are installed on the system, the next step is to
them to work seamlessly together. There are two parts to this. configure them to work seamlessly together. This includes two parts.
#. `Configure Docker <https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#run-kata-containers-with-docker>`_ #. `Configure Docker <https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#run-kata-containers-with-docker>`_
to recognize the ``kata-runtime`` as an additional runtime available for use. to recognize the ``kata-runtime`` as an additional runtime available for
use.
#. Configure Kata to use ACRN. #. Configure Kata to use ACRN.
@@ -69,13 +71,16 @@ them to work seamlessly together. There are two parts to this.
$ sudo mkdir -p /etc/kata-containers $ sudo mkdir -p /etc/kata-containers
$ sudo cp /usr/share/defaults/kata-containers/configuration-acrn.toml /etc/kata-containers/configuration.toml $ sudo cp /usr/share/defaults/kata-containers/configuration-acrn.toml /etc/kata-containers/configuration.toml
You can verify that these configurations are effective by checking the following outputs: Verify that these configurations are effective by checking the following
outputs:
.. code-block:: none .. code-block:: none
$ sudo docker info | grep runtime $ sudo docker info | grep runtime
WARNING: the devicemapper storage-driver is deprecated, and will be removed in a future release. WARNING: the devicemapper storage-driver is deprecated, and will be
WARNING: devicemapper: usage of loopback devices is strongly discouraged for production use. removed in a future release.
WARNING: devicemapper: usage of loopback devices is strongly discouraged
for production use.
Use `--storage-opt dm.thinpooldev` to specify a custom block storage device. Use `--storage-opt dm.thinpooldev` to specify a custom block storage device.
Runtimes: kata-runtime runc Runtimes: kata-runtime runc
@@ -97,10 +102,10 @@ You can verify that these configurations are effective by checking the following
Run a Kata Container with ACRN Run a Kata Container with ACRN
****************************** ******************************
The system is now ready to run a Kata Container on ACRN (a reboot is recommended The system is now ready to run a Kata Container on ACRN. Note that a reboot
after the installation). is recommended after the installation.
Before running a Kata Container on ACRN, you must offline at least one CPU. Before running a Kata Container on ACRN, you must offline at least one CPU:
.. code-block:: none .. code-block:: none
@@ -108,12 +113,12 @@ Before running a Kata Container on ACRN, you must offline at least one CPU.
$ chmod +x ./offline_cpu.sh $ chmod +x ./offline_cpu.sh
$ sudo ./offline_cpu.sh $ sudo ./offline_cpu.sh
Now start a Kata Container on ACRN. Start a Kata Container on ACRN:
.. code-block:: none .. code-block:: none
$ sudo docker run -ti --runtime=kata-runtime busybox sh $ sudo docker run -ti --runtime=kata-runtime busybox sh
If you run into problems, contact us on the mailing list and provide as much If you run into problems, contact us on the ACRN mailing list and provide as
details as possible about the issue. The output of ``sudo docker info`` and much detail as possible about the issue. The output of ``sudo docker info``
``kata-runtime kata-env`` is useful. and ``kata-runtime kata-env`` is useful.