This repository contains the following components:
| Binary name | Description |
|---|---|
containerd-shim-kata-v2 |
The shimv2 runtime |
kata-runtime |
utility program |
For details of the other Kata Containers repositories, see the repository summary.
The containerd-shim-kata-v2 binary is the Kata
Containers shimv2 runtime. It leverages the
virtcontainers
package to provide a high-performance standards-compliant runtime that creates
hardware-virtualized Linux containers running on Linux hosts.
The runtime is OCI-compatible, CRI-O-compatible, and Containerd-compatible, allowing it to work seamlessly with both Docker and Kubernetes respectively.
See the installation guides available for various operating systems.
See the architecture overview for details on the Kata Containers design.
The runtime uses a TOML format configuration file called configuration.toml.
The file is divided into sections for settings related to various
parts of the system including the runtime itself, the agent and
the hypervisor.
Each option has a comment explaining its use.
Note:
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.
The shimv2 runtime looks for its configuration in the following places (in order):
-
The
io.data containers.config.config_pathannotation specified in the OCI configuration file (config.jsonfile) used to create the pod sandbox. -
The containerd shimv2 options passed to the runtime.
-
The value of the
KATA_CONF_FILEenvironment variable.
The kata-runtime utility program looks for its configuration in the
following locations (in order):
-
The path specified by the
--configcommand-line option. -
The value of the
KATA_CONF_FILEenvironment variable.
Note: For both binaries, the first path that exists will be used.
Kata Containers supports multiple hypervisors so your configuration.toml
configuration file may be a symbolic link to a hypervisor-specific
configuration file. See
the hypervisors document for further details.
Since the runtime supports a
stateless system,
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
takes priority.
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 --show-default-config-pathsThe 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 envFor detailed information and analysis on obtaining logs for other system
components, see the documentation for the
kata-log-parser
tool.
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 (syslog or journald) using the kata identifier.
Note: Kata logging requires containerd debug to be enabled.
To view the shimv2 runtime logs:
$ sudo journalctl -t kataSee the debugging section of the developer guide.
See the limitations file for further details.
See how to reach the community.
See the project table of contents and the documentation repository.
For details of the other packages contained in this repository, see the package documentation.