From b1981993363a631e7a38de84eaf987dbe4862805 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Wed, 8 Dec 2021 15:46:50 +0800 Subject: [PATCH] Configuration API for v1.23 --- .../cluster-administration/system-traces.md | 4 +- .../scheduling-eviction/kube-scheduler.md | 2 +- .../scheduler-perf-tuning.md | 4 +- content/en/docs/reference/_index.md | 4 +- .../config-api/apiserver-audit.v1.md | 28 + ...1alpha1.md => apiserver-config.v1beta1.md} | 181 +- .../config-api/kube-proxy-config.v1alpha1.md | 129 ++ .../kube-scheduler-config.v1beta2.md | 1172 ++++-------- .../kube-scheduler-config.v1beta3.md | 1587 +++++++++++++++++ .../kube-scheduler-policy-config.v1.md | 4 +- .../config-api/kubeadm-config.v1beta3.md | 444 +++-- .../config-api/kubelet-config.v1beta1.md | 239 ++- .../en/docs/reference/scheduling/config.md | 5 +- .../en/docs/reference/scheduling/policies.md | 2 +- .../configure-multiple-schedulers.md | 4 +- 15 files changed, 2552 insertions(+), 1257 deletions(-) rename content/en/docs/reference/config-api/{apiserver-config.v1alpha1.md => apiserver-config.v1beta1.md} (51%) create mode 100644 content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md diff --git a/content/en/docs/concepts/cluster-administration/system-traces.md b/content/en/docs/concepts/cluster-administration/system-traces.md index f324604b16..51428bad3e 100644 --- a/content/en/docs/concepts/cluster-administration/system-traces.md +++ b/content/en/docs/concepts/cluster-administration/system-traces.md @@ -66,7 +66,7 @@ with `--tracing-config-file=`. This is an example config that re spans for 1 in 10000 requests, and uses the default OpenTelemetry endpoint: ```yaml -apiVersion: apiserver.config.k8s.io/v1alpha1 +apiVersion: apiserver.config.k8s.io/v1beta1 kind: TracingConfiguration # default value #endpoint: localhost:4317 @@ -74,7 +74,7 @@ samplingRatePerMillion: 100 ``` For more information about the `TracingConfiguration` struct, see -[API server config API (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/#apiserver-k8s-io-v1alpha1-TracingConfiguration). +[API server config API (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/#apiserver-k8s-io-v1beta1-TracingConfiguration). ## Stability diff --git a/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md b/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md index 916f050513..df688ded9a 100644 --- a/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md +++ b/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md @@ -85,7 +85,7 @@ of the scheduler: * Read about [scheduler performance tuning](/docs/concepts/scheduling-eviction/scheduler-perf-tuning/) * Read about [Pod topology spread constraints](/docs/concepts/workloads/pods/pod-topology-spread-constraints/) * Read the [reference documentation](/docs/reference/command-line-tools-reference/kube-scheduler/) for kube-scheduler -* Read the [kube-scheduler config (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) reference +* Read the [kube-scheduler config (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) reference * Learn about [configuring multiple schedulers](/docs/tasks/extend-kubernetes/configure-multiple-schedulers/) * Learn about [topology management policies](/docs/tasks/administer-cluster/topology-manager/) * Learn about [Pod Overhead](/docs/concepts/scheduling-eviction/pod-overhead/) diff --git a/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md b/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md index 5894398c9b..00302166ce 100644 --- a/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md +++ b/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md @@ -43,7 +43,7 @@ If you set `percentageOfNodesToScore` above 100, kube-scheduler acts as if you had set a value of 100. To change the value, edit the -[kube-scheduler configuration file](/docs/reference/config-api/kube-scheduler-config.v1beta2/) +[kube-scheduler configuration file](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and then restart the scheduler. In many cases, the configuration file can be found at `/etc/kubernetes/config/kube-scheduler.yaml`. @@ -161,5 +161,5 @@ After going over all the Nodes, it goes back to Node 1. ## {{% heading "whatsnext" %}} -* Check the [kube-scheduler configuration reference (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) +* Check the [kube-scheduler configuration reference (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 5d1826f461..377c612e61 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -73,10 +73,10 @@ configure kubernetes components or tools. Most of these APIs are not exposed 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 (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/) +* [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) * [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) -* [kube-scheduler configuration (v1beta1)](/docs/reference/config-api/kube-scheduler-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/) * [kube-scheduler policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/) * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) * [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/) diff --git a/content/en/docs/reference/config-api/apiserver-audit.v1.md b/content/en/docs/reference/config-api/apiserver-audit.v1.md index 11df06bd8c..f722e81341 100644 --- a/content/en/docs/reference/config-api/apiserver-audit.v1.md +++ b/content/en/docs/reference/config-api/apiserver-audit.v1.md @@ -279,6 +279,19 @@ be specified per rule in which case the union of both are omitted. +omitManagedFields
+bool + + + OmitManagedFields indicates whether to omit the managed fields of the request +and response bodies from being written to the API audit log. +This is used as a global default - a value of 'true' will omit the managed fileds, +otherwise the managed fields will be included in the API audit log. +Note that this can also be specified per rule in which case the value specified +in a rule will override the global default. + + + @@ -594,6 +607,21 @@ An empty list means no restrictions will apply. +omitManagedFields
+bool + + + OmitManagedFields indicates whether to omit the managed fields of the request +and response bodies from being written to the API audit log. +- a value of 'true' will drop the managed fields from the API audit log +- a value of 'false' indicates that the managed fileds should be included + in the API audit log +Note that the value, if specified, in this rule will override the global default +If a value is not specified then the global default specified in +Policy.OmitManagedFields will stand. + + + diff --git a/content/en/docs/reference/config-api/apiserver-config.v1alpha1.md b/content/en/docs/reference/config-api/apiserver-config.v1beta1.md similarity index 51% rename from content/en/docs/reference/config-api/apiserver-config.v1alpha1.md rename to content/en/docs/reference/config-api/apiserver-config.v1beta1.md index 81702355a5..fb5363f58d 100644 --- a/content/en/docs/reference/config-api/apiserver-config.v1alpha1.md +++ b/content/en/docs/reference/config-api/apiserver-config.v1beta1.md @@ -1,53 +1,20 @@ --- -title: kube-apiserver Configuration (v1alpha1) +title: kube-apiserver Configuration (v1beta1) content_type: tool-reference -package: apiserver.k8s.io/v1alpha1 +package: apiserver.k8s.io/v1beta1 auto_generated: true --- -Package v1alpha1 is the v1alpha1 version of the API. +Package v1beta1 is the v1beta1 version of the API. ## Resource Types -- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) -- [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration) -- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration) +- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration) -## `AdmissionConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionConfiguration} - - - - - -AdmissionConfiguration provides versioned configuration for admission controllers. - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		apiserver.k8s.io/v1alpha1
kind
string		AdmissionConfiguration
plugins
-[]AdmissionPluginConfiguration -		 - Plugins allows specifying a configuration per admission control plugin.
- - - -## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration} +## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration} @@ -59,14 +26,14 @@ EgressSelectorConfiguration provides versioned configuration for egress selector FieldDescription -apiVersion
stringapiserver.k8s.io/v1alpha1 +apiVersion
stringapiserver.k8s.io/v1beta1 kind
stringEgressSelectorConfiguration egressSelections [Required]
-[]EgressSelection +[]EgressSelection connectionServices contains a list of egress selection client configurations @@ -78,108 +45,14 @@ EgressSelectorConfiguration provides versioned configuration for egress selector -## `TracingConfiguration` {#apiserver-k8s-io-v1alpha1-TracingConfiguration} - - - - - -TracingConfiguration provides versioned configuration for tracing clients. - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		apiserver.k8s.io/v1alpha1
kind
string		TracingConfiguration
endpoint
-string -		 - Endpoint of the collector that's running on the control-plane node. -The APIServer uses the egressType ControlPlane when sending data to the collector. -The syntax is defined in https://github.com/grpc/grpc/blob/master/doc/naming.md. -Defaults to the otlpgrpc default, localhost:4317 -The connection is insecure, and does not support TLS.
samplingRatePerMillion
-int32 -		 - SamplingRatePerMillion is the number of samples to collect per million spans. -Defaults to 0.
- - - -## `AdmissionPluginConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionPluginConfiguration} +## `Connection` {#apiserver-k8s-io-v1beta1-Connection} **Appears in:** -- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) - - -AdmissionPluginConfiguration provides the configuration for a single plug-in. - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Name is the name of the admission controller. -It must match the registered admission plugin name.
path
-string -		 - Path is the path to a configuration file that contains the plugin's -configuration
configuration
-k8s.io/apimachinery/pkg/runtime.Unknown -		 - Configuration is an embedded configuration object to be used as the plugin's -configuration. If present, it will be used instead of the path to the configuration file.
- - - -## `Connection` {#apiserver-k8s-io-v1alpha1-Connection} - - - - -**Appears in:** - -- [EgressSelection](#apiserver-k8s-io-v1alpha1-EgressSelection) +- [EgressSelection](#apiserver-k8s-io-v1beta1-EgressSelection) Connection provides the configuration for a single egress selection client. @@ -191,7 +64,7 @@ Connection provides the configuration for a single egress selection client. proxyProtocol [Required]
-ProtocolType +ProtocolType Protocol is the protocol used to connect from client to the konnectivity server. @@ -199,7 +72,7 @@ Connection provides the configuration for a single egress selection client. transport
-Transport +Transport Transport defines the transport configurations we use to dial to the konnectivity server. @@ -212,14 +85,14 @@ This is required if ProxyProtocol is HTTPConnect or GRPC. -## `EgressSelection` {#apiserver-k8s-io-v1alpha1-EgressSelection} +## `EgressSelection` {#apiserver-k8s-io-v1beta1-EgressSelection} **Appears in:** -- [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration) +- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration) EgressSelection provides the configuration for a single egress selection client. @@ -241,7 +114,7 @@ The "master" egress selector is deprecated in favor of "controlplane" connection [Required]
-Connection +Connection connection is the exact information used to configure the egress selection @@ -253,14 +126,14 @@ The "master" egress selector is deprecated in favor of "controlplane" -## `ProtocolType` {#apiserver-k8s-io-v1alpha1-ProtocolType} +## `ProtocolType` {#apiserver-k8s-io-v1beta1-ProtocolType} (Alias of `string`) **Appears in:** -- [Connection](#apiserver-k8s-io-v1alpha1-Connection) +- [Connection](#apiserver-k8s-io-v1beta1-Connection) ProtocolType is a set of valid values for Connection.ProtocolType @@ -269,14 +142,14 @@ ProtocolType is a set of valid values for Connection.ProtocolType -## `TCPTransport` {#apiserver-k8s-io-v1alpha1-TCPTransport} +## `TCPTransport` {#apiserver-k8s-io-v1beta1-TCPTransport} **Appears in:** -- [Transport](#apiserver-k8s-io-v1alpha1-Transport) +- [Transport](#apiserver-k8s-io-v1beta1-Transport) TCPTransport provides the information to connect to konnectivity server via TCP @@ -297,7 +170,7 @@ As an example it might be "https://127.0.0.1:8131" tlsConfig
-TLSConfig +TLSConfig TLSConfig is the config needed to use TLS when connecting to konnectivity server @@ -309,14 +182,14 @@ As an example it might be "https://127.0.0.1:8131" -## `TLSConfig` {#apiserver-k8s-io-v1alpha1-TLSConfig} +## `TLSConfig` {#apiserver-k8s-io-v1beta1-TLSConfig} **Appears in:** -- [TCPTransport](#apiserver-k8s-io-v1alpha1-TCPTransport) +- [TCPTransport](#apiserver-k8s-io-v1beta1-TCPTransport) TLSConfig provides the authentication information to connect to konnectivity server @@ -363,14 +236,14 @@ Must be configured if TCPTransport.URL is prefixed with https:// -## `Transport` {#apiserver-k8s-io-v1alpha1-Transport} +## `Transport` {#apiserver-k8s-io-v1beta1-Transport} **Appears in:** -- [Connection](#apiserver-k8s-io-v1alpha1-Connection) +- [Connection](#apiserver-k8s-io-v1beta1-Connection) Transport defines the transport configurations we use to dial to the konnectivity server @@ -382,7 +255,7 @@ Transport defines the transport configurations we use to dial to the konnectivit tcp
-TCPTransport +TCPTransport TCP is the TCP configuration for communicating with the konnectivity server via TCP @@ -392,7 +265,7 @@ Requires at least one of TCP or UDS to be set uds
-UDSTransport +UDSTransport UDS is the UDS configuration for communicating with the konnectivity server via UDS @@ -405,14 +278,14 @@ Requires at least one of TCP or UDS to be set -## `UDSTransport` {#apiserver-k8s-io-v1alpha1-UDSTransport} +## `UDSTransport` {#apiserver-k8s-io-v1beta1-UDSTransport} **Appears in:** -- [Transport](#apiserver-k8s-io-v1alpha1-Transport) +- [Transport](#apiserver-k8s-io-v1beta1-Transport) UDSTransport provides the information to connect to konnectivity server via UDS diff --git a/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md b/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md index 94209488fe..c0c2312f6f 100644 --- a/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md +++ b/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md @@ -548,6 +548,8 @@ this always falls back to the userspace proxy. - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + - [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) @@ -611,6 +613,8 @@ client. **Appears in:** +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) @@ -641,6 +645,75 @@ enableProfiling is true. + + + +## `FormatOptions` {#FormatOptions} + + + + +**Appears in:** + +- [LoggingConfiguration](#LoggingConfiguration) + + +FormatOptions contains options for the different logging formats. + + + + + + + + + + + + + +
FieldDescription
json [Required]
+JSONOptions +		 + [Experimental] JSON contains options for logging format "json".
+ +## `JSONOptions` {#JSONOptions} + + + + +**Appears in:** + +- [FormatOptions](#FormatOptions) + + +JSONOptions contains options for logging format "json". + + + + + + + + + + + + + + + + +
FieldDescription
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.
@@ -653,6 +726,8 @@ enableProfiling is true. - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + - [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) @@ -767,6 +842,35 @@ default value of format is `text` +flushFrequency [Required]
+time.Duration + + + Maximum number of seconds between log flushes. Ignored if the +selected logging backend writes log messages without buffering. + + + +verbosity [Required]
+uint32 + + + Verbosity is the threshold that determines which log messages are +logged. Default is zero which logs only the most important +messages. Higher values enable additional messages. Error messages +are always logged. + + + +vmodule [Required]
+VModuleConfiguration + + + VModule overrides the verbosity threshold for individual files. +Only supported for "text" log format. + + + sanitization [Required]
bool @@ -776,5 +880,30 @@ Runtime log sanitization may introduce significant computation overhead and ther +options [Required]
+FormatOptions + + + [Experimental] Options holds additional parameters that are specific +to the different logging formats. Only the options for the selected +format get used, but all of them get validated. + + + + +## `VModuleConfiguration` {#VModuleConfiguration} + +(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`) + + +**Appears in:** + +- [LoggingConfiguration](#LoggingConfiguration) + + +VModuleConfiguration is a collection of individual file names or patterns +and the corresponding verbosity threshold. + + diff --git a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md index 1a28c03c88..5479abcf36 100644 --- a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md +++ b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md @@ -17,243 +17,6 @@ auto_generated: true - [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta2-NodeResourcesFitArgs) - [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadArgs) - [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta2-VolumeBindingArgs) -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) - - - -## `ClientConnectionConfiguration` {#ClientConnectionConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - - -ClientConnectionConfiguration contains details for constructing a client. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
kubeconfig [Required]
-string -		 - kubeconfig is the path to a KubeConfig file.
acceptContentTypes [Required]
-string -		 - acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the -default value of 'application/json'. This field will control all connections to the server used by a particular -client.
contentType [Required]
-string -		 - contentType is the content type used when sending data to the server from this client.
qps [Required]
-float32 -		 - qps controls the number of queries per second allowed for this connection.
burst [Required]
-int32 -		 - burst allows extra queries to accumulate when a client is exceeding its rate.
- -## `DebuggingConfiguration` {#DebuggingConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - - -DebuggingConfiguration holds configuration for Debugging related features. - - - - - - - - - - - - - - - - - - -
FieldDescription
enableProfiling [Required]
-bool -		 - enableProfiling enables profiling via web interface host:port/debug/pprof/
enableContentionProfiling [Required]
-bool -		 - enableContentionProfiling enables lock contention profiling, if -enableProfiling is true.
- -## `LeaderElectionConfiguration` {#LeaderElectionConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - - -LeaderElectionConfiguration defines the configuration of leader election -clients for components that can run with leader election enabled. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
leaderElect [Required]
-bool -		 - leaderElect enables a leader election client to gain leadership -before executing the main loop. Enable this when running replicated -components for high availability.
leaseDuration [Required]
-meta/v1.Duration -		 - leaseDuration is the duration that non-leader candidates will wait -after observing a leadership renewal until attempting to acquire -leadership of a led but unrenewed leader slot. This is effectively the -maximum duration that a leader can be stopped before it is replaced -by another candidate. This is only applicable if leader election is -enabled.
renewDeadline [Required]
-meta/v1.Duration -		 - renewDeadline is the interval between attempts by the acting master to -renew a leadership slot before it stops leading. This must be less -than or equal to the lease duration. This is only applicable if leader -election is enabled.
retryPeriod [Required]
-meta/v1.Duration -		 - retryPeriod is the duration the clients should wait between attempting -acquisition and renewal of a leadership. This is only applicable if -leader election is enabled.
resourceLock [Required]
-string -		 - resourceLock indicates the resource object type that will be used to lock -during leader election cycles.
resourceName [Required]
-string -		 - resourceName indicates the name of resource object that will be used to lock -during leader election cycles.
resourceNamespace [Required]
-string -		 - resourceName indicates the namespace of resource object that will be used to lock -during leader election cycles.
- -## `LoggingConfiguration` {#LoggingConfiguration} - - - - -**Appears in:** - -- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) - - -LoggingConfiguration contains logging options -Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. - - - - - - - - - - - - - - - - - - -
FieldDescription
format [Required]
-string -		 - Format Flag specifies the structure of log messages. -default value of format is `text`
sanitization [Required]
-bool -		 - [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). -Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
@@ -386,8 +149,9 @@ settings for the proxy server to use when communicating with the apiserver. string - HealthzBindAddress is the IP address and port for the health check server to serve on, -defaulting to 0.0.0.0:10251 + Note: Both HealthzBindAddress and MetricsBindAddress fields are deprecated. +Only empty address or port 0 is allowed. Anything else will fail validation. +HealthzBindAddress is the IP address and port for the health check server to serve on. @@ -395,8 +159,7 @@ defaulting to 0.0.0.0:10251 string - MetricsBindAddress is the IP address and port for the metrics server to -serve on, defaulting to 0.0.0.0:10251. + MetricsBindAddress is the IP address and port for the metrics server to serve on. @@ -770,7 +533,7 @@ can implement this function. tlsConfig [Required]
-ExtenderTLSConfig +ExtenderTLSConfig TLSConfig specifies the transport layer security config @@ -797,7 +560,7 @@ assuming that the extender already cached full details of all nodes in the clust managedResources
-[]ExtenderManagedResource +[]ExtenderManagedResource ManagedResources is a list of extended resources that are managed by @@ -825,6 +588,139 @@ fail when the extender returns an error or is not reachable. +## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta2-ExtenderManagedResource} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) + + +ExtenderManagedResource describes the arguments of extended resources +managed by an extender. + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 + Name is the extended resource name.
ignoredByScheduler [Required]
+bool +		 + IgnoredByScheduler indicates whether kube-scheduler should ignore this +resource when applying predicates.
+ + + +## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta2-ExtenderTLSConfig} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) + + +ExtenderTLSConfig contains settings to enable TLS with extender + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
insecure [Required]
+bool +		 + Server should be accessed without verifying the TLS certificate. For testing only.
serverName [Required]
+string +		 + ServerName is passed to the server for SNI and is used in the client to check server +certificates against. If ServerName is empty, the hostname used to contact the +server is used.
certFile [Required]
+string +		 + Server requires TLS client certificate authentication
keyFile [Required]
+string +		 + Server requires TLS client certificate authentication
caFile [Required]
+string +		 + Trusted root certificates for server
certData [Required]
+[]byte +		 + CertData holds PEM-encoded bytes (typically read from a client certificate file). +CertData takes precedence over CertFile
keyData [Required]
+[]byte +		 + KeyData holds PEM-encoded bytes (typically read from a client certificate key file). +KeyData takes precedence over KeyFile
caData [Required]
+[]byte +		 + CAData holds PEM-encoded bytes (typically read from a root certificates bundle). +CAData takes precedence over CAFile
+ + + ## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile} @@ -1057,7 +953,7 @@ be invoked before default plugins, default plugins must be disabled and re-enabl PluginSet - PostFilter is a list of plugins that are invoked after filtering phase, no matter whether filtering succeeds or not. + PostFilter is a list of plugins that are invoked after filtering phase, but only when no feasible nodes were found for the pod. @@ -1119,6 +1015,14 @@ The scheduler call these plugins in order. Scheduler skips the rest of these plu +multiPoint [Required]
+PluginSet + + + MultiPoint is a simplified config section to enable plugins for all valid extension points. + + + @@ -1322,89 +1226,80 @@ UtilizationShapePoint represents single point of priority function shape. - -## `Policy` {#kubescheduler-config-k8s-io-v1-Policy} +## `ClientConnectionConfiguration` {#ClientConnectionConfiguration} +**Appears in:** -Policy describes a struct for a policy resource used in api. +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) + + +ClientConnectionConfiguration contains details for constructing a client. - - - - - + kubeconfig is the path to a KubeConfig file. - + acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the +default value of 'application/json'. This field will control all connections to the server used by a particular +client. - + contentType is the content type used when sending data to the server from this client. - + + + + + - - - - - + burst allows extra queries to accumulate when a client is exceeding its rate.
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1
kind
string		Policy
predicates [Required]
-[]PredicatePolicy +
kubeconfig [Required]
+string 		- Holds the information to configure the fit predicate functions
priorities [Required]
-[]PriorityPolicy +
acceptContentTypes [Required]
+string 		- Holds the information to configure the priority functions
extenders [Required]
-[]LegacyExtender +
contentType [Required]
+string 		- Holds the information to communicate with the extender(s)
hardPodAffinitySymmetricWeight [Required]
+
qps [Required]
+float32 +		 + qps controls the number of queries per second allowed for this connection.
burst [Required]
int32 		- RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule -corresponding to every RequiredDuringScheduling affinity rule. -HardPodAffinitySymmetricWeight represents the weight of implicit PreferredDuringScheduling affinity rule, in the range 1-100.
alwaysCheckAllPredicates [Required]
-bool -		 - When AlwaysCheckAllPredicates is set to true, scheduler checks all -the configured predicates even after one or more of them fails. -When the flag is set to false, scheduler skips checking the rest -of the predicates after it finds one predicate that failed.
- - -## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1-ExtenderManagedResource} +## `DebuggingConfiguration` {#DebuggingConfiguration} **Appears in:** -- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) - -- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) -ExtenderManagedResource describes the arguments of extended resources -managed by an extender. +DebuggingConfiguration holds configuration for Debugging related features. @@ -1412,41 +1307,37 @@ managed by an extender. - - - - - - + enableProfiling enables profiling via web interface host:port/debug/pprof/ + + + + +
FieldDescription
name [Required]
-string -		 - Name is the extended resource name.
ignoredByScheduler [Required]
+
enableProfiling [Required]
bool 		- IgnoredByScheduler indicates whether kube-scheduler should ignore this -resource when applying predicates.
enableContentionProfiling [Required]
+bool +		 + enableContentionProfiling enables lock contention profiling, if +enableProfiling is true.
- - -## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1-ExtenderTLSConfig} +## `FormatOptions` {#FormatOptions} **Appears in:** -- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) - -- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) +- [LoggingConfiguration](#LoggingConfiguration) -ExtenderTLSConfig contains settings to enable TLS with extender +FormatOptions contains options for the different logging formats. @@ -1454,91 +1345,28 @@ ExtenderTLSConfig contains settings to enable TLS with extender - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + [Experimental] JSON contains options for logging format "json".
FieldDescription
insecure [Required]
-bool +
json [Required]
+JSONOptions 		- Server should be accessed without verifying the TLS certificate. For testing only.
serverName [Required]
-string -		 - ServerName is passed to the server for SNI and is used in the client to check server -certificates against. If ServerName is empty, the hostname used to contact the -server is used.
certFile [Required]
-string -		 - Server requires TLS client certificate authentication
keyFile [Required]
-string -		 - Server requires TLS client certificate authentication
caFile [Required]
-string -		 - Trusted root certificates for server
certData [Required]
-[]byte -		 - CertData holds PEM-encoded bytes (typically read from a client certificate file). -CertData takes precedence over CertFile
keyData [Required]
-[]byte -		 - KeyData holds PEM-encoded bytes (typically read from a client certificate key file). -KeyData takes precedence over KeyFile
caData [Required]
-[]byte -		 - CAData holds PEM-encoded bytes (typically read from a root certificates bundle). -CAData takes precedence over CAFile
- - -## `LabelPreference` {#kubescheduler-config-k8s-io-v1-LabelPreference} +## `JSONOptions` {#JSONOptions} **Appears in:** -- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) +- [FormatOptions](#FormatOptions) -LabelPreference holds the parameters that are used to configure the corresponding priority function +JSONOptions contains options for logging format "json". @@ -1546,40 +1374,40 @@ LabelPreference holds the parameters that are used to configure the correspondin - - - - - - + [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. + + + + +
FieldDescription
label [Required]
-string -		 - Used to identify node "groups"
presence [Required]
+
splitStream [Required]
bool 		- This is a boolean flag -If true, higher priority is given to nodes that have the label -If false, higher priority is given to nodes that do not have the label
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.
- - -## `LabelsPresence` {#kubescheduler-config-k8s-io-v1-LabelsPresence} +## `LeaderElectionConfiguration` {#LeaderElectionConfiguration} **Appears in:** -- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) -LabelsPresence holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. +LeaderElectionConfiguration defines the configuration of leader election +clients for components that can run with leader election enabled. @@ -1587,40 +1415,92 @@ LabelsPresence holds the parameters that are used to configure the corresponding - - - - - - + leaderElect enables a leader election client to gain leadership +before executing the main loop. Enable this when running replicated +components for high availability. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
labels [Required]
-[]string -		 - The list of labels that identify node "groups" -All of the labels should be either present (or absent) for the node to be considered a fit for hosting the pod
presence [Required]
+
leaderElect [Required]
bool 		- The boolean flag that indicates whether the labels should be present or absent from the node
leaseDuration [Required]
+meta/v1.Duration +		 + leaseDuration is the duration that non-leader candidates will wait +after observing a leadership renewal until attempting to acquire +leadership of a led but unrenewed leader slot. This is effectively the +maximum duration that a leader can be stopped before it is replaced +by another candidate. This is only applicable if leader election is +enabled.
renewDeadline [Required]
+meta/v1.Duration +		 + renewDeadline is the interval between attempts by the acting master to +renew a leadership slot before it stops leading. This must be less +than or equal to the lease duration. This is only applicable if leader +election is enabled.
retryPeriod [Required]
+meta/v1.Duration +		 + retryPeriod is the duration the clients should wait between attempting +acquisition and renewal of a leadership. This is only applicable if +leader election is enabled.
resourceLock [Required]
+string +		 + resourceLock indicates the resource object type that will be used to lock +during leader election cycles.
resourceName [Required]
+string +		 + resourceName indicates the name of resource object that will be used to lock +during leader election cycles.
resourceNamespace [Required]
+string +		 + resourceName indicates the namespace of resource object that will be used to lock +during leader election cycles.
- - -## `LegacyExtender` {#kubescheduler-config-k8s-io-v1-LegacyExtender} +## `LoggingConfiguration` {#LoggingConfiguration} **Appears in:** -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) -LegacyExtender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, -it is assumed that the extender chose not to provide that extension. +LoggingConfiguration contains logging options +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. @@ -1628,481 +1508,77 @@ it is assumed that the extender chose not to provide that extension. - + Format Flag specifies the structure of log messages. +default value of format is `text` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Maximum number of seconds between log flushes. Ignored if the +selected logging backend writes log messages without buffering. - + + + + + + + + + + + [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). +Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`) - - - - - - + [Experimental] Options holds additional parameters that are specific +to the different logging formats. Only the options for the selected +format get used, but all of them get validated.
FieldDescription
urlPrefix [Required]
+
format [Required]
string 		- URLPrefix at which the extender is available
filterVerb [Required]
-string -		 - Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
preemptVerb [Required]
-string -		 - Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
prioritizeVerb [Required]
-string -		 - Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
weight [Required]
-int64 -		 - The numeric multiplier for the node scores that the prioritize call generates. -The weight should be a positive integer
bindVerb [Required]
-string -		 - Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender. -If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender -can implement this function.
enableHttps [Required]
-bool -		 - EnableHTTPS specifies whether https should be used to communicate with the extender
tlsConfig [Required]
-ExtenderTLSConfig -		 - TLSConfig specifies the transport layer security config
httpTimeout [Required]
+
flushFrequency [Required]
time.Duration 		- HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize -timeout is ignored, k8s/other extenders priorities are used to select the node.
nodeCacheCapable [Required]
+
verbosity [Required]
+uint32 +		 + Verbosity is the threshold that determines which log messages are +logged. Default is zero which logs only the most important +messages. Higher values enable additional messages. Error messages +are always logged.
vmodule [Required]
+VModuleConfiguration +		 + VModule overrides the verbosity threshold for individual files. +Only supported for "text" log format.
sanitization [Required]
bool 		- NodeCacheCapable specifies that the extender is capable of caching node information, -so the scheduler should only send minimal information about the eligible nodes -assuming that the extender already cached full details of all nodes in the cluster
managedResources
-[]ExtenderManagedResource +
options [Required]
+FormatOptions 		- ManagedResources is a list of extended resources that are managed by -this extender. -- A pod will be sent to the extender on the Filter, Prioritize and Bind - (if the extender is the binder) phases iff the pod requests at least - one of the extended resources in this list. If empty or unspecified, - all pods will be sent to this extender. -- If IgnoredByScheduler is set to true for a resource, kube-scheduler - will skip checking the resource in predicates.
ignorable [Required]
-bool -		 - Ignorable specifies if the extender is ignorable, i.e. scheduling should not -fail when the extender returns an error or is not reachable.
+ +## `VModuleConfiguration` {#VModuleConfiguration} - - -## `PredicateArgument` {#kubescheduler-config-k8s-io-v1-PredicateArgument} - - +(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`) **Appears in:** -- [PredicatePolicy](#kubescheduler-config-k8s-io-v1-PredicatePolicy) +- [LoggingConfiguration](#LoggingConfiguration) -PredicateArgument represents the arguments to configure predicate functions in scheduler policy configuration. -Only one of its members may be specified +VModuleConfiguration is a collection of individual file names or patterns +and the corresponding verbosity threshold. - - - - - - - - - - - - - - - - -
FieldDescription
serviceAffinity [Required]
-ServiceAffinity -		 - The predicate that provides affinity for pods belonging to a service -It uses a label to identify nodes that belong to the same "group"
labelsPresence [Required]
-LabelsPresence -		 - The predicate that checks whether a particular node has a certain label -defined or not, regardless of value
- - - -## `PredicatePolicy` {#kubescheduler-config-k8s-io-v1-PredicatePolicy} - - - - -**Appears in:** - -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) - - -PredicatePolicy describes a struct of a predicate policy. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Identifier of the predicate policy -For a custom predicate, the name can be user-defined -For the Kubernetes provided predicates, the name is the identifier of the pre-defined predicate
argument [Required]
-PredicateArgument -		 - Holds the parameters to configure the given predicate
- - - -## `PriorityArgument` {#kubescheduler-config-k8s-io-v1-PriorityArgument} - - - - -**Appears in:** - -- [PriorityPolicy](#kubescheduler-config-k8s-io-v1-PriorityPolicy) - - -PriorityArgument represents the arguments to configure priority functions in scheduler policy configuration. -Only one of its members may be specified - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
serviceAntiAffinity [Required]
-ServiceAntiAffinity -		 - The priority function that ensures a good spread (anti-affinity) for pods belonging to a service -It uses a label to identify nodes that belong to the same "group"
labelPreference [Required]
-LabelPreference -		 - The priority function that checks whether a particular node has a certain label -defined or not, regardless of value
requestedToCapacityRatioArguments [Required]
-RequestedToCapacityRatioArguments -		 - The RequestedToCapacityRatio priority function is parametrized with function shape.
- - - -## `PriorityPolicy` {#kubescheduler-config-k8s-io-v1-PriorityPolicy} - - - - -**Appears in:** - -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) - - -PriorityPolicy describes a struct of a priority policy. - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Identifier of the priority policy -For a custom priority, the name can be user-defined -For the Kubernetes provided priority functions, the name is the identifier of the pre-defined priority function
weight [Required]
-int64 -		 - The numeric multiplier for the node scores that the priority function generates -The weight should be non-zero and can be a positive or a negative integer
argument [Required]
-PriorityArgument -		 - Holds the parameters to configure the given priority function
- - - -## `RequestedToCapacityRatioArguments` {#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments} - - - - -**Appears in:** - -- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) - - -RequestedToCapacityRatioArguments holds arguments specific to RequestedToCapacityRatio priority function. - - - - - - - - - - - - - - - - - - -
FieldDescription
shape [Required]
-[]UtilizationShapePoint -		 - Array of point defining priority function shape.
resources [Required]
-[]ResourceSpec -		 - No description provided. -
- - - -## `ResourceSpec` {#kubescheduler-config-k8s-io-v1-ResourceSpec} - - - - -**Appears in:** - -- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) - - -ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Name of the resource to be managed by RequestedToCapacityRatio function.
weight [Required]
-int64 -		 - Weight of the resource.
- - - -## `ServiceAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAffinity} - - - - -**Appears in:** - -- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) - - -ServiceAffinity holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. - - - - - - - - - - - - - -
FieldDescription
labels [Required]
-[]string -		 - The list of labels that identify node "groups" -All of the labels should match for the node to be considered a fit for hosting the pod
- - - -## `ServiceAntiAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAntiAffinity} - - - - -**Appears in:** - -- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) - - -ServiceAntiAffinity holds the parameters that are used to configure the corresponding priority function - - - - - - - - - - - - - -
FieldDescription
label [Required]
-string -		 - Used to identify node "groups"
- - - -## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1-UtilizationShapePoint} - - - - -**Appears in:** - -- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) - - -UtilizationShapePoint represents single point of priority function shape. - - - - - - - - - - - - - - - - - - -
FieldDescription
utilization [Required]
-int32 -		 - Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
score [Required]
-int32 -		 - Score assigned to given utilization (y axis). Valid values are 0 to 10.
- - diff --git a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md new file mode 100644 index 0000000000..f9ca9e5bd8 --- /dev/null +++ b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md @@ -0,0 +1,1587 @@ +--- +title: kube-scheduler Configuration (v1beta3) +content_type: tool-reference +package: kubescheduler.config.k8s.io/v1beta3 +auto_generated: true +--- + + +## Resource Types + + +- [DefaultPreemptionArgs](#kubescheduler-config-k8s-io-v1beta3-DefaultPreemptionArgs) +- [InterPodAffinityArgs](#kubescheduler-config-k8s-io-v1beta3-InterPodAffinityArgs) +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) +- [NodeAffinityArgs](#kubescheduler-config-k8s-io-v1beta3-NodeAffinityArgs) +- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs) +- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs) +- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs) +- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs) + + + + +## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1beta3-DefaultPreemptionArgs} + + + + + +DefaultPreemptionArgs holds arguments used to configure the +DefaultPreemption plugin. + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		DefaultPreemptionArgs
minCandidateNodesPercentage [Required]
+int32 +		 + MinCandidateNodesPercentage is the minimum number of candidates to +shortlist when dry running preemption as a percentage of number of nodes. +Must be in the range [0, 100]. Defaults to 10% of the cluster size if +unspecified.
minCandidateNodesAbsolute [Required]
+int32 +		 + MinCandidateNodesAbsolute is the absolute minimum number of candidates to +shortlist. The likely number of candidates enumerated for dry running +preemption is given by the formula: +numCandidates = max(numNodes ∗ minCandidateNodesPercentage, minCandidateNodesAbsolute) +We say "likely" because there are other factors such as PDB violations +that play a role in the number of candidates shortlisted. Must be at least +0 nodes. Defaults to 100 nodes if unspecified.
+ + + +## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-InterPodAffinityArgs} + + + + + +InterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin. + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		InterPodAffinityArgs
hardPodAffinityWeight [Required]
+int32 +		 + HardPodAffinityWeight is the scoring weight for existing pods with a +matching hard affinity to the incoming pod.
+ + + +## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration} + + + + + +KubeSchedulerConfiguration configures a scheduler + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		KubeSchedulerConfiguration
parallelism [Required]
+int32 +		 + Parallelism defines the amount of parallelism in algorithms for scheduling a Pods. Must be greater than 0. Defaults to 16
leaderElection [Required]
+LeaderElectionConfiguration +		 + LeaderElection defines the configuration of leader election client.
clientConnection [Required]
+ClientConnectionConfiguration +		 + ClientConnection specifies the kubeconfig file and client connection +settings for the proxy server to use when communicating with the apiserver.
DebuggingConfiguration [Required]
+DebuggingConfiguration +		(Members of DebuggingConfiguration are embedded into this type.) + DebuggingConfiguration holds configuration for Debugging related features +TODO: We might wanna make this a substruct like Debugging componentbaseconfigv1alpha1.DebuggingConfiguration
percentageOfNodesToScore [Required]
+int32 +		 + PercentageOfNodesToScore is the percentage of all nodes that once found feasible +for running a pod, the scheduler stops its search for more feasible nodes in +the cluster. This helps improve scheduler's performance. Scheduler always tries to find +at least "minFeasibleNodesToFind" feasible nodes no matter what the value of this flag is. +Example: if the cluster size is 500 nodes and the value of this flag is 30, +then scheduler stops finding further feasible nodes once it finds 150 feasible ones. +When the value is 0, default percentage (5%--50% based on the size of the cluster) of the +nodes will be scored.
podInitialBackoffSeconds [Required]
+int64 +		 + PodInitialBackoffSeconds is the initial backoff for unschedulable pods. +If specified, it must be greater than 0. If this value is null, the default value (1s) +will be used.
podMaxBackoffSeconds [Required]
+int64 +		 + PodMaxBackoffSeconds is the max backoff for unschedulable pods. +If specified, it must be greater than podInitialBackoffSeconds. If this value is null, +the default value (10s) will be used.
profiles [Required]
+[]KubeSchedulerProfile +		 + Profiles are scheduling profiles that kube-scheduler supports. Pods can +choose to be scheduled under a particular profile by setting its associated +scheduler name. Pods that don't specify any scheduler name are scheduled +with the "default-scheduler" profile, if present here.
extenders [Required]
+[]Extender +		 + Extenders are the list of scheduler extenders, each holding the values of how to communicate +with the extender. These extenders are shared by all scheduler profiles.
+ + + +## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeAffinityArgs} + + + + + +NodeAffinityArgs holds arguments to configure the NodeAffinity plugin. + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		NodeAffinityArgs
addedAffinity
+core/v1.NodeAffinity +		 + AddedAffinity is applied to all Pods additionally to the NodeAffinity +specified in the PodSpec. That is, Nodes need to satisfy AddedAffinity +AND .spec.NodeAffinity. AddedAffinity is empty by default (all Nodes +match). +When AddedAffinity is used, some Pods with affinity requirements that match +a specific Node (such as Daemonset Pods) might remain unschedulable.
+ + + +## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs} + + + + + +NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResourcesBalancedAllocation plugin. + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		NodeResourcesBalancedAllocationArgs
resources [Required]
+[]ResourceSpec +		 + Resources to be managed, the default is "cpu" and "memory" if not specified.
+ + + +## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs} + + + + + +NodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		NodeResourcesFitArgs
ignoredResources [Required]
+[]string +		 + IgnoredResources is the list of resources that NodeResources fit filter +should ignore. This doesn't apply to scoring.
ignoredResourceGroups [Required]
+[]string +		 + IgnoredResourceGroups defines the list of resource groups that NodeResources fit filter should ignore. +e.g. if group is ["example.com"], it will ignore all resource names that begin +with "example.com", such as "example.com/aaa" and "example.com/bbb". +A resource group name can't contain '/'. This doesn't apply to scoring.
scoringStrategy [Required]
+ScoringStrategy +		 + ScoringStrategy selects the node resource scoring strategy. +The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.
+ + + +## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs} + + + + + +PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin. + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		PodTopologySpreadArgs
defaultConstraints
+[]core/v1.TopologySpreadConstraint +		 + DefaultConstraints defines topology spread constraints to be applied to +Pods that don't define any in `pod.spec.topologySpreadConstraints`. +`.defaultConstraints[∗].labelSelectors` must be empty, as they are +deduced from the Pod's membership to Services, ReplicationControllers, +ReplicaSets or StatefulSets. +When not empty, .defaultingType must be "List".
defaultingType
+PodTopologySpreadConstraintsDefaulting +		 + DefaultingType determines how .defaultConstraints are deduced. Can be one +of "System" or "List". + +- "System": Use kubernetes defined constraints that spread Pods among + Nodes and Zones. +- "List": Use constraints defined in .defaultConstraints. + +Defaults to "List" if feature gate DefaultPodTopologySpread is disabled +and to "System" if enabled.
+ + + +## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs} + + + + + +VolumeBindingArgs holds arguments used to configure the VolumeBinding plugin. + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta3
kind
string		VolumeBindingArgs
bindTimeoutSeconds [Required]
+int64 +		 + BindTimeoutSeconds is the timeout in seconds in volume binding operation. +Value must be non-negative integer. The value zero indicates no waiting. +If this value is nil, the default value (600) will be used.
shape
+[]UtilizationShapePoint +		 + Shape specifies the points defining the score function shape, which is +used to score nodes based on the utilization of statically provisioned +PVs. The utilization is calculated by dividing the total requested +storage of the pod by the total capacity of feasible PVs on each node. +Each point contains utilization (ranges from 0 to 100) and its +associated score (ranges from 0 to 10). You can turn the priority by +specifying different scores for different utilization numbers. +The default shape points are: +1) 0 for 0 utilization +2) 10 for 100 utilization +All points must be sorted in increasing order by utilization.
+ + + +## `Extender` {#kubescheduler-config-k8s-io-v1beta3-Extender} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + + +Extender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, +it is assumed that the extender chose not to provide that extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
urlPrefix [Required]
+string +		 + URLPrefix at which the extender is available
filterVerb [Required]
+string +		 + Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
preemptVerb [Required]
+string +		 + Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
prioritizeVerb [Required]
+string +		 + Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
weight [Required]
+int64 +		 + The numeric multiplier for the node scores that the prioritize call generates. +The weight should be a positive integer
bindVerb [Required]
+string +		 + Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender. +If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender +can implement this function.
enableHTTPS [Required]
+bool +		 + EnableHTTPS specifies whether https should be used to communicate with the extender
tlsConfig [Required]
+ExtenderTLSConfig +		 + TLSConfig specifies the transport layer security config
httpTimeout [Required]
+meta/v1.Duration +		 + HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize +timeout is ignored, k8s/other extenders priorities are used to select the node.
nodeCacheCapable [Required]
+bool +		 + NodeCacheCapable specifies that the extender is capable of caching node information, +so the scheduler should only send minimal information about the eligible nodes +assuming that the extender already cached full details of all nodes in the cluster
managedResources
+[]ExtenderManagedResource +		 + ManagedResources is a list of extended resources that are managed by +this extender. +- A pod will be sent to the extender on the Filter, Prioritize and Bind + (if the extender is the binder) phases iff the pod requests at least + one of the extended resources in this list. If empty or unspecified, + all pods will be sent to this extender. +- If IgnoredByScheduler is set to true for a resource, kube-scheduler + will skip checking the resource in predicates.
ignorable [Required]
+bool +		 + Ignorable specifies if the extender is ignorable, i.e. scheduling should not +fail when the extender returns an error or is not reachable.
+ + + +## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta3-ExtenderManagedResource} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender) + + +ExtenderManagedResource describes the arguments of extended resources +managed by an extender. + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 + Name is the extended resource name.
ignoredByScheduler [Required]
+bool +		 + IgnoredByScheduler indicates whether kube-scheduler should ignore this +resource when applying predicates.
+ + + +## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta3-ExtenderTLSConfig} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender) + + +ExtenderTLSConfig contains settings to enable TLS with extender + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
insecure [Required]
+bool +		 + Server should be accessed without verifying the TLS certificate. For testing only.
serverName [Required]
+string +		 + ServerName is passed to the server for SNI and is used in the client to check server +certificates against. If ServerName is empty, the hostname used to contact the +server is used.
certFile [Required]
+string +		 + Server requires TLS client certificate authentication
keyFile [Required]
+string +		 + Server requires TLS client certificate authentication
caFile [Required]
+string +		 + Trusted root certificates for server
certData [Required]
+[]byte +		 + CertData holds PEM-encoded bytes (typically read from a client certificate file). +CertData takes precedence over CertFile
keyData [Required]
+[]byte +		 + KeyData holds PEM-encoded bytes (typically read from a client certificate key file). +KeyData takes precedence over KeyFile
caData [Required]
+[]byte +		 + CAData holds PEM-encoded bytes (typically read from a root certificates bundle). +CAData takes precedence over CAFile
+ + + +## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + + +KubeSchedulerProfile is a scheduling profile. + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
schedulerName [Required]
+string +		 + SchedulerName is the name of the scheduler associated to this profile. +If SchedulerName matches with the pod's "spec.schedulerName", then the pod +is scheduled with this profile.
plugins [Required]
+Plugins +		 + Plugins specify the set of plugins that should be enabled or disabled. +Enabled plugins are the ones that should be enabled in addition to the +default plugins. Disabled plugins are any of the default plugins that +should be disabled. +When no enabled or disabled plugin is specified for an extension point, +default plugins for that extension point will be used if there is any. +If a QueueSort plugin is specified, the same QueueSort Plugin and +PluginConfig must be specified for all profiles.
pluginConfig [Required]
+[]PluginConfig +		 + PluginConfig is an optional set of custom plugin arguments for each plugin. +Omitting config args for a plugin is equivalent to using the default config +for that plugin.
+ + + +## `Plugin` {#kubescheduler-config-k8s-io-v1beta3-Plugin} + + + + +**Appears in:** + +- [PluginSet](#kubescheduler-config-k8s-io-v1beta3-PluginSet) + + +Plugin specifies a plugin name and its weight when applicable. Weight is used only for Score plugins. + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 + Name defines the name of plugin
weight [Required]
+int32 +		 + Weight defines the weight of plugin, only used for Score plugins.
+ + + +## `PluginConfig` {#kubescheduler-config-k8s-io-v1beta3-PluginConfig} + + + + +**Appears in:** + +- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile) + + +PluginConfig specifies arguments that should be passed to a plugin at the time of initialization. +A plugin that is invoked at multiple extension points is initialized once. Args can have arbitrary structure. +It is up to the plugin to process these Args. + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 + Name defines the name of plugin being configured
args [Required]
+k8s.io/apimachinery/pkg/runtime.RawExtension +		 + Args defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.
+ + + +## `PluginSet` {#kubescheduler-config-k8s-io-v1beta3-PluginSet} + + + + +**Appears in:** + +- [Plugins](#kubescheduler-config-k8s-io-v1beta3-Plugins) + + +PluginSet specifies enabled and disabled plugins for an extension point. +If an array is empty, missing, or nil, default plugins at that extension point will be used. + + + + + + + + + + + + + + + + + + +
FieldDescription
enabled [Required]
+[]Plugin +		 + Enabled specifies plugins that should be enabled in addition to default plugins. +If the default plugin is also configured in the scheduler config file, the weight of plugin will +be overridden accordingly. +These are called after default plugins and in the same order specified here.
disabled [Required]
+[]Plugin +		 + Disabled specifies default plugins that should be disabled. +When all default plugins need to be disabled, an array containing only one "∗" should be provided.
+ + + +## `Plugins` {#kubescheduler-config-k8s-io-v1beta3-Plugins} + + + + +**Appears in:** + +- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile) + + +Plugins include multiple extension points. When specified, the list of plugins for +a particular extension point are the only ones enabled. If an extension point is +omitted from the config, then the default set of plugins is used for that extension point. +Enabled plugins are called in the order specified here, after default plugins. If they need to +be invoked before default plugins, default plugins must be disabled and re-enabled here in desired order. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
queueSort [Required]
+PluginSet +		 + QueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue.
preFilter [Required]
+PluginSet +		 + PreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.
filter [Required]
+PluginSet +		 + Filter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod.
postFilter [Required]
+PluginSet +		 + PostFilter is a list of plugins that are invoked after filtering phase, but only when no feasible nodes were found for the pod.
preScore [Required]
+PluginSet +		 + PreScore is a list of plugins that are invoked before scoring.
score [Required]
+PluginSet +		 + Score is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase.
reserve [Required]
+PluginSet +		 + Reserve is a list of plugins invoked when reserving/unreserving resources +after a node is assigned to run the pod.
permit [Required]
+PluginSet +		 + Permit is a list of plugins that control binding of a Pod. These plugins can prevent or delay binding of a Pod.
preBind [Required]
+PluginSet +		 + PreBind is a list of plugins that should be invoked before a pod is bound.
bind [Required]
+PluginSet +		 + Bind is a list of plugins that should be invoked at "Bind" extension point of the scheduling framework. +The scheduler call these plugins in order. Scheduler skips the rest of these plugins as soon as one returns success.
postBind [Required]
+PluginSet +		 + PostBind is a list of plugins that should be invoked after a pod is successfully bound.
multiPoint [Required]
+PluginSet +		 + MultiPoint is a simplified config section to enable plugins for all valid extension points. +Plugins enabled through MultiPoint will automatically register for every individual extension +point the plugin has implemented. Disabling a plugin through MultiPoint disables that behavior. +The same is true for disabling "∗" through MultiPoint (no default plugins will be automatically registered). +Plugins can still be disabled through their individual extension points. + +In terms of precedence, plugin config follows this basic hierarchy + 1. Specific extension points + 2. Explicitly configured MultiPoint plugins + 3. The set of default plugins, as MultiPoint plugins +This implies that a higher precedence plugin will run first and overwrite any settings within MultiPoint. +Explicitly user-configured plugins also take a higher precedence over default plugins. +Within this hierarchy, an Enabled setting takes precedence over Disabled. For example, if a plugin is +set in both `multiPoint.Enabled` and `multiPoint.Disabled`, the plugin will be enabled. Similarly, +including `multiPoint.Disabled = '∗'` and `multiPoint.Enabled = pluginA` will still register that specific +plugin through MultiPoint. This follows the same behavior as all other extension point configurations.
+ + + +## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadConstraintsDefaulting} + +(Alias of `string`) + + +**Appears in:** + +- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs) + + +PodTopologySpreadConstraintsDefaulting defines how to set default constraints +for the PodTopologySpread plugin. + + + + + +## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam} + + + + +**Appears in:** + +- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy) + + +RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters + + + + + + + + + + + + + +
FieldDescription
shape [Required]
+[]UtilizationShapePoint +		 + Shape is a list of points defining the scoring function shape.
+ + + +## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta3-ResourceSpec} + + + + +**Appears in:** + +- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs) + +- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy) + + +ResourceSpec represents a single resource. + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 + Name of the resource.
weight [Required]
+int64 +		 + Weight of the resource.
+ + + +## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy} + + + + +**Appears in:** + +- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs) + + +ScoringStrategy define ScoringStrategyType for node resource plugin + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
type [Required]
+ScoringStrategyType +		 + Type selects which strategy to run.
resources [Required]
+[]ResourceSpec +		 + Resources to consider when scoring. +The default resource set includes "cpu" and "memory" with an equal weight. +Allowed weights go from 1 to 100. +Weight defaults to 1 if not specified or explicitly set to 0.
requestedToCapacityRatio [Required]
+RequestedToCapacityRatioParam +		 + Arguments specific to RequestedToCapacityRatio strategy.
+ + + +## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategyType} + +(Alias of `string`) + + +**Appears in:** + +- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy) + + +ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin. + + + + + +## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta3-UtilizationShapePoint} + + + + +**Appears in:** + +- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs) + +- [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam) + + +UtilizationShapePoint represents single point of priority function shape. + + + + + + + + + + + + + + + + + + +
FieldDescription
utilization [Required]
+int32 +		 + Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
score [Required]
+int32 +		 + Score assigned to given utilization (y axis). Valid values are 0 to 10.
+ + + + + +## `ClientConnectionConfiguration` {#ClientConnectionConfiguration} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + + +ClientConnectionConfiguration contains details for constructing a client. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
kubeconfig [Required]
+string +		 + kubeconfig is the path to a KubeConfig file.
acceptContentTypes [Required]
+string +		 + acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the +default value of 'application/json'. This field will control all connections to the server used by a particular +client.
contentType [Required]
+string +		 + contentType is the content type used when sending data to the server from this client.
qps [Required]
+float32 +		 + qps controls the number of queries per second allowed for this connection.
burst [Required]
+int32 +		 + burst allows extra queries to accumulate when a client is exceeding its rate.
+ +## `DebuggingConfiguration` {#DebuggingConfiguration} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + + +DebuggingConfiguration holds configuration for Debugging related features. + + + + + + + + + + + + + + + + + + +
FieldDescription
enableProfiling [Required]
+bool +		 + enableProfiling enables profiling via web interface host:port/debug/pprof/
enableContentionProfiling [Required]
+bool +		 + enableContentionProfiling enables lock contention profiling, if +enableProfiling is true.
+ +## `FormatOptions` {#FormatOptions} + + + + +**Appears in:** + +- [LoggingConfiguration](#LoggingConfiguration) + + +FormatOptions contains options for the different logging formats. + + + + + + + + + + + + + +
FieldDescription
json [Required]
+JSONOptions +		 + [Experimental] JSON contains options for logging format "json".
+ +## `JSONOptions` {#JSONOptions} + + + + +**Appears in:** + +- [FormatOptions](#FormatOptions) + + +JSONOptions contains options for logging format "json". + + + + + + + + + + + + + + + + + + +
FieldDescription
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.
+ +## `LeaderElectionConfiguration` {#LeaderElectionConfiguration} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) + + +LeaderElectionConfiguration defines the configuration of leader election +clients for components that can run with leader election enabled. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
leaderElect [Required]
+bool +		 + leaderElect enables a leader election client to gain leadership +before executing the main loop. Enable this when running replicated +components for high availability.
leaseDuration [Required]
+meta/v1.Duration +		 + leaseDuration is the duration that non-leader candidates will wait +after observing a leadership renewal until attempting to acquire +leadership of a led but unrenewed leader slot. This is effectively the +maximum duration that a leader can be stopped before it is replaced +by another candidate. This is only applicable if leader election is +enabled.
renewDeadline [Required]
+meta/v1.Duration +		 + renewDeadline is the interval between attempts by the acting master to +renew a leadership slot before it stops leading. This must be less +than or equal to the lease duration. This is only applicable if leader +election is enabled.
retryPeriod [Required]
+meta/v1.Duration +		 + retryPeriod is the duration the clients should wait between attempting +acquisition and renewal of a leadership. This is only applicable if +leader election is enabled.
resourceLock [Required]
+string +		 + resourceLock indicates the resource object type that will be used to lock +during leader election cycles.
resourceName [Required]
+string +		 + resourceName indicates the name of resource object that will be used to lock +during leader election cycles.
resourceNamespace [Required]
+string +		 + resourceName indicates the namespace of resource object that will be used to lock +during leader election cycles.
+ +## `LoggingConfiguration` {#LoggingConfiguration} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +LoggingConfiguration contains logging options +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
format [Required]
+string +		 + Format Flag specifies the structure of log messages. +default value of format is `text`
flushFrequency [Required]
+time.Duration +		 + Maximum number of seconds between log flushes. Ignored if the +selected logging backend writes log messages without buffering.
verbosity [Required]
+uint32 +		 + Verbosity is the threshold that determines which log messages are +logged. Default is zero which logs only the most important +messages. Higher values enable additional messages. Error messages +are always logged.
vmodule [Required]
+VModuleConfiguration +		 + VModule overrides the verbosity threshold for individual files. +Only supported for "text" log format.
sanitization [Required]
+bool +		 + [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). +Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
options [Required]
+FormatOptions +		 + [Experimental] Options holds additional parameters that are specific +to the different logging formats. Only the options for the selected +format get used, but all of them get validated.
+ +## `VModuleConfiguration` {#VModuleConfiguration} + +(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`) + + +**Appears in:** + +- [LoggingConfiguration](#LoggingConfiguration) + + +VModuleConfiguration is a collection of individual file names or patterns +and the corresponding verbosity threshold. + + diff --git a/content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md b/content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md index 8b6c0a9a24..e694f7ecbc 100644 --- a/content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md +++ b/content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md @@ -89,7 +89,7 @@ of the predicates after it finds one predicate that failed. **Appears in:** -- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) +- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) - [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) @@ -132,7 +132,7 @@ resource when applying predicates. **Appears in:** -- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) +- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) - [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) diff --git a/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md b/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md index 5f73e8b3a8..602f646e84 100644 --- a/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md +++ b/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md @@ -4,59 +4,58 @@ content_type: tool-reference package: kubeadm.k8s.io/v1beta3 auto_generated: true --- +## Overview + Package v1beta3 defines the v1beta3 version of the kubeadm configuration file format. This version improves on the v1beta2 format by fixing some minor issues and adding a few new fields. A list of changes since v1beta2: -- The deprecated `ClusterConfiguration.useHyperKubeImage` field has been removed. +- The deprecated "ClusterConfiguration.useHyperKubeImage" field has been removed. Kubeadm no longer supports the hyperkube image. -- The `ClusterConfiguration.dns.type` field has been removed since CoreDNS is the only supported +- The "ClusterConfiguration.DNS.Type" field has been removed since CoreDNS is the only supported DNS server type by kubeadm. - Include "datapolicy" tags on the fields that hold secrets. This would result in the field values to be omitted when API structures are printed with klog. -- Add `InitConfiguration.skipPhases`, `JoinConfiguration.skipPhases` to allow skipping +- Add "InitConfiguration.SkipPhases", "JoinConfiguration.SkipPhases" to allow skipping a list of phases during kubeadm init/join command execution. -- Add `InitConfiguration.nodeRegistration.imagePullPolicy" and - `JoinConfiguration.nodeRegistration.imagePullPolicy` to allow specifying - the images pull policy during kubeadm "init" and "join". The value must be - one of "Always", "Never" or "IfNotPresent". "IfNotPresent" is the default, - which has been the existing behavior prior to this addition. -- Add `InitConfiguration.patches.directory`, `JoinConfiguration.patches.directory` - to allow the user to configure a directory from which to take patches for - components deployed by kubeadm. -- Move the `BootstrapToken∗` API and related utilities out of the "kubeadm" API group - to a new group "bootstraptoken". The kubeadm API version v1beta3 no longer contains - the `BootstrapToken∗` structures. +- Add "InitConfiguration.NodeRegistration.ImagePullPolicy" and "JoinConfiguration.NodeRegistration.ImagePullPolicy" + to allow specifying the images pull policy during kubeadm "init" and "join". + The value must be one of "Always", "Never" or "IfNotPresent". + "IfNotPresent" is the default, which has been the existing behavior prior to this addition. +- Add "InitConfiguration.Patches.Directory", "JoinConfiguration.Patches.Directory" to allow + the user to configure a directory from which to take patches for components deployed by kubeadm. +- Move the BootstrapToken∗ API and related utilities out of the "kubeadm" API group to a new group + "bootstraptoken". The kubeadm API version v1beta3 no longer contains the BootstrapToken∗ structures. -## Migration from old kubeadm config versions +Migration from old kubeadm config versions -- kubeadm v1.15.x and newer can be used to migrate from the v1beta1 to v1beta2. -- kubeadm v1.22.x no longer supports v1beta1 and older APIs, but can be used to migrate v1beta2 to v1beta3. +- kubeadm v1.15.x and newer can be used to migrate from v1beta1 to v1beta2. +- kubeadm v1.22.x and newer no longer support v1beta1 and older APIs, but can be used to migrate v1beta2 to v1beta3. ## Basics -The preferred way to configure kubeadm is to pass an YAML configuration file with the --config option. Some of the +The preferred way to configure kubeadm is to pass an YAML configuration file with the `--config` option. Some of the configuration options defined in the kubeadm config file are also available as command line flags, but only the most common/simple use case are supported with this approach. -A kubeadm config file could contain multiple configuration types separated using three dashes (“---”). +A kubeadm config file could contain multiple configuration types separated using three dashes (`---`). kubeadm supports the following configuration types: ```yaml apiVersion: kubeadm.k8s.io/v1beta3 kind: InitConfiguration ---- + apiVersion: kubeadm.k8s.io/v1beta3 kind: ClusterConfiguration ---- + apiVersion: kubelet.config.k8s.io/v1beta1 kind: KubeletConfiguration ---- + apiVersion: kubeproxy.config.k8s.io/v1alpha1 kind: KubeProxyConfiguration ---- + apiVersion: kubeadm.k8s.io/v1beta3 kind: JoinConfiguration ``` @@ -69,11 +68,12 @@ kubeadm config print join-defaults ``` The list of configuration types that must be included in a configuration file depends by the action you are -performing (init or join) and by the configuration options you are going to use (defaults or advanced customization). +performing (`init` or `join`) and by the configuration options you are going to use (defaults or advanced +customization). If some configuration types are not provided, or provided only partially, kubeadm will use default values; defaults provided by kubeadm includes also enforcing consistency of values across components when required (e.g. -cluster-cidr flag on controller manager and clusterCIDR on kube-proxy). +`--cluster-cidr` flag on controller manager and `clusterCIDR` on kube-proxy). Users are always allowed to override default values, with the only exception of a small subset of setting with relevance for security (e.g. enforce authorization-mode Node and RBAC on api server) @@ -97,8 +97,8 @@ nodeRegistration: ``` The InitConfiguration type should be used to configure runtime settings, that in case of kubeadm init -are the configuration of the bootstrap token and all the setting which are specific to the node where kubeadm -is executed, including: +are the configuration of the bootstrap token and all the setting which are specific to the node where +kubeadm is executed, including: - NodeRegistration, that holds fields that relate to registering the new node to the cluster; use it to customize the node name, the CRI socket to use or any other settings that should apply to this @@ -107,13 +107,13 @@ is executed, including: - LocalAPIEndpoint, that represents the endpoint of the instance of the API server to be deployed on this node; use it e.g. to customize the API server advertise address. - ```yaml + ``` apiVersion: kubeadm.k8s.io/v1beta3 kind: ClusterConfiguration networking: - ... + ... etcd: - ... + ... apiServer: extraArgs: ... @@ -126,9 +126,11 @@ The ClusterConfiguration type should be used to configure cluster-wide settings, including settings for: - Networking, that holds configuration for the networking topology of the cluster; use it e.g. to customize - pod subnet or services subnet. + Pod subnet or services subnet. + - Etcd configurations; use it e.g. to customize the local etcd or to configure the API server for using an external etcd cluster. + - kube-apiserver, kube-scheduler, kube-controller-manager configurations; use it to customize control-plane components by adding customized setting or overriding kubeadm default settings. @@ -138,59 +140,60 @@ including settings for: ... ``` -The KubeProxyConfiguration type should be used to change the configuration passed to kube-proxy instances deployed -in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults. +The KubeProxyConfiguration type should be used to change the configuration passed to kube-proxy instances +deployed in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults. -See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ or https://godoc.org/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration -for kube proxy official documentation. +See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ or +https://godoc.org/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration +for kube-proxy official documentation. ```yaml apiVersion: kubelet.config.k8s.io/v1beta1 kind: KubeletConfiguration -... + ... ``` The KubeletConfiguration type should be used to change the configurations that will be passed to all kubelet instances deployed in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults. -See https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/ or https://godoc.org/k8s.io/kubelet/config/v1beta1#KubeletConfiguration +See https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/ or +https://godoc.org/k8s.io/kubelet/config/v1beta1#KubeletConfiguration for kubelet official documentation. Here is a fully populated example of a single YAML file containing multiple configuration types to be used during a `kubeadm init` run. -```yaml apiVersion: kubeadm.k8s.io/v1beta3 kind: InitConfiguration bootstrapTokens: - - token: "9a08jv.c0izixklcxtmnze7" - description: "kubeadm bootstrap token" - ttl: "24h" - - token: "783bde.3f89s0fje9f38fhf" - description: "another bootstrap token" - usages: - - authentication - - signing - groups: - - system:bootstrappers:kubeadm:default-node-token +- token: "9a08jv.c0izixklcxtmnze7" + description: "kubeadm bootstrap token" + ttl: "24h" +- token: "783bde.3f89s0fje9f38fhf" + description: "another bootstrap token" + usages: + - authentication + - signing + groups: + - system:bootstrappers:kubeadm:default-node-token nodeRegistration: name: "ec2-10-100-0-1" criSocket: "/var/run/dockershim.sock" taints: - - key: "kubeadmNode" - value: "master" - effect: "NoSchedule" + - key: "kubeadmNode" + value: "master" + effect: "NoSchedule" kubeletExtraArgs: v: 4 - ignorePreflightErrors: - - IsPrivilegedUser - imagePullPolicy: "IfNotPresent" +ignorePreflightErrors: +- IsPrivilegedUser + imagePullPolicy: "IfNotPresent" localAPIEndpoint: advertiseAddress: "10.100.0.1" bindPort: 6443 certificateKey: "e6a2eb8581237ab72a4f494f30285ec12a9694d750b9785706a83bfcbbbd2204" -skipPhases: - - add/kube-proxy + skipPhases: + - addon/kube-proxy --- apiVersion: kubeadm.k8s.io/v1beta3 kind: ClusterConfiguration @@ -203,9 +206,9 @@ etcd: extraArgs: listen-client-urls: "http://10.100.0.1:2379" serverCertSANs: - - "ec2-10-100-0-1.compute-1.amazonaws.com" + - "ec2-10-100-0-1.compute-1.amazonaws.com" peerCertSANs: - - "10.100.0.1" + - "10.100.0.1" # external: # endpoints: # - "10.100.0.1:2379" @@ -214,42 +217,42 @@ etcd: # certFile: "/etcd/kubernetes/pki/etcd/etcd.crt" # keyFile: "/etcd/kubernetes/pki/etcd/etcd.key" networking: - serviceSubnet: "10.96.0.0/12" - podSubnet: "10.100.0.1/24" + serviceSubnet: "10.96.0.0/16" + podSubnet: "10.244.0.0/24" dnsDomain: "cluster.local" -kubernetesVersion: "v1.12.0" +kubernetesVersion: "v1.21.0" controlPlaneEndpoint: "10.100.0.1:6443" apiServer: extraArgs: authorization-mode: "Node,RBAC" extraVolumes: - - name: "some-volume" - hostPath: "/etc/some-path" - mountPath: "/etc/some-pod-path" - readOnly: false - pathType: File + - name: "some-volume" + hostPath: "/etc/some-path" + mountPath: "/etc/some-pod-path" + readOnly: false + pathType: File certSANs: - - "10.100.1.1" - - "ec2-10-100-0-1.compute-1.amazonaws.com" + - "10.100.1.1" + - "ec2-10-100-0-1.compute-1.amazonaws.com" timeoutForControlPlane: 4m0s controllerManager: extraArgs: "node-cidr-mask-size": "20" extraVolumes: - - name: "some-volume" - hostPath: "/etc/some-path" - mountPath: "/etc/some-pod-path" - readOnly: false - pathType: File + - name: "some-volume" + hostPath: "/etc/some-path" + mountPath: "/etc/some-pod-path" + readOnly: false + pathType: File scheduler: extraArgs: address: "10.100.0.1" extraVolumes: - - name: "some-volume" - hostPath: "/etc/some-path" - mountPath: "/etc/some-pod-path" - readOnly: false - pathType: File + - name: "some-volume" + hostPath: "/etc/some-path" + mountPath: "/etc/some-pod-path" + readOnly: false + pathType: File certificatesDir: "/etc/kubernetes/pki" imageRepository: "k8s.gcr.io" clusterName: "example-cluster" @@ -261,27 +264,26 @@ kind: KubeletConfiguration apiVersion: kubeproxy.config.k8s.io/v1alpha1 kind: KubeProxyConfiguration # kube-proxy specific options here -``` ## Kubeadm join configuration types -When executing kubeadm join with the `--config` option, the JoinConfiguration type should be provided. +When executing `kubeadm join` with the `--config` option, the JoinConfiguration type should be provided. ```yaml apiVersion: kubeadm.k8s.io/v1beta3 kind: JoinConfiguration -... + ... ``` -The JoinConfiguration type should be used to configure runtime settings, that in case of kubeadm join +The JoinConfiguration type should be used to configure runtime settings, that in case of `kubeadm join` are the discovery method used for accessing the cluster info and all the setting which are specific to the node where kubeadm is executed, including: - NodeRegistration, that holds fields that relate to registering the new node to the cluster; use it to customize the node name, the CRI socket to use or any other settings that should apply to this node only (e.g. the node ip). -- APIEndpoint, that represents the endpoint of the instance of the API server to be eventually - deployed on this node. + +- APIEndpoint, that represents the endpoint of the instance of the API server to be eventually deployed on this node. ## Resource Types @@ -315,7 +317,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster Etcd - `etcd` holds configuration for etcd. + Etcd holds configuration for etcd. @@ -323,7 +325,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster Networking - `networking` holds configuration for the networking topology of the cluster. + Networking holds configuration for the networking topology of the cluster. @@ -331,7 +333,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster string - `kubernetesVersion` is the target version of the control plane. + KubernetesVersion is the target version of the control plane. @@ -339,18 +341,17 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster string - `controlPlaneEndpoint` sets a stable IP address or DNS name for the control plane; it + ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. -In case the `controlPlaneEndpoint` is not specified, the `advertiseAddress` + `bindPort` -are used; in case the `controlPlaneEndpoint` is specified but without a TCP port, -the `bindPort` of the `localAPIEndpoint` is used. +In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort +are used; in case the ControlPlaneEndpoint is specified but without a TCP port, +the BindPort is used. Possible usages are: - -- In a cluster with more than one control plane instances, this field should be - assigned the address of the external load balancer in front of the - control plane instances. -- In environments with enforced node recycling, the ControlPlaneEndpoint - could be used for assigning a stable DNS to the control plane. +e.g. In a cluster with more than one control plane instances, this field should be +assigned the address of the external load balancer in front of the +control plane instances. +e.g. in environments with enforced node recycling, the ControlPlaneEndpoint +could be used for assigning a stable DNS to the control plane. @@ -358,7 +359,7 @@ Possible usages are: APIServer - `apiServer` contains extra settings for the API server. + APIServer contains extra settings for the API server control plane component @@ -366,7 +367,7 @@ Possible usages are: ControlPlaneComponent - `controllerManager` contains extra settings for the controller manager. + ControllerManager contains extra settings for the controller manager control plane component @@ -374,7 +375,7 @@ Possible usages are: ControlPlaneComponent - `scheduler` contains extra settings for the scheduler. + Scheduler contains extra settings for the scheduler control plane component @@ -382,7 +383,7 @@ Possible usages are: DNS - `dns` defines the options for the DNS add-on. + DNS defines the options for the DNS add-on installed in the cluster. @@ -390,7 +391,7 @@ Possible usages are: string - `certificatesDir` specifies where to store or look for all required certificates. + CertificatesDir specifies where to store or look for all required certificates. @@ -398,11 +399,10 @@ Possible usages are: string - `imageRepository` sets the container registry to pull images from. -If empty, `k8s.gcr.io` will be used by default; in case of kubernetes version is -a CI build (kubernetes version starts with `ci/` or `ci-cross/`) -`gcr.io/k8s-staging-ci-images` will be used as a default for control plane -components and for kube-proxy, while `k8s.gcr.io` will be used for all the other images. + ImageRepository sets the container registry to pull images from. +If empty, `k8s.gcr.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/`) +`gcr.io/k8s-staging-ci-images` will be used as a default for control plane components and for kube-proxy, while `k8s.gcr.io` +will be used for all the other images. @@ -410,7 +410,7 @@ components and for kube-proxy, while `k8s.gcr.io` will be used for all the other map[string]bool - Feature gates enabled by the user. + FeatureGates enabled by the user. @@ -418,7 +418,7 @@ components and for kube-proxy, while `k8s.gcr.io` will be used for all the other string - The cluster name. + The cluster name @@ -450,8 +450,8 @@ information. []BootstrapToken - `bootstrapTokens` is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. -This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature. + BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. +This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature @@ -459,7 +459,7 @@ This information IS NOT uploaded to the kubeadm cluster configmap, partly becaus NodeRegistrationOptions - `nodeRegistration` holds fields that relate to registering the new control-plane node to the cluster + NodeRegistration holds fields that relate to registering the new control-plane node to the cluster @@ -467,7 +467,7 @@ This information IS NOT uploaded to the kubeadm cluster configmap, partly becaus APIEndpoint - `localAPIEndpoint` represents the endpoint of the API server instance that's deployed on this control plane node + LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible @@ -480,8 +480,8 @@ fails you may set the desired value here. string - `certificateKey` sets the key with which certificates and keys are encrypted prior to being uploaded in -a Secret in the cluster during the "uploadcerts" init phase. + CertificateKey sets the key with which certificates and keys are encrypted prior to being uploaded in +a secret in the cluster during the uploadcerts init phase. @@ -489,9 +489,9 @@ a Secret in the cluster during the "uploadcerts" init phase. []string - `skipPhases` is a list of phases to skip during command execution. -The list of phases can be obtained with the `kubeadm init --help` command. -The flag `--skip-phases` takes precedence over this field. + SkipPhases is a list of phases to skip during command execution. +The list of phases can be obtained with the "kubeadm init --help" command. +The flag "--skip-phases" takes precedence over this field. @@ -499,7 +499,7 @@ The flag `--skip-phases` takes precedence over this field. Patches - `patches` contains options related to applying patches to components deployed by kubeadm during + Patches contains options related to applying patches to components deployed by kubeadm during "kubeadm init". @@ -531,8 +531,7 @@ JoinConfiguration contains elements describing a particular node. NodeRegistrationOptions - `nodeRegistration` holds fields that relate to registering the new control-plane -node to the cluster + NodeRegistration holds fields that relate to registering the new control-plane node to the cluster @@ -540,7 +539,7 @@ node to the cluster string - `caCertPath` is the path to the SSL certificate authority used to + CACertPath is the path to the SSL certificate authority used to secure comunications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". @@ -550,7 +549,7 @@ Defaults to "/etc/kubernetes/pki/ca.crt". Discovery - `discovery` specifies the options for the kubelet to use during the TLS Bootstrap process. + Discovery specifies the options for the kubelet to use during the TLS Bootstrap process @@ -558,8 +557,8 @@ Defaults to "/etc/kubernetes/pki/ca.crt". JoinControlPlane - `controlPlane` defines the additional control plane instance to be deployed on the -joining node. If nil, no additional control plane instance will be deployed. + ControlPlane defines the additional control plane instance to be deployed on the joining node. +If nil, no additional control plane instance will be deployed. @@ -567,9 +566,9 @@ joining node. If nil, no additional control plane instance will be deployed.[]string - `skipPhases` is a list of phases to skip during command execution. -The list of phases can be obtained with the `kubeadm join --help` command. -The flag `--skip-phases` takes precedence over this field. + SkipPhases is a list of phases to skip during command execution. +The list of phases can be obtained with the "kubeadm join --help" command. +The flag "--skip-phases" takes precedence over this field. @@ -577,8 +576,8 @@ The flag `--skip-phases` takes precedence over this field. Patches - `patches` contains options related to applying patches to components deployed by kubeadm during -`kubeadm join`. + Patches contains options related to applying patches to components deployed by kubeadm during +"kubeadm join". @@ -611,7 +610,7 @@ APIEndpoint struct contains elements of API server instance deployed on a node. string - `advertiseAddress` sets the IP address for the API server to advertise. + AdvertiseAddress sets the IP address for the API server to advertise. @@ -619,7 +618,8 @@ APIEndpoint struct contains elements of API server instance deployed on a node. int32 - `bindPort` sets the secure port for the API Server to bind to. Defaults to 6443. + BindPort sets the secure port for the API Server to bind to. +Defaults to 6443. @@ -659,7 +659,7 @@ APIServer holds settings necessary for API server deployments in the cluster []string - `certSANs` sets extra Subject Alternative Names for the API Server signing cert. + CertSANs sets extra Subject Alternative Names for the API Server signing cert. @@ -667,7 +667,7 @@ APIServer holds settings necessary for API server deployments in the cluster meta/v1.Duration - `timeoutForControlPlane` controls the timeout that we use for API server to appear + TimeoutForControlPlane controls the timeout that we use for API server to appear @@ -698,7 +698,8 @@ BootstrapTokenDiscovery is used to set the options for bootstrap token based dis string - `token` is a token used to validate cluster information fetched from the control-plane. + Token is a token used to validate cluster information +fetched from the control-plane. @@ -706,8 +707,7 @@ BootstrapTokenDiscovery is used to set the options for bootstrap token based dis string - `apiServerEndpoint` is an IP or domain name to the API server from which -information will be fetched. + APIServerEndpoint is an IP or domain name to the API server from which info will be fetched. @@ -715,13 +715,13 @@ information will be fetched. []string - CACertHashes specifies a set of public key pins to verify when token-based -discovery is used. The root CA found during discovery must match one of these -values. Specifying an empty set disables root CA pinning, which can be unsafe. -Each hash is specified as `:`, where the only currently supported -type is "sha256". This is a hex-encoded SHA-256 hash of the Subject Public Key -Info (SPKI) object in DER-encoded ASN.1. These hashes can be calculated using, -for example, OpenSSL. + CACertHashes specifies a set of public key pins to verify +when token-based discovery is used. The root CA found during discovery +must match one of these values. Specifying an empty set disables root CA +pinning, which can be unsafe. Each hash is specified as ":", +where the only currently supported type is "sha256". This is a hex-encoded +SHA-256 hash of the Subject Public Key Info (SPKI) object in DER-encoded +ASN.1. These hashes can be calculated using, for example, OpenSSL. @@ -729,9 +729,9 @@ for example, OpenSSL. bool - `unsafeSkipCAVerification` allows token-based discovery without CA verification -via `caCertHashes`. This can weaken the security of kubeadm since other nodes -can impersonate the control-plane. + UnsafeSkipCAVerification allows token-based discovery +without CA verification via CACertHashes. This can weaken +the security of kubeadm since other nodes can impersonate the control-plane. @@ -764,9 +764,11 @@ ControlPlaneComponent holds settings common to control plane component of the cl map[string]string - `extraArgs` is an extra set of flags to pass to the control plane component. + ExtraArgs is an extra set of flags to pass to the control plane component. A key in this map is the flag name as it appears on the -command line except without leading dash(es). +command line except without leading dash(es). +TODO: This is temporary and ideally we would like to switch all components to +use ComponentConfig + ConfigMaps. @@ -774,7 +776,7 @@ command line except without leading dash(es). []HostPathMount - `extraVolumes` is an extra set of host volumes, mounted to the control plane component. + ExtraVolumes is an extra set of host volumes, mounted to the control plane component. @@ -805,7 +807,7 @@ DNS defines the DNS addon that should be used in the cluster ImageMeta (Members of ImageMeta are embedded into this type.) - `imageMeta` allows to customize the image used for the DNS component. + ImageMeta allows to customize the image used for the DNS component @@ -848,8 +850,8 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap BootstrapTokenDiscovery - `bootstrapToken` is used to set the options for bootstrap token based discovery. -`bootstrapToken` and `file` are mutually exclusive. + BootstrapToken is used to set the options for bootstrap token based discovery +BootstrapToken and File are mutually exclusive @@ -857,8 +859,8 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap FileDiscovery - `file` specifies a file or URL to a kubeconfig file from which to load cluster information. -`bootstrapToken` and `file` are mutually exclusive. + File is used to specify a file or URL to a kubeconfig file from which to load cluster information +BootstrapToken and File are mutually exclusive @@ -866,11 +868,9 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap string - `tlsBootstrapToken` is a token used for TLS bootstrapping. -If `bootstrapToken` is set, this field is defaulted to `bootstrapToken.token`, -but can be overridden. -If `file` is set, this field ∗∗must be set∗∗ in case the KubeConfigFile does -not contain any other authentication information + TLSBootstrapToken is a token used for TLS bootstrapping. +If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. +If .File is set, this field ∗∗must be set∗∗ in case the KubeConfigFile does not contain any other authentication information @@ -878,7 +878,7 @@ not contain any other authentication information meta/v1.Duration - `timeout` modifies the discovery timeout. + Timeout modifies the discovery timeout @@ -909,8 +909,8 @@ Etcd contains elements describing Etcd configuration. LocalEtcd - `local` provides configuration knobs for configuring the local etcd instance. -`local` and `external` are mutually exclusive. + Local provides configuration knobs for configuring the local etcd instance +Local and External are mutually exclusive @@ -918,8 +918,8 @@ Etcd contains elements describing Etcd configuration. ExternalEtcd - `external` describes how to connect to an external etcd cluster. -`local` and `external` are mutually exclusive. + External describes how to connect to an external etcd cluster +Local and External are mutually exclusive @@ -951,7 +951,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli []string - `endpoints` are endpoints of etcd members. This field is required. + Endpoints of etcd members. Required for ExternalEtcd. @@ -959,7 +959,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli string - `caFile` is an SSL Certificate Authority file used to secure etcd communication. + CAFile is an SSL Certificate Authority file used to secure etcd communication. Required if using a TLS connection. @@ -968,7 +968,7 @@ Required if using a TLS connection. string - `certFile` is an SSL certification file used to secure etcd communication. + CertFile is an SSL certification file used to secure etcd communication. Required if using a TLS connection. @@ -977,7 +977,7 @@ Required if using a TLS connection. string - `keyFile` is an SSL key file used to secure etcd communication. + KeyFile is an SSL key file used to secure etcd communication. Required if using a TLS connection. @@ -1009,8 +1009,7 @@ FileDiscovery is used to specify a file or URL to a kubeconfig file from which t string - `kubeConfigPath` specifies the actual file path or URL to the kubeconfig file -from which to load cluster information + KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information @@ -1029,7 +1028,8 @@ from which to load cluster information - [ControlPlaneComponent](#kubeadm-k8s-io-v1beta3-ControlPlaneComponent) -HostPathMount contains elements describing volumes that are mounted from the host. +HostPathMount contains elements describing volumes that are mounted from the +host. @@ -1041,7 +1041,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos string + Name of the volume inside the pod template. @@ -1049,7 +1049,8 @@ HostPathMount contains elements describing volumes that are mounted from the hos string + HostPath is the path in the host that will be mounted inside +the pod. @@ -1057,7 +1058,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos string + MountPath is the path inside the pod where hostPath will be mounted. @@ -1065,7 +1066,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos bool + ReadOnly controls write access to the volume @@ -1073,7 +1074,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos core/v1.HostPathType + PathType is the type of the HostPath. @@ -1107,8 +1108,8 @@ originated from the Kubernetes/Kubernetes release process string + ImageRepository sets the container registry to pull images from. +if not set, the ImageRepository defined in ClusterConfiguration will be used instead. @@ -1116,9 +1117,8 @@ If not set, the ImageRepository defined in ClusterConfiguration will be used ins string + ImageTag allows to specify a tag for the image. +In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. @@ -1149,8 +1149,7 @@ JoinControlPlane contains elements describing an additional control plane instan APIEndpoint + LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node. @@ -1158,9 +1157,8 @@ on this node.string + CertificateKey is the key that is used for decryption of certificates after they are downloaded from the secret +upon joining a new control plane node. The corresponding encryption key is in the InitConfiguration. @@ -1191,7 +1189,7 @@ LocalEtcd describes that kubeadm should run an etcd cluster locally ImageMeta + ImageMeta allows to customize the container used for etcd @@ -1199,7 +1197,7 @@ LocalEtcd describes that kubeadm should run an etcd cluster locally string @@ -1208,10 +1206,10 @@ Defaults to "/var/lib/etcd".map[string]string +A key in this map is the flag name as it appears on the +command line except without leading dash(es). @@ -1219,7 +1217,7 @@ without leading dash(es).[]string + ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert. @@ -1227,7 +1225,7 @@ without leading dash(es).[]string + PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. @@ -1258,7 +1256,7 @@ Networking contains elements describing cluster's networking configuration string + ServiceSubnet is the subnet used by k8s services. Defaults to "10.96.0.0/12". @@ -1266,7 +1264,7 @@ Networking contains elements describing cluster's networking configuration string + PodSubnet is the subnet used by pods. @@ -1274,7 +1272,7 @@ Networking contains elements describing cluster's networking configuration string + DNSDomain is the dns domain used by k8s services. Defaults to "cluster.local". @@ -1307,10 +1305,9 @@ NodeRegistrationOptions holds fields that relate to registering a new control-pl string + Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. +This field is also used in the CommonName field of the kubelet's client certificate to the API server. +Defaults to the hostname of the node if not provided. @@ -1318,8 +1315,7 @@ API server. Defaults to the hostname of the node if not provided.string + CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use @@ -1327,11 +1323,9 @@ annotated to the Node API object, for later re-use.[]core/v1.Taint + Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process +it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an +empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration. @@ -1339,13 +1333,11 @@ file. This field is solely used for Node registration.map[string]string + KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file +kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap +Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. +A key in this map is the flag name as it appears on the +command line except without leading dash(es). @@ -1353,8 +1345,7 @@ leading dash(es).[]string + IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. @@ -1362,11 +1353,9 @@ the current node is registered.core/v1.PullPolicy +If this field is unset kubeadm will default it to "IfNotPresent", or pull the required images if not present on the host. @@ -1399,13 +1388,12 @@ Patches contains options related to applying patches to components deployed by k string diff --git a/content/en/docs/reference/config-api/kubelet-config.v1beta1.md b/content/en/docs/reference/config-api/kubelet-config.v1beta1.md index 261a6dd5f8..619b8d70f6 100644 --- a/content/en/docs/reference/config-api/kubelet-config.v1beta1.md +++ b/content/en/docs/reference/config-api/kubelet-config.v1beta1.md @@ -493,14 +493,13 @@ Default: "5m"int32 @@ -693,7 +690,7 @@ Valid values include: requested resources; - `best-effort`: kubelet will favor pods with NUMA alignment of CPU and device resources; -- `none`: kublet has no knowledge of NUMA alignment of a pod's CPU and device resources. +- `none`: kubelet has no knowledge of NUMA alignment of a pod's CPU and device resources. - `single-numa-node`: kubelet only allows pods with a single NUMA alignment of CPU and device resources. @@ -819,6 +816,7 @@ If DynamicKubeletConfig (deprecated; default off) is on, when dynamically updating this field, consider that changes will only take effect on Pods created after the update. Draining the node is recommended before changing this field. +If set to the empty string, will override the default and effectively disable DNS lookups. Default: "/etc/resolv.conf" @@ -1417,6 +1415,39 @@ Default: "0s" + + + + + @@ -1485,6 +1516,26 @@ Default: 0.8 + + + + + + + + + +
FieldDescription
- `name` is the volume name inside the Pod template.
- `hostPath` is the path in the host that will be mounted inside the Pod.
- `mountPath` is the path inside the Pod where the `hostPath` volume is mounted.
- `readOnly` controls write access to the volume.
- `pathType` is the type of the `hostPath` volume.
- `imageRepository` sets the container registry to pull images from. -If not set, the ImageRepository defined in ClusterConfiguration will be used instead.
- `imageTag` allows to specify a tag for the image. -In case this value is set, kubeadm does not change automatically the -version of the above components during upgrades.
- `localAPIEndpoint` represents the endpoint of the API server instance to be deployed -on this node.
- `certificateKey` is the key that is used for decryption of certificates after they -are downloaded from the secret upon joining a new control plane node. The -corresponding encryption key is in the InitConfiguration.
(Members of ImageMeta are embedded into this type.) - `ImageMeta` allows to customize the container used for etcd.
- `dataDir` is the directory etcd will place its data. + DataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd".
- `extraArgs` are extra arguments provided to the etcd binary + ExtraArgs are extra arguments provided to the etcd binary when run inside a static pod. -A key in this map is the flag name as it appears on the command line except -without leading dash(es).
- `serverCertSANs` sets extra Subject Alternative Names for the etcd server signing cert.
- `peerCertSANs` sets extra Subject Alternative Names for the etcd peer signing cert.
- `serviceSubnet` is the subnet used by k8s services. Defaults to "10.96.0.0/12".
- `podSubnet` is the subnet used by Pods.
- `dnsDomain` is the DNS domain used by k8s services. Defaults to "cluster.local".
- `name` is the `.metadata.name` field of the Node API object that will be created in this -`kubeadm init` or `kubeadm join` operation. -This field is also used in the `CommonName` field of the kubelet's client certificate to the -API server. Defaults to the hostname of the node if not provided.
- `criSocket` is used to retrieve container runtime info. This information will be -annotated to the Node API object, for later re-use.
- `taints` specifies the taints the Node API object should be registered with. If -this field is unset, i.e. nil, in the `kubeadm init` process, it will be defaulted -to `['"node-role.kubernetes.io/master"=""']`. If you don't want to taint your -control-plane node, set this field to an empty list, i.e. `taints: []` in the YAML -file. This field is solely used for Node registration.
- `kubeletExtraArgs` passes through extra arguments to the kubelet. The arguments here -are passed to the kubelet command line via the environment file kubeadm writes at -runtime for the kubelet to source. This overrides the generic base-level -configuration in the "kubelet-config-1.X" ConfigMap. Flags have higher priority when -parsing. These values are local and specific to the node kubeadm is executing on. -A key in this map is the flag name as it appears on the command line except without -leading dash(es).
- `ignorePreflightErrors` provides a slice of pre-flight errors to be ignored when -the current node is registered.
- `imagePullPolicy` specifies the policy for image pulling during `kubeadm init` and -`kubeadm join` operations. + ImagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". -If this field is unset kubeadm will default it to "IfNotPresent", or pull the required -images if not present on the host.
- `directory` is a path to a directory that contains files named -`target[suffix][+patchtype].extension`. -For example, `kube-apiserver0+merge.yaml` or just `etcd.json`. `target` can be one of -"kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". `patchtype` can be one -of "strategic", "merge" or "json" and they match the patch formats supported by kubectl. -The default `patchtype` is "strategic". `extension` must be either "json" or "yaml". -`suffix` is an optional string that can be used to determine which patches are applied + Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". +For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of +"kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one +of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. +The default "patchtype" is "strategic". "extension" must be either "json" or "yaml". +"suffix" is an optional string that can be used to determine which patches are applied first alpha-numerically.
- nodeLeaseDurationSeconds is the duration the Kubelet will set on its corresponding Lease, -when the NodeLease feature is enabled. This feature provides an indicator of node -health by having the Kubelet create and periodically renew a lease, named after the node, -in the kube-node-lease namespace. If the lease expires, the node can be considered unhealthy. -The lease is currently renewed every 10s, per KEP-0009. In the future, the lease renewal interval -may be set based on the lease duration. + nodeLeaseDurationSeconds is the duration the Kubelet will set on its corresponding Lease. +NodeLease provides an indicator of node health by having the Kubelet create and +periodically renew a lease, named after the node, in the kube-node-lease namespace. +If the lease expires, the node can be considered unhealthy. +The lease is currently renewed every 10s, per KEP-0009. In the future, the lease renewal +interval may be set based on the lease duration. The field value must be greater than 0. -Requires the NodeLease feature gate to be enabled. If DynamicKubeletConfig (deprecated; default off) is on, when dynamically updating this field, consider that decreasing the duration may reduce tolerance for issues that temporarily prevent @@ -514,11 +513,9 @@ Default: 40 imageMinimumGCAge is the minimum age for an unused image before it is -garbage collected. -If DynamicKubeletConfig (deprecated; default off) is on, when -dynamically updating this field, consider that -it may trigger or delay garbage collection, and may change the image overhead -on the node. +garbage collected. If DynamicKubeletConfig (deprecated; default off) +is on, when dynamically updating this field, consider that it may trigger or +delay garbage collection, and may change the image overhead on the node. Default: "2m"
shutdownGracePeriodByPodPriority
+[]ShutdownGracePeriodByPodPriority +		 + shutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods based +on their associated priority class value. +When a shutdown request is received, the Kubelet will initiate shutdown on all pods +running on the node with a grace period that depends on the priority of the pod, +and then wait for all pods to exit. +Each entry in the array represents the graceful shutdown time a pod with a priority +class value that lies in the range of that value and the next higher entry in the +list when the node is shutting down. +For example, to allow critical pods 10s to shutdown, priority>=10000 pods 20s to +shutdown, and all remaining pods 30s to shutdown. + +shutdownGracePeriodByPodPriority: + - priority: 2000000000 + shutdownGracePeriodSeconds: 10 + - priority: 10000 + shutdownGracePeriodSeconds: 20 + - priority: 0 + shutdownGracePeriodSeconds: 30 + +The time the Kubelet will wait before exiting will at most be the maximum of all +shutdownGracePeriodSeconds for each priority class range represented on the node. +When all pods have exited or reached their grace periods, the Kubelet will release +the shutdown inhibit lock. +Requires the GracefulNodeShutdown feature gate to be enabled. +This configuration must be empty if either ShutdownGracePeriod or ShutdownGracePeriodCriticalPods is set. +Default: nil
reservedMemory
[]MemoryReservation
registerWithTaints
+[]core/v1.Taint +		 + registerWithTaints are an array of taints to add to a node object when +the kubelet registers itself. This only takes effect when registerNode +is true and upon the initial registration of the node. +Default: nil
registerNode
+bool +		 + registerNode enables automatic registration with the apiserver. +Default: true
@@ -1879,10 +1930,118 @@ managers (secret, configmap) are discovering object changes. + + +## `ShutdownGracePeriodByPodPriority` {#kubelet-config-k8s-io-v1beta1-ShutdownGracePeriodByPodPriority} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +ShutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods based on their associated priority class value + + + + + + + + + + + + + + + + + + +
FieldDescription
priority [Required]
+int32 +		 + priority is the priority value associated with the shutdown grace period
shutdownGracePeriodSeconds [Required]
+int64 +		 + shutdownGracePeriodSeconds is the shutdown grace period in seconds
+ +## `FormatOptions` {#FormatOptions} + + + + +**Appears in:** + +- [LoggingConfiguration](#LoggingConfiguration) + + +FormatOptions contains options for the different logging formats. + + + + + + + + + + + + + +
FieldDescription
json [Required]
+JSONOptions +		 + [Experimental] JSON contains options for logging format "json".
+ +## `JSONOptions` {#JSONOptions} + + + + +**Appears in:** + +- [FormatOptions](#FormatOptions) + + +JSONOptions contains options for logging format "json". + + + + + + + + + + + + + + + + + + +
FieldDescription
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.
+ ## `LoggingConfiguration` {#LoggingConfiguration} @@ -1911,6 +2070,35 @@ default value of format is `text` +flushFrequency [Required]
+time.Duration + + + Maximum number of seconds between log flushes. Ignored if the +selected logging backend writes log messages without buffering. + + + +verbosity [Required]
+uint32 + + + Verbosity is the threshold that determines which log messages are +logged. Default is zero which logs only the most important +messages. Higher values enable additional messages. Error messages +are always logged. + + + +vmodule [Required]
+VModuleConfiguration + + + VModule overrides the verbosity threshold for individual files. +Only supported for "text" log format. + + + sanitization [Required]
bool @@ -1920,5 +2108,30 @@ Runtime log sanitization may introduce significant computation overhead and ther +options [Required]
+FormatOptions + + + [Experimental] Options holds additional parameters that are specific +to the different logging formats. Only the options for the selected +format get used, but all of them get validated. + + + + +## `VModuleConfiguration` {#VModuleConfiguration} + +(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`) + + +**Appears in:** + +- [LoggingConfiguration](#LoggingConfiguration) + + +VModuleConfiguration is a collection of individual file names or patterns +and the corresponding verbosity threshold. + + diff --git a/content/en/docs/reference/scheduling/config.md b/content/en/docs/reference/scheduling/config.md index ca756f6124..502ffcb61e 100644 --- a/content/en/docs/reference/scheduling/config.md +++ b/content/en/docs/reference/scheduling/config.md @@ -20,7 +20,8 @@ by implementing one or more of these extension points. You can specify scheduling profiles by running `kube-scheduler --config `, using the -KubeSchedulerConfiguration ([v1beta2](/docs/reference/config-api/kube-scheduler-config.v1beta2/)) +KubeSchedulerConfiguration ([v1beta2](/docs/reference/config-api/kube-scheduler-config.v1beta2/) +or [v1beta3](/docs/reference/config-api/kube-scheduler-config.v1beta3/)) struct. A minimal configuration looks as follows: @@ -456,5 +457,5 @@ as well as its seamless integration with the existing methods for configuring ex * Read the [kube-scheduler reference](/docs/reference/command-line-tools-reference/kube-scheduler/) * Learn about [scheduling](/docs/concepts/scheduling-eviction/kube-scheduler/) -* Read the [kube-scheduler configuration (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) reference * Read the [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) reference +* Read the [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) reference diff --git a/content/en/docs/reference/scheduling/policies.md b/content/en/docs/reference/scheduling/policies.md index 3e2e554fc9..13cc13845c 100644 --- a/content/en/docs/reference/scheduling/policies.md +++ b/content/en/docs/reference/scheduling/policies.md @@ -16,5 +16,5 @@ This scheduling policy is not supported since Kubernetes v1.23. Associated flags * Learn about [scheduling](/docs/concepts/scheduling-eviction/kube-scheduler/) * Learn about [kube-scheduler Configuration](/docs/reference/scheduling/config/) -* Read the [kube-scheduler configuration reference (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2) +* Read the [kube-scheduler configuration reference (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) * Read the [kube-scheduler Policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/) diff --git a/content/en/docs/tasks/extend-kubernetes/configure-multiple-schedulers.md b/content/en/docs/tasks/extend-kubernetes/configure-multiple-schedulers.md index bed250a170..51271bdeab 100644 --- a/content/en/docs/tasks/extend-kubernetes/configure-multiple-schedulers.md +++ b/content/en/docs/tasks/extend-kubernetes/configure-multiple-schedulers.md @@ -76,7 +76,7 @@ to customize the behavior of your scheduler implementation. This configuration h the `kube-scheduler` during initialization with the `--config` option. The `my-scheduler-config` ConfigMap stores the configuration file. The Pod of the`my-scheduler` Deployment mounts the `my-scheduler-config` ConfigMap as a volume. In the aforementioned Scheduler Configuration, your scheduler implementation is represented via -a [KubeSchedulerProfile](/docs/reference/config-api/kube-scheduler-config.v1beta2/#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile). +a [KubeSchedulerProfile](/docs/reference/config-api/kube-scheduler-config.v1beta3/#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile). {{< note >}} To determine if a scheduler is responsible for scheduling a specific Pod, the `spec.schedulerName` field in a PodTemplate or Pod manifest must match the `schedulerName` field of the `KubeSchedulerProfile`. @@ -89,7 +89,7 @@ Also, note that you create a dedicated service account `my-scheduler` and bind t Please see the [kube-scheduler documentation](/docs/reference/command-line-tools-reference/kube-scheduler/) for detailed description of other command line arguments and -[Scheduler Configuration reference](https://kubernetes.io/docs/reference/config-api/kube-scheduler-config.v1beta2/) for +[Scheduler Configuration reference](/docs/reference/config-api/kube-scheduler-config.v1beta3/) for detailed description of other customizable `kube-scheduler` configurations. ## Run the second scheduler in the cluster