Skip to content

Commit 92e35e7

Browse files
committed
update credential provider godoc with unique provider name req
Signed-off-by: Anish Ramasekar <[email protected]>
1 parent 9a331bb commit 92e35e7

File tree

5 files changed

+14
-10
lines changed

5 files changed

+14
-10
lines changed

pkg/generated/openapi/zz_generated.openapi.go

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/kubelet/apis/config/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -604,7 +604,7 @@ type CredentialProviderConfig struct {
604604
// Multiple providers may match against a single image, in which case credentials
605605
// from all providers will be returned to the kubelet. If multiple providers are called
606606
// for a single image, the results are combined. If providers return overlapping
607-
// auth keys, the value from the provider earlier in this list is used.
607+
// auth keys, the value from the provider earlier in this list is attempted first.
608608
Providers []CredentialProvider
609609
}
610610

@@ -614,6 +614,7 @@ type CredentialProvider struct {
614614
// name is the required name of the credential provider. It must match the name of the
615615
// provider executable as seen by the kubelet. The executable must be in the kubelet's
616616
// bin directory (set by the --credential-provider-bin-dir flag).
617+
// Required to be unique across all providers.
617618
Name string
618619

619620
// matchImages is a required list of strings used to match against images in order to

staging/src/k8s.io/kubelet/config/v1/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ type CredentialProviderConfig struct {
3232
// Multiple providers may match against a single image, in which case credentials
3333
// from all providers will be returned to the kubelet. If multiple providers are called
3434
// for a single image, the results are combined. If providers return overlapping
35-
// auth keys, the value from the provider earlier in this list is used.
35+
// auth keys, the value from the provider earlier in this list is attempted first.
3636
Providers []CredentialProvider `json:"providers"`
3737
}
3838

@@ -42,6 +42,7 @@ type CredentialProvider struct {
4242
// name is the required name of the credential provider. It must match the name of the
4343
// provider executable as seen by the kubelet. The executable must be in the kubelet's
4444
// bin directory (set by the --image-credential-provider-bin-dir flag).
45+
// Required to be unique across all providers.
4546
Name string `json:"name"`
4647

4748
// matchImages is a required list of strings used to match against images in order to

staging/src/k8s.io/kubelet/config/v1alpha1/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ type CredentialProviderConfig struct {
3232
// Multiple providers may match against a single image, in which case credentials
3333
// from all providers will be returned to the kubelet. If multiple providers are called
3434
// for a single image, the results are combined. If providers return overlapping
35-
// auth keys, the value from the provider earlier in this list is used.
35+
// auth keys, the value from the provider earlier in this list is attempted first.
3636
Providers []CredentialProvider `json:"providers"`
3737
}
3838

@@ -42,6 +42,7 @@ type CredentialProvider struct {
4242
// name is the required name of the credential provider. It must match the name of the
4343
// provider executable as seen by the kubelet. The executable must be in the kubelet's
4444
// bin directory (set by the --image-credential-provider-bin-dir flag).
45+
// Required to be unique across all providers.
4546
Name string `json:"name"`
4647

4748
// matchImages is a required list of strings used to match against images in order to

staging/src/k8s.io/kubelet/config/v1beta1/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1004,7 +1004,7 @@ type CredentialProviderConfig struct {
10041004
// Multiple providers may match against a single image, in which case credentials
10051005
// from all providers will be returned to the kubelet. If multiple providers are called
10061006
// for a single image, the results are combined. If providers return overlapping
1007-
// auth keys, the value from the provider earlier in this list is used.
1007+
// auth keys, the value from the provider earlier in this list is attempted first.
10081008
Providers []CredentialProvider `json:"providers"`
10091009
}
10101010

@@ -1014,6 +1014,7 @@ type CredentialProvider struct {
10141014
// name is the required name of the credential provider. It must match the name of the
10151015
// provider executable as seen by the kubelet. The executable must be in the kubelet's
10161016
// bin directory (set by the --image-credential-provider-bin-dir flag).
1017+
// Required to be unique across all providers.
10171018
Name string `json:"name"`
10181019

10191020
// matchImages is a required list of strings used to match against images in order to

0 commit comments

Comments
 (0)