From 5205efd9b4783ab1246b8f0a03739f91cf367106 Mon Sep 17 00:00:00 2001 From: Manabu Sugimoto Date: Mon, 30 May 2022 15:55:58 +0900 Subject: [PATCH] runk: Add Podman guide in README runk can launch containers using Podman, so add the guide in README. Fixes: #4338 Signed-off-by: Manabu Sugimoto --- src/tools/runk/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/tools/runk/README.md b/src/tools/runk/README.md index 9d18e27bce..10e24753f7 100644 --- a/src/tools/runk/README.md +++ b/src/tools/runk/README.md @@ -149,6 +149,26 @@ $ sudo runk state test $ sudo runk delete test ``` +## Using `runk` from `Podman` + +`runk` can run containers using [`Podman`](https://github.com/containers/podman). + +First, install `Podman` from source code or package by following the +[`Podman` installation instructions](https://podman.io/getting-started/installation). + +### Running a container with `Podman` command line + +```bash +$ sudo podman --runtime /usr/local/bin/runk run -it --rm busybox sh +/ # +``` + +> **Note:** +> `runk` does not support some commands except +> [OCI standard operations](https://github.com/opencontainers/runtime-spec/blob/main/runtime.md#operations) +> yet, so those commands do not work in `Podman`. Regarding commands currently +> implemented in `runk`, see the [Status of `runk`](#status-of-runk) section. + ## Using `runk` from `containerd` `runk` can run containers with the containerd runtime handler support on `containerd`.