Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename --k8s-keychain flag #2053

Open
imjasonh opened this issue Jul 6, 2022 · 0 comments
Open

Rename --k8s-keychain flag #2053

imjasonh opened this issue Jul 6, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@imjasonh
Copy link
Member

imjasonh commented Jul 6, 2022

Description

The --k8s-keychain flag (e.g., in cosign sign) is

whether to use the kubernetes keychain instead of the default keychain (supports workload identity).

This is a bit of a misnomer, since "the kubernetes keychain" as a term isn't particularly well defined, and because what I believe it means is, "the common set of cloud auth helpers that can be included in Kubernetes (i.e., GCP, AWS, Azure)", and in actuality, the flag enables a number of auth helpers that aren't exactly that set of "kubernetes auth helpers":

kc := authn.NewMultiKeychain(
authn.DefaultKeychain,
google.Keychain,
authn.NewKeychainFromHelper(ecr.NewECRHelper(ecr.WithLogger(ioutil.Discard))),
authn.NewKeychainFromHelper(credhelper.NewACRCredentialsHelper()),
github.Keychain,
)

Along with GCP, AWS and Azure, this set includes the GHCR auth helper, and with #2007 this keychain will also include an Alibaba helper.

I propose changing this flag to something like --workload-identity (ideas welcome!) or at least improve docs to clarify what it does.

@imjasonh imjasonh added the enhancement New feature or request label Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant