github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-27 07:48:55 +00:00
Code Issues Projects Releases Wiki Activity

docs: Clarifying minimum version of containerd for annotations

Browse Source 
Using pod annotations requires a minimum version of v1.3.0 of containerd
to pass annotations down to kata. This is already somewhat mentioned in
the corresponding how-to, however, it can be mis-read as the minimum
version of kata-containers instead of containerd. This can cause
extended and futile troubleshooting on older distributions such as
Ubuntu 16.04 which ship a version of 1.2.x of containerd. This patch
attempts to clarify this.

Fixes: #690

Signed-off-by: Georg Kunz <georg.kunz@est.tech>
This commit is contained in:
Georg Kunz 2020-07-15 12:53:02 +02:00
parent d88f8910ab
commit ab7afae6d3
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/how-to/how-to-set-sandbox-config-kata.md
View File

@ -79,13 +79,14 @@ There are several kinds of Kata configurations and they are listed below.
# CRI Configuration # CRI Configuration
In case of CRI-O, all annotations specified in the pod spec are passed down to Kata. In case of CRI-O, all annotations specified in the pod spec are passed down to Kata.
For containerd, annotations specified in the pod spec are passed down to Kata For containerd, annotations specified in the pod spec are passed down to Kata
starting with version `1.3.0`. Additionally, extra configuration is needed for containerd, starting with version `1.3.0` of containerd. Additionally, extra configuration is
by providing a `pod_annotations` field in the containerd config file. The `pod_annotations` needed for containerd, by providing a `pod_annotations` field in the containerd config
field is a list of annotations that can be passed down to Kata as OCI annotations. file. The `pod_annotations` field is a list of annotations that can be passed down to
It supports golang match patterns. Since annotations supported by Kata follow the pattern Kata as OCI annotations. It supports golang match patterns. Since annotations supported
`io.katacontainers.*`, the following configuration would work for passing annotations to by Kata follow the pattern `io.katacontainers.*`, the following configuration would work
Kata from containerd: for passing annotations to Kata from containerd:
``` ```
$ cat /etc/containerd/config $ cat /etc/containerd/config