mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-10-21 20:08:54 +00:00
1fe080fd24
This was added in the 1.x repo and is missing in the 2.x repo. Copying over the document from 1.x. This is a starting point and focuses on the devices / interfaces with the virtual machine, and ultimately to the container itself. We then discuss how these devices/interfaces vary by VMM/hypervisor. The threat model drawing is created via gdocs, located here: https://docs.google.com/drawings/d/1dPi9DG9bcCUXlayxrR2OUa1miEZXewtW7YCt4r_VDmA/edit?usp=sharing For Kata 2.x, the block named as `kata-runtime` has been changed to `kata-shim`. Fixes: #2340 Signed-off-by: Eric Ernst <eric.ernst@intel.com> Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2.7 KiB
2.7 KiB
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
- Installation guides: Install and run Kata Containers with Docker or Kubernetes
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.
Howto guides
See the howto documentation.
Kata Use-Cases
- GPU Passthrough with Kata
- OpenStack Zun with Kata Containers
- SR-IOV with Kata
- Intel QAT with Kata
- VPP with Kata
- SPDK vhost-user with Kata
- Intel SGX with Kata
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 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
Code Licensing
- Licensing: About the licensing strategy of Kata Containers.
The Release Process
Help Improving the Documents
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.