mirror of https://github.com/kata-containers/kata-containers.git synced 2025-05-07 16:07:37 +00:00

History

stevenhorsman 59ae244442 doc: Update crictl pod-config - Ensure that our documented crictl pod config file contents have uid and namespace fields for compatibility with crictl 1.24+ This avoids a user potentially hitting the error: ``` getting sandbox status of pod "d3af2db414ce8": metadata.Name, metadata.Namespace or metadata.Uid is not in metadata "&PodSandboxMetadata{Name:nydus-sandbox,Uid:,Namespace:default,Attempt:1,}" getting sandbox status of pod "-A": rpc error: code = NotFound desc = an error occurred when try to find sandbox: not found ``` Fixes: #8092 Signed-off-by: stevenhorsman <steven@uk.ibm.com> (cherry picked from commit `8f8c2215`)		2023-10-02 14:53:46 +01:00
..
design	metrics: Fix general check static warnings	2023-09-26 16:30:59 +00:00
how-to	doc: Update crictl pod-config	2023-10-02 14:53:46 +01:00
install	docs: Use control-plane term instead of master	2023-08-01 17:41:40 +09:00
presentations	docs: Add unit testing presentation	2022-03-01 15:52:03 +00:00
threat-model	threat-model: Add missing threat-model document	2021-09-21 20:20:39 +05:30
use-cases	docs: Update url link in QAT documentation	2023-01-25 15:27:29 +00:00
code-pr-advice.md	docs: Update outdated URLs and keep them available	2022-06-15 16:34:28 +08:00
Developer-Guide.md	docs: Update Developer Guide	2023-06-14 15:36:51 +00:00
Documentation-Requirements.md	docs: Remove table of contents	2021-07-30 10:58:22 +01:00
hypervisors.md	docs: add Dragonball to hypervisors	2022-07-11 09:38:17 +08:00
Licensing-strategy.md	docs: Remove table of contents	2021-07-30 10:58:22 +01:00
Limitations.md	doc: add vcpu handlint doc for runtime-rs	2023-06-12 19:23:11 +08:00
Makefile	docs: merge documentation repository	2020-06-23 21:27:23 -07:00
README.md	docs: Remove VPP documentation	2022-03-23 15:50:37 +00:00
Release-Process.md	docs: Change the order of release step	2023-02-16 12:12:21 -08:00
Stable-Branch-Strategy.md	docs: Update the stable branch strategy	2021-12-17 13:48:26 +01:00
tracing.md	docs: Fix relative links in Markdown	2022-02-11 13:49:42 +01:00
Unit-Test-Advice.md	docs: Specify language in markdown for syntax highlight	2022-09-01 13:54:31 +08:00
Upgrading.md	docs: Remove word duplication	2022-01-04 15:58:50 +00: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.