summaryrefslogtreecommitdiffstats
path: root/cmd/krane/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/krane/README.md')
-rw-r--r--cmd/krane/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/cmd/krane/README.md b/cmd/krane/README.md
new file mode 100644
index 0000000..2f21e00
--- /dev/null
+++ b/cmd/krane/README.md
@@ -0,0 +1,15 @@
+# `krane`
+
+<img src="../../images/crane.png" width="40%">
+
+This tool is a variant of the [`crane`](../crane/README.md) command, but builds in
+support for authenticating against registries using common credential helpers
+that find credentials from the environment.
+
+In particular this tool supports authenticating with common "workload identity"
+mechanisms on platforms such as GKE and EKS.
+
+This additional keychain logic only kicks in if alternative authentication
+mechanisms have NOT been configured and `crane` would otherwise perform the
+command without credentials, so **it is a drop-in replacement for `crane` that
+adds support for authenticating with cloud workload identity mechanisms**.