kata-containers/docs/design/architecture/example-command.md
James O. D. Hunt 7229b7a69d docs: Split background and example out of arch doc
Move the background and example command details out of the architecture
doc and into separate files.

Partially fixes: #3246.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2021-12-16 14:18:38 +00:00

1.2 KiB

Example command

The following containerd command creates a container. It is referred to throughout the architecture document to help explain various points:

$ sudo ctr run --runtime "io.containerd.kata.v2" --rm -t "quay.io/libpod/ubuntu:latest" foo sh

This command requests that containerd:

  • Create a container (ctr run).

  • Use the Kata shimv2 runtime (--runtime "io.containerd.kata.v2").

  • Delete the container when it exits (--rm).

  • Attach the container to the user's terminal (-t).

  • Use the Ubuntu Linux container image to create the container rootfs that will become the container environment (quay.io/libpod/ubuntu:latest).

  • Create the container with the name "foo".

  • Run the sh(1) command in the Ubuntu rootfs based container environment.

    The command specified here is referred to as the workload.

Note:

For the purposes of this document and to keep explanations simpler, we assume the user is running this command in the host environment.