github/kata-containers
1
0
Fork 2
mirror of https://github.com/kata-containers/kata-containers.git synced 2026-04-26 18:43:06 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #11611 from Xynnn007/docs-typo

Browse Source 
docs: fix nerdctl guest image command
This commit is contained in:
Fabiano Fidêncio
2026-04-16 15:36:37 +02:00
committed by GitHub
parent 57ce3a1347 1d806e0cfa
commit d9128a58d9
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/design/kata-guest-image-management-design.md
View File

@@ -160,11 +160,14 @@ Next, the kata-agent's RPC module will handle the create container request which
## Using guest image pull with `nerdctl`
When running a workload, add the `--label io.kubernetes.cri.image-name=<image>` option e.g.:
When running a workload, add the `--annotation io.kubernetes.cri.image-name=<image>` option e.g.:
```sh
nerdctl run --runtime io.containerd.kata.v2 --snapshotter nydus --label io.kubernetes.cri.image-name=docker.io/library/busybox:latest --rm docker.io/library/busybox:latest uname -r
nerdctl run --runtime io.containerd.kata.v2 --snapshotter nydus --annotation io.kubernetes.cri.image-name=docker.io/library/busybox:latest --rm docker.io/library/busybox:latest uname -r
```
> [!NOTE]
> The command above is for `nerdctl` >= `2.0`. If `nerdctl` is older than `2.0`, use `--label io.containerd.kata.v2.image-name=<image>`.
References:
1. [[RFC] Image management proposal for hosting sharing and peer pods](https://github.com/confidential-containers/confidential-containers/issues/137)
2. https://github.com/containerd/containerd/blob/main/docs/content-flow.md