3cbd21c0b9
- qemu: refactor maximum vcpus supported in aarch64 - Add ref counter for devices - versions: update kernel version 4.14.67 - network: always assign sandbox networkNS - virtcontainers: wait until process exited before RemoveContainer - virtcontainers: revert apply devices constraints - vendor: update govmm to be compatible with qemu 2.8 - network: Remove CNI docs - network: Move OCI hooks and network namespace creation out of virtcontainers - virtcontainers: delete out-of-date TODO - build: fix breaking 1.8.3 build - virtcontainers: apply devices constraints - kata-env: Fix amd64 VM container capable check - travis: Add variable needed to run static checks - virtcontainers: Apply memory constraints - builtin-proxy: print guest console output to logger - vendor: Update kata agent for gRPC tracing - Pass qemu --share-rw option for hotplugging disks - virtcontainers: storage: Rework resource storage - qemu/arm64: Detect host GIC version to configure guest GIC - virtcontainers: kata_agent: Move out a generic function - virtcontainers: qemu: Don't shutdown QMP from hotplug - Add virtcontainers trace support - vfio: Add configuration to support VFIO hotplug on root bus - vendor: update kata agent - network: fix vhost-user net creation - vc: Remove unused variable NumInterfaces - cli: kata-env: show if vsocks are supported - api: add sandbox hotplug network - CI: bump the CI travis's go to 1.10 - cli: kata-env: add runtime path to output - Remove unused cni code - devices: add interface "sandbox.AddDevice" - versions: Update the commit for qemu-lite - tracing: Add initial opentracing support - cli: Make message of using initrd OR rootfs clearer - vendor: Update dep lock file for new format - network: Error out when host-networking is requested - virtcontainers: ppc64le: Add nvdimm to defaultQemuMachineOption - virtcontainers: qemu: x86: Support "virt" machine type |
||
|---|---|---|
| .ci | ||
| .github | ||
| arch | ||
| cli | ||
| data | ||
| vendor | ||
| virtcontainers | ||
| .gitignore | ||
| .gitmodules | ||
| .pullapprove.yml | ||
| .travis.yml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| 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
- 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.