mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-01-21 15:24:29 +01:00
87d9ebc14cc74de02e302655e06d7847a4c1d048
We have some initial Firecracker/Kata documentaiton, but for now it lives in the wiki. Link off to it from the top level docs README to make it more obvious and easier to find. Fixes: #367 Signed-off-by: Graham Whaley <graham.whaley@intel.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
- 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.
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
Description
Languages
Rust
57%
Go
27%
Shell
8%
RPC
5.9%
Makefile
1%
Other
1.1%