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

Merge pull request #30803 from tengqm/configapi-123

Browse Source 
Configuration API for v1.23
This commit is contained in:
Kubernetes Prow Robot
2021-12-08 15:25:45 -08:00
committed by GitHub
parent 532affacb0 b198199336
commit 2740d85747
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
+183 -195
View File
@@ -4,59 +4,58 @@ content_type: tool-reference
package: kubeadm.k8s.io/v1beta3 package: kubeadm.k8s.io/v1beta3
auto_generated: true auto_generated: true
--- ---
## Overview
Package v1beta3 defines the v1beta3 version of the kubeadm configuration file format. 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. This version improves on the v1beta2 format by fixing some minor issues and adding a few new fields.
A list of changes since v1beta2: 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. 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. DNS server type by kubeadm.
- Include "datapolicy" tags on the fields that hold secrets. - 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. 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. a list of phases during kubeadm init/join command execution.
- Add `InitConfiguration.nodeRegistration.imagePullPolicy" and - Add "InitConfiguration.NodeRegistration.ImagePullPolicy" and "JoinConfiguration.NodeRegistration.ImagePullPolicy"
`JoinConfiguration.nodeRegistration.imagePullPolicy` to allow specifying to allow specifying the images pull policy during kubeadm "init" and "join".
the images pull policy during kubeadm "init" and "join". The value must be The value must be one of "Always", "Never" or "IfNotPresent".
one of "Always", "Never" or "IfNotPresent". "IfNotPresent" is the default, "IfNotPresent" is the default, which has been the existing behavior prior to this addition.
which has been the existing behavior prior to this addition. - Add "InitConfiguration.Patches.Directory", "JoinConfiguration.Patches.Directory" to allow
- Add `InitConfiguration.patches.directory`, `JoinConfiguration.patches.directory` the user to configure a directory from which to take patches for components deployed by kubeadm.
to allow the user to configure a directory from which to take patches for - Move the BootstrapToken&lowast; API and related utilities out of the "kubeadm" API group to a new group
components deployed by kubeadm. "bootstraptoken". The kubeadm API version v1beta3 no longer contains the BootstrapToken&lowast; structures.
- Move the `BootstrapToken&lowast;` 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&lowast;` 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.15.x and newer can be used to migrate from 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.22.x and newer no longer support v1beta1 and older APIs, but can be used to migrate v1beta2 to v1beta3.
## Basics ## 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 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. 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: kubeadm supports the following configuration types:
```yaml ```yaml
apiVersion: kubeadm.k8s.io/v1beta3 apiVersion: kubeadm.k8s.io/v1beta3
kind: InitConfiguration kind: InitConfiguration
---
apiVersion: kubeadm.k8s.io/v1beta3 apiVersion: kubeadm.k8s.io/v1beta3
kind: ClusterConfiguration kind: ClusterConfiguration
---
apiVersion: kubelet.config.k8s.io/v1beta1 apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration kind: KubeletConfiguration
---
apiVersion: kubeproxy.config.k8s.io/v1alpha1 apiVersion: kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration kind: KubeProxyConfiguration
---
apiVersion: kubeadm.k8s.io/v1beta3 apiVersion: kubeadm.k8s.io/v1beta3
kind: JoinConfiguration 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 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 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. 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 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) 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 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 are the configuration of the bootstrap token and all the setting which are specific to the node where
is executed, including: kubeadm is executed, including:
- NodeRegistration, that holds fields that relate to registering the new node to the cluster; - 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 use it to customize the node name, the CRI socket to use or any other settings that should apply to this
@@ -107,7 +107,7 @@ is executed, including:
- LocalAPIEndpoint, that represents the endpoint of the instance of the API server to be deployed on this node; - 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. use it e.g. to customize the API server advertise address.
```yaml ```
apiVersion: kubeadm.k8s.io/v1beta3 apiVersion: kubeadm.k8s.io/v1beta3
kind: ClusterConfiguration kind: ClusterConfiguration
networking: networking:
@@ -126,9 +126,11 @@ The ClusterConfiguration type should be used to configure cluster-wide settings,
including settings for: including settings for:
- Networking, that holds configuration for the networking topology of the cluster; use it e.g. to customize - 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 - Etcd configurations; use it e.g. to customize the local etcd or to configure the API server
for using an external etcd cluster. for using an external etcd cluster.
- kube-apiserver, kube-scheduler, kube-controller-manager configurations; use it to customize control-plane - kube-apiserver, kube-scheduler, kube-controller-manager configurations; use it to customize control-plane
components by adding customized setting or overriding kubeadm default settings. components by adding customized setting or overriding kubeadm default settings.
@@ -138,35 +140,36 @@ including settings for:
... ...
``` ```
The KubeProxyConfiguration type should be used to change the configuration passed to kube-proxy instances deployed The KubeProxyConfiguration type should be used to change the configuration passed to kube-proxy instances
in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults. 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 See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ or
for kube proxy official documentation. https://godoc.org/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration
for kube-proxy official documentation.
```yaml ```yaml
apiVersion: kubelet.config.k8s.io/v1beta1 apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration kind: KubeletConfiguration
... ...
``` ```
The KubeletConfiguration type should be used to change the configurations that will be passed to all kubelet instances 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. 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. for kubelet official documentation.
Here is a fully populated example of a single YAML file containing multiple Here is a fully populated example of a single YAML file containing multiple
configuration types to be used during a `kubeadm init` run. configuration types to be used during a `kubeadm init` run.
```yaml
apiVersion: kubeadm.k8s.io/v1beta3 apiVersion: kubeadm.k8s.io/v1beta3
kind: InitConfiguration kind: InitConfiguration
bootstrapTokens: bootstrapTokens:
- token: "9a08jv.c0izixklcxtmnze7" - token: "9a08jv.c0izixklcxtmnze7"
description: "kubeadm bootstrap token" description: "kubeadm bootstrap token"
ttl: "24h" ttl: "24h"
- token: "783bde.3f89s0fje9f38fhf" - token: "783bde.3f89s0fje9f38fhf"
description: "another bootstrap token" description: "another bootstrap token"
usages: usages:
- authentication - authentication
@@ -182,15 +185,15 @@ nodeRegistration:
effect: "NoSchedule" effect: "NoSchedule"
kubeletExtraArgs: kubeletExtraArgs:
v: 4 v: 4
ignorePreflightErrors: ignorePreflightErrors:
- IsPrivilegedUser - IsPrivilegedUser
imagePullPolicy: "IfNotPresent" imagePullPolicy: "IfNotPresent"
localAPIEndpoint: localAPIEndpoint:
advertiseAddress: "10.100.0.1" advertiseAddress: "10.100.0.1"
bindPort: 6443 bindPort: 6443
certificateKey: "e6a2eb8581237ab72a4f494f30285ec12a9694d750b9785706a83bfcbbbd2204" certificateKey: "e6a2eb8581237ab72a4f494f30285ec12a9694d750b9785706a83bfcbbbd2204"
skipPhases: skipPhases:
- add/kube-proxy - addon/kube-proxy
--- ---
apiVersion: kubeadm.k8s.io/v1beta3 apiVersion: kubeadm.k8s.io/v1beta3
kind: ClusterConfiguration kind: ClusterConfiguration
@@ -214,10 +217,10 @@ etcd:
# certFile: "/etcd/kubernetes/pki/etcd/etcd.crt" # certFile: "/etcd/kubernetes/pki/etcd/etcd.crt"
# keyFile: "/etcd/kubernetes/pki/etcd/etcd.key" # keyFile: "/etcd/kubernetes/pki/etcd/etcd.key"
networking: networking:
serviceSubnet: "10.96.0.0/12" serviceSubnet: "10.96.0.0/16"
podSubnet: "10.100.0.1/24" podSubnet: "10.244.0.0/24"
dnsDomain: "cluster.local" dnsDomain: "cluster.local"
kubernetesVersion: "v1.12.0" kubernetesVersion: "v1.21.0"
controlPlaneEndpoint: "10.100.0.1:6443" controlPlaneEndpoint: "10.100.0.1:6443"
apiServer: apiServer:
extraArgs: extraArgs:
@@ -261,27 +264,26 @@ kind: KubeletConfiguration
apiVersion: kubeproxy.config.k8s.io/v1alpha1 apiVersion: kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration kind: KubeProxyConfiguration
# kube-proxy specific options here # kube-proxy specific options here
```
## Kubeadm join configuration types ## 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 ```yaml
apiVersion: kubeadm.k8s.io/v1beta3 apiVersion: kubeadm.k8s.io/v1beta3
kind: JoinConfiguration 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 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: to the node where kubeadm is executed, including:
- NodeRegistration, that holds fields that relate to registering the new node to the cluster; - 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 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). 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 ## Resource Types
@@ -315,7 +317,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster
<a href="#kubeadm-k8s-io-v1beta3-Etcd"><code>Etcd</code></a> <a href="#kubeadm-k8s-io-v1beta3-Etcd"><code>Etcd</code></a>
</td> </td>
<td> <td>
`etcd` holds configuration for etcd.</td> Etcd holds configuration for etcd.</td>
</tr> </tr>
@@ -323,7 +325,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster
<a href="#kubeadm-k8s-io-v1beta3-Networking"><code>Networking</code></a> <a href="#kubeadm-k8s-io-v1beta3-Networking"><code>Networking</code></a>
</td> </td>
<td> <td>
`networking` holds configuration for the networking topology of the cluster.</td> Networking holds configuration for the networking topology of the cluster.</td>
</tr> </tr>
@@ -331,7 +333,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`kubernetesVersion` is the target version of the control plane.</td> KubernetesVersion is the target version of the control plane.</td>
</tr> </tr>
@@ -339,18 +341,17 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`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. 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` In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort
are used; in case the `controlPlaneEndpoint` is specified but without a TCP port, are used; in case the ControlPlaneEndpoint is specified but without a TCP port,
the `bindPort` of the `localAPIEndpoint` is used. the BindPort is used.
Possible usages are: Possible usages are:
e.g. In a cluster with more than one control plane instances, this field should be
- 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
assigned the address of the external load balancer in front of the control plane instances.
control plane instances. e.g. in environments with enforced node recycling, the ControlPlaneEndpoint
- In environments with enforced node recycling, the ControlPlaneEndpoint could be used for assigning a stable DNS to the control plane.</td>
could be used for assigning a stable DNS to the control plane.</td>
</tr> </tr>
@@ -358,7 +359,7 @@ Possible usages are:
<a href="#kubeadm-k8s-io-v1beta3-APIServer"><code>APIServer</code></a> <a href="#kubeadm-k8s-io-v1beta3-APIServer"><code>APIServer</code></a>
</td> </td>
<td> <td>
`apiServer` contains extra settings for the API server.</td> APIServer contains extra settings for the API server control plane component</td>
</tr> </tr>
@@ -366,7 +367,7 @@ Possible usages are:
<a href="#kubeadm-k8s-io-v1beta3-ControlPlaneComponent"><code>ControlPlaneComponent</code></a> <a href="#kubeadm-k8s-io-v1beta3-ControlPlaneComponent"><code>ControlPlaneComponent</code></a>
</td> </td>
<td> <td>
`controllerManager` contains extra settings for the controller manager.</td> ControllerManager contains extra settings for the controller manager control plane component</td>
</tr> </tr>
@@ -374,7 +375,7 @@ Possible usages are:
<a href="#kubeadm-k8s-io-v1beta3-ControlPlaneComponent"><code>ControlPlaneComponent</code></a> <a href="#kubeadm-k8s-io-v1beta3-ControlPlaneComponent"><code>ControlPlaneComponent</code></a>
</td> </td>
<td> <td>
`scheduler` contains extra settings for the scheduler.</td> Scheduler contains extra settings for the scheduler control plane component</td>
</tr> </tr>
@@ -382,7 +383,7 @@ Possible usages are:
<a href="#kubeadm-k8s-io-v1beta3-DNS"><code>DNS</code></a> <a href="#kubeadm-k8s-io-v1beta3-DNS"><code>DNS</code></a>
</td> </td>
<td> <td>
`dns` defines the options for the DNS add-on.</td> DNS defines the options for the DNS add-on installed in the cluster.</td>
</tr> </tr>
@@ -390,7 +391,7 @@ Possible usages are:
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`certificatesDir` specifies where to store or look for all required certificates.</td> CertificatesDir specifies where to store or look for all required certificates.</td>
</tr> </tr>
@@ -398,11 +399,10 @@ Possible usages are:
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`imageRepository` sets the container registry to pull images from. 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 If empty, `k8s.gcr.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/`)
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`
`gcr.io/k8s-staging-ci-images` will be used as a default for control plane will be used for all the other images.</td>
components and for kube-proxy, while `k8s.gcr.io` will be used for all the other images.</td>
</tr> </tr>
@@ -410,7 +410,7 @@ components and for kube-proxy, while `k8s.gcr.io` will be used for all the other
<code>map[string]bool</code> <code>map[string]bool</code>
</td> </td>
<td> <td>
Feature gates enabled by the user.</td> FeatureGates enabled by the user.</td>
</tr> </tr>
@@ -418,7 +418,7 @@ components and for kube-proxy, while `k8s.gcr.io` will be used for all the other
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
The cluster name.</td> The cluster name</td>
</tr> </tr>
@@ -450,8 +450,8 @@ information.
<a href="#BootstrapToken"><code>[]BootstrapToken</code></a> <a href="#BootstrapToken"><code>[]BootstrapToken</code></a>
</td> </td>
<td> <td>
`bootstrapTokens` is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. 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.</td> This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature</td>
</tr> </tr>
@@ -459,7 +459,7 @@ This information IS NOT uploaded to the kubeadm cluster configmap, partly becaus
<a href="#kubeadm-k8s-io-v1beta3-NodeRegistrationOptions"><code>NodeRegistrationOptions</code></a> <a href="#kubeadm-k8s-io-v1beta3-NodeRegistrationOptions"><code>NodeRegistrationOptions</code></a>
</td> </td>
<td> <td>
`nodeRegistration` holds fields that relate to registering the new control-plane node to the cluster</td> NodeRegistration holds fields that relate to registering the new control-plane node to the cluster</td>
</tr> </tr>
@@ -467,7 +467,7 @@ This information IS NOT uploaded to the kubeadm cluster configmap, partly becaus
<a href="#kubeadm-k8s-io-v1beta3-APIEndpoint"><code>APIEndpoint</code></a> <a href="#kubeadm-k8s-io-v1beta3-APIEndpoint"><code>APIEndpoint</code></a>
</td> </td>
<td> <td>
`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 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 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 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.</td>
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`certificateKey` sets the key with which certificates and keys are encrypted prior to being uploaded in 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.</td> a secret in the cluster during the uploadcerts init phase.</td>
</tr> </tr>
@@ -489,9 +489,9 @@ a Secret in the cluster during the "uploadcerts" init phase.</td>
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
`skipPhases` is a list of phases to skip during command execution. 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 list of phases can be obtained with the "kubeadm init --help" command.
The flag `--skip-phases` takes precedence over this field.</td> The flag "--skip-phases" takes precedence over this field.</td>
</tr> </tr>
@@ -499,7 +499,7 @@ The flag `--skip-phases` takes precedence over this field.</td>
<a href="#kubeadm-k8s-io-v1beta3-Patches"><code>Patches</code></a> <a href="#kubeadm-k8s-io-v1beta3-Patches"><code>Patches</code></a>
</td> </td>
<td> <td>
`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".</td> "kubeadm init".</td>
</tr> </tr>
@@ -531,8 +531,7 @@ JoinConfiguration contains elements describing a particular node.
<a href="#kubeadm-k8s-io-v1beta3-NodeRegistrationOptions"><code>NodeRegistrationOptions</code></a> <a href="#kubeadm-k8s-io-v1beta3-NodeRegistrationOptions"><code>NodeRegistrationOptions</code></a>
</td> </td>
<td> <td>
`nodeRegistration` holds fields that relate to registering the new control-plane NodeRegistration holds fields that relate to registering the new control-plane node to the cluster</td>
node to the cluster</td>
</tr> </tr>
@@ -540,7 +539,7 @@ node to the cluster</td>
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`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. secure comunications between node and control-plane.
Defaults to "/etc/kubernetes/pki/ca.crt".</td> Defaults to "/etc/kubernetes/pki/ca.crt".</td>
</tr> </tr>
@@ -550,7 +549,7 @@ Defaults to "/etc/kubernetes/pki/ca.crt".</td>
<a href="#kubeadm-k8s-io-v1beta3-Discovery"><code>Discovery</code></a> <a href="#kubeadm-k8s-io-v1beta3-Discovery"><code>Discovery</code></a>
</td> </td>
<td> <td>
`discovery` specifies the options for the kubelet to use during the TLS Bootstrap process.</td> Discovery specifies the options for the kubelet to use during the TLS Bootstrap process</td>
</tr> </tr>
@@ -558,8 +557,8 @@ Defaults to "/etc/kubernetes/pki/ca.crt".</td>
<a href="#kubeadm-k8s-io-v1beta3-JoinControlPlane"><code>JoinControlPlane</code></a> <a href="#kubeadm-k8s-io-v1beta3-JoinControlPlane"><code>JoinControlPlane</code></a>
</td> </td>
<td> <td>
`controlPlane` defines the additional control plane instance to be deployed on the ControlPlane defines the additional control plane instance to be deployed on the joining node.
joining node. If nil, no additional control plane instance will be deployed.</td> If nil, no additional control plane instance will be deployed.</td>
</tr> </tr>
@@ -567,9 +566,9 @@ joining node. If nil, no additional control plane instance will be deployed.</td
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
`skipPhases` is a list of phases to skip during command execution. 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 list of phases can be obtained with the "kubeadm join --help" command.
The flag `--skip-phases` takes precedence over this field.</td> The flag "--skip-phases" takes precedence over this field.</td>
</tr> </tr>
@@ -577,8 +576,8 @@ The flag `--skip-phases` takes precedence over this field.</td>
<a href="#kubeadm-k8s-io-v1beta3-Patches"><code>Patches</code></a> <a href="#kubeadm-k8s-io-v1beta3-Patches"><code>Patches</code></a>
</td> </td>
<td> <td>
`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 join`.</td> "kubeadm join".</td>
</tr> </tr>
@@ -611,7 +610,7 @@ APIEndpoint struct contains elements of API server instance deployed on a node.
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`advertiseAddress` sets the IP address for the API server to advertise.</td> AdvertiseAddress sets the IP address for the API server to advertise.</td>
</tr> </tr>
@@ -619,7 +618,8 @@ APIEndpoint struct contains elements of API server instance deployed on a node.
<code>int32</code> <code>int32</code>
</td> </td>
<td> <td>
`bindPort` sets the secure port for the API Server to bind to. Defaults to 6443.</td> BindPort sets the secure port for the API Server to bind to.
Defaults to 6443.</td>
</tr> </tr>
@@ -659,7 +659,7 @@ APIServer holds settings necessary for API server deployments in the cluster
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
`certSANs` sets extra Subject Alternative Names for the API Server signing cert.</td> CertSANs sets extra Subject Alternative Names for the API Server signing cert.</td>
</tr> </tr>
@@ -667,7 +667,7 @@ APIServer holds settings necessary for API server deployments in the cluster
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a> <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td> </td>
<td> <td>
`timeoutForControlPlane` controls the timeout that we use for API server to appear</td> TimeoutForControlPlane controls the timeout that we use for API server to appear</td>
</tr> </tr>
@@ -698,7 +698,8 @@ BootstrapTokenDiscovery is used to set the options for bootstrap token based dis
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`token` is a token used to validate cluster information fetched from the control-plane.</td> Token is a token used to validate cluster information
fetched from the control-plane.</td>
</tr> </tr>
@@ -706,8 +707,7 @@ BootstrapTokenDiscovery is used to set the options for bootstrap token based dis
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`apiServerEndpoint` is an IP or domain name to the API server from which APIServerEndpoint is an IP or domain name to the API server from which info will be fetched.</td>
information will be fetched.</td>
</tr> </tr>
@@ -715,13 +715,13 @@ information will be fetched.</td>
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
CACertHashes specifies a set of public key pins to verify when token-based CACertHashes specifies a set of public key pins to verify
discovery is used. The root CA found during discovery must match one of these when token-based discovery is used. The root CA found during discovery
values. Specifying an empty set disables root CA pinning, which can be unsafe. must match one of these values. Specifying an empty set disables root CA
Each hash is specified as `<type>:<value>`, where the only currently supported pinning, which can be unsafe. Each hash is specified as "<type>:<value>",
type is "sha256". This is a hex-encoded SHA-256 hash of the Subject Public Key where the only currently supported type is "sha256". This is a hex-encoded
Info (SPKI) object in DER-encoded ASN.1. These hashes can be calculated using, SHA-256 hash of the Subject Public Key Info (SPKI) object in DER-encoded
for example, OpenSSL.</td> ASN.1. These hashes can be calculated using, for example, OpenSSL.</td>
</tr> </tr>
@@ -729,9 +729,9 @@ for example, OpenSSL.</td>
<code>bool</code> <code>bool</code>
</td> </td>
<td> <td>
`unsafeSkipCAVerification` allows token-based discovery without CA verification UnsafeSkipCAVerification allows token-based discovery
via `caCertHashes`. This can weaken the security of kubeadm since other nodes without CA verification via CACertHashes. This can weaken
can impersonate the control-plane.</td> the security of kubeadm since other nodes can impersonate the control-plane.</td>
</tr> </tr>
@@ -764,9 +764,11 @@ ControlPlaneComponent holds settings common to control plane component of the cl
<code>map[string]string</code> <code>map[string]string</code>
</td> </td>
<td> <td>
`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 A key in this map is the flag name as it appears on the
command line except without leading dash(es).</td> command line except without leading dash(es).
TODO: This is temporary and ideally we would like to switch all components to
use ComponentConfig + ConfigMaps.</td>
</tr> </tr>
@@ -774,7 +776,7 @@ command line except without leading dash(es).</td>
<a href="#kubeadm-k8s-io-v1beta3-HostPathMount"><code>[]HostPathMount</code></a> <a href="#kubeadm-k8s-io-v1beta3-HostPathMount"><code>[]HostPathMount</code></a>
</td> </td>
<td> <td>
`extraVolumes` is an extra set of host volumes, mounted to the control plane component.</td> ExtraVolumes is an extra set of host volumes, mounted to the control plane component.</td>
</tr> </tr>
@@ -805,7 +807,7 @@ DNS defines the DNS addon that should be used in the cluster
<a href="#kubeadm-k8s-io-v1beta3-ImageMeta"><code>ImageMeta</code></a> <a href="#kubeadm-k8s-io-v1beta3-ImageMeta"><code>ImageMeta</code></a>
</td> </td>
<td>(Members of <code>ImageMeta</code> are embedded into this type.) <td>(Members of <code>ImageMeta</code> are embedded into this type.)
`imageMeta` allows to customize the image used for the DNS component.</td> ImageMeta allows to customize the image used for the DNS component</td>
</tr> </tr>
@@ -848,8 +850,8 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap
<a href="#kubeadm-k8s-io-v1beta3-BootstrapTokenDiscovery"><code>BootstrapTokenDiscovery</code></a> <a href="#kubeadm-k8s-io-v1beta3-BootstrapTokenDiscovery"><code>BootstrapTokenDiscovery</code></a>
</td> </td>
<td> <td>
`bootstrapToken` is used to set the options for bootstrap token based discovery. BootstrapToken is used to set the options for bootstrap token based discovery
`bootstrapToken` and `file` are mutually exclusive.</td> BootstrapToken and File are mutually exclusive</td>
</tr> </tr>
@@ -857,8 +859,8 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap
<a href="#kubeadm-k8s-io-v1beta3-FileDiscovery"><code>FileDiscovery</code></a> <a href="#kubeadm-k8s-io-v1beta3-FileDiscovery"><code>FileDiscovery</code></a>
</td> </td>
<td> <td>
`file` specifies a file or URL to a kubeconfig file from which to load cluster information. 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.</td> BootstrapToken and File are mutually exclusive</td>
</tr> </tr>
@@ -866,11 +868,9 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`tlsBootstrapToken` is a token used for TLS bootstrapping. TLSBootstrapToken is a token used for TLS bootstrapping.
If `bootstrapToken` is set, this field is defaulted to `bootstrapToken.token`, If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden.
but can be overridden. If .File is set, this field &lowast;&lowast;must be set&lowast;&lowast; in case the KubeConfigFile does not contain any other authentication information</td>
If `file` is set, this field &lowast;&lowast;must be set&lowast;&lowast; in case the KubeConfigFile does
not contain any other authentication information</td>
</tr> </tr>
@@ -878,7 +878,7 @@ not contain any other authentication information</td>
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a> <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td> </td>
<td> <td>
`timeout` modifies the discovery timeout.</td> Timeout modifies the discovery timeout</td>
</tr> </tr>
@@ -909,8 +909,8 @@ Etcd contains elements describing Etcd configuration.
<a href="#kubeadm-k8s-io-v1beta3-LocalEtcd"><code>LocalEtcd</code></a> <a href="#kubeadm-k8s-io-v1beta3-LocalEtcd"><code>LocalEtcd</code></a>
</td> </td>
<td> <td>
`local` provides configuration knobs for configuring the local etcd instance. Local provides configuration knobs for configuring the local etcd instance
`local` and `external` are mutually exclusive.</td> Local and External are mutually exclusive</td>
</tr> </tr>
@@ -918,8 +918,8 @@ Etcd contains elements describing Etcd configuration.
<a href="#kubeadm-k8s-io-v1beta3-ExternalEtcd"><code>ExternalEtcd</code></a> <a href="#kubeadm-k8s-io-v1beta3-ExternalEtcd"><code>ExternalEtcd</code></a>
</td> </td>
<td> <td>
`external` describes how to connect to an external etcd cluster. External describes how to connect to an external etcd cluster
`local` and `external` are mutually exclusive.</td> Local and External are mutually exclusive</td>
</tr> </tr>
@@ -951,7 +951,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
`endpoints` are endpoints of etcd members. This field is required.</td> Endpoints of etcd members. Required for ExternalEtcd.</td>
</tr> </tr>
@@ -959,7 +959,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`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.</td> Required if using a TLS connection.</td>
</tr> </tr>
@@ -968,7 +968,7 @@ Required if using a TLS connection.</td>
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`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.</td> Required if using a TLS connection.</td>
</tr> </tr>
@@ -977,7 +977,7 @@ Required if using a TLS connection.</td>
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`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.</td> Required if using a TLS connection.</td>
</tr> </tr>
@@ -1009,8 +1009,7 @@ FileDiscovery is used to specify a file or URL to a kubeconfig file from which t
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`kubeConfigPath` specifies the actual file path or URL to the kubeconfig file KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information</td>
from which to load cluster information</td>
</tr> </tr>
@@ -1029,7 +1028,8 @@ from which to load cluster information</td>
- [ControlPlaneComponent](#kubeadm-k8s-io-v1beta3-ControlPlaneComponent) - [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.
<table class="table"> <table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
@@ -1041,7 +1041,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`name` is the volume name inside the Pod template.</td> Name of the volume inside the pod template.</td>
</tr> </tr>
@@ -1049,7 +1049,8 @@ HostPathMount contains elements describing volumes that are mounted from the hos
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`hostPath` is the path in the host that will be mounted inside the Pod.</td> HostPath is the path in the host that will be mounted inside
the pod.</td>
</tr> </tr>
@@ -1057,7 +1058,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`mountPath` is the path inside the Pod where the `hostPath` volume is mounted.</td> MountPath is the path inside the pod where hostPath will be mounted.</td>
</tr> </tr>
@@ -1065,7 +1066,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos
<code>bool</code> <code>bool</code>
</td> </td>
<td> <td>
`readOnly` controls write access to the volume.</td> ReadOnly controls write access to the volume</td>
</tr> </tr>
@@ -1073,7 +1074,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#hostpathtype-v1-core"><code>core/v1.HostPathType</code></a> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#hostpathtype-v1-core"><code>core/v1.HostPathType</code></a>
</td> </td>
<td> <td>
`pathType` is the type of the `hostPath` volume.</td> PathType is the type of the HostPath.</td>
</tr> </tr>
@@ -1107,8 +1108,8 @@ originated from the Kubernetes/Kubernetes release process
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`imageRepository` sets the container registry to pull images from. ImageRepository sets the container registry to pull images from.
If not set, the ImageRepository defined in ClusterConfiguration will be used instead.</td> if not set, the ImageRepository defined in ClusterConfiguration will be used instead.</td>
</tr> </tr>
@@ -1116,9 +1117,8 @@ If not set, the ImageRepository defined in ClusterConfiguration will be used ins
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`imageTag` allows to specify a tag for the image. ImageTag allows to specify a tag for the image.
In case this value is set, kubeadm does not change automatically the In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.</td>
version of the above components during upgrades.</td>
</tr> </tr>
@@ -1149,8 +1149,7 @@ JoinControlPlane contains elements describing an additional control plane instan
<a href="#kubeadm-k8s-io-v1beta3-APIEndpoint"><code>APIEndpoint</code></a> <a href="#kubeadm-k8s-io-v1beta3-APIEndpoint"><code>APIEndpoint</code></a>
</td> </td>
<td> <td>
`localAPIEndpoint` represents the endpoint of the API server instance to be deployed LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node.</td>
on this node.</td>
</tr> </tr>
@@ -1158,9 +1157,8 @@ on this node.</td>
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`certificateKey` is the key that is used for decryption of certificates after they CertificateKey is the key that is used for decryption of certificates after they are downloaded from the secret
are downloaded from the secret upon joining a new control plane node. The upon joining a new control plane node. The corresponding encryption key is in the InitConfiguration.</td>
corresponding encryption key is in the InitConfiguration.</td>
</tr> </tr>
@@ -1191,7 +1189,7 @@ LocalEtcd describes that kubeadm should run an etcd cluster locally
<a href="#kubeadm-k8s-io-v1beta3-ImageMeta"><code>ImageMeta</code></a> <a href="#kubeadm-k8s-io-v1beta3-ImageMeta"><code>ImageMeta</code></a>
</td> </td>
<td>(Members of <code>ImageMeta</code> are embedded into this type.) <td>(Members of <code>ImageMeta</code> are embedded into this type.)
`ImageMeta` allows to customize the container used for etcd.</td> ImageMeta allows to customize the container used for etcd</td>
</tr> </tr>
@@ -1199,7 +1197,7 @@ LocalEtcd describes that kubeadm should run an etcd cluster locally
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`dataDir` is the directory etcd will place its data. DataDir is the directory etcd will place its data.
Defaults to "/var/lib/etcd".</td> Defaults to "/var/lib/etcd".</td>
</tr> </tr>
@@ -1208,10 +1206,10 @@ Defaults to "/var/lib/etcd".</td>
<code>map[string]string</code> <code>map[string]string</code>
</td> </td>
<td> <td>
`extraArgs` are extra arguments provided to the etcd binary ExtraArgs are extra arguments provided to the etcd binary
when run inside a static pod. when run inside a static pod.
A key in this map is the flag name as it appears on the command line except A key in this map is the flag name as it appears on the
without leading dash(es).</td> command line except without leading dash(es).</td>
</tr> </tr>
@@ -1219,7 +1217,7 @@ without leading dash(es).</td>
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
`serverCertSANs` sets extra Subject Alternative Names for the etcd server signing cert.</td> ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert.</td>
</tr> </tr>
@@ -1227,7 +1225,7 @@ without leading dash(es).</td>
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
`peerCertSANs` sets extra Subject Alternative Names for the etcd peer signing cert.</td> PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert.</td>
</tr> </tr>
@@ -1258,7 +1256,7 @@ Networking contains elements describing cluster's networking configuration
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`serviceSubnet` is the subnet used by k8s services. Defaults to "10.96.0.0/12".</td> ServiceSubnet is the subnet used by k8s services. Defaults to "10.96.0.0/12".</td>
</tr> </tr>
@@ -1266,7 +1264,7 @@ Networking contains elements describing cluster's networking configuration
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`podSubnet` is the subnet used by Pods.</td> PodSubnet is the subnet used by pods.</td>
</tr> </tr>
@@ -1274,7 +1272,7 @@ Networking contains elements describing cluster's networking configuration
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`dnsDomain` is the DNS domain used by k8s services. Defaults to "cluster.local".</td> DNSDomain is the dns domain used by k8s services. Defaults to "cluster.local".</td>
</tr> </tr>
@@ -1307,10 +1305,9 @@ NodeRegistrationOptions holds fields that relate to registering a new control-pl
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`name` is the `.metadata.name` field of the Node API object that will be created in this Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation.
`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.
This field is also used in the `CommonName` field of the kubelet's client certificate to the Defaults to the hostname of the node if not provided.</td>
API server. Defaults to the hostname of the node if not provided.</td>
</tr> </tr>
@@ -1318,8 +1315,7 @@ API server. Defaults to the hostname of the node if not provided.</td>
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`criSocket` is used to retrieve container runtime info. This information will be CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use</td>
annotated to the Node API object, for later re-use.</td>
</tr> </tr>
@@ -1327,11 +1323,9 @@ annotated to the Node API object, for later re-use.</td>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#taint-v1-core"><code>[]core/v1.Taint</code></a> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#taint-v1-core"><code>[]core/v1.Taint</code></a>
</td> </td>
<td> <td>
`taints` specifies the taints the Node API object should be registered with. If 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
this field is unset, i.e. nil, in the `kubeadm init` process, it will be defaulted 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
to `['"node-role.kubernetes.io/master"=""']`. If you don't want to taint your empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration.</td>
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.</td>
</tr> </tr>
@@ -1339,13 +1333,11 @@ file. This field is solely used for Node registration.</td>
<code>map[string]string</code> <code>map[string]string</code>
</td> </td>
<td> <td>
`kubeletExtraArgs` passes through extra arguments to the kubelet. The arguments here KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file
are passed to the kubelet command line via the environment file kubeadm writes at kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap
runtime for the kubelet to source. This overrides the generic base-level Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.
configuration in the "kubelet-config-1.X" ConfigMap. Flags have higher priority when A key in this map is the flag name as it appears on the
parsing. These values are local and specific to the node kubeadm is executing on. command line except without leading dash(es).</td>
A key in this map is the flag name as it appears on the command line except without
leading dash(es).</td>
</tr> </tr>
@@ -1353,8 +1345,7 @@ leading dash(es).</td>
<code>[]string</code> <code>[]string</code>
</td> </td>
<td> <td>
`ignorePreflightErrors` provides a slice of pre-flight errors to be ignored when IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered.</td>
the current node is registered.</td>
</tr> </tr>
@@ -1362,11 +1353,9 @@ the current node is registered.</td>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#pullpolicy-v1-core"><code>core/v1.PullPolicy</code></a> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#pullpolicy-v1-core"><code>core/v1.PullPolicy</code></a>
</td> </td>
<td> <td>
`imagePullPolicy` specifies the policy for image pulling during `kubeadm init` and ImagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations.
`kubeadm join` operations.
The value of this field must be one of "Always", "IfNotPresent" or "Never". 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 If this field is unset kubeadm will default it to "IfNotPresent", or pull the required images if not present on the host.</td>
images if not present on the host.</td>
</tr> </tr>
@@ -1399,13 +1388,12 @@ Patches contains options related to applying patches to components deployed by k
<code>string</code> <code>string</code>
</td> </td>
<td> <td>
`directory` is a path to a directory that contains files named Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension".
`target[suffix][+patchtype].extension`. For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of
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
"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.
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".
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
`suffix` is an optional string that can be used to determine which patches are applied
first alpha-numerically.</td> first alpha-numerically.</td>
</tr> </tr>
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