README.md

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: Kata Containers with k8s and cri-containerd

• HOWTO: OpenStack Zun with Kata Containers

• HOWTO: Kata Containers with Firecracker

• HOWTO: Sysctls with Kata Containers

• HOWTO: VM Templating and VM Cache

Kata Use-Cases

• VPP with Kata
• SR-IOV with Kata
• GPU Passthrough 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

• Release strategy
• Release Checklist

Help Improving the Documents

• Documentation Requirements