images

kix images evaluates a cluster and lists the container images it needs. It does not contact a cluster. Use the list to pull, mirror, or preload images before deploying to an environment without registry access.

This page is hand-maintained. Check cli/kix-cli/src/cli.rs and cli/kix-cli/src/commands/images.rs when in doubt.

Synopsis

kix images <CLUSTER> [--sources] [-o text|json|yaml]
           [--flake <FLAKE>] [--no-cache]

Argument or flag	Default	Meaning
<CLUSTER>		Cluster name to evaluate.
--sources	Off	In text output, list under each image the resources that reference it, as Kind namespace/name (container: <name>).
-o, --output	text	text and markdown print one image reference per line. json and yaml print an array of { image, sources }, whatever --sources says.
--flake <FLAKE>	.	Flake to evaluate.
--no-cache	Off	Evaluate from Nix instead of reading the eval cache.

What is listed

Kix reads the image of every container, init container, and ephemeral container in Pods and in the pod templates of Deployments, StatefulSets, DaemonSets, ReplicaSets, Jobs, and CronJobs. It adds the images a package declares in out.extraImages, which cover pods an operator creates at run time.

Each image reference appears once, sorted, exactly as written in the manifests: a tag, a digest, or both. Each entry in sources has kind, namespace, name, and container. Cluster-scoped sources have the namespace _cluster. A cluster with no images prints No container images found.

Examples

❱ kix images demo

❱ kix images demo --sources

❱ kix images demo | xargs -n1 docker pull

Exit status

0 when the cluster evaluates, 1 when it does not.

Use it in a task

See List images for air-gapped preloading for pulling and loading the list.