abaa45068f
- versions: bump firecracker version - clh: use http client - rootless: Disable vhost-net for rootless - compatoci: Add a SetLogger call - virtiofs: stop sandbox when virtiofsd quits - vc: Remove device when AddDevice encounters error - kernel: update to 4.19.83 - Cloud Hypervisor: driver update number 2 - vc: Use map to represent ignoredMounts - Fc comment - vc: Check return value from os.MkdirAll in virtiofsdArgs - vc: Drop Sandbox#Pause and Sandbox#Resume - vc: Use map built-in accessor to find container in Sandbox#GetContainer - Makefile: fix suspicious line - k8s: fix wrong number cpus after killing a container - vc: Utilize map for newMounts to speed up replaceOCIMountSource - vc: Sandbox#getAndSetSandboxBlockIndex shouldn't alter BlockIndex in case of error - virtcontainers: rename GetOCISpec to GetPatchedOCISpec - tracing: Unbreak tracing test - fc.go: Set firecracker log level to debug if hypervisor.enable_debug … - virtcontainers: honour ContainerConfig struct comment and don't save OCI spec - virtcontainers: improve algorithm to find containers - Merge #3 of kata-containers/runtime - FC: extract error info from firecracker built-in log and metrics scheme - gitignore: include cloud hypervisor configuration toml - Respect containerd's debug config - Clh driver: removed hard-coded vsock contextid (cid) - vc: Persist file handle may leak in FS#ToDisk - vc: Clean up directories in case MkdirAll fails - vc: Restore sandbox state when there is error starting containers - vc: Persist file handle may leak in FS#FromDisk - sync fork after merge clh driver #1 |
||
|---|---|---|
| .ci | ||
| .github | ||
| arch | ||
| cli | ||
| containerd-shim-v2 | ||
| data | ||
| hack | ||
| netmon | ||
| pkg | ||
| protocols/cache | ||
| vendor | ||
| virtcontainers | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| CODE_OF_CONDUCT.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| golang.mk | ||
| Gopkg.lock | ||
| Gopkg.toml | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| VERSION | ||
| versions.yaml | ||
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
- Download and install
- Quick start for developers
- Architecture overview
- Configuration
- Logging
- Debugging
- Limitations
- Community
- Further information
- Additional packages
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 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.
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:
- Intel VT-x technology.
- ARM Hyp mode (virtualization extension).
- IBM Power Systems.
- IBM Z mainframes.
Hardware requirements
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
Note:
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).
Download and install
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.
Additional packages
For details of the other packages contained in this repository, see the package documentation.