99c6726cf6
- stable-2.4 | Second round of backports for the 2.4.1 release - stable-2.4 | First round of backports for the 2.4.1 release - stable-2.4 | versions: Upgrade to Cloud Hypervisor v23.0 - stable-2.4 | runtime: Base64 encode the direct volume mountInfo path - stable-2.4 | agent: Avoid agent panic when reading empty stats8e076c87release: Adapt kata-deploy for 2.4.1b50b091cagent: watchers: ensure uid/gid is preserved on copy/mkdir03bc89abclh: Rely on Cloud Hypervisor for generating the device ID6b2c641ftools: fix typo in clh directory name81e10fe3packaging: Fix clh build from source fall-back8b21c5f7agent: modify the type of swappiness to u643f5c6e71runtime: Allock mockfs storage to be placed in any directory0bd1abacruntime: Let MockFSInit create a mock fs driver at any path3e74243fruntime: Move mockfs control global into mockfs.goaed4fe6aruntime: Export StoragePathSuffixe1c4f57cruntime: Don't abuse MockStorageRootPath() for factory testsc49084f3runtime: Make bind mount tests better clean up after themselves4e350f7druntime: Clean up mock hook logs in tests415420f6runtime: Make SetupOCIConfigFile clean up after itself688b9abdruntime: Don't use fixed /tmp/mountPoint pathdc1288dekata-monitor: add a README file78edf827kata-monitor: add some links when generating pages for browserseff74fabagent: fsGroup support for direct-assigned volume01cd5809proto: fsGroup support for direct-assigned volume97ad1d55runtime: fsGroup support for direct-assigned volumeb62cced7runtime: no need to write virtiofsd error to log8242cfd2kata-monitor: update the hrefs in the debug/pprof index pagea37d4e53agent: best-effort removing mount pointd1197ee8tools/packaging: Fix error path in 'kata-deploy-binaries.sh -s'c9c77511tools/packaging: Fix usage of kata-deploy-binaries.sh1e622316tools/packaging/kata-deploy: Copy install_yq.sh in a dedicated script8fa64e01packaging: Eliminate TTY_OPT and NO_TTY variables in kata-deploy8f67f9e3tools/packaging/kata-deploy/local-build: Add build to gitignore3049b776versions: Bump firecracker to v0.23.4aedfef29runtime/virtcontainers: Pass the hugepages resources to agentc9e1f727agent: Verify that we allocated as many hugepages as we needba858e8cagent: Don't attempt to create directories for hugepage configurationbc32eff7virtcontainers: clh: Re-generate the client code984ef538versions: Upgrade to Cloud Hypervisor v23.0adf6493bruntime: Base64 encode the direct volume mountInfo path6b417540agent: Avoid agent panic when reading empty stats Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
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-checksoption.By default, only a brief success / failure message is printed. If more details are needed, the
--verboseflag can be used to display the list of all the checks performed.If the command is run as the
rootuser 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. |
| 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
See the glossary of terms related to Kata Containers.