mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-28 11:44:38 +00:00

History

James O. D. Hunt d41c375c4f docs: Add more advice to the UT advice doc Add information to the unit test advice document on test strategies and the test environment. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>		2021-11-25 14:44:40 +00:00
..
design	docs: update kata 2.0 metrics documentation	2021-11-11 09:33:01 +01:00
how-to	cri-o: Update deployment documentation	2021-11-15 18:30:40 +01:00
install	docs: Add kata-deploy as part of the install docs	2021-11-23 13:57:22 +01:00
threat-model	threat-model: Add missing threat-model document	2021-09-21 20:20:39 +05:30
use-cases	docs: update using-SPDK-vhostuser-and-kata.md	2021-11-18 09:41:12 +08:00
Developer-Guide.md	docs: Add explanation about seccomp	2021-10-27 19:06:13 +09:00
Documentation-Requirements.md	docs: Remove table of contents	2021-07-30 10:58:22 +01:00
hypervisors.md	docs: Remove table of contents	2021-07-30 10:58:22 +01:00
Licensing-strategy.md	docs: Remove table of contents	2021-07-30 10:58:22 +01:00
Limitations.md	docs: Remove table of contents	2021-07-30 10:58:22 +01:00
Makefile	docs: merge documentation repository	2020-06-23 21:27:23 -07:00
README.md	docs: Move unit test advice doc from tests repo	2021-11-25 14:44:40 +00:00
Release-Process.md	workflows: Remove non-used main.yaml	2021-11-12 18:17:11 +01:00
Stable-Branch-Strategy.md	docs: Don't use Docker as an example of a container manager	2021-05-21 09:52:39 +02:00
tracing.md	docs: Write tracing documentation	2021-10-19 17:33:01 +01:00
Unit-Test-Advice.md	docs: Add more advice to the UT advice doc	2021-11-25 14:44:40 +00:00
Upgrading.md	docs: Remove table of contents	2021-07-30 10:58:22 +01:00

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.

Howto guides

See the howto documentation.

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 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 Unit Tests

Unit Test Advice

Help Improving the Documents

Documentation Requirements

Code Licensing

Licensing: About the licensing strategy of Kata Containers.

The Release Process

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.