6d391c4355
This includes the addition of "SandboxPidNs" in the CreateContainerRequest api. Shortlog: a30395a grpc: signal frozen containers 08674c0 agent: Add support for ephemeral volumes c517125 ci: Refactor to pass metalinter checks ad9c33d tests: Modify tests to take into account if pid ns needs to be shared e334596 namespace: Share pid namespace of containers 1e72fbb agent: Get cgroup mounts info from /proc/cgroups ab6c4ff namespaces: Create persistent UTS and IPC namespaces be3993e release: Kata Containers 1.0.0 75c6fc0 grpc: implement pause and resume commands 9da1fea release: Kata Containers 0.3.0 4bad43e grpc: honour CPU constraints in Kubernetes 11d5c56 grpc: log errors in async commands 7b47559 channel: Support Epoll on Arm64 a7033a7 release: update version to 0.2.0 5c3c000 signal: Backtrace on SIGUSR1 a0880aa signal: Switch to standard signal handling f8081ca main: Improve logging in signal handling loop 075ad56 main: Rename signal functions for clarity 899bc6d main: Log errors on failure 6689db0 agent: Fix typo Signed-off-by: Archana Shinde <archana.m.shinde@intel.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 both OCI-compatible and CRI-O-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.