Pulls and unpacks a container image to the local filesystem. Usable both as a standalone CLI tool, and as a go module.

Go to file

caroline-suse-rancher 8cfe84a9ef Merge pull request #36 from swastik959/add-1.34 [1.34] bumped k8s dependencies		2025-10-14 15:07:11 -04:00
.github/workflows	…
package	…
pkg	Update kubernetes to v1.33 and golang 1.24 (#34 )	2025-04-29 11:41:38 -07:00
scripts	Make the build consistent across archs for Go to correctly report the package path inside the binary	2024-12-01 11:42:09 -08:00
.gitignore	…
Dockerfile.dapper	updated dockerfile	2025-10-08 12:43:27 +05:30
LICENSE	…
Makefile	…
README.md	…
go.mod	removed go toolchain	2025-10-08 12:30:45 +05:30
go.sum	[1.34] bumped k8s dependencies	2025-10-01 22:07:37 +05:30
main.go	Migrate to urfavecli v2	2025-02-11 15:46:36 -08:00

README.md

wharfie

Utility libraries to provide additional functionality for users of go-containerregistry. Also includes a basic command-line app demonstrating use of the library code.

cli

NAME:
   wharfie - pulls and unpacks a container image to the local filesystem

USAGE:
   wharfie [global options] command [command options] <image> <destination>

VERSION:
   v0.3.1

DESCRIPTION:
   Supports K3s/RKE2 style repository rewrites, endpoint overrides, and auth configuration.
   Supports optional loading from local image tarballs or layer cache.
   Supports Kubelet credential provider plugins.

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --private-registry value                   Private registry configuration file (default: "/etc/rancher/common/registries.yaml")
   --images-dir value                         Images tarball directory
   --cache                                    Enable layer cache when image is not available locally
   --cache-dir value                          Layer cache directory (default: "$XDG_CACHE_HOME/rancher/wharfie")
   --image-credential-provider-config value   Image credential provider configuration file
   --image-credential-provider-bin-dir value  Image credential provider binary directory
   --debug                                    Enable debug logging
   --help, -h                                 show help
   --version, -v                              print the version

image credential providers

(KEP-2133) kubelet image credential providers are supported. At the time of this writing, none of the out-of-tree cloud providers offer standalone binaries. The wharfie docker image (available by running make package-image) bundles provider plugins at /bin/plugins, with a sample config file at /etc/config.yaml.

More information is available at: