This repository contains the runtime for the Kata Containers project.
For details of the other Kata Containers repositories, see the repository summary.
kata-runtime, referred to as "the runtime", is the Command-Line Interface
(CLI) part of the Kata Containers runtime component. It leverages the
package to provide a high-performance standards-compliant runtime that creates
hardware-virtualized Linux containers running on Linux hosts.
The code is licensed under an Apache 2.0 license.
See the license file for further details.
Kata Containers currently works on systems supporting the following technologies:
The runtime has a built-in command to determine if your host system is capable of running and creating a Kata Container:
$ kata-runtime kata-check
By default, only a brief success / failure message is printed. If more details are needed, the
--verboseflag can be used to display the list of all the checks performed.
rootpermission is needed to check if the system is capable of running Kata containers. In this case, additional checks are performed (e.g., if another incompatible hypervisor is running).
See the installation guides available for various operating systems.
See the developer guide.
See the architecture overview for details on the Kata Containers design.
The runtime uses a TOML format configuration file called
The file contains comments explaining all options.
The initial values in the configuration file provide a good default configuration. You may need to modify this file to optimise or tailor your system, or if you have specific requirements.
Since the runtime supports a
it checks for this configuration file in multiple locations, two of which are
built in to the runtime. The default location is
/usr/share/defaults/kata-containers/configuration.toml for a standard
system. However, if
/etc/kata-containers/configuration.toml exists, this
The below command lists the full paths to the configuration files that the runtime attempts to load. The first path that exists will be used:
$ kata-runtime --kata-show-default-config-paths
Aside from the built-in locations, it is possible to specify the path to a
custom configuration file using the
$ kata-runtime --kata-config=/some/where/configuration.toml ...
The runtime will log the full path to the configuration file it is using. See the logging section for further details.
To see details of your systems runtime environment (including the location of the configuration file being used), run:
$ kata-runtime kata-env
For detailed information and analysis on obtaining logs for other system
components, see the documentation for the
For runtime logs, see the following sections for the CRI-O and containerd shimv2 based runtimes.
The Kata OCI runtime (including when used with CRI-O), provides
However, the runtime also always logs to the system log (
To view runtime log output:
$ sudo journalctl -t kata-runtime
The Kata containerd shimv2 runtime logs through
containerd, and its logs will be sent
to wherever the
containerd logs are directed. However, the
shimv2 runtime also always logs to the system log (
journald) under the
identifier name of
To view the
shimv2 runtime log output:
$ sudo journalctl -t kata
See the limitations file for further details.
For details of the other packages contained in this repository, see the package documentation.