From e29f7ad7db0f4ec19b022293293b57461347bf6f Mon Sep 17 00:00:00 2001 From: Anish Ramasekar Date: Thu, 16 Jan 2025 14:54:37 -0800 Subject: [PATCH] update credential provider godoc with unique provider name req Signed-off-by: Anish Ramasekar Kubernetes-commit: 92e35e7618ff30e1c8e79f5efb3788dfedf24bb3 --- config/v1/types.go | 3 ++- config/v1alpha1/types.go | 3 ++- config/v1beta1/types.go | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/config/v1/types.go b/config/v1/types.go index 1b59a7d..ca3a3e9 100644 --- a/config/v1/types.go +++ b/config/v1/types.go @@ -32,7 +32,7 @@ type CredentialProviderConfig struct { // Multiple providers may match against a single image, in which case credentials // from all providers will be returned to the kubelet. If multiple providers are called // for a single image, the results are combined. If providers return overlapping - // auth keys, the value from the provider earlier in this list is used. + // auth keys, the value from the provider earlier in this list is attempted first. Providers []CredentialProvider `json:"providers"` } @@ -42,6 +42,7 @@ type CredentialProvider struct { // name is the required name of the credential provider. It must match the name of the // provider executable as seen by the kubelet. The executable must be in the kubelet's // bin directory (set by the --image-credential-provider-bin-dir flag). + // Required to be unique across all providers. Name string `json:"name"` // matchImages is a required list of strings used to match against images in order to diff --git a/config/v1alpha1/types.go b/config/v1alpha1/types.go index 92daa99..6de4250 100644 --- a/config/v1alpha1/types.go +++ b/config/v1alpha1/types.go @@ -32,7 +32,7 @@ type CredentialProviderConfig struct { // Multiple providers may match against a single image, in which case credentials // from all providers will be returned to the kubelet. If multiple providers are called // for a single image, the results are combined. If providers return overlapping - // auth keys, the value from the provider earlier in this list is used. + // auth keys, the value from the provider earlier in this list is attempted first. Providers []CredentialProvider `json:"providers"` } @@ -42,6 +42,7 @@ type CredentialProvider struct { // name is the required name of the credential provider. It must match the name of the // provider executable as seen by the kubelet. The executable must be in the kubelet's // bin directory (set by the --image-credential-provider-bin-dir flag). + // Required to be unique across all providers. Name string `json:"name"` // matchImages is a required list of strings used to match against images in order to diff --git a/config/v1beta1/types.go b/config/v1beta1/types.go index a2cd809..ce2d312 100644 --- a/config/v1beta1/types.go +++ b/config/v1beta1/types.go @@ -1004,7 +1004,7 @@ type CredentialProviderConfig struct { // Multiple providers may match against a single image, in which case credentials // from all providers will be returned to the kubelet. If multiple providers are called // for a single image, the results are combined. If providers return overlapping - // auth keys, the value from the provider earlier in this list is used. + // auth keys, the value from the provider earlier in this list is attempted first. Providers []CredentialProvider `json:"providers"` } @@ -1014,6 +1014,7 @@ type CredentialProvider struct { // name is the required name of the credential provider. It must match the name of the // provider executable as seen by the kubelet. The executable must be in the kubelet's // bin directory (set by the --image-credential-provider-bin-dir flag). + // Required to be unique across all providers. Name string `json:"name"` // matchImages is a required list of strings used to match against images in order to