979f064df3
Bring support for loading kernel modules shortlog: 72a50ef revert: agent: sandbox_pause should get arguments from proc ad72fe8 agent: add support for loading kernel modules 4ab32a9 vendor: dep check fixes b8b8dac s390x: add virtio-blk-ccw support cf20c9b ci: Allow travis to use go install script 5ffb2a6 agent: make NoPivotRoot config depend on `/` fs type a1c9d50 make: install depends on $(TARGET) 7c97a0a agent: delete element of sandbox.deviceWatchers with right key d0117bf release: Kata Containers 1.9.0-alpha0 4354b24 tests: Add lots of new unit tests d4a22d1 device: Allow uevent handler to be stopped 8eb2134 config: Add parseCmdlineOption test d4f205d device: Add extra checks faa6cb0 mount: Fix incorrect error return 2d95c36 mount: Add test for parseMountFlagsAndOptions 5163bab console: Add debug console test d167490 sandbox: Remove redundant check 72fc0ad mount: Improve error message c92715f tests: Add test for getMemory cd2f994 memory: Add extra check for memory file 458b4aa vendor: Move to a previous version for runtime-spec vendor 3cce728 vendor: Update the vendoring for github.com/opencontainers/runtime-spec 7ae6030 release: Kata Containers 1.8.0-rc0 32428bc vendor: update dependency opencontainers/runc cfbd8c9 agent: sandbox_pause should get arguments from proc 47476d4 agent: lock subreaper agent thread 3548e65 release: Kata Containers 1.8.0-alpha2 0ead592 docs: Fix capitalization 9b59925 mount: Virtio-blk container rootfs mount for ACRN hypervisor cf50209 release: Kata Containers 1.8.0-alpha1 0666ef0 release: Kata Containers 1.8.0-alpha0 ca2f724 grpc: add unit test for onlineResources function 06a0743 tmp: Add tmp.mount to kata-containers.target 353263d docs: Fix typos and formatting 5064045 docs: Add missing document link c66349b mount: Add a proper rollback path to addStorages() 5583acd release: Kata Containers 1.7.0 5f9df74 updateInterface: enable hot-add nic on arm64 86ca8e0 vendor: update gogo/protobuf to v1.2.1 c9343fb release: Kata Containers 1.7.0-rc1 560dc87 vendor: update vsock package version 0af7173 agent: support debug console d9aa453 proto: add network stats 3169c9b docs: Fix markdown in TRACING.md 8aa2880 release: Kata Containers 1.7.0-alpha1 2ada1d1 agent: Display trace details cb32d28 test: Fix mockContainer 3e12793 agent: Fix container creation 6e558f7 vendor: Update libcontainer vendoring 7fbd860 agent: send SIGKILL instead of SIGTERM to container init process 8847998 agent: Add support for local storage 8b34aaf make: Add build option STATIC=1 to statically link 01b1cb2 travis: Use xenial d815c97 lint: Update code to handle lint issues 828b417 ci: Update travis go version from 1.10 to 1.11 f61ca8a release: Kata Containers 1.7.0-alpha0 bdf2290 ci: travis: checkout test repo to correct branch 209aa2f agent: Fix "agent grpc server quits" show wrong error 2af3599 channel: Check for channel type in kernel cmdline options 8187461 vendor: use latest github.com/mdlayher/vsock 39696c0 vendor: Revert "vendor: Update libcontainer vendoring" 7866668 agent: Revert "agent: Fix container creation" 8f893b9 test: Revert "test: Fix mockContainer" 49e5847 systemd-target: Add chronyd.service to kata-containers.target 0bf9d1e make: Install systemd targets in systemd unit dir 85e0942 docs: Explain shutdown behaviour with tracing 99d6118 docs: Define "VM" in tracing doc 353ec2d service: Fix user initiated shutdown with static tracing Signed-off-by: Julio Montes <julio.montes@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
- 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 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).
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.