Go to file
Peng Tao 70d8b167e7 release: Kata Containers 1.6.0-rc2
- volumes: Handle k8s empty-dirs of "default" medium type
- versions: kernel: update to 4.19.28
- qemu: throw error when fail to get addr from bridges
- vc:qemu: Fix id calculation of memory hotplug
- s390x: 2 small test fixes
- arm64: support NVDIMM
- virtcontainers: move resource calculation to its own function
- versions: update nemu to latest release
- Add crio and containerd details to collect script
- pkg: reduce memory footprint
- Fix rootfs mount assumptions
- s390x: fix golint complain
- Network: remove Physical field in VethEndpoint
- test: add tests for sandbox creation rollback and cleanup
- VMCache: the new function that creates VMs as caches before using it
- unit test: Fix local test
- Add upstream version url regexp's to allow upto date checks
- virtcontainer: watch the qemu's console when proxy's debug enabled
- unit-test: fix undefined struct field SupportVSocks on arm64
- Makefile: Fix aarch64 fail in No GO command or GOPATH not set mode
- tracing: Fix tracing
- config: check the builtIn first when updating shim/proxy/agent
- qemu: fix devID value error
- Makefile: Change "GOPATH not set" to "No GO command"

8e2a5ea tests: Fix units tests to check empty-dir volumes backed by host-dir
47a6023 volumes: Handle k8s empty-dirs of "default" medium type
4e81522 vc:qemu: Fix id calculation of memory hotplug
502fdab test: add test for addDeviceToBridge
0061e16 virtcontainers: move resource calculation to its own function
7504d9e unit-test: add TestSandboxUpdateResources
f009a53 versions: update nemu to latest release
f2a506a scripts: Add containerd details to collect script
7266d31 scripts: Log crio config file in collect script
30f9776 scripts: Create separate section for crio in collect script
ae08ea3 scripts: Add helper function to collect script
ae4d8b4 versions: kernel: update to 4.19.28
c7ace4b qemu: throw error when fail to get addr from bridges
2456ac5 pkg: reduce memory footprint
df9a401 Network: remove Physical field in VethEndpoint
76d9db3 vendor: Add github.com/gogo/protobuf
45fe870 runtime: Add unit tests
0f8b2ad VMCache: Update factory to run as a VMCache server
90704c8 VMCache: the core and the client
d8bcddb qemu-arm64: add unit test for func appendImage on aarch64
986e4dc qemu-arm64: Support nvdimm on arm64
8ba27e1 s390x: remove pmu from test
6242af3 s390x: fix TestQemuS390xMemoryTopology
613edd5 s390x: fix golint complain
27a92f9 runtime: Fix rootfs mount assumptions
c964a26 virtcontainers: makefile fix .ci path
fcee080 unit-test: Fix local test
c4957dd virtcontainer: watch the qemu's console when proxy's debug enabled
1e30673 test: add tests for sandbox creation rollback and cleanup
bdb34e7 Makefile: Fix aarch64 fail in No GO command or GOPATH not set mode
c759cf5 tracing: Fix tracing
31232b4 config: check the builtIn first when updating shim/proxy/agent
03dd780 qemu: fix devID value error
a1ddf53 Makefile: Change "GOPATH not set" to "No GO command or GOPATH not set"
35672b5 unit-test: fix undefined struct field SupportVSocks on arm64
975157d versions.yaml: add uscan annotations

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2019-03-18 22:13:32 +08:00
.ci make: notify user if yq is going to be installed 2018-11-16 18:56:46 +01:00
.github github: Add issue template 2018-03-22 13:56:43 +00:00
arch build: Add support for building firecracker hypervisor 2019-01-14 16:55:01 +00:00
cli VMCache: Update factory to run as a VMCache server 2019-03-08 10:06:38 +08:00
containerd-shim-v2 shimv2: Send task events to containerd/cri 2019-02-11 11:49:10 +08:00
data scripts: Add containerd details to collect script 2019-03-11 14:20:39 +00:00
hack VMCache: the core and the client 2019-03-08 10:05:59 +08:00
netmon virtcontainers: Alias for pkg/types 2019-01-08 14:24:06 +01:00
pkg tests: Fix units tests to check empty-dir volumes backed by host-dir 2019-03-15 11:02:17 -07:00
protocols/cache VMCache: the core and the client 2019-03-08 10:05:59 +08:00
vendor vendor: Add missing comma to Gopkg.lock and dep ensure 2019-02-16 22:55:39 +08:00
virtcontainers volumes: Handle k8s empty-dirs of "default" medium type 2019-03-15 09:44:10 -07:00
.gitignore build: Add support for building firecracker hypervisor 2019-01-14 16:55:01 +00:00
.gitmodules submodules: Remove cc-runtime and runv 2018-03-21 12:10:15 -07:00
.travis.yml CI: travis: call yq installer 2018-10-30 15:44:40 +00:00
CODE_OF_CONDUCT.md docs: Add missing standard docs 2018-02-09 14:45:14 +00:00
CODEOWNERS ci: Add a CODEOWNERS file for github ack checks 2019-01-30 11:23:25 +00:00
CONTRIBUTING.md docs: Add missing standard docs 2018-02-09 14:45:14 +00:00
golang.mk Makefile: Change "GOPATH not set" to "No GO command or GOPATH not set" 2019-03-01 22:47:37 +08:00
Gopkg.lock vendor: Add github.com/gogo/protobuf 2019-03-08 20:59:00 +08:00
Gopkg.toml vendor: Add github.com/gogo/protobuf 2019-03-08 20:59:00 +08:00
LICENSE Initial commit 2017-11-21 17:03:45 +08:00
Makefile Makefile: Fix aarch64 fail in No GO command or GOPATH not set mode 2019-03-05 09:48:03 +08:00
README.md doc: Fix invalid URLs 2019-02-28 01:41:18 -06:00
VERSION release: Kata Containers 1.6.0-rc2 2019-03-18 22:13:32 +08:00
versions.yaml Merge pull request #1289 from grahamwhaley/20190227_v4.19.26 2019-03-13 15:21:31 -07:00

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.