- runtime: Use static_sandbox_resource_mgmt=true for TEEs - update tokio dependency - resource-control: fix setting CPU affinities on Linux - runtime: use enable_vcpus_pinning from toml - gha: k8s: Make the tests more reliable - gha: Enable SEV-SNP tests on main - gha: tdx: Use the k3s overlay for kata-cleanup - runtime: Port sev package to main - gpu: Rename the last bits from `gpu` to `nvidia-gpu` - deploy: fix shell script error - ppc64le: switch virtiofsd from C to rust version - osbuilder: Fix indentation in rootfs.sh - virtcontainers/qemu_test.go: Improve coverage - agent: Add context to errors that may occur when AgentConfig file is … - virtcontainers/pkg/compatoci/: Improved coverage for for Kata 2.0 - kata-manager: Fix '-o' syntax and logic error - kata-ctl: Add the option to install kata-ctl to a user specified directory - runtime-rs: fix building instructions to use correct required Rust ve… - Dragonball: use LinuxBootConfigurator::write_bootparams - kata-deploy: Add http_proxy as part of the docker build - kata-deploy: Do not ship the kata tarball - kata-deploy: Build improvements - deploy: Fix arch in image tag - Revert "kata-deploy: Use readinessProbe to ensure everything is ready" - virtcontainers: Improved test coverage for fc.go from 4.6% to 18.5% - main | release: Fix multi-arch publishing is not supported - cache: More fixes to nvidia-gpu kernels caching - runtime: remove overriding ARCH value by default for ppc64le - gha: Fix Body Line Length action flagging empty body commit messages - gha: Fix snap creation workflow - cache: Fix nvidia-gpu version - cache: Update the KERNEL_FLAVOUR list to include nvidia-gpu - packaging: Add SEV-SNP artifacts to main - docs: Mark snap installation method as unmaintained - packaging: Add sev artifacts to main - kata-ctl: add generic kvm check & unit test - Log-parser-rs - warning_fix: fix warnings when build with cargo-1.68.0 - cross-compile: Include documentation and configuration for cross-compile - runtime: Fix virtiofs fd leak - gpu: cold plug VFIO devices - pkg/signals: Improved test coverage 60% to 100% - virtcontainers/persist: Improved test coverage 65% to 87.5% - virtcontainers/clh_test.go: improve unit test coverage - virtcontainers/factory: Improved test coverage - gha: Also run k8s tests on qemu-snp - gha: sev: fix for kata-deploy error - gha: Also run k8s tests on qemu-sev - Implement the "kata-ctl env" command - runtime-rs: support keep_abnormal in toml config - gpu: Build and Ship an GPU enabled Kernel - kata-ctl: checks for kvm, kvm_intel modules loaded - osbuilder: Fix D-Bus enabling in the dracut case - snap: fix docker start fail issue - kata-manager: Fix containerd download - agent: Fix ut issue caused by fd double closed - Bump ttrpc to 0.7.2 and protobuf to 3.2.0 - gpu: Add GPU enabled confguration and runtime - gpu: Do not pass-through PCI (Host) Bridges - cache-components: Fix caching of TDVF and QEMU for TDX - gha: tdx: Ensure kata-deploy is removed after the tests run - versions: Upgrade to Cloud Hypervisor v31.0 - osbuilder: Enable dbus in the dracut case - runtime: Don't create socket file in /run/kata - nydus_rootfs/prefetch_files: add prefetch_files for RAFS - runtime-rs/virtio-fs: add support extra handler for cache mode. - runtime-rs: enable nerdctl to setup cni plugin - tdx: Add artefacts from the latest TDX tools release into main - runtime: support non-root for clh - gha: ci-on-push: Run k8s tests with dragonball - rustjail: Use CPUWeight with systemd and CgroupsV2 - gha: k8s-on-aks: {create,delete} AKS must be a coded-in step - docs: update the rust version from version.yaml - gha: k8s-on-aks: Set {create,delete}_aks as steps - gha: k8s-on-aks: Fix cluster name - gha: Also run k8s tests on AKS with dragonball - gha: Only push images to registry after merging a PR - gha: aks: Use D4s_v5 instance - tools: Avoid building the kernel twice - rustjail: Fix panic when cgroup manager fails - runtime: add filter metrics with specific names - gha: Use ghcr.io for the k8s CI - GHA |Switch "kubernetes tests" from jenkins to GitHub actions - docs: Update CNM url in networking document - kata-ctl: add function to get platform protection. |
||
---|---|---|
.github | ||
ci | ||
docs | ||
snap | ||
src | ||
tests | ||
tools | ||
utils | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
CODEOWNERS | ||
CONTRIBUTING.md | ||
deny.toml | ||
Glossary.md | ||
LICENSE | ||
Makefile | ||
README.md | ||
utils.mk | ||
VERSION | ||
versions.yaml |

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.
License
The code is licensed under the Apache 2.0 license. See the license file for further details.
Platform support
Kata Containers currently runs on 64-bit systems supporting the following technologies:
Architecture | Virtualization technology |
---|---|
x86_64 , amd64 |
Intel VT-x, AMD SVM |
aarch64 ("arm64 ") |
ARM Hyp |
ppc64le |
IBM Power |
s390x |
IBM Z & LinuxONE SIE |
Hardware requirements
The Kata Containers runtime provides a command to determine if your host system is capable of running and creating a Kata Container:
$ kata-runtime check
Notes:
This command runs a number of checks including connecting to the network to determine if a newer release of Kata Containers is available on GitHub. If you do not wish this to check to run, add the
--no-network-checks
option.By default, only a brief success / failure message is printed. If more details are needed, the
--verbose
flag can be used to display the list of all the checks performed.If the command is run as the
root
user additional checks are run (including checking if another incompatible hypervisor is running). When running asroot
, network checks are automatically disabled.
Getting started
See the installation documentation.
Documentation
See the official documentation including:
Configuration
Kata Containers uses a single configuration file which contains a number of sections for various parts of the Kata Containers system including the runtime, the agent and the hypervisor.
Hypervisors
See the hypervisors document and the Hypervisor specific configuration details.
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
See the developer guide.
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. |
runtime-rs | core | The Rust version runtime. |
agent | core | Management process running inside the virtual machine / POD that sets up the container environment. |
dragonball |
core | An optional built-in VMM brings out-of-the-box Kata Containers experience with optimizations on container workloads |
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. |
kata-ctl |
utility | Tool that provides advanced commands and debug facilities. |
log-parser-rs |
utility | Tool that aid in analyzing logs from the kata runtime. |
trace-forwarder |
utility | Agent tracing helper. |
runk |
utility | Standard OCI container runtime based on the agent. |
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
See the glossary of terms related to Kata Containers.