Go to file
David Gibson 34273da98f runtime/device: Allow VFIO devices to be presented to guest as VFIO devices
On a conventional (e.g. runc) container, passing in a VFIO group device,
/dev/vfio/NN, will result in the same VFIO group device being available
within the container.

With Kata, however, the VFIO device will be bound to the guest kernel's
driver (if it has one), possibly appearing as some other device (or a
network interface) within the guest.

This add a new `vfio_mode` option to alter this.  If set to "vfio" it will
instruct the agent to remap VFIO devices to the VFIO driver within the
guest as well, meaning they will appear as VFIO devices within the
container.

Unlike a runc container, the VFIO devices will have different names to the
host, since the names correspond to the IOMMU groups of the guest and those
can't be remapped with namespaces.

For now we keep 'guest-kernel' as the value in the default configuration
files, to maintain current Kata behaviour.  In future we should change this
to 'vfio' as the default.  That will make Kata's default behaviour more
closely resemble OCI specified behaviour.

fixes #693

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2021-10-25 12:29:31 +11:00
.github/workflows GitHubActions: fix invalid format of require-pr-porting-labels.yaml 2021-10-07 10:23:44 +08:00
ci runtime: delete useless src/runtime/cli/exit.go 2021-10-20 11:42:37 +08:00
docs Merge pull request #2810 from mythi/sgx-doc 2021-10-21 12:28:29 +01:00
pkg/logging logging: Use guard to make threaded logging safe 2021-03-29 14:32:11 +01:00
snap snap: make curl commands consistent 2021-10-19 08:36:06 -05:00
src runtime/device: Allow VFIO devices to be presented to guest as VFIO devices 2021-10-25 12:29:31 +11:00
tools Merge pull request #2863 from wainersm/osbuilder_dracut_rust 2021-10-19 11:48:39 +01:00
utils utils: kata-manager: Update kata-manager.sh for new containerd config 2021-09-05 17:15:15 +08:00
.gitignore gitignore: Ignore *~ editor backup files 2021-02-19 09:54:53 +11:00
CODE_OF_CONDUCT.md docs: Add contributing and code of conduct docs 2018-02-06 10:41:09 +00:00
CODEOWNERS docs: fix static check errors 2020-09-28 11:01:03 +08:00
CONTRIBUTING.md docs: Add contributing and code of conduct docs 2018-02-06 10:41:09 +00:00
Glossary.md docs: added a glossary to support SEO tactics 2021-07-20 11:22:58 +02:00
LICENSE Initial commit 2017-12-06 23:01:13 -06:00
Makefile makefile: Include kata-deploy targets 2021-09-09 14:32:08 +00:00
README.md docs: Removed mention of 1.x 2021-07-30 10:58:22 +01:00
utils.mk build: Add make vendor 2021-07-14 13:59:41 +02:00
VERSION release: Kata Containers 2.3.0-alpha2 2021-10-14 06:56:30 +02:00
versions.yaml versions: Upgrade to Cloud Hypervisor v19.0 2021-10-20 15:39:53 -07:00

Kata Containers

Welcome to Kata Containers!

This repository is the home of the Kata Containers code for the 2.0 and newer releases.

If you want to learn about Kata Containers, visit the main Kata Containers website.

Introduction

Kata Containers is an open source project and community working to build a standard implementation of lightweight Virtual Machines (VMs) that feel and perform like containers, but provide the workload isolation and security advantages of VMs.

Getting started

See the installation documentation.

Documentation

See the official documentation (including installation guides, the developer guide, design documents and more).

Community

To learn more about the project, its community and governance, see the community repository. This is the first place to go if you wish to contribute to the project.

Getting help

See the community section for ways to contact us.

Raising issues

Please raise an issue in this repository.

Note: If you are reporting a security issue, please follow the vulnerability reporting process

Developers

Components

Main components

The table below lists the core parts of the project:

Component Type Description
runtime core Main component run by a container manager and providing a containerd shimv2 runtime implementation.
agent core Management process running inside the virtual machine / POD that sets up the container environment.
documentation documentation Documentation common to all components (such as design and install documentation).
tests tests Excludes unit tests which live with the main code.

Additional components

The table below lists the remaining parts of the project:

Component Type Description
packaging infrastructure Scripts and metadata for producing packaged binaries
(components, hypervisors, kernel and rootfs).
kernel kernel Linux kernel used by the hypervisor to boot the guest image. Patches are stored here.
osbuilder infrastructure Tool to create "mini O/S" rootfs and initrd images and kernel for the hypervisor.
agent-ctl utility Tool that provides low-level access for testing the agent.
trace-forwarder utility Agent tracing helper.
ci CI Continuous Integration configuration files and scripts.
katacontainers.io Source for the katacontainers.io site.

Packaging and releases

Kata Containers is now available natively for most distributions. However, packaging scripts and metadata are still used to generate snap and GitHub releases. See the components section for further details.

Glossary of Terms