k3d/docs/usage/commands/k3d_image_import.md

2.1 KiB

k3d image import

Import image(s) from docker into k3d cluster(s).

Synopsis

Import image(s) from docker into k3d cluster(s).

If an IMAGE starts with the prefix 'docker.io/', then this prefix is stripped internally. That is, 'docker.io/rancher/k3d-tools:latest' is treated as 'rancher/k3d-tools:latest'.

If an IMAGE starts with the prefix 'library/' (or 'docker.io/library/'), then this prefix is stripped internally. That is, 'library/busybox:latest' (or 'docker.io/library/busybox:latest') are treated as 'busybox:latest'.

If an IMAGE does not have a version tag, then ':latest' is assumed. That is, 'rancher/k3d-tools' is treated as 'rancher/k3d-tools:latest'.

A file ARCHIVE always takes precedence. So if a file './rancher/k3d-tools' exists, k3d will try to import it instead of the IMAGE of the same name.

k3d image import [IMAGE | ARCHIVE [IMAGE | ARCHIVE...]] [flags]

Options

  -c, --cluster stringArray   Select clusters to load the image to. (default [k3s-default])
  -h, --help                  help for import
  -k, --keep-tarball          Do not delete the tarball containing the saved images from the shared volume
  -t, --keep-tools            Do not delete the tools node after import
  -m, --load-mode            Which method to use to load images to the cluster [auto, direct, tools-node]. (default "auto")

Options inherited from parent commands

      --timestamps   Enable Log timestamps
      --trace        Enable super verbose output (trace logging)
      --verbose      Enable verbose output (debug logging)

Loading modes

Auto

Auto-determine whether to use direct or tools-node.

For remote container runtimes, tools-node is faster due to less network overhead, thus it is automatically selected for remote runtimes.

Otherwise direct is used.

Direct

Directly load the given images to the k3s nodes. No separate container is spawned, no intermediate files are written.

Tools Node

Start a k3d-tools container in the container runtime, copy images to that runtime, then load the images to k3s nodes from there.

SEE ALSO