diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 377c612e619..a0230e7c8a5 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -74,6 +74,7 @@ by the API server in a RESTful way though they are essential for a user or an operator to use or manage a cluster. * [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) +* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) * [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) * [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) * [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) diff --git a/content/en/docs/reference/config-api/kubelet-config.v1alpha1.md b/content/en/docs/reference/config-api/kubelet-config.v1alpha1.md new file mode 100644 index 00000000000..ffb3d85ac25 --- /dev/null +++ b/content/en/docs/reference/config-api/kubelet-config.v1alpha1.md @@ -0,0 +1,281 @@ +--- +title: Kubelet Configuration (v1alpha1) +content_type: tool-reference +package: kubelet.config.k8s.io/v1alpha1 +auto_generated: true +--- + + +## Resource Types + + +- [CredentialProviderConfig](#kubelet-config-k8s-io-v1alpha1-CredentialProviderConfig) + + + +## `FormatOptions` {#FormatOptions} + + + + +**Appears in:** + +- [LoggingConfiguration](#LoggingConfiguration) + + +FormatOptions contains options for the different logging formats. + +
| Field | Description |
|---|---|
json [Required]+ JSONOptions
+ |
++ [Experimental] JSON contains options for logging format "json". | +
| Field | Description |
|---|---|
splitStream [Required]+ bool
+ |
++ [Experimental] SplitStream redirects error messages to stderr while +info messages go to stdout, with buffering. The default is to write +both to stdout, without buffering. | +
infoBufferSize [Required]+ k8s.io/apimachinery/pkg/api/resource.QuantityValue
+ |
++ [Experimental] InfoBufferSize sets the size of the info stream when +using split streams. The default is zero, which disables buffering. | +
| Field | Description |
|---|---|
apiVersionstring | kubelet.config.k8s.io/v1alpha1 |
kindstring | CredentialProviderConfig |
providers [Required]+ []CredentialProvider
+ |
++ providers is a list of credential provider plugins that will be enabled by the kubelet. +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. | +
| Field | Description |
|---|---|
name [Required]+ string
+ |
++ 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). | +
matchImages [Required]+ []string
+ |
++ matchImages is a required list of strings used to match against images in order to +determine if this provider should be invoked. If one of the strings matches the +requested image from the kubelet, the plugin will be invoked and given a chance +to provide credentials. Images are expected to contain the registry domain +and URL path. + +Each entry in matchImages is a pattern which can optionally contain a port and a path. +Globs can be used in the domain, but not in the port or the path. Globs are supported +as subdomains like '∗.k8s.io' or 'k8s.∗.io', and top-level-domains such as 'k8s.∗'. +Matching partial subdomains like 'app∗.k8s.io' is also supported. Each glob can only match +a single subdomain segment, so ∗.io does not match ∗.k8s.io. + +A match exists between an image and a matchImage when all of the below are true: +- Both contain the same number of domain parts and each part matches. +- The URL path of an imageMatch must be a prefix of the target image URL path. +- If the imageMatch contains a port, then the port must match in the image as well. + +Example values of matchImages: + - 123456789.dkr.ecr.us-east-1.amazonaws.com + - ∗.azurecr.io + - gcr.io + - ∗.∗.registry.io + - registry.io:8080/path | +
defaultCacheDuration [Required]+ meta/v1.Duration
+ |
++ defaultCacheDuration is the default duration the plugin will cache credentials in-memory +if a cache duration is not provided in the plugin response. This field is required. | +
apiVersion [Required]+ string
+ |
++ Required input version of the exec CredentialProviderRequest. The returned CredentialProviderResponse +MUST use the same encoding version as the input. Current supported values are: +- credentialprovider.kubelet.k8s.io/v1alpha1 | +
args+ []string
+ |
++ Arguments to pass to the command when executing it. | +
env+ []ExecEnvVar
+ |
++ Env defines additional environment variables to expose to the process. These +are unioned with the host's environment, as well as variables client-go uses +to pass argument to the plugin. | +
| Field | Description |
|---|---|
name [Required]+ string
+ |
++ No description provided. + | +
value [Required]+ string
+ |
++ No description provided. + | +