mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-01-09 01:14:20 +01:00
1d1782f051
New documentation is great, but finding it should be easy. Require that all new docs are referenced by an existing document in the repo. Fixes #475. Signed-off-by: James O. D. Hunt <james.o.hunt@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. -
HOWTO: Sysctls with Kata Containers
-
HOWTO: VM Templating and VM Cache
Kata Use-Cases
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.