e69ebe5add
To include SandboxId in CreateSandboxRequest. Included commits: 745fa71 (origin/pr/309) agent: set sandbox id log field in CreateSandbox a3321f4 (origin/pr/304) vendor: Revendor netlink to fix PID 1 segfault a9ade15 (origin/pr/293) agent: Add sandbox level reference counter for sandbox storage 5f89c07 (origin/pr/263) yamux: disable yamux keep alive in server channel 815f831 (origin/pr/303) agent: do not quit on grpc serve errors 8abefd1 (origin/pr/301) protocols/client: close yamux session when closing the stream 67643cf (origin/pr/297) agent: Fix CPU tests for both initrd and rootfs image cf8d3c8 (origin/pr/295) agent: disable yamux keep alive ed656df (origin/pr/284) grpc: Ignore WriteStdin after the standard input has been closed 1a52204 grpc: Don't close the terminal on CloseStdin() call 04457e3 (origin/pr/292) logging: Add sandbox field ba2a32a (origin/pr/286) create: Reduce cyclomatic complexity of CreateContainer bce5f78 (origin/pr/289) logging: Redirect yamux warnings/errors to logger 23311ea namespace: Add check to make sure PID namespace is not received 7fe2eba (origin/pr/273) release: Kata Containers 1.1.0 4ef4971 (origin/pr/277) travis: Enable travis ci for ppc64le 57bf4e6 (origin/pr/279) namespace: do not create path using rand. a589bdb (origin/pr/275) CI: update static-checks.sh in travis.yml 1372df2 (origin/pr/271) logging: Fix handling of non-string fields when PID 1 4018add (origin/pr/269) agent: honour CPU constraints when agent is the init process 1cff660 (origin/pr/268) mount: Remove redundant mkdir cc74b5d (origin/pr/266) network: Setup localhost when running as init dc06ec7 network: Add extra sanity checks b580ae7 network: Check all function parameters ee106e9 main: Exit(1) on error 5bf3909 network: Reduce cyclomatic complexity cdf9bce namespace: Simplify code 0d7f36f (origin/pr/260) agent: update container cpuset cgroup parents 4cf1809 (origin/pr/258) agent: update container cpuset cgroup before setting the new configuration d70e5bb agent: don't modify container's config a30395a (origin/pr/253) grpc: signal frozen containers Signed-off-by: Peng Tao <bergwolf@gmail.com>
Runtime
This repository contains the runtime for the Kata Containers project.
For details of the other Kata Containers repositories, see the repository summary.
- Introduction
- License
- Platform support
- Quick start for users
- Quick start for developers
- Architecture overview
- Configuration
- Logging
- Debugging
- Limitations
- Community
- Further information
Introduction
kata-runtime, referred to as "the runtime", is the Command-Line Interface
(CLI) part of the Kata Containers runtime component. It leverages the
virtcontainers
package to provide a high-performance standards-compliant runtime that creates
hardware-virtualized containers.
The runtime is OCI-compatible, CRI-O-compatible, and Containerd-compatible, allowing it to work seamlessly with both Docker and Kubernetes respectively.
License
The code is licensed under an Apache 2.0 license.
See the license file for further details.
Platform support
Kata Containers currently works on systems supporting the following technologies:
Hardware requirements
The runtime has a built-in command to determine if your host system is capable of running a Kata Container:
$ kata-runtime kata-check
Note:
If you run the previous command as the
rootuser, further checks will be performed (e.g. it will check if another incompatible hypervisor is running):$ sudo kata-runtime kata-check
Quick start for users
See the installation guides available for various operating systems.
Quick start for developers
See the developer guide.
Architecture overview
See the architecture overview for details on the Kata Containers design.
Configuration
The runtime uses a TOML format configuration file called configuration.toml.
The file contains comments explaining all options.
Note:
The initial values in the configuration file provide a good default configuration. You might need to modify this file if you have specialist needs.
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 command below lists the full paths to the configuration files that the runtime attempts to load. The first path that exists is 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-config option:
$ 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
Logging
The runtime provides --log= and --log-format= options. However, the
runtime always logs to the system log (syslog or journald).
To view runtime log output:
$ sudo journalctl -t kata-runtime
For detailed information and analysis on obtaining logs for other system components, see the documentation for the kata-log-parser tool.
Debugging
See the debugging section of the developer guide.
Limitations
See the limitations file for further details.
Community
Contact
See how to reach the community.
Further information
See the project table of contents and the documentation repository.