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

Tracing

See the tracing documentation.

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.

How-to guides

See the how-to documentation.

Kata Use-Cases

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

Help Writing a Code PR

• Code PR advice.

Help Writing Unit Tests

• Unit Test Advice
• Unit testing presentation

Help Improving the Documents

• Documentation Requirements

Code Licensing

• Licensing: About the licensing strategy of Kata Containers.

The Release Process

• Release strategy
• Release Process

Presentations

• Presentations

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.