Merge pull request #203 from MCamp859/kata-docs-update

Updated kata and kata_migration tutorials.
This commit is contained in:
mvincerx
2018-07-26 11:58:21 -07:00
committed by GitHub
2 changed files with 32 additions and 39 deletions
+30 -28
View File
@@ -3,16 +3,16 @@
Install Kata Containers\*
#########################
This tutorial describes how to install, configure and run Kata Containers\* on
|CLOSIA|. Kata Containers is an open source project dedicated to the
development of a lightweight implementation of Virtual Machines (VMs)
offering the speed of containers and the security of VMs.
This tutorial describes how to install, configure, and run `Kata Containers`_
on |CLOSIA|. Kata Containers is an open source project developing a
lightweight implementation of :abbr:`VMs (Virtual Machines)` that offer the
speed of containers and the security of VMs.
Prerequisites
*************
This tutorial assumes you have installed |CL| on your host system.
For detailed instructions on installing |CL| on a bare metal system, visit
For detailed instructions on installing |CL| on a bare metal system, follow
the :ref:`bare metal installation tutorial<bare-metal-install>`.
If you have Clear Containers installed on your |CL| system, then follow the
@@ -28,24 +28,23 @@ Install Kata Containers
***********************
Kata Containers is included in the :file:`containers-virt` bundle. To install the
framework, enter:
framework, enter the following command:
.. code-block:: bash
sudo swupd bundle-add containers-virt
Configure Docker\* to use Kata Containers by default
Configure Docker\* to use Kata Containers by default.
.. code-block:: bash
sudo mkdir -p /etc/systemd/system/docker.service.d/
cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/kata-containers.conf
cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/51-runtime.conf
[Service]
ExecStart=
ExecStart=/usr/bin/dockerd -D --add-runtime kata-runtime=/usr/bin/kata-runtime --default-runtime=kata-runtime
Environment="DOCKER_DEFAULT_RUNTIME=--default-runtime kata-runtime"
EOF
Restart the Docker and Kata Containers systemd services
Restart the Docker and Kata Containers systemd services.
.. code-block:: bash
@@ -61,9 +60,8 @@ Run Kata Containers
.. note::
In cases where it is necessary to use a proxy server and your proxy
environment variables are already set, run the following commands as
a shell script to configure Docker:
If you use a proxy server and your proxy environment variables are already
set, run the following commands as a shell script to configure Docker:
.. code-block:: bash
@@ -81,24 +79,28 @@ Run Kata Containers
**Congratulations!**
You have successfully installed and set up Kata Containers on |CLOSIA|.
You've successfully installed and set up Kata Containers on |CLOSIA|.
More information about Docker in |CLOSIA|
*****************************************
More information about Docker
*****************************
Docker on |CLOSIA| provides a docker.service service file to start the Docker
daemon. The daemon will use runc or kata-runtime depending on
the environment:
Docker on |CLOSIA| provides a :file:`docker.service` file to start the Docker
daemon. The daemon will use runc or kata-runtime depending on the
environment:
If you are running |CL| on bare metal or on a VM with Nested
Virtualization activated, Docker will use kata-runtime as the
default runtime. If you are running |CL| on a VM without Nested
Virtualization, Docker will use runc as the default runtime. It is not
necessary to manually configure the runtime for Docker, since Docker itself
will automatically use the one supported by the system.
* If you are running |CL| on bare metal or on a VM with Nested
Virtualization activated, Docker uses kata-runtime as the
default runtime.
* If you are running |CL| on a VM without Nested Virtualization,
Docker uses runc as the default runtime.
To check which runtime your system is using, run:
You do not need to manually configure the runtime for Docker, because
it automatically uses the runtime supported by the system.
Check which runtime your system is using with the command:
.. code-block:: bash
sudo docker info | grep runtime
.. _Kata Containers: https://katacontainers.io/
@@ -37,14 +37,6 @@ Make any required changes before continuing this process.
You do not need to manually remove any Clear Containers packages.
Disable Clear Containers manager configuration
**********************************************
Remove the Clear Containers configuration file:
.. code-block:: bash
sudo rm /etc/systemd/system/docker.service.d/clear-containers.conf
Enable Kata Containers as default
*********************************
@@ -54,10 +46,9 @@ Enable Kata Containers as default
.. code-block:: bash
sudo mkdir -p /etc/systemd/system/docker.service.d/
cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/kata-containers.conf
cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/51-runtime.conf
[Service]
ExecStart=
ExecStart=/usr/bin/dockerd -D --add-runtime kata-runtime=/usr/bin/kata-runtime --default-runtime=kata-runtime
Environment="DOCKER_DEFAULT_RUNTIME=--default-runtime kata-runtime"
EOF
#. Restart the Docker systemd services.