mirror of
https://github.com/kata-containers/kata-containers.git
synced 2026-07-26 15:55:24 +00:00
bc5ae6437d
Document operational requirements for using the EROFS snapshotter with Kata Containers. Call out that EROFS layer conversion can happen during CreateContainer, not only during image pull, so kubelet runtimeRequestTimeout may need to be increased for large images. Also document the kernel modules needed for EROFS and dm-verity, the erofs-utils version required by the configured mkfs options, and the distinction between host-side fs-verity and guest-visible dm-verity. Signed-off-by: Manuel Huber <manuelh@nvidia.com> Assisted-by: OpenAI <support@openai.com>
Documentation
The Kata Containers documentation repository hosts overall system documentation, with information common to multiple components.
For details of the other Kata Containers repositories, see the repository summary.
Getting Started
- Quick Start Guide: Understand the basics and run your first Kata workload in minutes
- Installation guides: Install and run Kata Containers with Docker or Kubernetes
Tracing
See the tracing documentation.
More User Guides
- Upgrading: how to upgrade from Clear Containers and runV to Kata Containers and how to upgrade an existing Kata Containers system to the latest version.
- Limitations: differences and limitations compared with the default Docker runtime,
runc.
How-to guides
See the how-to documentation.
Kata Use-Cases
- GPU Passthrough with Kata
- SR-IOV with Kata
- Intel QAT with Kata
- SPDK vhost-user with Kata
- Intel SGX with Kata
- IBM Crypto Express passthrough with Confidential Containers
Developer Guide
Documents that help to understand and contribute to Kata Containers.
Design and Implementations
- Kata Containers Architecture: Architectural overview of Kata Containers
- Kata Containers CI: Kata Containers CI document
- Kata Containers E2E Flow: The entire end-to-end flow of Kata Containers
- Kata Containers design: More Kata Containers design documents
- Kata Containers threat model: Kata Containers threat model
How to Contribute
- Developer Guide: Setup the Kata Containers developing environments
- How to contribute to Kata Containers
- Code of Conduct
- How to submit a blog post
Help Writing a Code PR
Help Writing Unit Tests
Help Improving the Documents
Code Licensing
- Licensing: About the licensing strategy of Kata Containers.
The Release Process
Presentations
Website Changes
If you have a suggestion for how we can improve the website, please raise an issue (or a PR) on the repository that holds the source for the website.