Skip to content
Kata Containers runtime
Branch: master
Clone or download
Latest commit b218229 Apr 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci Merge pull request #1414 from teawater/yq_version Apr 8, 2019
.github github: Add issue template Mar 22, 2018
arch build: Add support for building firecracker hypervisor Jan 14, 2019
cli factory: Add new factory option template_path Apr 19, 2019
containerd-shim-v2 shimv2: convert vc errors to grpc errors Apr 12, 2019
data Merge pull request #1405 from jodh-intel/update-collect-script-for-da… Mar 22, 2019
hack VMCache: the core and the client Mar 8, 2019
netmon netmon: Fix bug in how routes are converted Apr 12, 2019
pkg factory: Add new factory option template_path Apr 19, 2019
protocols/cache factory: Make factory status can show status of VMCache server Apr 10, 2019
vendor Merge pull request #1498 from devimc/topic/vendor/govmm Apr 10, 2019
virtcontainers Merge pull request #883 from WeiZhang555/rfc-persist-data-standard-wip Apr 20, 2019
.gitignore build: Add support for building firecracker hypervisor Jan 14, 2019
.gitmodules submodules: Remove cc-runtime and runv Mar 21, 2018
.travis.yml travis: use xenial Apr 8, 2019
CODEOWNERS ci: Add a CODEOWNERS file for github ack checks Jan 30, 2019
CODE_OF_CONDUCT.md docs: Add missing standard docs Feb 9, 2018
CONTRIBUTING.md docs: Add missing standard docs Feb 9, 2018
Gopkg.lock Merge pull request #1498 from devimc/topic/vendor/govmm Apr 10, 2019
Gopkg.toml Merge pull request #1498 from devimc/topic/vendor/govmm Apr 10, 2019
LICENSE Initial commit Nov 21, 2017
Makefile network: Make tcfilter model as default Apr 15, 2019
README.md cri-o: Update repository URL Apr 9, 2019
VERSION release: Kata Containers 1.7.0-alpha1 Apr 17, 2019
golang.mk Makefile: Change "GOPATH not set" to "No GO command or GOPATH not set" Mar 1, 2019
versions.yaml

README.md

Build Status Build Status Go Report Card GoDoc

Runtime

This repository contains the runtime for the Kata Containers project.

For details of the other Kata Containers repositories, see the repository summary.

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:

  • 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 root user, further checks will be performed (e.g. it will check if another incompatible hypervisor is running):

$ sudo kata-runtime kata-check

Download and install

Get it from the Snap Store

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

See the community repository.

Contact

See how to reach the community.

Further information

See the project table of contents and the documentation repository.

You can’t perform that action at this time.