Improve configuration API for 1.23
The previous commit for configuration APIs has some nits to fix: - The client-authentication API has both v1beta1 and v1 supported. We need to include both. - The kube-scheduler v1alpha1 is superceded by v1alpha3 which is new. - The links to some external type definitions should point to the 1.23 API rather than old versions.
This commit is contained in:
@@ -73,14 +73,16 @@ 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 (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/)
|
|
||||||
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/)
|
* [kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/)
|
||||||
* [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
|
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) and
|
||||||
* [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/)
|
[kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
|
||||||
* [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/)
|
* [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) and
|
||||||
|
[kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/)
|
||||||
* [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/)
|
||||||
* [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/)
|
* [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) and
|
||||||
|
[Client authentication API (v1)](/docs/reference/config-api/client-authentication.v1/)
|
||||||
* [WebhookAdmission configuration (v1)](/docs/reference/config-api/apiserver-webhookadmission.v1/)
|
* [WebhookAdmission configuration (v1)](/docs/reference/config-api/apiserver-webhookadmission.v1/)
|
||||||
|
|
||||||
## Config API for kubeadm
|
## Config API for kubeadm
|
||||||
|
|||||||
@@ -1232,3 +1232,5 @@ The following `ExecCredential` manifest describes a cluster information sample.
|
|||||||
## {{% heading "whatsnext" %}}
|
## {{% heading "whatsnext" %}}
|
||||||
|
|
||||||
* Read the [client authentication reference (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/)
|
* Read the [client authentication reference (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/)
|
||||||
|
* Read the [client authentication reference (v1)](/docs/reference/config-api/client-authentication.v1/)
|
||||||
|
|
||||||
|
|||||||
@@ -16,14 +16,12 @@ auto_generated: true
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Event` {#audit-k8s-io-v1-Event}
|
## `Event` {#audit-k8s-io-v1-Event}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [EventList](#audit-k8s-io-v1-EventList)
|
- [EventList](#audit-k8s-io-v1-EventList)
|
||||||
|
|
||||||
|
|
||||||
@@ -81,7 +79,7 @@ For non-resource requests, this is the lower-cased HTTP method.</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>user</code> <B>[Required]</B><br/>
|
<tr><td><code>user</code> <B>[Required]</B><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Authenticated user information.</td>
|
Authenticated user information.</td>
|
||||||
@@ -89,7 +87,7 @@ For non-resource requests, this is the lower-cased HTTP method.</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>impersonatedUser</code><br/>
|
<tr><td><code>impersonatedUser</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#userinfo-v1-authentication"><code>authentication/v1.UserInfo</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Impersonated user information.</td>
|
Impersonated user information.</td>
|
||||||
@@ -123,7 +121,7 @@ Does not apply for List-type requests, or non-resource requests.</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>responseStatus</code><br/>
|
<tr><td><code>responseStatus</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#status-v1-meta"><code>meta/v1.Status</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta"><code>meta/v1.Status</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
The response status, populated even when the ResponseObject is not a Status type.
|
The response status, populated even when the ResponseObject is not a Status type.
|
||||||
@@ -154,7 +152,7 @@ at Response Level.</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>requestReceivedTimestamp</code><br/>
|
<tr><td><code>requestReceivedTimestamp</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Time the request reached the apiserver.</td>
|
Time the request reached the apiserver.</td>
|
||||||
@@ -162,7 +160,7 @@ at Response Level.</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>stageTimestamp</code><br/>
|
<tr><td><code>stageTimestamp</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Time the request reached current audit stage.</td>
|
Time the request reached current audit stage.</td>
|
||||||
@@ -184,8 +182,6 @@ should be short. Annotations are included in the Metadata level.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `EventList` {#audit-k8s-io-v1-EventList}
|
## `EventList` {#audit-k8s-io-v1-EventList}
|
||||||
|
|
||||||
@@ -206,7 +202,7 @@ EventList is a list of audit Events.
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>metadata</code><br/>
|
<tr><td><code>metadata</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<span class="text-muted">No description provided.</span>
|
<span class="text-muted">No description provided.</span>
|
||||||
@@ -225,8 +221,6 @@ EventList is a list of audit Events.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Policy` {#audit-k8s-io-v1-Policy}
|
## `Policy` {#audit-k8s-io-v1-Policy}
|
||||||
|
|
||||||
@@ -234,7 +228,6 @@ EventList is a list of audit Events.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [PolicyList](#audit-k8s-io-v1-PolicyList)
|
- [PolicyList](#audit-k8s-io-v1-PolicyList)
|
||||||
|
|
||||||
|
|
||||||
@@ -252,7 +245,7 @@ categories are logged.
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>metadata</code><br/>
|
<tr><td><code>metadata</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
ObjectMeta is included for interoperability with API infrastructure.Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td>
|
ObjectMeta is included for interoperability with API infrastructure.Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td>
|
||||||
@@ -294,8 +287,6 @@ in a rule will override the global default.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PolicyList` {#audit-k8s-io-v1-PolicyList}
|
## `PolicyList` {#audit-k8s-io-v1-PolicyList}
|
||||||
|
|
||||||
@@ -316,7 +307,7 @@ PolicyList is a list of audit Policies.
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>metadata</code><br/>
|
<tr><td><code>metadata</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<span class="text-muted">No description provided.</span>
|
<span class="text-muted">No description provided.</span>
|
||||||
@@ -335,8 +326,6 @@ PolicyList is a list of audit Policies.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `GroupResources` {#audit-k8s-io-v1-GroupResources}
|
## `GroupResources` {#audit-k8s-io-v1-GroupResources}
|
||||||
|
|
||||||
@@ -344,7 +333,6 @@ PolicyList is a list of audit Policies.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
|
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
|
||||||
|
|
||||||
|
|
||||||
@@ -397,8 +385,6 @@ An empty list implies that every instance of the resource is matched.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Level` {#audit-k8s-io-v1-Level}
|
## `Level` {#audit-k8s-io-v1-Level}
|
||||||
|
|
||||||
@@ -406,17 +392,13 @@ An empty list implies that every instance of the resource is matched.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Event](#audit-k8s-io-v1-Event)
|
- [Event](#audit-k8s-io-v1-Event)
|
||||||
|
|
||||||
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
|
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
|
||||||
|
|
||||||
|
|
||||||
Level defines the amount of information logged during auditing
|
Level defines the amount of information logged during auditing
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ObjectReference` {#audit-k8s-io-v1-ObjectReference}
|
## `ObjectReference` {#audit-k8s-io-v1-ObjectReference}
|
||||||
|
|
||||||
@@ -424,7 +406,6 @@ Level defines the amount of information logged during auditing
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Event](#audit-k8s-io-v1-Event)
|
- [Event](#audit-k8s-io-v1-Event)
|
||||||
|
|
||||||
|
|
||||||
@@ -509,8 +490,6 @@ The empty string represents the core API group.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PolicyRule` {#audit-k8s-io-v1-PolicyRule}
|
## `PolicyRule` {#audit-k8s-io-v1-PolicyRule}
|
||||||
|
|
||||||
@@ -518,7 +497,6 @@ The empty string represents the core API group.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Policy](#audit-k8s-io-v1-Policy)
|
- [Policy](#audit-k8s-io-v1-Policy)
|
||||||
|
|
||||||
|
|
||||||
@@ -624,8 +602,6 @@ Policy.OmitManagedFields will stand.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Stage` {#audit-k8s-io-v1-Stage}
|
## `Stage` {#audit-k8s-io-v1-Stage}
|
||||||
|
|
||||||
@@ -633,16 +609,12 @@ Policy.OmitManagedFields will stand.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Event](#audit-k8s-io-v1-Event)
|
- [Event](#audit-k8s-io-v1-Event)
|
||||||
|
|
||||||
- [Policy](#audit-k8s-io-v1-Policy)
|
- [Policy](#audit-k8s-io-v1-Policy)
|
||||||
|
|
||||||
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
|
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
|
||||||
|
|
||||||
|
|
||||||
Stage defines the stages in request handling that audit events may be generated.
|
Stage defines the stages in request handling that audit events may be generated.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,91 @@
|
|||||||
|
---
|
||||||
|
title: kube-apiserver Configuration (v1)
|
||||||
|
content_type: tool-reference
|
||||||
|
package: apiserver.config.k8s.io/v1
|
||||||
|
auto_generated: true
|
||||||
|
---
|
||||||
|
Package v1 is the v1 version of the API.
|
||||||
|
|
||||||
|
## Resource Types
|
||||||
|
|
||||||
|
|
||||||
|
- [AdmissionConfiguration](#apiserver-config-k8s-io-v1-AdmissionConfiguration)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `AdmissionConfiguration` {#apiserver-config-k8s-io-v1-AdmissionConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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.config.k8s.io/v1</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-config-k8s-io-v1-AdmissionPluginConfiguration"><code>[]AdmissionPluginConfiguration</code></a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Plugins allows specifying a configuration per admission control plugin.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
## `AdmissionPluginConfiguration` {#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**Appears in:**
|
||||||
|
- [AdmissionConfiguration](#apiserver-config-k8s-io-v1-AdmissionConfiguration)
|
||||||
|
|
||||||
|
|
||||||
|
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>
|
||||||
|
|
||||||
@@ -1,311 +0,0 @@
|
|||||||
---
|
|
||||||
title: kube-apiserver Configuration (v1beta1)
|
|
||||||
content_type: tool-reference
|
|
||||||
package: apiserver.k8s.io/v1beta1
|
|
||||||
auto_generated: true
|
|
||||||
---
|
|
||||||
Package v1beta1 is the v1beta1 version of the API.
|
|
||||||
|
|
||||||
## Resource Types
|
|
||||||
|
|
||||||
|
|
||||||
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
EgressSelectorConfiguration provides versioned configuration for egress selector 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/v1beta1</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/>
|
|
||||||
<a href="#apiserver-k8s-io-v1beta1-EgressSelection"><code>[]EgressSelection</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
connectionServices contains a list of egress selection client configurations</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Connection` {#apiserver-k8s-io-v1beta1-Connection}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [EgressSelection](#apiserver-k8s-io-v1beta1-EgressSelection)
|
|
||||||
|
|
||||||
|
|
||||||
Connection provides the configuration for a single egress selection client.
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>proxyProtocol</code> <B>[Required]</B><br/>
|
|
||||||
<a href="#apiserver-k8s-io-v1beta1-ProtocolType"><code>ProtocolType</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
Protocol is the protocol used to connect from client to the konnectivity server.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>transport</code><br/>
|
|
||||||
<a href="#apiserver-k8s-io-v1beta1-Transport"><code>Transport</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
Transport defines the transport configurations we use to dial to the konnectivity server.
|
|
||||||
This is required if ProxyProtocol is HTTPConnect or GRPC.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `EgressSelection` {#apiserver-k8s-io-v1beta1-EgressSelection}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
EgressSelection provides the configuration for a single egress selection client.
|
|
||||||
|
|
||||||
<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 egress selection.
|
|
||||||
Currently supported values are "controlplane", "master", "etcd" and "cluster"
|
|
||||||
The "master" egress selector is deprecated in favor of "controlplane"</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>connection</code> <B>[Required]</B><br/>
|
|
||||||
<a href="#apiserver-k8s-io-v1beta1-Connection"><code>Connection</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
connection is the exact information used to configure the egress selection</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ProtocolType` {#apiserver-k8s-io-v1beta1-ProtocolType}
|
|
||||||
|
|
||||||
(Alias of `string`)
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [Connection](#apiserver-k8s-io-v1beta1-Connection)
|
|
||||||
|
|
||||||
|
|
||||||
ProtocolType is a set of valid values for Connection.ProtocolType
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `TCPTransport` {#apiserver-k8s-io-v1beta1-TCPTransport}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [Transport](#apiserver-k8s-io-v1beta1-Transport)
|
|
||||||
|
|
||||||
|
|
||||||
TCPTransport provides the information to connect to konnectivity server via TCP
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>url</code> <B>[Required]</B><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
URL is the location of the konnectivity server to connect to.
|
|
||||||
As an example it might be "https://127.0.0.1:8131"</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>tlsConfig</code><br/>
|
|
||||||
<a href="#apiserver-k8s-io-v1beta1-TLSConfig"><code>TLSConfig</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
TLSConfig is the config needed to use TLS when connecting to konnectivity server</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `TLSConfig` {#apiserver-k8s-io-v1beta1-TLSConfig}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [TCPTransport](#apiserver-k8s-io-v1beta1-TCPTransport)
|
|
||||||
|
|
||||||
|
|
||||||
TLSConfig provides the authentication information to connect to konnectivity server
|
|
||||||
Only used with TCPTransport
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>caBundle</code><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
caBundle is the file location of the CA to be used to determine trust with the konnectivity server.
|
|
||||||
Must be absent/empty if TCPTransport.URL is prefixed with http://
|
|
||||||
If absent while TCPTransport.URL is prefixed with https://, default to system trust roots.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>clientKey</code><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
clientKey is the file location of the client key to be used in mtls handshakes with the konnectivity server.
|
|
||||||
Must be absent/empty if TCPTransport.URL is prefixed with http://
|
|
||||||
Must be configured if TCPTransport.URL is prefixed with https://</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>clientCert</code><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
clientCert is the file location of the client certificate to be used in mtls handshakes with the konnectivity server.
|
|
||||||
Must be absent/empty if TCPTransport.URL is prefixed with http://
|
|
||||||
Must be configured if TCPTransport.URL is prefixed with https://</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Transport` {#apiserver-k8s-io-v1beta1-Transport}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [Connection](#apiserver-k8s-io-v1beta1-Connection)
|
|
||||||
|
|
||||||
|
|
||||||
Transport defines the transport configurations we use to dial to the konnectivity server
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>tcp</code><br/>
|
|
||||||
<a href="#apiserver-k8s-io-v1beta1-TCPTransport"><code>TCPTransport</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
TCP is the TCP configuration for communicating with the konnectivity server via TCP
|
|
||||||
ProxyProtocol of GRPC is not supported with TCP transport at the moment
|
|
||||||
Requires at least one of TCP or UDS to be set</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>uds</code><br/>
|
|
||||||
<a href="#apiserver-k8s-io-v1beta1-UDSTransport"><code>UDSTransport</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
UDS is the UDS configuration for communicating with the konnectivity server via UDS
|
|
||||||
Requires at least one of TCP or UDS to be set</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `UDSTransport` {#apiserver-k8s-io-v1beta1-UDSTransport}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [Transport](#apiserver-k8s-io-v1beta1-Transport)
|
|
||||||
|
|
||||||
|
|
||||||
UDSTransport provides the information to connect to konnectivity server via UDS
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>udsName</code> <B>[Required]</B><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
UDSName is the name of the unix domain socket to connect to konnectivity server
|
|
||||||
This does not use a unix:// prefix. (Eg: /etc/srv/kubernetes/konnectivity-server/konnectivity-server.socket)</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
@@ -13,7 +13,6 @@ Package v1 is the v1 version of the API.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `WebhookAdmission` {#apiserver-config-k8s-io-v1-WebhookAdmission}
|
## `WebhookAdmission` {#apiserver-config-k8s-io-v1-WebhookAdmission}
|
||||||
|
|
||||||
|
|
||||||
@@ -42,5 +41,4 @@ WebhookAdmission provides configuration for the webhook admission controller.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,249 @@
|
|||||||
|
---
|
||||||
|
title: Client Authentication (v1)
|
||||||
|
content_type: tool-reference
|
||||||
|
package: client.authentication.k8s.io/v1
|
||||||
|
auto_generated: true
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
## Resource Types
|
||||||
|
|
||||||
|
|
||||||
|
- [ExecCredential](#client-authentication-k8s-io-v1-ExecCredential)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `ExecCredential` {#client-authentication-k8s-io-v1-ExecCredential}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
ExecCredential is used by exec-based plugins to communicate credentials to
|
||||||
|
HTTP transports.
|
||||||
|
|
||||||
|
<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>client.authentication.k8s.io/v1</code></td></tr>
|
||||||
|
<tr><td><code>kind</code><br/>string</td><td><code>ExecCredential</code></td></tr>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>spec</code> <B>[Required]</B><br/>
|
||||||
|
<a href="#client-authentication-k8s-io-v1-ExecCredentialSpec"><code>ExecCredentialSpec</code></a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Spec holds information passed to the plugin by the transport.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>status</code><br/>
|
||||||
|
<a href="#client-authentication-k8s-io-v1-ExecCredentialStatus"><code>ExecCredentialStatus</code></a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Status is filled in by the plugin and holds the credentials that the transport
|
||||||
|
should use to contact the API.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
## `Cluster` {#client-authentication-k8s-io-v1-Cluster}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**Appears in:**
|
||||||
|
- [ExecCredentialSpec](#client-authentication-k8s-io-v1-ExecCredentialSpec)
|
||||||
|
|
||||||
|
|
||||||
|
Cluster contains information to allow an exec plugin to communicate
|
||||||
|
with the kubernetes cluster being authenticated to.
|
||||||
|
|
||||||
|
To ensure that this struct contains everything someone would need to communicate
|
||||||
|
with a kubernetes cluster (just like they would via a kubeconfig), the fields
|
||||||
|
should shadow "k8s.io/client-go/tools/clientcmd/api/v1".Cluster, with the exception
|
||||||
|
of CertificateAuthority, since CA data will always be passed to the plugin as bytes.
|
||||||
|
|
||||||
|
<table class="table">
|
||||||
|
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
||||||
|
<tbody>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>server</code> <B>[Required]</B><br/>
|
||||||
|
<code>string</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Server is the address of the kubernetes cluster (https://hostname:port).</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>tls-server-name</code><br/>
|
||||||
|
<code>string</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
TLSServerName is passed to the server for SNI and is used in the client to
|
||||||
|
check server certificates against. If ServerName is empty, the hostname
|
||||||
|
used to contact the server is used.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>insecure-skip-tls-verify</code><br/>
|
||||||
|
<code>bool</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
InsecureSkipTLSVerify skips the validity check for the server's certificate.
|
||||||
|
This will make your HTTPS connections insecure.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>certificate-authority-data</code><br/>
|
||||||
|
<code>[]byte</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
CAData contains PEM-encoded certificate authority certificates.
|
||||||
|
If empty, system roots should be used.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>proxy-url</code><br/>
|
||||||
|
<code>string</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
ProxyURL is the URL to the proxy to be used for all requests to this
|
||||||
|
cluster.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>config</code><br/>
|
||||||
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Config holds additional config data that is specific to the exec
|
||||||
|
plugin with regards to the cluster being authenticated to.
|
||||||
|
|
||||||
|
This data is sourced from the clientcmd Cluster object's
|
||||||
|
extensions[client.authentication.k8s.io/exec] field:
|
||||||
|
|
||||||
|
clusters:
|
||||||
|
- name: my-cluster
|
||||||
|
cluster:
|
||||||
|
...
|
||||||
|
extensions:
|
||||||
|
- name: client.authentication.k8s.io/exec # reserved extension name for per cluster exec config
|
||||||
|
extension:
|
||||||
|
audience: 06e3fbd18de8 # arbitrary config
|
||||||
|
|
||||||
|
In some environments, the user config may be exactly the same across many clusters
|
||||||
|
(i.e. call this exec plugin) minus some details that are specific to each cluster
|
||||||
|
such as the audience. This field allows the per cluster config to be directly
|
||||||
|
specified with the cluster info. Using this field to store secret data is not
|
||||||
|
recommended as one of the prime benefits of exec plugins is that no secrets need
|
||||||
|
to be stored directly in the kubeconfig.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
## `ExecCredentialSpec` {#client-authentication-k8s-io-v1-ExecCredentialSpec}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**Appears in:**
|
||||||
|
- [ExecCredential](#client-authentication-k8s-io-v1-ExecCredential)
|
||||||
|
|
||||||
|
|
||||||
|
ExecCredentialSpec holds request and runtime specific information provided by
|
||||||
|
the transport.
|
||||||
|
|
||||||
|
<table class="table">
|
||||||
|
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
||||||
|
<tbody>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>cluster</code><br/>
|
||||||
|
<a href="#client-authentication-k8s-io-v1-Cluster"><code>Cluster</code></a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Cluster contains information to allow an exec plugin to communicate with the
|
||||||
|
kubernetes cluster being authenticated to. Note that Cluster is non-nil only
|
||||||
|
when provideClusterInfo is set to true in the exec provider config (i.e.,
|
||||||
|
ExecConfig.ProvideClusterInfo).</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>interactive</code> <B>[Required]</B><br/>
|
||||||
|
<code>bool</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Interactive declares whether stdin has been passed to this exec plugin.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
## `ExecCredentialStatus` {#client-authentication-k8s-io-v1-ExecCredentialStatus}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**Appears in:**
|
||||||
|
- [ExecCredential](#client-authentication-k8s-io-v1-ExecCredential)
|
||||||
|
|
||||||
|
|
||||||
|
ExecCredentialStatus holds credentials for the transport to use.
|
||||||
|
|
||||||
|
Token and ClientKeyData are sensitive fields. This data should only be
|
||||||
|
transmitted in-memory between client and exec plugin process. Exec plugin
|
||||||
|
itself should at least be protected via file permissions.
|
||||||
|
|
||||||
|
<table class="table">
|
||||||
|
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
||||||
|
<tbody>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>expirationTimestamp</code><br/>
|
||||||
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#time-v1-meta"><code>meta/v1.Time</code></a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
ExpirationTimestamp indicates a time when the provided credentials expire.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>token</code> <B>[Required]</B><br/>
|
||||||
|
<code>string</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Token is a bearer token used by the client for request authentication.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>clientCertificateData</code> <B>[Required]</B><br/>
|
||||||
|
<code>string</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
PEM-encoded client TLS certificates (including intermediates, if any).</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>clientKeyData</code> <B>[Required]</B><br/>
|
||||||
|
<code>string</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
PEM-encoded private key for the above certificate.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
@@ -13,13 +13,10 @@ auto_generated: true
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ExecCredential` {#client-authentication-k8s-io-v1beta1-ExecCredential}
|
## `ExecCredential` {#client-authentication-k8s-io-v1beta1-ExecCredential}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
ExecCredential is used by exec-based plugins to communicate credentials to
|
ExecCredential is used by exec-based plugins to communicate credentials to
|
||||||
HTTP transports.
|
HTTP transports.
|
||||||
|
|
||||||
@@ -30,41 +27,32 @@ HTTP transports.
|
|||||||
<tr><td><code>apiVersion</code><br/>string</td><td><code>client.authentication.k8s.io/v1beta1</code></td></tr>
|
<tr><td><code>apiVersion</code><br/>string</td><td><code>client.authentication.k8s.io/v1beta1</code></td></tr>
|
||||||
<tr><td><code>kind</code><br/>string</td><td><code>ExecCredential</code></td></tr>
|
<tr><td><code>kind</code><br/>string</td><td><code>ExecCredential</code></td></tr>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>spec</code> <B>[Required]</B><br/>
|
<tr><td><code>spec</code> <B>[Required]</B><br/>
|
||||||
<a href="#client-authentication-k8s-io-v1beta1-ExecCredentialSpec"><code>ExecCredentialSpec</code></a>
|
<a href="#client-authentication-k8s-io-v1beta1-ExecCredentialSpec"><code>ExecCredentialSpec</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Spec holds information passed to the plugin by the transport.</td>
|
Spec holds information passed to the plugin by the transport.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>status</code><br/>
|
<tr><td><code>status</code><br/>
|
||||||
<a href="#client-authentication-k8s-io-v1beta1-ExecCredentialStatus"><code>ExecCredentialStatus</code></a>
|
<a href="#client-authentication-k8s-io-v1beta1-ExecCredentialStatus"><code>ExecCredentialStatus</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Status is filled in by the plugin and holds the credentials that the transport
|
Status is filled in by the plugin and holds the credentials that the transport
|
||||||
should use to contact the API.</td>
|
should use to contact the API.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Cluster` {#client-authentication-k8s-io-v1beta1-Cluster}
|
## `Cluster` {#client-authentication-k8s-io-v1beta1-Cluster}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [ExecCredentialSpec](#client-authentication-k8s-io-v1beta1-ExecCredentialSpec)
|
- [ExecCredentialSpec](#client-authentication-k8s-io-v1beta1-ExecCredentialSpec)
|
||||||
|
|
||||||
|
|
||||||
Cluster contains information to allow an exec plugin to communicate
|
Cluster contains information to allow an exec plugin to communicate
|
||||||
with the kubernetes cluster being authenticated to.
|
with the kubernetes cluster being authenticated to.
|
||||||
|
|
||||||
@@ -77,53 +65,47 @@ of CertificateAuthority, since CA data will always be passed to the plugin as by
|
|||||||
<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>server</code> <B>[Required]</B><br/>
|
<tr><td><code>server</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Server is the address of the kubernetes cluster (https://hostname:port).</td>
|
Server is the address of the kubernetes cluster (https://hostname:port).
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>tls-server-name</code><br/>
|
<tr><td><code>tls-server-name</code><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
TLSServerName is passed to the server for SNI and is used in the client to
|
TLSServerName is passed to the server for SNI and is used in the client to
|
||||||
check server certificates against. If ServerName is empty, the hostname
|
check server certificates against. If ServerName is empty, the hostname
|
||||||
used to contact the server is used.</td>
|
used to contact the server is used.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>insecure-skip-tls-verify</code><br/>
|
<tr><td><code>insecure-skip-tls-verify</code><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
InsecureSkipTLSVerify skips the validity check for the server's certificate.
|
InsecureSkipTLSVerify skips the validity check for the server's certificate.
|
||||||
This will make your HTTPS connections insecure.</td>
|
This will make your HTTPS connections insecure.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>certificate-authority-data</code><br/>
|
<tr><td><code>certificate-authority-data</code><br/>
|
||||||
<code>[]byte</code>
|
<code>[]byte</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
CAData contains PEM-encoded certificate authority certificates.
|
CAData contains PEM-encoded certificate authority certificates.
|
||||||
If empty, system roots should be used.</td>
|
If empty, system roots should be used.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>proxy-url</code><br/>
|
<tr><td><code>proxy-url</code><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
ProxyURL is the URL to the proxy to be used for all requests to this
|
ProxyURL is the URL to the proxy to be used for all requests to this
|
||||||
cluster.</td>
|
cluster.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>config</code><br/>
|
<tr><td><code>config</code><br/>
|
||||||
<a href="https://godoc.org/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
|
||||||
</td>
|
</td>
|
||||||
@@ -148,25 +130,19 @@ In some environments, the user config may be exactly the same across many cluste
|
|||||||
such as the audience. This field allows the per cluster config to be directly
|
such as the audience. This field allows the per cluster config to be directly
|
||||||
specified with the cluster info. Using this field to store secret data is not
|
specified with the cluster info. Using this field to store secret data is not
|
||||||
recommended as one of the prime benefits of exec plugins is that no secrets need
|
recommended as one of the prime benefits of exec plugins is that no secrets need
|
||||||
to be stored directly in the kubeconfig.</td>
|
to be stored directly in the kubeconfig.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ExecCredentialSpec` {#client-authentication-k8s-io-v1beta1-ExecCredentialSpec}
|
## `ExecCredentialSpec` {#client-authentication-k8s-io-v1beta1-ExecCredentialSpec}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)
|
- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)
|
||||||
|
|
||||||
|
|
||||||
ExecCredentialSpec holds request and runtime specific information provided by
|
ExecCredentialSpec holds request and runtime specific information provided by
|
||||||
the transport.
|
the transport.
|
||||||
|
|
||||||
@@ -174,7 +150,6 @@ the transport.
|
|||||||
<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>cluster</code><br/>
|
<tr><td><code>cluster</code><br/>
|
||||||
<a href="#client-authentication-k8s-io-v1beta1-Cluster"><code>Cluster</code></a>
|
<a href="#client-authentication-k8s-io-v1beta1-Cluster"><code>Cluster</code></a>
|
||||||
@@ -183,33 +158,26 @@ the transport.
|
|||||||
Cluster contains information to allow an exec plugin to communicate with the
|
Cluster contains information to allow an exec plugin to communicate with the
|
||||||
kubernetes cluster being authenticated to. Note that Cluster is non-nil only
|
kubernetes cluster being authenticated to. Note that Cluster is non-nil only
|
||||||
when provideClusterInfo is set to true in the exec provider config (i.e.,
|
when provideClusterInfo is set to true in the exec provider config (i.e.,
|
||||||
ExecConfig.ProvideClusterInfo).</td>
|
ExecConfig.ProvideClusterInfo).
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>interactive</code> <B>[Required]</B><br/>
|
<tr><td><code>interactive</code> <B>[Required]</B><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Interactive declares whether stdin has been passed to this exec plugin.</td>
|
Interactive declares whether stdin has been passed to this exec plugin.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ExecCredentialStatus` {#client-authentication-k8s-io-v1beta1-ExecCredentialStatus}
|
## `ExecCredentialStatus` {#client-authentication-k8s-io-v1beta1-ExecCredentialStatus}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)
|
- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)
|
||||||
|
|
||||||
|
|
||||||
ExecCredentialStatus holds credentials for the transport to use.
|
ExecCredentialStatus holds credentials for the transport to use.
|
||||||
|
|
||||||
Token and ClientKeyData are sensitive fields. This data should only be
|
Token and ClientKeyData are sensitive fields. This data should only be
|
||||||
@@ -220,41 +188,35 @@ itself should at least be protected via file permissions.
|
|||||||
<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>expirationTimestamp</code><br/>
|
<tr><td><code>expirationTimestamp</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#time-v1-meta"><code>meta/v1.Time</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#time-v1-meta"><code>meta/v1.Time</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
ExpirationTimestamp indicates a time when the provided credentials expire.</td>
|
ExpirationTimestamp indicates a time when the provided credentials expire.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>token</code> <B>[Required]</B><br/>
|
<tr><td><code>token</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Token is a bearer token used by the client for request authentication.</td>
|
Token is a bearer token used by the client for request authentication.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>clientCertificateData</code> <B>[Required]</B><br/>
|
<tr><td><code>clientCertificateData</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
PEM-encoded client TLS certificates (including intermediates, if any).</td>
|
PEM-encoded client TLS certificates (including intermediates, if any).
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>clientKeyData</code> <B>[Required]</B><br/>
|
<tr><td><code>clientKeyData</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
PEM-encoded private key for the above certificate.</td>
|
PEM-encoded private key for the above certificate.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -13,13 +13,10 @@ auto_generated: true
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeProxyConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration}
|
## `KubeProxyConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
KubeProxyConfiguration contains everything necessary to configure the
|
KubeProxyConfiguration contains everything necessary to configure the
|
||||||
Kubernetes proxy server.
|
Kubernetes proxy server.
|
||||||
|
|
||||||
@@ -30,156 +27,137 @@ Kubernetes proxy server.
|
|||||||
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubeproxy.config.k8s.io/v1alpha1</code></td></tr>
|
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubeproxy.config.k8s.io/v1alpha1</code></td></tr>
|
||||||
<tr><td><code>kind</code><br/>string</td><td><code>KubeProxyConfiguration</code></td></tr>
|
<tr><td><code>kind</code><br/>string</td><td><code>KubeProxyConfiguration</code></td></tr>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>featureGates</code> <B>[Required]</B><br/>
|
<tr><td><code>featureGates</code> <B>[Required]</B><br/>
|
||||||
<code>map[string]bool</code>
|
<code>map[string]bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
featureGates is a map of feature names to bools that enable or disable alpha/experimental features.</td>
|
featureGates is a map of feature names to bools that enable or disable alpha/experimental features.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>bindAddress</code> <B>[Required]</B><br/>
|
<tr><td><code>bindAddress</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
bindAddress is the IP address for the proxy server to serve on (set to 0.0.0.0
|
bindAddress is the IP address for the proxy server to serve on (set to 0.0.0.0
|
||||||
for all interfaces)</td>
|
for all interfaces)
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>healthzBindAddress</code> <B>[Required]</B><br/>
|
<tr><td><code>healthzBindAddress</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
healthzBindAddress is the IP address and port for the health check server to serve on,
|
healthzBindAddress is the IP address and port for the health check server to serve on,
|
||||||
defaulting to 0.0.0.0:10256</td>
|
defaulting to 0.0.0.0:10256
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>metricsBindAddress</code> <B>[Required]</B><br/>
|
<tr><td><code>metricsBindAddress</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
metricsBindAddress is the IP address and port for the metrics server to serve on,
|
metricsBindAddress is the IP address and port for the metrics server to serve on,
|
||||||
defaulting to 127.0.0.1:10249 (set to 0.0.0.0 for all interfaces)</td>
|
defaulting to 127.0.0.1:10249 (set to 0.0.0.0 for all interfaces)
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>bindAddressHardFail</code> <B>[Required]</B><br/>
|
<tr><td><code>bindAddressHardFail</code> <B>[Required]</B><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
bindAddressHardFail, if true, kube-proxy will treat failure to bind to a port as fatal and exit</td>
|
bindAddressHardFail, if true, kube-proxy will treat failure to bind to a port as fatal and exit
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>enableProfiling</code> <B>[Required]</B><br/>
|
<tr><td><code>enableProfiling</code> <B>[Required]</B><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
enableProfiling enables profiling via web interface on /debug/pprof handler.
|
enableProfiling enables profiling via web interface on /debug/pprof handler.
|
||||||
Profiling handlers will be handled by metrics server.</td>
|
Profiling handlers will be handled by metrics server.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>clusterCIDR</code> <B>[Required]</B><br/>
|
<tr><td><code>clusterCIDR</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
clusterCIDR is the CIDR range of the pods in the cluster. It is used to
|
clusterCIDR is the CIDR range of the pods in the cluster. It is used to
|
||||||
bridge traffic coming from outside of the cluster. If not provided,
|
bridge traffic coming from outside of the cluster. If not provided,
|
||||||
no off-cluster bridging will be performed.</td>
|
no off-cluster bridging will be performed.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>hostnameOverride</code> <B>[Required]</B><br/>
|
<tr><td><code>hostnameOverride</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
hostnameOverride, if non-empty, will be used as the identity instead of the actual hostname.</td>
|
hostnameOverride, if non-empty, will be used as the identity instead of the actual hostname.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>clientConnection</code> <B>[Required]</B><br/>
|
<tr><td><code>clientConnection</code> <B>[Required]</B><br/>
|
||||||
<a href="#ClientConnectionConfiguration"><code>ClientConnectionConfiguration</code></a>
|
<a href="#ClientConnectionConfiguration"><code>ClientConnectionConfiguration</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
clientConnection specifies the kubeconfig file and client connection settings for the proxy
|
clientConnection specifies the kubeconfig file and client connection settings for the proxy
|
||||||
server to use when communicating with the apiserver.</td>
|
server to use when communicating with the apiserver.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>iptables</code> <B>[Required]</B><br/>
|
<tr><td><code>iptables</code> <B>[Required]</B><br/>
|
||||||
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration"><code>KubeProxyIPTablesConfiguration</code></a>
|
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration"><code>KubeProxyIPTablesConfiguration</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
iptables contains iptables-related configuration options.</td>
|
iptables contains iptables-related configuration options.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>ipvs</code> <B>[Required]</B><br/>
|
<tr><td><code>ipvs</code> <B>[Required]</B><br/>
|
||||||
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration"><code>KubeProxyIPVSConfiguration</code></a>
|
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration"><code>KubeProxyIPVSConfiguration</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
ipvs contains ipvs-related configuration options.</td>
|
ipvs contains ipvs-related configuration options.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>oomScoreAdj</code> <B>[Required]</B><br/>
|
<tr><td><code>oomScoreAdj</code> <B>[Required]</B><br/>
|
||||||
<code>int32</code>
|
<code>int32</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
oomScoreAdj is the oom-score-adj value for kube-proxy process. Values must be within
|
oomScoreAdj is the oom-score-adj value for kube-proxy process. Values must be within
|
||||||
the range [-1000, 1000]</td>
|
the range [-1000, 1000]
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>mode</code> <B>[Required]</B><br/>
|
<tr><td><code>mode</code> <B>[Required]</B><br/>
|
||||||
<a href="#kubeproxy-config-k8s-io-v1alpha1-ProxyMode"><code>ProxyMode</code></a>
|
<a href="#kubeproxy-config-k8s-io-v1alpha1-ProxyMode"><code>ProxyMode</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
mode specifies which proxy mode to use.</td>
|
mode specifies which proxy mode to use.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>portRange</code> <B>[Required]</B><br/>
|
<tr><td><code>portRange</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
portRange is the range of host ports (beginPort-endPort, inclusive) that may be consumed
|
portRange is the range of host ports (beginPort-endPort, inclusive) that may be consumed
|
||||||
in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.</td>
|
in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>udpIdleTimeout</code> <B>[Required]</B><br/>
|
<tr><td><code>udpIdleTimeout</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
udpIdleTimeout is how long an idle UDP connection will be kept open (e.g. '250ms', '2s').
|
udpIdleTimeout is how long an idle UDP connection will be kept open (e.g. '250ms', '2s').
|
||||||
Must be greater than 0. Only applicable for proxyMode=userspace.</td>
|
Must be greater than 0. Only applicable for proxyMode=userspace.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>conntrack</code> <B>[Required]</B><br/>
|
<tr><td><code>conntrack</code> <B>[Required]</B><br/>
|
||||||
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration"><code>KubeProxyConntrackConfiguration</code></a>
|
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration"><code>KubeProxyConntrackConfiguration</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
conntrack contains conntrack-related configuration options.</td>
|
conntrack contains conntrack-related configuration options.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>configSyncPeriod</code> <B>[Required]</B><br/>
|
<tr><td><code>configSyncPeriod</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
configSyncPeriod is how often configuration from the apiserver is refreshed. Must be greater
|
configSyncPeriod is how often configuration from the apiserver is refreshed. Must be greater
|
||||||
than 0.</td>
|
than 0.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>nodePortAddresses</code> <B>[Required]</B><br/>
|
<tr><td><code>nodePortAddresses</code> <B>[Required]</B><br/>
|
||||||
<code>[]string</code>
|
<code>[]string</code>
|
||||||
</td>
|
</td>
|
||||||
@@ -190,49 +168,40 @@ In case someone would like to expose a service on localhost for local visit and
|
|||||||
particular purpose, a list of IP blocks would do that.
|
particular purpose, a list of IP blocks would do that.
|
||||||
If set it to "127.0.0.0/8", kube-proxy will only select the loopback interface for NodePort.
|
If set it to "127.0.0.0/8", kube-proxy will only select the loopback interface for NodePort.
|
||||||
If set it to a non-zero IP block, kube-proxy will filter that down to just the IPs that applied to the node.
|
If set it to a non-zero IP block, kube-proxy will filter that down to just the IPs that applied to the node.
|
||||||
An empty string slice is meant to select all network interfaces.</td>
|
An empty string slice is meant to select all network interfaces.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>winkernel</code> <B>[Required]</B><br/>
|
<tr><td><code>winkernel</code> <B>[Required]</B><br/>
|
||||||
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration"><code>KubeProxyWinkernelConfiguration</code></a>
|
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration"><code>KubeProxyWinkernelConfiguration</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
winkernel contains winkernel-related configuration options.</td>
|
winkernel contains winkernel-related configuration options.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>showHiddenMetricsForVersion</code> <B>[Required]</B><br/>
|
<tr><td><code>showHiddenMetricsForVersion</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
ShowHiddenMetricsForVersion is the version for which you want to show hidden metrics.</td>
|
ShowHiddenMetricsForVersion is the version for which you want to show hidden metrics.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>detectLocalMode</code> <B>[Required]</B><br/>
|
<tr><td><code>detectLocalMode</code> <B>[Required]</B><br/>
|
||||||
<a href="#kubeproxy-config-k8s-io-v1alpha1-LocalMode"><code>LocalMode</code></a>
|
<a href="#kubeproxy-config-k8s-io-v1alpha1-LocalMode"><code>LocalMode</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
DetectLocalMode determines mode to use for detecting local traffic, defaults to LocalModeClusterCIDR</td>
|
DetectLocalMode determines mode to use for detecting local traffic, defaults to LocalModeClusterCIDR
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeProxyConntrackConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration}
|
## `KubeProxyConntrackConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
||||||
|
|
||||||
|
|
||||||
KubeProxyConntrackConfiguration contains conntrack settings for
|
KubeProxyConntrackConfiguration contains conntrack settings for
|
||||||
the Kubernetes proxy server.
|
the Kubernetes proxy server.
|
||||||
|
|
||||||
@@ -240,60 +209,50 @@ the Kubernetes proxy server.
|
|||||||
<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>maxPerCore</code> <B>[Required]</B><br/>
|
<tr><td><code>maxPerCore</code> <B>[Required]</B><br/>
|
||||||
<code>int32</code>
|
<code>int32</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
maxPerCore is the maximum number of NAT connections to track
|
maxPerCore is the maximum number of NAT connections to track
|
||||||
per CPU core (0 to leave the limit as-is and ignore min).</td>
|
per CPU core (0 to leave the limit as-is and ignore min).
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>min</code> <B>[Required]</B><br/>
|
<tr><td><code>min</code> <B>[Required]</B><br/>
|
||||||
<code>int32</code>
|
<code>int32</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
min is the minimum value of connect-tracking records to allocate,
|
min is the minimum value of connect-tracking records to allocate,
|
||||||
regardless of conntrackMaxPerCore (set maxPerCore=0 to leave the limit as-is).</td>
|
regardless of conntrackMaxPerCore (set maxPerCore=0 to leave the limit as-is).
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>tcpEstablishedTimeout</code> <B>[Required]</B><br/>
|
<tr><td><code>tcpEstablishedTimeout</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
tcpEstablishedTimeout is how long an idle TCP connection will be kept open
|
tcpEstablishedTimeout is how long an idle TCP connection will be kept open
|
||||||
(e.g. '2s'). Must be greater than 0 to set.</td>
|
(e.g. '2s'). Must be greater than 0 to set.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>tcpCloseWaitTimeout</code> <B>[Required]</B><br/>
|
<tr><td><code>tcpCloseWaitTimeout</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
tcpCloseWaitTimeout is how long an idle conntrack entry
|
tcpCloseWaitTimeout is how long an idle conntrack entry
|
||||||
in CLOSE_WAIT state will remain in the conntrack
|
in CLOSE_WAIT state will remain in the conntrack
|
||||||
table. (e.g. '60s'). Must be greater than 0 to set.</td>
|
table. (e.g. '60s'). Must be greater than 0 to set.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeProxyIPTablesConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration}
|
## `KubeProxyIPTablesConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
||||||
|
|
||||||
|
|
||||||
KubeProxyIPTablesConfiguration contains iptables-related configuration
|
KubeProxyIPTablesConfiguration contains iptables-related configuration
|
||||||
details for the Kubernetes proxy server.
|
details for the Kubernetes proxy server.
|
||||||
|
|
||||||
@@ -301,58 +260,48 @@ details for the Kubernetes proxy server.
|
|||||||
<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>masqueradeBit</code> <B>[Required]</B><br/>
|
<tr><td><code>masqueradeBit</code> <B>[Required]</B><br/>
|
||||||
<code>int32</code>
|
<code>int32</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
masqueradeBit is the bit of the iptables fwmark space to use for SNAT if using
|
masqueradeBit is the bit of the iptables fwmark space to use for SNAT if using
|
||||||
the pure iptables proxy mode. Values must be within the range [0, 31].</td>
|
the pure iptables proxy mode. Values must be within the range [0, 31].
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>masqueradeAll</code> <B>[Required]</B><br/>
|
<tr><td><code>masqueradeAll</code> <B>[Required]</B><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode.</td>
|
masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>syncPeriod</code> <B>[Required]</B><br/>
|
<tr><td><code>syncPeriod</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
syncPeriod is the period that iptables rules are refreshed (e.g. '5s', '1m',
|
syncPeriod is the period that iptables rules are refreshed (e.g. '5s', '1m',
|
||||||
'2h22m'). Must be greater than 0.</td>
|
'2h22m'). Must be greater than 0.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>minSyncPeriod</code> <B>[Required]</B><br/>
|
<tr><td><code>minSyncPeriod</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
minSyncPeriod is the minimum period that iptables rules are refreshed (e.g. '5s', '1m',
|
minSyncPeriod is the minimum period that iptables rules are refreshed (e.g. '5s', '1m',
|
||||||
'2h22m').</td>
|
'2h22m').
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeProxyIPVSConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration}
|
## `KubeProxyIPVSConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
||||||
|
|
||||||
|
|
||||||
KubeProxyIPVSConfiguration contains ipvs-related configuration
|
KubeProxyIPVSConfiguration contains ipvs-related configuration
|
||||||
details for the Kubernetes proxy server.
|
details for the Kubernetes proxy server.
|
||||||
|
|
||||||
@@ -360,94 +309,80 @@ details for the Kubernetes proxy server.
|
|||||||
<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>syncPeriod</code> <B>[Required]</B><br/>
|
<tr><td><code>syncPeriod</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
syncPeriod is the period that ipvs rules are refreshed (e.g. '5s', '1m',
|
syncPeriod is the period that ipvs rules are refreshed (e.g. '5s', '1m',
|
||||||
'2h22m'). Must be greater than 0.</td>
|
'2h22m'). Must be greater than 0.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>minSyncPeriod</code> <B>[Required]</B><br/>
|
<tr><td><code>minSyncPeriod</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
minSyncPeriod is the minimum period that ipvs rules are refreshed (e.g. '5s', '1m',
|
minSyncPeriod is the minimum period that ipvs rules are refreshed (e.g. '5s', '1m',
|
||||||
'2h22m').</td>
|
'2h22m').
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>scheduler</code> <B>[Required]</B><br/>
|
<tr><td><code>scheduler</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
ipvs scheduler</td>
|
ipvs scheduler
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>excludeCIDRs</code> <B>[Required]</B><br/>
|
<tr><td><code>excludeCIDRs</code> <B>[Required]</B><br/>
|
||||||
<code>[]string</code>
|
<code>[]string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
excludeCIDRs is a list of CIDR's which the ipvs proxier should not touch
|
excludeCIDRs is a list of CIDR's which the ipvs proxier should not touch
|
||||||
when cleaning up ipvs services.</td>
|
when cleaning up ipvs services.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>strictARP</code> <B>[Required]</B><br/>
|
<tr><td><code>strictARP</code> <B>[Required]</B><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
strict ARP configure arp_ignore and arp_announce to avoid answering ARP queries
|
strict ARP configure arp_ignore and arp_announce to avoid answering ARP queries
|
||||||
from kube-ipvs0 interface</td>
|
from kube-ipvs0 interface
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>tcpTimeout</code> <B>[Required]</B><br/>
|
<tr><td><code>tcpTimeout</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
tcpTimeout is the timeout value used for idle IPVS TCP sessions.
|
tcpTimeout is the timeout value used for idle IPVS TCP sessions.
|
||||||
The default value is 0, which preserves the current timeout value on the system.</td>
|
The default value is 0, which preserves the current timeout value on the system.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>tcpFinTimeout</code> <B>[Required]</B><br/>
|
<tr><td><code>tcpFinTimeout</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN.
|
tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN.
|
||||||
The default value is 0, which preserves the current timeout value on the system.</td>
|
The default value is 0, which preserves the current timeout value on the system.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>udpTimeout</code> <B>[Required]</B><br/>
|
<tr><td><code>udpTimeout</code> <B>[Required]</B><br/>
|
||||||
<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>
|
||||||
udpTimeout is the timeout value used for IPVS UDP packets.
|
udpTimeout is the timeout value used for IPVS UDP packets.
|
||||||
The default value is 0, which preserves the current timeout value on the system.</td>
|
The default value is 0, which preserves the current timeout value on the system.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeProxyWinkernelConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration}
|
## `KubeProxyWinkernelConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
||||||
|
|
||||||
|
|
||||||
KubeProxyWinkernelConfiguration contains Windows/HNS settings for
|
KubeProxyWinkernelConfiguration contains Windows/HNS settings for
|
||||||
the Kubernetes proxy server.
|
the Kubernetes proxy server.
|
||||||
|
|
||||||
@@ -455,66 +390,52 @@ the Kubernetes proxy server.
|
|||||||
<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>networkName</code> <B>[Required]</B><br/>
|
<tr><td><code>networkName</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
networkName is the name of the network kube-proxy will use
|
networkName is the name of the network kube-proxy will use
|
||||||
to create endpoints and policies</td>
|
to create endpoints and policies
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>sourceVip</code> <B>[Required]</B><br/>
|
<tr><td><code>sourceVip</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
sourceVip is the IP address of the source VIP endoint used for
|
sourceVip is the IP address of the source VIP endoint used for
|
||||||
NAT when loadbalancing</td>
|
NAT when loadbalancing
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>enableDSR</code> <B>[Required]</B><br/>
|
<tr><td><code>enableDSR</code> <B>[Required]</B><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
enableDSR tells kube-proxy whether HNS policies should be created
|
enableDSR tells kube-proxy whether HNS policies should be created
|
||||||
with DSR</td>
|
with DSR
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `LocalMode` {#kubeproxy-config-k8s-io-v1alpha1-LocalMode}
|
## `LocalMode` {#kubeproxy-config-k8s-io-v1alpha1-LocalMode}
|
||||||
|
|
||||||
(Alias of `string`)
|
(Alias of `string`)
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
||||||
|
|
||||||
|
|
||||||
LocalMode represents modes to detect local traffic from the node
|
LocalMode represents modes to detect local traffic from the node
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ProxyMode` {#kubeproxy-config-k8s-io-v1alpha1-ProxyMode}
|
## `ProxyMode` {#kubeproxy-config-k8s-io-v1alpha1-ProxyMode}
|
||||||
|
|
||||||
(Alias of `string`)
|
(Alias of `string`)
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
||||||
|
|
||||||
|
|
||||||
ProxyMode represents modes used by the Kubernetes proxy server.
|
ProxyMode represents modes used by the Kubernetes proxy server.
|
||||||
|
|
||||||
Currently, three modes of proxy are available in Linux platform: 'userspace' (older, going to be EOL), 'iptables'
|
Currently, three modes of proxy are available in Linux platform: 'userspace' (older, going to be EOL), 'iptables'
|
||||||
@@ -532,7 +453,6 @@ future). If winkernel proxy is selected, regardless of how, but the Windows kern
|
|||||||
this always falls back to the userspace proxy.
|
this always falls back to the userspace proxy.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -540,122 +460,62 @@ this always falls back to the userspace proxy.
|
|||||||
## `ClientConnectionConfiguration` {#ClientConnectionConfiguration}
|
## `ClientConnectionConfiguration` {#ClientConnectionConfiguration}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
|
||||||
|
|
||||||
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
ClientConnectionConfiguration contains details for constructing a client.
|
ClientConnectionConfiguration contains details for constructing a client.
|
||||||
|
|
||||||
<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>
|
||||||
<tbody>
|
<tbody>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>kubeconfig</code> <B>[Required]</B><br/>
|
<tr><td><code>kubeconfig</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
kubeconfig is the path to a KubeConfig file.</td>
|
kubeconfig is the path to a KubeConfig file.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>acceptContentTypes</code> <B>[Required]</B><br/>
|
<tr><td><code>acceptContentTypes</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the
|
acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the
|
||||||
default value of 'application/json'. This field will control all connections to the server used by a particular
|
default value of 'application/json'. This field will control all connections to the server used by a particular
|
||||||
client.</td>
|
client.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>contentType</code> <B>[Required]</B><br/>
|
<tr><td><code>contentType</code> <B>[Required]</B><br/>
|
||||||
<code>string</code>
|
<code>string</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
contentType is the content type used when sending data to the server from this client.</td>
|
contentType is the content type used when sending data to the server from this client.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>qps</code> <B>[Required]</B><br/>
|
<tr><td><code>qps</code> <B>[Required]</B><br/>
|
||||||
<code>float32</code>
|
<code>float32</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
qps controls the number of queries per second allowed for this connection.</td>
|
qps controls the number of queries per second allowed for this connection.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>burst</code> <B>[Required]</B><br/>
|
<tr><td><code>burst</code> <B>[Required]</B><br/>
|
||||||
<code>int32</code>
|
<code>int32</code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
burst allows extra queries to accumulate when a client is exceeding its rate.</td>
|
burst allows extra queries to accumulate when a client is exceeding its rate.
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## `DebuggingConfiguration` {#DebuggingConfiguration}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
|
||||||
|
|
||||||
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
DebuggingConfiguration holds configuration for Debugging related features.
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>enableProfiling</code> <B>[Required]</B><br/>
|
|
||||||
<code>bool</code>
|
|
||||||
</td>
|
</td>
|
||||||
<td>
|
|
||||||
enableProfiling enables profiling via web interface host:port/debug/pprof/</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>enableContentionProfiling</code> <B>[Required]</B><br/>
|
|
||||||
<code>bool</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
enableContentionProfiling enables lock contention profiling, if
|
|
||||||
enableProfiling is true.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
## `FormatOptions` {#FormatOptions}
|
## `FormatOptions` {#FormatOptions}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [LoggingConfiguration](#LoggingConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
FormatOptions contains options for the different logging formats.
|
FormatOptions contains options for the different logging formats.
|
||||||
@@ -664,36 +524,30 @@ FormatOptions contains options for the different logging formats.
|
|||||||
<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>json</code> <B>[Required]</B><br/>
|
<tr><td><code>json</code> <B>[Required]</B><br/>
|
||||||
<a href="#JSONOptions"><code>JSONOptions</code></a>
|
<a href="#JSONOptions"><code>JSONOptions</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
[Experimental] JSON contains options for logging format "json".</td>
|
[Experimental] JSON contains options for logging format "json".
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
## `JSONOptions` {#JSONOptions}
|
## `JSONOptions` {#JSONOptions}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [FormatOptions](#FormatOptions)
|
- [FormatOptions](#FormatOptions)
|
||||||
|
|
||||||
|
|
||||||
JSONOptions contains options for logging format "json".
|
JSONOptions contains options for logging format "json".
|
||||||
|
|
||||||
<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>
|
||||||
<tbody>
|
<tbody>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>splitStream</code> <B>[Required]</B><br/>
|
<tr><td><code>splitStream</code> <B>[Required]</B><br/>
|
||||||
<code>bool</code>
|
<code>bool</code>
|
||||||
@@ -701,206 +555,25 @@ JSONOptions contains options for logging format "json".
|
|||||||
<td>
|
<td>
|
||||||
[Experimental] SplitStream redirects error messages to stderr while
|
[Experimental] SplitStream redirects error messages to stderr while
|
||||||
info messages go to stdout, with buffering. The default is to write
|
info messages go to stdout, with buffering. The default is to write
|
||||||
both to stdout, without buffering.</td>
|
both to stdout, without buffering.
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
|
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
|
||||||
<code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code>
|
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue"><code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
[Experimental] InfoBufferSize sets the size of the info stream when
|
[Experimental] InfoBufferSize sets the size of the info stream when
|
||||||
using split streams. The default is zero, which disables buffering.</td>
|
using split streams. The default is zero, which disables buffering.
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## `LeaderElectionConfiguration` {#LeaderElectionConfiguration}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
|
||||||
|
|
||||||
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
LeaderElectionConfiguration defines the configuration of leader election
|
|
||||||
clients for components that can run with leader election enabled.
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>leaderElect</code> <B>[Required]</B><br/>
|
|
||||||
<code>bool</code>
|
|
||||||
</td>
|
</td>
|
||||||
<td>
|
|
||||||
leaderElect enables a leader election client to gain leadership
|
|
||||||
before executing the main loop. Enable this when running replicated
|
|
||||||
components for high availability.</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>leaseDuration</code> <B>[Required]</B><br/>
|
|
||||||
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
leaseDuration is the duration that non-leader candidates will wait
|
|
||||||
after observing a leadership renewal until attempting to acquire
|
|
||||||
leadership of a led but unrenewed leader slot. This is effectively the
|
|
||||||
maximum duration that a leader can be stopped before it is replaced
|
|
||||||
by another candidate. This is only applicable if leader election is
|
|
||||||
enabled.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>renewDeadline</code> <B>[Required]</B><br/>
|
|
||||||
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
renewDeadline is the interval between attempts by the acting master to
|
|
||||||
renew a leadership slot before it stops leading. This must be less
|
|
||||||
than or equal to the lease duration. This is only applicable if leader
|
|
||||||
election is enabled.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>retryPeriod</code> <B>[Required]</B><br/>
|
|
||||||
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
retryPeriod is the duration the clients should wait between attempting
|
|
||||||
acquisition and renewal of a leadership. This is only applicable if
|
|
||||||
leader election is enabled.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>resourceLock</code> <B>[Required]</B><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
resourceLock indicates the resource object type that will be used to lock
|
|
||||||
during leader election cycles.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>resourceName</code> <B>[Required]</B><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
resourceName indicates the name of resource object that will be used to lock
|
|
||||||
during leader election cycles.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>resourceNamespace</code> <B>[Required]</B><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
resourceName indicates the namespace of resource object that will be used to lock
|
|
||||||
during leader election cycles.</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## `LoggingConfiguration` {#LoggingConfiguration}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
LoggingConfiguration contains logging options
|
|
||||||
Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information.
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>format</code> <B>[Required]</B><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
Format Flag specifies the structure of log messages.
|
|
||||||
default value of format is `text`</td>
|
|
||||||
</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/>
|
|
||||||
<code>bool</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
|
|
||||||
Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)</td>
|
|
||||||
</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}
|
## `VModuleConfiguration` {#VModuleConfiguration}
|
||||||
|
|
||||||
(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`)
|
(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`)
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [LoggingConfiguration](#LoggingConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
VModuleConfiguration is a collection of individual file names or patterns
|
VModuleConfiguration is a collection of individual file names or patterns
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -20,7 +20,6 @@ auto_generated: true
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1beta2-DefaultPreemptionArgs}
|
## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1beta2-DefaultPreemptionArgs}
|
||||||
|
|
||||||
|
|
||||||
@@ -67,8 +66,6 @@ that play a role in the number of candidates shortlisted. Must be at least
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta2-InterPodAffinityArgs}
|
## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta2-InterPodAffinityArgs}
|
||||||
|
|
||||||
@@ -99,8 +96,6 @@ matching hard affinity to the incoming pod.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration}
|
## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration}
|
||||||
|
|
||||||
@@ -229,8 +224,6 @@ with the extender. These extenders are shared by all scheduler profiles.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeAffinityArgs}
|
## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeAffinityArgs}
|
||||||
|
|
||||||
@@ -251,7 +244,7 @@ NodeAffinityArgs holds arguments to configure the NodeAffinity plugin.
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>addedAffinity</code><br/>
|
<tr><td><code>addedAffinity</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#nodeaffinity-v1-core"><code>core/v1.NodeAffinity</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#nodeaffinity-v1-core"><code>core/v1.NodeAffinity</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
AddedAffinity is applied to all Pods additionally to the NodeAffinity
|
AddedAffinity is applied to all Pods additionally to the NodeAffinity
|
||||||
@@ -265,8 +258,6 @@ a specific Node (such as Daemonset Pods) might remain unschedulable.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeResourcesBalancedAllocationArgs}
|
## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeResourcesBalancedAllocationArgs}
|
||||||
|
|
||||||
@@ -296,8 +287,6 @@ NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResour
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeResourcesFitArgs}
|
## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeResourcesFitArgs}
|
||||||
|
|
||||||
@@ -348,8 +337,6 @@ The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.<
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadArgs}
|
## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadArgs}
|
||||||
|
|
||||||
@@ -370,7 +357,7 @@ PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread pl
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>defaultConstraints</code><br/>
|
<tr><td><code>defaultConstraints</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#topologyspreadconstraint-v1-core"><code>[]core/v1.TopologySpreadConstraint</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#topologyspreadconstraint-v1-core"><code>[]core/v1.TopologySpreadConstraint</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
DefaultConstraints defines topology spread constraints to be applied to
|
DefaultConstraints defines topology spread constraints to be applied to
|
||||||
@@ -400,8 +387,6 @@ and to "System" if enabled.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta2-VolumeBindingArgs}
|
## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta2-VolumeBindingArgs}
|
||||||
|
|
||||||
@@ -451,8 +436,6 @@ All points must be sorted in increasing order by utilization.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Extender` {#kubescheduler-config-k8s-io-v1beta2-Extender}
|
## `Extender` {#kubescheduler-config-k8s-io-v1beta2-Extender}
|
||||||
|
|
||||||
@@ -460,7 +443,6 @@ All points must be sorted in increasing order by utilization.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -585,8 +567,6 @@ fail when the extender returns an error or is not reachable.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta2-ExtenderManagedResource}
|
## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta2-ExtenderManagedResource}
|
||||||
|
|
||||||
@@ -594,7 +574,6 @@ fail when the extender returns an error or is not reachable.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender)
|
- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender)
|
||||||
|
|
||||||
|
|
||||||
@@ -626,8 +605,6 @@ resource when applying predicates.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta2-ExtenderTLSConfig}
|
## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta2-ExtenderTLSConfig}
|
||||||
|
|
||||||
@@ -635,7 +612,6 @@ resource when applying predicates.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender)
|
- [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender)
|
||||||
|
|
||||||
|
|
||||||
@@ -718,8 +694,6 @@ CAData takes precedence over CAFile</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile}
|
## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile}
|
||||||
|
|
||||||
@@ -727,7 +701,6 @@ CAData takes precedence over CAFile</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -776,8 +749,6 @@ for that plugin.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Plugin` {#kubescheduler-config-k8s-io-v1beta2-Plugin}
|
## `Plugin` {#kubescheduler-config-k8s-io-v1beta2-Plugin}
|
||||||
|
|
||||||
@@ -785,7 +756,6 @@ for that plugin.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [PluginSet](#kubescheduler-config-k8s-io-v1beta2-PluginSet)
|
- [PluginSet](#kubescheduler-config-k8s-io-v1beta2-PluginSet)
|
||||||
|
|
||||||
|
|
||||||
@@ -815,8 +785,6 @@ Plugin specifies a plugin name and its weight when applicable. Weight is used on
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PluginConfig` {#kubescheduler-config-k8s-io-v1beta2-PluginConfig}
|
## `PluginConfig` {#kubescheduler-config-k8s-io-v1beta2-PluginConfig}
|
||||||
|
|
||||||
@@ -824,7 +792,6 @@ Plugin specifies a plugin name and its weight when applicable. Weight is used on
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile)
|
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile)
|
||||||
|
|
||||||
|
|
||||||
@@ -856,8 +823,6 @@ It is up to the plugin to process these Args.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PluginSet` {#kubescheduler-config-k8s-io-v1beta2-PluginSet}
|
## `PluginSet` {#kubescheduler-config-k8s-io-v1beta2-PluginSet}
|
||||||
|
|
||||||
@@ -865,7 +830,6 @@ It is up to the plugin to process these Args.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Plugins](#kubescheduler-config-k8s-io-v1beta2-Plugins)
|
- [Plugins](#kubescheduler-config-k8s-io-v1beta2-Plugins)
|
||||||
|
|
||||||
|
|
||||||
@@ -900,8 +864,6 @@ When all default plugins need to be disabled, an array containing only one "&low
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Plugins` {#kubescheduler-config-k8s-io-v1beta2-Plugins}
|
## `Plugins` {#kubescheduler-config-k8s-io-v1beta2-Plugins}
|
||||||
|
|
||||||
@@ -909,7 +871,6 @@ When all default plugins need to be disabled, an array containing only one "&low
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile)
|
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile)
|
||||||
|
|
||||||
|
|
||||||
@@ -1025,8 +986,6 @@ The scheduler call these plugins in order. Scheduler skips the rest of these plu
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadConstraintsDefaulting}
|
## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadConstraintsDefaulting}
|
||||||
|
|
||||||
@@ -1034,7 +993,6 @@ The scheduler call these plugins in order. Scheduler skips the rest of these plu
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadArgs)
|
- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadArgs)
|
||||||
|
|
||||||
|
|
||||||
@@ -1042,8 +1000,6 @@ PodTopologySpreadConstraintsDefaulting defines how to set default constraints
|
|||||||
for the PodTopologySpread plugin.
|
for the PodTopologySpread plugin.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1beta2-RequestedToCapacityRatioParam}
|
## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1beta2-RequestedToCapacityRatioParam}
|
||||||
|
|
||||||
@@ -1051,7 +1007,6 @@ for the PodTopologySpread plugin.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy)
|
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy)
|
||||||
|
|
||||||
|
|
||||||
@@ -1073,8 +1028,6 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta2-ResourceSpec}
|
## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta2-ResourceSpec}
|
||||||
|
|
||||||
@@ -1082,9 +1035,7 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta2-NodeResourcesBalancedAllocationArgs)
|
- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta2-NodeResourcesBalancedAllocationArgs)
|
||||||
|
|
||||||
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy)
|
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy)
|
||||||
|
|
||||||
|
|
||||||
@@ -1114,8 +1065,6 @@ ResourceSpec represents a single resource.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy}
|
## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy}
|
||||||
|
|
||||||
@@ -1123,7 +1072,6 @@ ResourceSpec represents a single resource.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta2-NodeResourcesFitArgs)
|
- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta2-NodeResourcesFitArgs)
|
||||||
|
|
||||||
|
|
||||||
@@ -1164,8 +1112,6 @@ Weight defaults to 1 if not specified or explicitly set to 0.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1beta2-ScoringStrategyType}
|
## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1beta2-ScoringStrategyType}
|
||||||
|
|
||||||
@@ -1173,15 +1119,12 @@ Weight defaults to 1 if not specified or explicitly set to 0.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy)
|
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy)
|
||||||
|
|
||||||
|
|
||||||
ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.
|
ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta2-UtilizationShapePoint}
|
## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta2-UtilizationShapePoint}
|
||||||
|
|
||||||
@@ -1189,9 +1132,7 @@ ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta2-VolumeBindingArgs)
|
- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta2-VolumeBindingArgs)
|
||||||
|
|
||||||
- [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1beta2-RequestedToCapacityRatioParam)
|
- [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1beta2-RequestedToCapacityRatioParam)
|
||||||
|
|
||||||
|
|
||||||
@@ -1221,7 +1162,6 @@ UtilizationShapePoint represents single point of priority function shape.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1232,7 +1172,6 @@ UtilizationShapePoint represents single point of priority function shape.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1295,7 +1234,6 @@ client.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1333,7 +1271,6 @@ enableProfiling is true.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [LoggingConfiguration](#LoggingConfiguration)
|
- [LoggingConfiguration](#LoggingConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1362,7 +1299,6 @@ FormatOptions contains options for the different logging formats.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [FormatOptions](#FormatOptions)
|
- [FormatOptions](#FormatOptions)
|
||||||
|
|
||||||
|
|
||||||
@@ -1385,7 +1321,7 @@ both to stdout, without buffering.</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
|
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
|
||||||
<code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code>
|
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue"><code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
[Experimental] InfoBufferSize sets the size of the info stream when
|
[Experimental] InfoBufferSize sets the size of the info stream when
|
||||||
@@ -1402,7 +1338,6 @@ using split streams. The default is zero, which disables buffering.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1495,7 +1430,6 @@ during leader election cycles.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1574,7 +1508,6 @@ format get used, but all of them get validated.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [LoggingConfiguration](#LoggingConfiguration)
|
- [LoggingConfiguration](#LoggingConfiguration)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ auto_generated: true
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1beta3-DefaultPreemptionArgs}
|
## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1beta3-DefaultPreemptionArgs}
|
||||||
|
|
||||||
|
|
||||||
@@ -67,8 +66,6 @@ that play a role in the number of candidates shortlisted. Must be at least
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-InterPodAffinityArgs}
|
## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-InterPodAffinityArgs}
|
||||||
|
|
||||||
@@ -99,8 +96,6 @@ matching hard affinity to the incoming pod.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration}
|
## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration}
|
||||||
|
|
||||||
@@ -211,8 +206,6 @@ with the extender. These extenders are shared by all scheduler profiles.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeAffinityArgs}
|
## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeAffinityArgs}
|
||||||
|
|
||||||
@@ -233,7 +226,7 @@ NodeAffinityArgs holds arguments to configure the NodeAffinity plugin.
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>addedAffinity</code><br/>
|
<tr><td><code>addedAffinity</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#nodeaffinity-v1-core"><code>core/v1.NodeAffinity</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#nodeaffinity-v1-core"><code>core/v1.NodeAffinity</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
AddedAffinity is applied to all Pods additionally to the NodeAffinity
|
AddedAffinity is applied to all Pods additionally to the NodeAffinity
|
||||||
@@ -247,8 +240,6 @@ a specific Node (such as Daemonset Pods) might remain unschedulable.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs}
|
## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs}
|
||||||
|
|
||||||
@@ -278,8 +269,6 @@ NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResour
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs}
|
## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs}
|
||||||
|
|
||||||
@@ -330,8 +319,6 @@ The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.<
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs}
|
## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs}
|
||||||
|
|
||||||
@@ -352,7 +339,7 @@ PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread pl
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>defaultConstraints</code><br/>
|
<tr><td><code>defaultConstraints</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#topologyspreadconstraint-v1-core"><code>[]core/v1.TopologySpreadConstraint</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#topologyspreadconstraint-v1-core"><code>[]core/v1.TopologySpreadConstraint</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
DefaultConstraints defines topology spread constraints to be applied to
|
DefaultConstraints defines topology spread constraints to be applied to
|
||||||
@@ -382,8 +369,6 @@ and to "System" if enabled.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs}
|
## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs}
|
||||||
|
|
||||||
@@ -433,8 +418,6 @@ All points must be sorted in increasing order by utilization.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Extender` {#kubescheduler-config-k8s-io-v1beta3-Extender}
|
## `Extender` {#kubescheduler-config-k8s-io-v1beta3-Extender}
|
||||||
|
|
||||||
@@ -442,7 +425,6 @@ All points must be sorted in increasing order by utilization.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -567,8 +549,6 @@ fail when the extender returns an error or is not reachable.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta3-ExtenderManagedResource}
|
## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta3-ExtenderManagedResource}
|
||||||
|
|
||||||
@@ -576,7 +556,6 @@ fail when the extender returns an error or is not reachable.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender)
|
- [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender)
|
||||||
|
|
||||||
|
|
||||||
@@ -608,8 +587,6 @@ resource when applying predicates.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta3-ExtenderTLSConfig}
|
## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta3-ExtenderTLSConfig}
|
||||||
|
|
||||||
@@ -617,7 +594,6 @@ resource when applying predicates.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender)
|
- [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender)
|
||||||
|
|
||||||
|
|
||||||
@@ -700,8 +676,6 @@ CAData takes precedence over CAFile</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile}
|
## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile}
|
||||||
|
|
||||||
@@ -709,7 +683,6 @@ CAData takes precedence over CAFile</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -758,8 +731,6 @@ for that plugin.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Plugin` {#kubescheduler-config-k8s-io-v1beta3-Plugin}
|
## `Plugin` {#kubescheduler-config-k8s-io-v1beta3-Plugin}
|
||||||
|
|
||||||
@@ -767,7 +738,6 @@ for that plugin.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [PluginSet](#kubescheduler-config-k8s-io-v1beta3-PluginSet)
|
- [PluginSet](#kubescheduler-config-k8s-io-v1beta3-PluginSet)
|
||||||
|
|
||||||
|
|
||||||
@@ -797,8 +767,6 @@ Plugin specifies a plugin name and its weight when applicable. Weight is used on
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PluginConfig` {#kubescheduler-config-k8s-io-v1beta3-PluginConfig}
|
## `PluginConfig` {#kubescheduler-config-k8s-io-v1beta3-PluginConfig}
|
||||||
|
|
||||||
@@ -806,7 +774,6 @@ Plugin specifies a plugin name and its weight when applicable. Weight is used on
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile)
|
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile)
|
||||||
|
|
||||||
|
|
||||||
@@ -838,8 +805,6 @@ It is up to the plugin to process these Args.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PluginSet` {#kubescheduler-config-k8s-io-v1beta3-PluginSet}
|
## `PluginSet` {#kubescheduler-config-k8s-io-v1beta3-PluginSet}
|
||||||
|
|
||||||
@@ -847,7 +812,6 @@ It is up to the plugin to process these Args.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [Plugins](#kubescheduler-config-k8s-io-v1beta3-Plugins)
|
- [Plugins](#kubescheduler-config-k8s-io-v1beta3-Plugins)
|
||||||
|
|
||||||
|
|
||||||
@@ -882,8 +846,6 @@ When all default plugins need to be disabled, an array containing only one "&low
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Plugins` {#kubescheduler-config-k8s-io-v1beta3-Plugins}
|
## `Plugins` {#kubescheduler-config-k8s-io-v1beta3-Plugins}
|
||||||
|
|
||||||
@@ -891,7 +853,6 @@ When all default plugins need to be disabled, an array containing only one "&low
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile)
|
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile)
|
||||||
|
|
||||||
|
|
||||||
@@ -1022,8 +983,6 @@ plugin through MultiPoint. This follows the same behavior as all other extension
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadConstraintsDefaulting}
|
## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadConstraintsDefaulting}
|
||||||
|
|
||||||
@@ -1031,7 +990,6 @@ plugin through MultiPoint. This follows the same behavior as all other extension
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs)
|
- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs)
|
||||||
|
|
||||||
|
|
||||||
@@ -1039,8 +997,6 @@ PodTopologySpreadConstraintsDefaulting defines how to set default constraints
|
|||||||
for the PodTopologySpread plugin.
|
for the PodTopologySpread plugin.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam}
|
## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam}
|
||||||
|
|
||||||
@@ -1048,7 +1004,6 @@ for the PodTopologySpread plugin.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy)
|
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy)
|
||||||
|
|
||||||
|
|
||||||
@@ -1070,8 +1025,6 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta3-ResourceSpec}
|
## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta3-ResourceSpec}
|
||||||
|
|
||||||
@@ -1079,9 +1032,7 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs)
|
- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs)
|
||||||
|
|
||||||
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy)
|
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy)
|
||||||
|
|
||||||
|
|
||||||
@@ -1111,8 +1062,6 @@ ResourceSpec represents a single resource.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy}
|
## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy}
|
||||||
|
|
||||||
@@ -1120,7 +1069,6 @@ ResourceSpec represents a single resource.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs)
|
- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs)
|
||||||
|
|
||||||
|
|
||||||
@@ -1161,8 +1109,6 @@ Weight defaults to 1 if not specified or explicitly set to 0.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategyType}
|
## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategyType}
|
||||||
|
|
||||||
@@ -1170,15 +1116,12 @@ Weight defaults to 1 if not specified or explicitly set to 0.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy)
|
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy)
|
||||||
|
|
||||||
|
|
||||||
ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.
|
ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta3-UtilizationShapePoint}
|
## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta3-UtilizationShapePoint}
|
||||||
|
|
||||||
@@ -1186,9 +1129,7 @@ ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs)
|
- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs)
|
||||||
|
|
||||||
- [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam)
|
- [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam)
|
||||||
|
|
||||||
|
|
||||||
@@ -1218,7 +1159,6 @@ UtilizationShapePoint represents single point of priority function shape.
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1229,9 +1169,7 @@ UtilizationShapePoint represents single point of priority function shape.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1294,10 +1232,8 @@ client.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
||||||
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
DebuggingConfiguration holds configuration for Debugging related features.
|
DebuggingConfiguration holds configuration for Debugging related features.
|
||||||
@@ -1334,7 +1270,6 @@ enableProfiling is true.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [LoggingConfiguration](#LoggingConfiguration)
|
- [LoggingConfiguration](#LoggingConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1363,7 +1298,6 @@ FormatOptions contains options for the different logging formats.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [FormatOptions](#FormatOptions)
|
- [FormatOptions](#FormatOptions)
|
||||||
|
|
||||||
|
|
||||||
@@ -1386,7 +1320,7 @@ both to stdout, without buffering.</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
|
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
|
||||||
<code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code>
|
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue"><code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
[Experimental] InfoBufferSize sets the size of the info stream when
|
[Experimental] InfoBufferSize sets the size of the info stream when
|
||||||
@@ -1403,9 +1337,7 @@ using split streams. The default is zero, which disables buffering.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1498,7 +1430,6 @@ during leader election cycles.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1577,7 +1508,6 @@ format get used, but all of them get validated.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [LoggingConfiguration](#LoggingConfiguration)
|
- [LoggingConfiguration](#LoggingConfiguration)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -14,6 +14,166 @@ auto_generated: true
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `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/>
|
||||||
|
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue"><code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code></a>
|
||||||
|
</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}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**Appears in:**
|
||||||
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
|
LoggingConfiguration contains logging options
|
||||||
|
Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information.
|
||||||
|
|
||||||
|
<table class="table">
|
||||||
|
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
||||||
|
<tbody>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td><code>format</code> <B>[Required]</B><br/>
|
||||||
|
<code>string</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Format Flag specifies the structure of log messages.
|
||||||
|
default value of format is `text`</td>
|
||||||
|
</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/>
|
||||||
|
<code>bool</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
|
||||||
|
Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)</td>
|
||||||
|
</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>
|
||||||
|
</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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletConfiguration` {#kubelet-config-k8s-io-v1beta1-KubeletConfiguration}
|
## `KubeletConfiguration` {#kubelet-config-k8s-io-v1beta1-KubeletConfiguration}
|
||||||
|
|
||||||
@@ -1517,7 +1677,7 @@ Default: 0.8</td>
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>registerWithTaints</code><br/>
|
<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>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#taint-v1-core"><code>[]core/v1.Taint</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
registerWithTaints are an array of taints to add to a node object when
|
registerWithTaints are an array of taints to add to a node object when
|
||||||
@@ -1538,8 +1698,6 @@ Default: true</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `SerializedNodeConfigSource` {#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource}
|
## `SerializedNodeConfigSource` {#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource}
|
||||||
|
|
||||||
@@ -1562,7 +1720,7 @@ It exists in the kubeletconfig API group because it is classified as a versioned
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>source</code><br/>
|
<tr><td><code>source</code><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#nodeconfigsource-v1-core"><code>core/v1.NodeConfigSource</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#nodeconfigsource-v1-core"><code>core/v1.NodeConfigSource</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
source is the source that we are serializing.</td>
|
source is the source that we are serializing.</td>
|
||||||
@@ -1571,21 +1729,6 @@ It exists in the kubeletconfig API group because it is classified as a versioned
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `HairpinMode` {#kubelet-config-k8s-io-v1beta1-HairpinMode}
|
|
||||||
|
|
||||||
(Alias of `string`)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
HairpinMode denotes how the kubelet should configure networking to handle
|
|
||||||
hairpin packets.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletAnonymousAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAnonymousAuthentication}
|
## `KubeletAnonymousAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAnonymousAuthentication}
|
||||||
|
|
||||||
@@ -1593,7 +1736,6 @@ hairpin packets.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
|
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
|
||||||
|
|
||||||
|
|
||||||
@@ -1619,8 +1761,6 @@ Anonymous requests have a username of `system:anonymous`, and a group name of
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAuthentication}
|
## `KubeletAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAuthentication}
|
||||||
|
|
||||||
@@ -1628,7 +1768,6 @@ Anonymous requests have a username of `system:anonymous`, and a group name of
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1666,8 +1805,6 @@ Anonymous requests have a username of `system:anonymous`, and a group name of
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorization}
|
## `KubeletAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorization}
|
||||||
|
|
||||||
@@ -1675,7 +1812,6 @@ Anonymous requests have a username of `system:anonymous`, and a group name of
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1707,8 +1843,6 @@ Webhook mode uses the SubjectAccessReview API to determine authorization.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletAuthorizationMode` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorizationMode}
|
## `KubeletAuthorizationMode` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorizationMode}
|
||||||
|
|
||||||
@@ -1716,15 +1850,12 @@ Webhook mode uses the SubjectAccessReview API to determine authorization.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization)
|
- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletWebhookAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthentication}
|
## `KubeletWebhookAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthentication}
|
||||||
|
|
||||||
@@ -1732,7 +1863,6 @@ Webhook mode uses the SubjectAccessReview API to determine authorization.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
|
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
|
||||||
|
|
||||||
|
|
||||||
@@ -1763,8 +1893,6 @@ tokenreviews.authentication.k8s.io API.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletWebhookAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthorization}
|
## `KubeletWebhookAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthorization}
|
||||||
|
|
||||||
@@ -1772,7 +1900,6 @@ tokenreviews.authentication.k8s.io API.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization)
|
- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization)
|
||||||
|
|
||||||
|
|
||||||
@@ -1804,8 +1931,6 @@ the webhook authorizer.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `KubeletX509Authentication` {#kubelet-config-k8s-io-v1beta1-KubeletX509Authentication}
|
## `KubeletX509Authentication` {#kubelet-config-k8s-io-v1beta1-KubeletX509Authentication}
|
||||||
|
|
||||||
@@ -1813,7 +1938,6 @@ the webhook authorizer.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
|
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
|
||||||
|
|
||||||
|
|
||||||
@@ -1838,8 +1962,6 @@ and groups corresponding to the Organization in the client certificate.</td>
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `MemoryReservation` {#kubelet-config-k8s-io-v1beta1-MemoryReservation}
|
## `MemoryReservation` {#kubelet-config-k8s-io-v1beta1-MemoryReservation}
|
||||||
|
|
||||||
@@ -1847,7 +1969,6 @@ and groups corresponding to the Organization in the client certificate.</td>
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1869,7 +1990,7 @@ MemoryReservation specifies the memory reservation of different types for each N
|
|||||||
|
|
||||||
|
|
||||||
<tr><td><code>limits</code> <B>[Required]</B><br/>
|
<tr><td><code>limits</code> <B>[Required]</B><br/>
|
||||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#resourcelist-v1-core"><code>core/v1.ResourceList</code></a>
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcelist-v1-core"><code>core/v1.ResourceList</code></a>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<span class="text-muted">No description provided.</span>
|
<span class="text-muted">No description provided.</span>
|
||||||
@@ -1879,8 +2000,6 @@ MemoryReservation specifies the memory reservation of different types for each N
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `MemorySwapConfiguration` {#kubelet-config-k8s-io-v1beta1-MemorySwapConfiguration}
|
## `MemorySwapConfiguration` {#kubelet-config-k8s-io-v1beta1-MemorySwapConfiguration}
|
||||||
|
|
||||||
@@ -1888,7 +2007,6 @@ MemoryReservation specifies the memory reservation of different types for each N
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1912,8 +2030,6 @@ MemoryReservation specifies the memory reservation of different types for each N
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy}
|
## `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy}
|
||||||
|
|
||||||
@@ -1921,7 +2037,6 @@ MemoryReservation specifies the memory reservation of different types for each N
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1929,8 +2044,6 @@ ResourceChangeDetectionStrategy denotes a mode in which internal
|
|||||||
managers (secret, configmap) are discovering object changes.
|
managers (secret, configmap) are discovering object changes.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ShutdownGracePeriodByPodPriority` {#kubelet-config-k8s-io-v1beta1-ShutdownGracePeriodByPodPriority}
|
## `ShutdownGracePeriodByPodPriority` {#kubelet-config-k8s-io-v1beta1-ShutdownGracePeriodByPodPriority}
|
||||||
|
|
||||||
@@ -1938,7 +2051,6 @@ managers (secret, configmap) are discovering object changes.
|
|||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
**Appears in:**
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
||||||
|
|
||||||
|
|
||||||
@@ -1968,170 +2080,4 @@ ShutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods ba
|
|||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</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}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**Appears in:**
|
|
||||||
|
|
||||||
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
|
|
||||||
|
|
||||||
|
|
||||||
LoggingConfiguration contains logging options
|
|
||||||
Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information.
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
|
|
||||||
<tbody>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<tr><td><code>format</code> <B>[Required]</B><br/>
|
|
||||||
<code>string</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
Format Flag specifies the structure of log messages.
|
|
||||||
default value of format is `text`</td>
|
|
||||||
</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/>
|
|
||||||
<code>bool</code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
|
|
||||||
Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)</td>
|
|
||||||
</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>
|
|
||||||
</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.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user