mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-09-09 04:39:17 +00:00
541ec4c08a
The existing document hasn't been updated since ~1.4. Updated to remove references to qemu-lite, added details on Firecracker. We still need details on ACRN added here as well. Fixes: #570 Signed-off-by: Eric Ernst <eric.ernst@intel.com>
Documentation
- Getting Started
- More User Guides
- Kata Use-Cases
- Developer Guide
- Help Improving the Documents
- Website Changes
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
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 design: More Kata Containers design documents
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.