whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Configuration API for v1.23

Browse Source
This commit is contained in:
Qiming Teng
2021-12-08 15:46:50 +08:00
parent e808edad3a
commit b198199336
15 changed files with 2552 additions and 1257 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/concepts/cluster-administration/system-traces.md
+2 -2
View File
@@ -66,7 +66,7 @@ with `--tracing-config-file=<path-to-config>`. This is an example config that re
spans for 1 in 10000 requests, and uses the default OpenTelemetry endpoint: spans for 1 in 10000 requests, and uses the default OpenTelemetry endpoint:
```yaml ```yaml
apiVersion: apiserver.config.k8s.io/v1alpha1 apiVersion: apiserver.config.k8s.io/v1beta1
kind: TracingConfiguration kind: TracingConfiguration
# default value # default value
#endpoint: localhost:4317 #endpoint: localhost:4317
@@ -74,7 +74,7 @@ samplingRatePerMillion: 100
``` ```
For more information about the `TracingConfiguration` struct, see 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 ## Stability
content/en/docs/concepts/scheduling-eviction/kube-scheduler.md
+1 -1
View File
@@ -85,7 +85,7 @@ of the scheduler:
* Read about [scheduler performance tuning](/docs/concepts/scheduling-eviction/scheduler-perf-tuning/) * 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 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 [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 [configuring multiple schedulers](/docs/tasks/extend-kubernetes/configure-multiple-schedulers/)
* Learn about [topology management policies](/docs/tasks/administer-cluster/topology-manager/) * Learn about [topology management policies](/docs/tasks/administer-cluster/topology-manager/)
* Learn about [Pod Overhead](/docs/concepts/scheduling-eviction/pod-overhead/) * Learn about [Pod Overhead](/docs/concepts/scheduling-eviction/pod-overhead/)
content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md
+2 -2
View File
@@ -43,7 +43,7 @@ If you set `percentageOfNodesToScore` above 100, kube-scheduler acts as if you
had set a value of 100. had set a value of 100.
To change the value, edit the 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. and then restart the scheduler.
In many cases, the configuration file can be found at `/etc/kubernetes/config/kube-scheduler.yaml`. 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" %}} ## {{% 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/)
content/en/docs/reference/_index.md
+2 -2
View File
@@ -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 by the API server in a RESTful way though they are essential for a user or an
operator to use or manage a cluster. 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/) * [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 (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-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/) * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
* [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/) * [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/)
content/en/docs/reference/config-api/apiserver-audit.v1.md
+28
View File
@@ -279,6 +279,19 @@ be specified per rule in which case the union of both are omitted.</td>
</tr> </tr>
<tr><td><code>omitManagedFields</code><br/>
<code>bool</code>
</td>
<td>
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.</td>
</tr>
</tbody> </tbody>
</table> </table>
@@ -594,6 +607,21 @@ An empty list means no restrictions will apply.</td>
</tr> </tr>
<tr><td><code>omitManagedFields</code><br/>
<code>bool</code>
</td>
<td>
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.</td>
</tr>
</tbody> </tbody>
</table> </table>
content/en/docs/reference/config-api/apiserver-config.v1alpha1.md → content/en/docs/reference/config-api/apiserver-config.v1beta1.md
+27 -154
View File
@@ -1,53 +1,20 @@
--- ---
title: kube-apiserver Configuration (v1alpha1) title: kube-apiserver Configuration (v1beta1)
content_type: tool-reference content_type: tool-reference
package: apiserver.k8s.io/v1alpha1 package: apiserver.k8s.io/v1beta1
auto_generated: true auto_generated: true
--- ---
Package v1alpha1 is the v1alpha1 version of the API. Package v1beta1 is the v1beta1 version of the API.
## Resource Types ## Resource Types
- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) - [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration)
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration)
- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration)
## `AdmissionConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionConfiguration} ## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration}
AdmissionConfiguration provides versioned configuration for admission controllers.
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>AdmissionConfiguration</code></td></tr>
<tr><td><code>plugins</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-AdmissionPluginConfiguration"><code>[]AdmissionPluginConfiguration</code></a>
</td>
<td>
Plugins allows specifying a configuration per admission control plugin.</td>
</tr>
</tbody>
</table>
## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration}
@@ -59,14 +26,14 @@ EgressSelectorConfiguration provides versioned configuration for egress selector
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody> <tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr> <tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>EgressSelectorConfiguration</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>EgressSelectorConfiguration</code></td></tr>
<tr><td><code>egressSelections</code> <B>[Required]</B><br/> <tr><td><code>egressSelections</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-EgressSelection"><code>[]EgressSelection</code></a> <a href="#apiserver-k8s-io-v1beta1-EgressSelection"><code>[]EgressSelection</code></a>
</td> </td>
<td> <td>
connectionServices contains a list of egress selection client configurations</td> connectionServices contains a list of egress selection client configurations</td>
@@ -78,108 +45,14 @@ EgressSelectorConfiguration provides versioned configuration for egress selector
## `TracingConfiguration` {#apiserver-k8s-io-v1alpha1-TracingConfiguration} ## `Connection` {#apiserver-k8s-io-v1beta1-Connection}
TracingConfiguration provides versioned configuration for tracing clients.
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>TracingConfiguration</code></td></tr>
<tr><td><code>endpoint</code><br/>
<code>string</code>
</td>
<td>
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.</td>
</tr>
<tr><td><code>samplingRatePerMillion</code><br/>
<code>int32</code>
</td>
<td>
SamplingRatePerMillion is the number of samples to collect per million spans.
Defaults to 0.</td>
</tr>
</tbody>
</table>
## `AdmissionPluginConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionPluginConfiguration}
**Appears in:** **Appears in:**
- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration) - [EgressSelection](#apiserver-k8s-io-v1beta1-EgressSelection)
AdmissionPluginConfiguration provides the configuration for a single plug-in.
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
Name is the name of the admission controller.
It must match the registered admission plugin name.</td>
</tr>
<tr><td><code>path</code><br/>
<code>string</code>
</td>
<td>
Path is the path to a configuration file that contains the plugin's
configuration</td>
</tr>
<tr><td><code>configuration</code><br/>
<a href="https://godoc.org/k8s.io/apimachinery/pkg/runtime#Unknown"><code>k8s.io/apimachinery/pkg/runtime.Unknown</code></a>
</td>
<td>
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.</td>
</tr>
</tbody>
</table>
## `Connection` {#apiserver-k8s-io-v1alpha1-Connection}
**Appears in:**
- [EgressSelection](#apiserver-k8s-io-v1alpha1-EgressSelection)
Connection provides the configuration for a single egress selection client. Connection provides the configuration for a single egress selection client.
@@ -191,7 +64,7 @@ Connection provides the configuration for a single egress selection client.
<tr><td><code>proxyProtocol</code> <B>[Required]</B><br/> <tr><td><code>proxyProtocol</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-ProtocolType"><code>ProtocolType</code></a> <a href="#apiserver-k8s-io-v1beta1-ProtocolType"><code>ProtocolType</code></a>
</td> </td>
<td> <td>
Protocol is the protocol used to connect from client to the konnectivity server.</td> Protocol is the protocol used to connect from client to the konnectivity server.</td>
@@ -199,7 +72,7 @@ Connection provides the configuration for a single egress selection client.
<tr><td><code>transport</code><br/> <tr><td><code>transport</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-Transport"><code>Transport</code></a> <a href="#apiserver-k8s-io-v1beta1-Transport"><code>Transport</code></a>
</td> </td>
<td> <td>
Transport defines the transport configurations we use to dial to the konnectivity server. 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.</td>
## `EgressSelection` {#apiserver-k8s-io-v1alpha1-EgressSelection} ## `EgressSelection` {#apiserver-k8s-io-v1beta1-EgressSelection}
**Appears in:** **Appears in:**
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration) - [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration)
EgressSelection provides the configuration for a single egress selection client. EgressSelection provides the configuration for a single egress selection client.
@@ -241,7 +114,7 @@ The "master" egress selector is deprecated in favor of "controlplane"</td>
<tr><td><code>connection</code> <B>[Required]</B><br/> <tr><td><code>connection</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-Connection"><code>Connection</code></a> <a href="#apiserver-k8s-io-v1beta1-Connection"><code>Connection</code></a>
</td> </td>
<td> <td>
connection is the exact information used to configure the egress selection</td> connection is the exact information used to configure the egress selection</td>
@@ -253,14 +126,14 @@ The "master" egress selector is deprecated in favor of "controlplane"</td>
## `ProtocolType` {#apiserver-k8s-io-v1alpha1-ProtocolType} ## `ProtocolType` {#apiserver-k8s-io-v1beta1-ProtocolType}
(Alias of `string`) (Alias of `string`)
**Appears in:** **Appears in:**
- [Connection](#apiserver-k8s-io-v1alpha1-Connection) - [Connection](#apiserver-k8s-io-v1beta1-Connection)
ProtocolType is a set of valid values for Connection.ProtocolType 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:** **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 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"</td>
<tr><td><code>tlsConfig</code><br/> <tr><td><code>tlsConfig</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-TLSConfig"><code>TLSConfig</code></a> <a href="#apiserver-k8s-io-v1beta1-TLSConfig"><code>TLSConfig</code></a>
</td> </td>
<td> <td>
TLSConfig is the config needed to use TLS when connecting to konnectivity server</td> TLSConfig is the config needed to use TLS when connecting to konnectivity server</td>
@@ -309,14 +182,14 @@ As an example it might be "https://127.0.0.1:8131"</td>
## `TLSConfig` {#apiserver-k8s-io-v1alpha1-TLSConfig} ## `TLSConfig` {#apiserver-k8s-io-v1beta1-TLSConfig}
**Appears in:** **Appears in:**
- [TCPTransport](#apiserver-k8s-io-v1alpha1-TCPTransport) - [TCPTransport](#apiserver-k8s-io-v1beta1-TCPTransport)
TLSConfig provides the authentication information to connect to konnectivity server TLSConfig provides the authentication information to connect to konnectivity server
@@ -363,14 +236,14 @@ Must be configured if TCPTransport.URL is prefixed with https://</td>
## `Transport` {#apiserver-k8s-io-v1alpha1-Transport} ## `Transport` {#apiserver-k8s-io-v1beta1-Transport}
**Appears in:** **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 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
<tr><td><code>tcp</code><br/> <tr><td><code>tcp</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-TCPTransport"><code>TCPTransport</code></a> <a href="#apiserver-k8s-io-v1beta1-TCPTransport"><code>TCPTransport</code></a>
</td> </td>
<td> <td>
TCP is the TCP configuration for communicating with the konnectivity server via TCP 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</td>
<tr><td><code>uds</code><br/> <tr><td><code>uds</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-UDSTransport"><code>UDSTransport</code></a> <a href="#apiserver-k8s-io-v1beta1-UDSTransport"><code>UDSTransport</code></a>
</td> </td>
<td> <td>
UDS is the UDS configuration for communicating with the konnectivity server via UDS 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</td>
## `UDSTransport` {#apiserver-k8s-io-v1alpha1-UDSTransport} ## `UDSTransport` {#apiserver-k8s-io-v1beta1-UDSTransport}
**Appears in:** **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 UDSTransport provides the information to connect to konnectivity server via UDS
content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md
+129
View File
@@ -548,6 +548,8 @@ this always falls back to the userspace proxy.
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) - [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
@@ -611,6 +613,8 @@ client.</td>
**Appears in:** **Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) - [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
@@ -641,6 +645,75 @@ enableProfiling is true.</td>
</tr> </tr>
</tbody>
</table>
## `FormatOptions` {#FormatOptions}
**Appears in:**
- [LoggingConfiguration](#LoggingConfiguration)
FormatOptions contains options for the different logging formats.
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>json</code> <B>[Required]</B><br/>
<a href="#JSONOptions"><code>JSONOptions</code></a>
</td>
<td>
[Experimental] JSON contains options for logging format "json".</td>
</tr>
</tbody>
</table>
## `JSONOptions` {#JSONOptions}
**Appears in:**
- [FormatOptions](#FormatOptions)
JSONOptions contains options for logging format "json".
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>splitStream</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
[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.</td>
</tr>
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
<code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code>
</td>
<td>
[Experimental] InfoBufferSize sets the size of the info stream when
using split streams. The default is zero, which disables buffering.</td>
</tr>
</tbody> </tbody>
</table> </table>
@@ -653,6 +726,8 @@ enableProfiling is true.</td>
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) - [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
@@ -767,6 +842,35 @@ default value of format is `text`</td>
</tr> </tr>
<tr><td><code>flushFrequency</code> <B>[Required]</B><br/>
<a href="https://godoc.org/time#Duration"><code>time.Duration</code></a>
</td>
<td>
Maximum number of seconds between log flushes. Ignored if the
selected logging backend writes log messages without buffering.</td>
</tr>
<tr><td><code>verbosity</code> <B>[Required]</B><br/>
<code>uint32</code>
</td>
<td>
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.</td>
</tr>
<tr><td><code>vmodule</code> <B>[Required]</B><br/>
<a href="#VModuleConfiguration"><code>VModuleConfiguration</code></a>
</td>
<td>
VModule overrides the verbosity threshold for individual files.
Only supported for "text" log format.</td>
</tr>
<tr><td><code>sanitization</code> <B>[Required]</B><br/> <tr><td><code>sanitization</code> <B>[Required]</B><br/>
<code>bool</code> <code>bool</code>
</td> </td>
@@ -776,5 +880,30 @@ Runtime log sanitization may introduce significant computation overhead and ther
</tr> </tr>
<tr><td><code>options</code> <B>[Required]</B><br/>
<a href="#FormatOptions"><code>FormatOptions</code></a>
</td>
<td>
[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.</td>
</tr>
</tbody> </tbody>
</table> </table>
## `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.
content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md
+323 -847
View File
File diff suppressed because it is too large Load Diff
content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md
+1587
View File
File diff suppressed because it is too large Load Diff
content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md
+2 -2
View File
@@ -89,7 +89,7 @@ of the predicates after it finds one predicate that failed.</td>
**Appears in:** **Appears in:**
- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) - [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender)
- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) - [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender)
@@ -132,7 +132,7 @@ resource when applying predicates.</td>
**Appears in:** **Appears in:**
- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) - [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender)
- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) - [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender)
content/en/docs/reference/config-api/kubeadm-config.v1beta3.md
+216 -228
View File
File diff suppressed because it is too large Load Diff
content/en/docs/reference/config-api/kubelet-config.v1beta1.md
+226 -13
View File
@@ -493,14 +493,13 @@ Default: "5m"</td>
<code>int32</code> <code>int32</code>
</td> </td>
<td> <td>
nodeLeaseDurationSeconds is the duration the Kubelet will set on its corresponding Lease, 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 NodeLease provides an indicator of node health by having the Kubelet create and
health by having the Kubelet create and periodically renew a lease, named after the node, periodically renew a lease, named after the node, in the kube-node-lease namespace.
in the kube-node-lease namespace. If the lease expires, the node can be considered unhealthy. 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 The lease is currently renewed every 10s, per KEP-0009. In the future, the lease renewal
may be set based on the lease duration. interval may be set based on the lease duration.
The field value must be greater than 0. The field value must be greater than 0.
Requires the NodeLease feature gate to be enabled.
If DynamicKubeletConfig (deprecated; default off) is on, when If DynamicKubeletConfig (deprecated; default off) is on, when
dynamically updating this field, consider that dynamically updating this field, consider that
decreasing the duration may reduce tolerance for issues that temporarily prevent decreasing the duration may reduce tolerance for issues that temporarily prevent
@@ -514,11 +513,9 @@ Default: 40</td>
</td> </td>
<td> <td>
imageMinimumGCAge is the minimum age for an unused image before it is imageMinimumGCAge is the minimum age for an unused image before it is
garbage collected. garbage collected. If DynamicKubeletConfig (deprecated; default off)
If DynamicKubeletConfig (deprecated; default off) is on, when is on, when dynamically updating this field, consider that it may trigger or
dynamically updating this field, consider that delay garbage collection, and may change the image overhead on the node.
it may trigger or delay garbage collection, and may change the image overhead
on the node.
Default: "2m"</td> Default: "2m"</td>
</tr> </tr>
@@ -693,7 +690,7 @@ Valid values include:
requested resources; requested resources;
- `best-effort`: kubelet will favor pods with NUMA alignment of CPU and device - `best-effort`: kubelet will favor pods with NUMA alignment of CPU and device
resources; 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 - `single-numa-node`: kubelet only allows pods with a single NUMA alignment
of CPU and device resources. of CPU and device resources.
@@ -819,6 +816,7 @@ If DynamicKubeletConfig (deprecated; default off) is on, when
dynamically updating this field, consider that dynamically updating this field, consider that
changes will only take effect on Pods created after the update. Draining changes will only take effect on Pods created after the update. Draining
the node is recommended before changing this field. 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"</td> Default: "/etc/resolv.conf"</td>
</tr> </tr>
@@ -1417,6 +1415,39 @@ Default: "0s"</td>
</tr> </tr>
<tr><td><code>shutdownGracePeriodByPodPriority</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-ShutdownGracePeriodByPodPriority"><code>[]ShutdownGracePeriodByPodPriority</code></a>
</td>
<td>
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</td>
</tr>
<tr><td><code>reservedMemory</code><br/> <tr><td><code>reservedMemory</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-MemoryReservation"><code>[]MemoryReservation</code></a> <a href="#kubelet-config-k8s-io-v1beta1-MemoryReservation"><code>[]MemoryReservation</code></a>
</td> </td>
@@ -1485,6 +1516,26 @@ Default: 0.8</td>
</tr> </tr>
<tr><td><code>registerWithTaints</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#taint-v1-core"><code>[]core/v1.Taint</code></a>
</td>
<td>
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</td>
</tr>
<tr><td><code>registerNode</code><br/>
<code>bool</code>
</td>
<td>
registerNode enables automatic registration with the apiserver.
Default: true</td>
</tr>
</tbody> </tbody>
</table> </table>
@@ -1881,8 +1932,116 @@ 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
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>priority</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
priority is the priority value associated with the shutdown grace period</td>
</tr>
<tr><td><code>shutdownGracePeriodSeconds</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
shutdownGracePeriodSeconds is the shutdown grace period in seconds</td>
</tr>
</tbody>
</table>
## `FormatOptions` {#FormatOptions}
**Appears in:**
- [LoggingConfiguration](#LoggingConfiguration)
FormatOptions contains options for the different logging formats.
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>json</code> <B>[Required]</B><br/>
<a href="#JSONOptions"><code>JSONOptions</code></a>
</td>
<td>
[Experimental] JSON contains options for logging format "json".</td>
</tr>
</tbody>
</table>
## `JSONOptions` {#JSONOptions}
**Appears in:**
- [FormatOptions](#FormatOptions)
JSONOptions contains options for logging format "json".
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>splitStream</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
[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.</td>
</tr>
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
<code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code>
</td>
<td>
[Experimental] InfoBufferSize sets the size of the info stream when
using split streams. The default is zero, which disables buffering.</td>
</tr>
</tbody>
</table>
## `LoggingConfiguration` {#LoggingConfiguration} ## `LoggingConfiguration` {#LoggingConfiguration}
@@ -1911,6 +2070,35 @@ default value of format is `text`</td>
</tr> </tr>
<tr><td><code>flushFrequency</code> <B>[Required]</B><br/>
<a href="https://godoc.org/time#Duration"><code>time.Duration</code></a>
</td>
<td>
Maximum number of seconds between log flushes. Ignored if the
selected logging backend writes log messages without buffering.</td>
</tr>
<tr><td><code>verbosity</code> <B>[Required]</B><br/>
<code>uint32</code>
</td>
<td>
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.</td>
</tr>
<tr><td><code>vmodule</code> <B>[Required]</B><br/>
<a href="#VModuleConfiguration"><code>VModuleConfiguration</code></a>
</td>
<td>
VModule overrides the verbosity threshold for individual files.
Only supported for "text" log format.</td>
</tr>
<tr><td><code>sanitization</code> <B>[Required]</B><br/> <tr><td><code>sanitization</code> <B>[Required]</B><br/>
<code>bool</code> <code>bool</code>
</td> </td>
@@ -1920,5 +2108,30 @@ Runtime log sanitization may introduce significant computation overhead and ther
</tr> </tr>
<tr><td><code>options</code> <B>[Required]</B><br/>
<a href="#FormatOptions"><code>FormatOptions</code></a>
</td>
<td>
[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.</td>
</tr>
</tbody> </tbody>
</table> </table>
## `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.
content/en/docs/reference/scheduling/config.md
+3 -2
View File
@@ -20,7 +20,8 @@ by implementing one or more of these extension points.
You can specify scheduling profiles by running `kube-scheduler --config <filename>`, You can specify scheduling profiles by running `kube-scheduler --config <filename>`,
using the 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. struct.
A minimal configuration looks as follows: 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/) * Read the [kube-scheduler reference](/docs/reference/command-line-tools-reference/kube-scheduler/)
* Learn about [scheduling](/docs/concepts/scheduling-eviction/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 (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
content/en/docs/reference/scheduling/policies.md
+1 -1
View File
@@ -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 [scheduling](/docs/concepts/scheduling-eviction/kube-scheduler/)
* Learn about [kube-scheduler Configuration](/docs/reference/scheduling/config/) * 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/) * Read the [kube-scheduler Policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/)
content/en/docs/tasks/extend-kubernetes/configure-multiple-schedulers.md
+2 -2
View File
@@ -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. 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 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 >}} {{< note >}}
To determine if a scheduler is responsible for scheduling a specific Pod, the `spec.schedulerName` field in a 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`. 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 Please see the
[kube-scheduler documentation](/docs/reference/command-line-tools-reference/kube-scheduler/) for [kube-scheduler documentation](/docs/reference/command-line-tools-reference/kube-scheduler/) for
detailed description of other command line arguments and 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. detailed description of other customizable `kube-scheduler` configurations.
## Run the second scheduler in the cluster ## Run the second scheduler in the cluster