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

History

Fabiano Fidêncio 10ed3da4eb release: Rename runtime-release-notes to release-notes There's no runtime repo anymore, let's avoid making a reference to it, which may end up confusing people reading the Release-Process file. Signed-off-by: Fabiano Fidêncio <fidencio@redhat.com>		2021-02-23 17:25:40 +01:00
..
design	Merge pull request #1031 from knittl/feature/kata-option-aliases	2021-02-10 16:22:13 +01:00
how-to	docs: Update documentation with new prefixless config options	2021-02-10 07:55:18 +01:00
install	branch: change 2.0-dev to main	2021-01-22 15:49:35 +08:00
use-cases	docs: use-cases: Add Intel SGX use case	2020-10-01 08:24:29 -05:00
Developer-Guide.md	Merge pull request #1344 from liubin/fix/1329-improvements-for-console-access	2021-02-18 17:59:32 -08:00
Documentation-Requirements.md	docs: Update documentation with new prefixless config options	2021-02-10 07:55:18 +01:00
hypervisors.md	docs: Create hypervisor summary document	2020-11-16 11:52:40 +00:00
LICENSE	docs: merge documentation repository	2020-06-23 21:27:23 -07:00
Licensing-strategy.md	docs: Update licensing strategy to use kata 2.0 repository	2021-02-15 11:10:01 -06:00
Limitations.md	docs: Update contributions section in limitations document kata 2.0	2020-07-31 11:25:36 -05:00
Makefile	docs: merge documentation repository	2020-06-23 21:27:23 -07:00
README.md	docs: add katacontainers end-to-end arch image	2021-02-04 08:51:36 +01:00
Release-Process.md	release: Rename runtime-release-notes to release-notes	2021-02-23 17:25:40 +01:00
Stable-Branch-Strategy.md	docs: merge documentation repository	2020-06-23 21:27:23 -07:00
Upgrading.md	docs: Update documentation with new subcommand forms	2020-10-24 15:28:54 +02:00

README.md

Documentation

Getting Started
More User Guides
Kata Use-Cases
Developer Guide
Help Improving the Documents
Website Changes

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

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

Documentation Requirements

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.