Go to file
katacontainersbot 677c7083b5 release: Kata Containers 1.7.0-rc1
- firecracker: Setup rootfs to be RO
- firecracker: Upgrade firecracker to 0.16.0
- Add virtio-fs support (alternative to virtio-9p)
- virtcontainers: fix invalid CPU topology
- Firecracker: Fix kernel command line parameters
- Firecracker: update to version v0.15.2
- devices: Skip floppy drives while passing devices to guest
- Add test skip utils
- firecracker: Add support for v0.15.x
- firecracker: Add support for default VM configuration
- build: Fix virtcontainers static check make target
- virtcontainers: Use shim to print the agent logs if there is no proxy
- shim v2: fix set status when container exit
- cli: do not fail on list when some containers bust
- versions: Bump NEMU version to latest release
- Revert "vc: change container rootfs to be a mount"
- Add agent trace support
- network: pass network interface RawFlags to agent
- Fix markdown
- Fix parallel make
- Update golang to 1.12.3
- vc: change container rootfs to be a mount
- persist: baseline persist data format
- factory: Add new factory option template_path
- vc: remove BlockIndex from container state
- factory: Check if vm templateing is on before vm templateing initialize

5e9cb48 firecracker: Setup rootfs to be RO
93e6ad1 firecracker: Upgrade firecracker to 0.16.0
0a69eb8 kata-env: add SharedFS option to output
75f7586 virtiofs: Add cache option
6767c1a virtiofs: Add cache size option
82d1a9d kata_agent: use virtio-fs shared dir in CreateSandbox
9480978 qemu: add vhost-user-fs-pci device instead of 9p
c155775 Firecracker: Fix kernel command line parameters
b496f3f firecracker: Add support for default VM configuration
f75b7fe firecracker: Add support for v0.15.x
23f7cfa tests: Update test code to use test constraints
8e144e0 pkg: Add test constraints feature
d690dff config: add virtio_fs_daemon string
9e87fa2 config: add shared_fs option
0217077 vendor: update govmm
9f87e78 build: Fix virtcontainers static check make target
fa5de87 virtcontainers: fix invalid CPU topology
b7f51be cli: do not fail on list when some containers bust
854cc86 shimv2: fix set status when container exit
582f20f virtcontainers: Use shim to print the agent logs if there is no proxy
da0ae03 versions: Bump NEMU version to latest release
ed64240 agent: Support Kata agent tracing
b573d9b vendor: Update for agent tracing and fix issues
b309dc5 agent: Provide explicit config options for the agent
87d9171 utils: Remove code duplication
ed248ce shim: Removed unused type and correct error message
97beb2b errors: Create a new standard error for invalid config
e803a7f agent: Return an error, not just an interface
bc9b9e2 vc: Revert "vc: change container rootfs to be a mount"
dd0808a network: pass network interface RawFlags to agent
196661b vc: change container rootfs to be a mount
989b373 docs: fix lisence header to 2019
3262da0 bugfix: fix potential panic
9bd4e50 store: address comments
0f52c8b test: add unit test for new FS storage driver
02f2122 test: fix unit test
e40dcb9 storage: set new storage driver as "experimental"
504c706 storage: address comments
6e4149d persist: save and restore state from persist.json
039ed4e persist: persist device data
b42fde6 persist: demo code for persist api
e14ffb4 persist: baseline persist data format
0549a70 factory: Add new factory option template_path
f6b8387 devices: Skip floppy drives while passing devices to guest
82d105f doc: Fix markdown
1a0a4bc doc: Fix broken internal link
92edeb1 doc: Simplify note
2037286 vc: remove BlockIndex from container state
76a5076 template: Add check if vm template is on before vm template initialize
8097c54 Firecracker: update to version v0.15.2
53ebe51 build: fix race between 'clean' and generated files
7949cd6 build: turn COMMIT into a file dependency
0f7bb25 build: extract config-generated.go.in from Makefile
1eb5d6c build: use MAKEFILE_LIST for a more complete Makefile dependency
bbf9253 build: add VERSION dependency to netmon target
b20fd9d build: remove duplicated COLLECT_SCRIPT from clean
e26f342 build: Update golang to 1.12.3

Signed-off-by: katacontainersbot <katacontainersbot@gmail.com>
2019-05-09 00:24:31 +00:00
.ci Merge pull request #1414 from teawater/yq_version 2019-04-08 09:47:03 +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 Merge pull request #1016 from stefanha/virtio-fs-core 2019-05-07 11:19:58 -07:00
containerd-shim-v2 tests: Update test code to use test constraints 2019-05-02 15:42:35 +01:00
data Merge pull request #1405 from jodh-intel/update-collect-script-for-dax-nvdimm-images 2019-03-22 09:54:03 +00:00
hack VMCache: the core and the client 2019-03-08 10:05:59 +08:00
netmon tests: Update test code to use test constraints 2019-05-02 15:42:35 +01:00
pkg Merge pull request #1016 from stefanha/virtio-fs-core 2019-05-07 11:19:58 -07:00
protocols/cache factory: Make factory status can show status of VMCache server 2019-04-10 11:03:14 +08:00
vendor vendor: update govmm 2019-05-01 09:59:53 -04:00
virtcontainers firecracker: Setup rootfs to be RO 2019-05-07 15:03:28 -07:00
.gitignore build: turn COMMIT into a file dependency 2019-04-17 11:59:10 +01:00
.gitmodules submodules: Remove cc-runtime and runv 2018-03-21 12:10:15 -07:00
.travis.yml travis: use xenial 2019-04-08 13:58:17 -05: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: update govmm 2019-05-01 09:59:53 -04:00
Gopkg.toml vendor: update govmm 2019-05-01 09:59:53 -04:00
LICENSE Initial commit 2017-11-21 17:03:45 +08:00
Makefile virtiofs: Add cache option 2019-05-05 11:32:34 -06:00
README.md doc: Fix broken internal link 2019-04-18 15:50:26 +01:00
VERSION release: Kata Containers 1.7.0-rc1 2019-05-09 00:24:31 +00:00
versions.yaml firecracker: Upgrade firecracker to 0.16.0 2019-05-07 14:44:02 -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).

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.