diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 8d18bba51e..dfeeb7d8b0 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -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 operator to use or manage a cluster. -* [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) -* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) -* [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) -* [kube-scheduler configuration (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2/) -* [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) + +* [kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/) +* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) and + [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) +* [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/) * [`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/) ## Config API for kubeadm diff --git a/content/en/docs/reference/access-authn-authz/authentication.md b/content/en/docs/reference/access-authn-authz/authentication.md index 7a38493a70..a7d5cd84d9 100644 --- a/content/en/docs/reference/access-authn-authz/authentication.md +++ b/content/en/docs/reference/access-authn-authz/authentication.md @@ -1232,3 +1232,5 @@ The following `ExecCredential` manifest describes a cluster information sample. ## {{% heading "whatsnext" %}} * 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/) + diff --git a/content/en/docs/reference/config-api/apiserver-audit.v1.md b/content/en/docs/reference/config-api/apiserver-audit.v1.md index f722e81341..e817b838ae 100644 --- a/content/en/docs/reference/config-api/apiserver-audit.v1.md +++ b/content/en/docs/reference/config-api/apiserver-audit.v1.md @@ -16,14 +16,12 @@ auto_generated: true - ## `Event` {#audit-k8s-io-v1-Event} **Appears in:** - - [EventList](#audit-k8s-io-v1-EventList) @@ -81,7 +79,7 @@ For non-resource requests, this is the lower-cased HTTP method. user [Required]
-authentication/v1.UserInfo +authentication/v1.UserInfo Authenticated user information. @@ -89,7 +87,7 @@ For non-resource requests, this is the lower-cased HTTP method. impersonatedUser
-authentication/v1.UserInfo +authentication/v1.UserInfo Impersonated user information. @@ -123,7 +121,7 @@ Does not apply for List-type requests, or non-resource requests. responseStatus
-meta/v1.Status +meta/v1.Status The response status, populated even when the ResponseObject is not a Status type. @@ -154,7 +152,7 @@ at Response Level. requestReceivedTimestamp
-meta/v1.MicroTime +meta/v1.MicroTime Time the request reached the apiserver. @@ -162,7 +160,7 @@ at Response Level. stageTimestamp
-meta/v1.MicroTime +meta/v1.MicroTime Time the request reached current audit stage. @@ -184,8 +182,6 @@ should be short. Annotations are included in the Metadata level. - - ## `EventList` {#audit-k8s-io-v1-EventList} @@ -206,7 +202,7 @@ EventList is a list of audit Events. metadata
-meta/v1.ListMeta +meta/v1.ListMeta No description provided. @@ -225,8 +221,6 @@ EventList is a list of audit Events. - - ## `Policy` {#audit-k8s-io-v1-Policy} @@ -234,7 +228,6 @@ EventList is a list of audit Events. **Appears in:** - - [PolicyList](#audit-k8s-io-v1-PolicyList) @@ -252,7 +245,7 @@ categories are logged. metadata
-meta/v1.ObjectMeta +meta/v1.ObjectMeta ObjectMeta is included for interoperability with API infrastructure.Refer to the Kubernetes API documentation for the fields of the metadata field. @@ -294,8 +287,6 @@ in a rule will override the global default. - - ## `PolicyList` {#audit-k8s-io-v1-PolicyList} @@ -316,7 +307,7 @@ PolicyList is a list of audit Policies. metadata
-meta/v1.ListMeta +meta/v1.ListMeta No description provided. @@ -335,8 +326,6 @@ PolicyList is a list of audit Policies. - - ## `GroupResources` {#audit-k8s-io-v1-GroupResources} @@ -344,7 +333,6 @@ PolicyList is a list of audit Policies. **Appears in:** - - [PolicyRule](#audit-k8s-io-v1-PolicyRule) @@ -397,8 +385,6 @@ An empty list implies that every instance of the resource is matched. - - ## `Level` {#audit-k8s-io-v1-Level} @@ -406,17 +392,13 @@ An empty list implies that every instance of the resource is matched. **Appears in:** - - [Event](#audit-k8s-io-v1-Event) - - [PolicyRule](#audit-k8s-io-v1-PolicyRule) Level defines the amount of information logged during auditing - - ## `ObjectReference` {#audit-k8s-io-v1-ObjectReference} @@ -424,7 +406,6 @@ Level defines the amount of information logged during auditing **Appears in:** - - [Event](#audit-k8s-io-v1-Event) @@ -509,8 +490,6 @@ The empty string represents the core API group. - - ## `PolicyRule` {#audit-k8s-io-v1-PolicyRule} @@ -518,7 +497,6 @@ The empty string represents the core API group. **Appears in:** - - [Policy](#audit-k8s-io-v1-Policy) @@ -624,8 +602,6 @@ Policy.OmitManagedFields will stand. - - ## `Stage` {#audit-k8s-io-v1-Stage} @@ -633,16 +609,12 @@ Policy.OmitManagedFields will stand. **Appears in:** - - [Event](#audit-k8s-io-v1-Event) - - [Policy](#audit-k8s-io-v1-Policy) - - [PolicyRule](#audit-k8s-io-v1-PolicyRule) Stage defines the stages in request handling that audit events may be generated. - diff --git a/content/en/docs/reference/config-api/apiserver-config.v1.md b/content/en/docs/reference/config-api/apiserver-config.v1.md new file mode 100644 index 0000000000..7767a4e406 --- /dev/null +++ b/content/en/docs/reference/config-api/apiserver-config.v1.md @@ -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. + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		apiserver.config.k8s.io/v1
kind
string		AdmissionConfiguration
plugins
+[]AdmissionPluginConfiguration +		 + Plugins allows specifying a configuration per admission control plugin.
+ +## `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. + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 + Name is the name of the admission controller. +It must match the registered admission plugin name.
path
+string +		 + Path is the path to a configuration file that contains the plugin's +configuration
configuration
+k8s.io/apimachinery/pkg/runtime.Unknown +		 + Configuration is an embedded configuration object to be used as the plugin's +configuration. If present, it will be used instead of the path to the configuration file.
+ diff --git a/content/en/docs/reference/config-api/apiserver-config.v1beta1.md b/content/en/docs/reference/config-api/apiserver-config.v1beta1.md deleted file mode 100644 index fb5363f58d..0000000000 --- a/content/en/docs/reference/config-api/apiserver-config.v1beta1.md +++ /dev/null @@ -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. - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		apiserver.k8s.io/v1beta1
kind
string		EgressSelectorConfiguration
egressSelections [Required]
-[]EgressSelection -		 - connectionServices contains a list of egress selection client configurations
- - - -## `Connection` {#apiserver-k8s-io-v1beta1-Connection} - - - - -**Appears in:** - -- [EgressSelection](#apiserver-k8s-io-v1beta1-EgressSelection) - - -Connection provides the configuration for a single egress selection client. - - - - - - - - - - - - - - - - - - -
FieldDescription
proxyProtocol [Required]
-ProtocolType -		 - Protocol is the protocol used to connect from client to the konnectivity server.
transport
-Transport -		 - Transport defines the transport configurations we use to dial to the konnectivity server. -This is required if ProxyProtocol is HTTPConnect or GRPC.
- - - -## `EgressSelection` {#apiserver-k8s-io-v1beta1-EgressSelection} - - - - -**Appears in:** - -- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration) - - -EgressSelection provides the configuration for a single egress selection client. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - 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"
connection [Required]
-Connection -		 - connection is the exact information used to configure the egress selection
- - - -## `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 - - - - - - - - - - - - - - - - - - -
FieldDescription
url [Required]
-string -		 - URL is the location of the konnectivity server to connect to. -As an example it might be "https://127.0.0.1:8131"
tlsConfig
-TLSConfig -		 - TLSConfig is the config needed to use TLS when connecting to konnectivity server
- - - -## `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 - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
caBundle
-string -		 - 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.
clientKey
-string -		 - 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://
clientCert
-string -		 - 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://
- - - -## `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 - - - - - - - - - - - - - - - - - - -
FieldDescription
tcp
-TCPTransport -		 - 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
uds
-UDSTransport -		 - UDS is the UDS configuration for communicating with the konnectivity server via UDS -Requires at least one of TCP or UDS to be set
- - - -## `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 - - - - - - - - - - - - - -
FieldDescription
udsName [Required]
-string -		 - 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)
- - diff --git a/content/en/docs/reference/config-api/apiserver-webhookadmission.v1.md b/content/en/docs/reference/config-api/apiserver-webhookadmission.v1.md index fb45ca7b1a..cecebc3d10 100644 --- a/content/en/docs/reference/config-api/apiserver-webhookadmission.v1.md +++ b/content/en/docs/reference/config-api/apiserver-webhookadmission.v1.md @@ -13,7 +13,6 @@ Package v1 is the v1 version of the API. - ## `WebhookAdmission` {#apiserver-config-k8s-io-v1-WebhookAdmission} @@ -42,5 +41,4 @@ WebhookAdmission provides configuration for the webhook admission controller. - diff --git a/content/en/docs/reference/config-api/client-authentication.v1.md b/content/en/docs/reference/config-api/client-authentication.v1.md new file mode 100644 index 0000000000..20f7554854 --- /dev/null +++ b/content/en/docs/reference/config-api/client-authentication.v1.md @@ -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. + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		client.authentication.k8s.io/v1
kind
string		ExecCredential
spec [Required]
+ExecCredentialSpec +		 + Spec holds information passed to the plugin by the transport.
status
+ExecCredentialStatus +		 + Status is filled in by the plugin and holds the credentials that the transport +should use to contact the API.
+ +## `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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
server [Required]
+string +		 + Server is the address of the kubernetes cluster (https://hostname:port).
tls-server-name
+string +		 + 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.
insecure-skip-tls-verify
+bool +		 + InsecureSkipTLSVerify skips the validity check for the server's certificate. +This will make your HTTPS connections insecure.
certificate-authority-data
+[]byte +		 + CAData contains PEM-encoded certificate authority certificates. +If empty, system roots should be used.
proxy-url
+string +		 + ProxyURL is the URL to the proxy to be used for all requests to this +cluster.
config
+k8s.io/apimachinery/pkg/runtime.RawExtension +		 + 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.
+ +## `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. + + + + + + + + + + + + + + + + + + +
FieldDescription
cluster
+Cluster +		 + 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).
interactive [Required]
+bool +		 + Interactive declares whether stdin has been passed to this exec plugin.
+ +## `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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
expirationTimestamp
+meta/v1.Time +		 + ExpirationTimestamp indicates a time when the provided credentials expire.
token [Required]
+string +		 + Token is a bearer token used by the client for request authentication.
clientCertificateData [Required]
+string +		 + PEM-encoded client TLS certificates (including intermediates, if any).
clientKeyData [Required]
+string +		 + PEM-encoded private key for the above certificate.
+ diff --git a/content/en/docs/reference/config-api/client-authentication.v1beta1.md b/content/en/docs/reference/config-api/client-authentication.v1beta1.md index d018fb208f..025e762274 100644 --- a/content/en/docs/reference/config-api/client-authentication.v1beta1.md +++ b/content/en/docs/reference/config-api/client-authentication.v1beta1.md @@ -13,13 +13,10 @@ auto_generated: true - ## `ExecCredential` {#client-authentication-k8s-io-v1beta1-ExecCredential} - - ExecCredential is used by exec-based plugins to communicate credentials to HTTP transports. @@ -30,41 +27,32 @@ HTTP transports. apiVersion
stringclient.authentication.k8s.io/v1beta1 kind
stringExecCredential - - spec [Required]
ExecCredentialSpec - Spec holds information passed to the plugin by the transport. + Spec holds information passed to the plugin by the transport. + - - status
ExecCredentialStatus Status is filled in by the plugin and holds the credentials that the transport -should use to contact the API. +should use to contact the API. + - - - - ## `Cluster` {#client-authentication-k8s-io-v1beta1-Cluster} - - **Appears in:** - [ExecCredentialSpec](#client-authentication-k8s-io-v1beta1-ExecCredentialSpec) - Cluster contains information to allow an exec plugin to communicate 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 FieldDescription - server [Required]
string - Server is the address of the kubernetes cluster (https://hostname:port). + Server is the address of the kubernetes cluster (https://hostname:port). + - - tls-server-name
string 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. +used to contact the server is used. + - - insecure-skip-tls-verify
bool InsecureSkipTLSVerify skips the validity check for the server's certificate. -This will make your HTTPS connections insecure. +This will make your HTTPS connections insecure. + - - certificate-authority-data
[]byte CAData contains PEM-encoded certificate authority certificates. -If empty, system roots should be used. +If empty, system roots should be used. + - - proxy-url
string ProxyURL is the URL to the proxy to be used for all requests to this -cluster. +cluster. + - - config
k8s.io/apimachinery/pkg/runtime.RawExtension @@ -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 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. +to be stored directly in the kubeconfig. + - - - - ## `ExecCredentialSpec` {#client-authentication-k8s-io-v1beta1-ExecCredentialSpec} - - **Appears in:** - [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential) - ExecCredentialSpec holds request and runtime specific information provided by the transport. @@ -174,7 +150,6 @@ the transport. FieldDescription - cluster
Cluster @@ -183,33 +158,26 @@ the transport. 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). +ExecConfig.ProvideClusterInfo). + - - interactive [Required]
bool - Interactive declares whether stdin has been passed to this exec plugin. + Interactive declares whether stdin has been passed to this exec plugin. + - - - - ## `ExecCredentialStatus` {#client-authentication-k8s-io-v1beta1-ExecCredentialStatus} - - **Appears in:** - [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential) - ExecCredentialStatus holds credentials for the transport to use. Token and ClientKeyData are sensitive fields. This data should only be @@ -220,41 +188,35 @@ itself should at least be protected via file permissions. FieldDescription - expirationTimestamp
-meta/v1.Time +meta/v1.Time - ExpirationTimestamp indicates a time when the provided credentials expire. + ExpirationTimestamp indicates a time when the provided credentials expire. + - - token [Required]
string - Token is a bearer token used by the client for request authentication. + Token is a bearer token used by the client for request authentication. + - - clientCertificateData [Required]
string - PEM-encoded client TLS certificates (including intermediates, if any). + PEM-encoded client TLS certificates (including intermediates, if any). + - - clientKeyData [Required]
string - PEM-encoded private key for the above certificate. + PEM-encoded private key for the above certificate. + - - - diff --git a/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md b/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md index c0c2312f6f..2dc445cd7e 100644 --- a/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md +++ b/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md @@ -13,13 +13,10 @@ auto_generated: true - ## `KubeProxyConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration} - - KubeProxyConfiguration contains everything necessary to configure the Kubernetes proxy server. @@ -30,156 +27,137 @@ Kubernetes proxy server. apiVersion
stringkubeproxy.config.k8s.io/v1alpha1 kind
stringKubeProxyConfiguration - - featureGates [Required]
map[string]bool - featureGates is a map of feature names to bools that enable or disable alpha/experimental features. + featureGates is a map of feature names to bools that enable or disable alpha/experimental features. + - - bindAddress [Required]
string bindAddress is the IP address for the proxy server to serve on (set to 0.0.0.0 -for all interfaces) +for all interfaces) + - - healthzBindAddress [Required]
string healthzBindAddress is the IP address and port for the health check server to serve on, -defaulting to 0.0.0.0:10256 +defaulting to 0.0.0.0:10256 + - - metricsBindAddress [Required]
string 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) +defaulting to 127.0.0.1:10249 (set to 0.0.0.0 for all interfaces) + - - bindAddressHardFail [Required]
bool - bindAddressHardFail, if true, kube-proxy will treat failure to bind to a port as fatal and exit + bindAddressHardFail, if true, kube-proxy will treat failure to bind to a port as fatal and exit + - - enableProfiling [Required]
bool enableProfiling enables profiling via web interface on /debug/pprof handler. -Profiling handlers will be handled by metrics server. +Profiling handlers will be handled by metrics server. + - - clusterCIDR [Required]
string 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, -no off-cluster bridging will be performed. +no off-cluster bridging will be performed. + - - hostnameOverride [Required]
string - hostnameOverride, if non-empty, will be used as the identity instead of the actual hostname. + hostnameOverride, if non-empty, will be used as the identity instead of the actual hostname. + - - clientConnection [Required]
ClientConnectionConfiguration clientConnection specifies the kubeconfig file and client connection settings for the proxy -server to use when communicating with the apiserver. +server to use when communicating with the apiserver. + - - iptables [Required]
KubeProxyIPTablesConfiguration - iptables contains iptables-related configuration options. + iptables contains iptables-related configuration options. + - - ipvs [Required]
KubeProxyIPVSConfiguration - ipvs contains ipvs-related configuration options. + ipvs contains ipvs-related configuration options. + - - oomScoreAdj [Required]
int32 oomScoreAdj is the oom-score-adj value for kube-proxy process. Values must be within -the range [-1000, 1000] +the range [-1000, 1000] + - - mode [Required]
ProxyMode - mode specifies which proxy mode to use. + mode specifies which proxy mode to use. + - - portRange [Required]
string 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. +in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen. + - - udpIdleTimeout [Required]
meta/v1.Duration 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. +Must be greater than 0. Only applicable for proxyMode=userspace. + - - conntrack [Required]
KubeProxyConntrackConfiguration - conntrack contains conntrack-related configuration options. + conntrack contains conntrack-related configuration options. + - - configSyncPeriod [Required]
meta/v1.Duration configSyncPeriod is how often configuration from the apiserver is refreshed. Must be greater -than 0. +than 0. + - - nodePortAddresses [Required]
[]string @@ -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. 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. -An empty string slice is meant to select all network interfaces. +An empty string slice is meant to select all network interfaces. + - - winkernel [Required]
KubeProxyWinkernelConfiguration - winkernel contains winkernel-related configuration options. + winkernel contains winkernel-related configuration options. + - - showHiddenMetricsForVersion [Required]
string - ShowHiddenMetricsForVersion is the version for which you want to show hidden metrics. + ShowHiddenMetricsForVersion is the version for which you want to show hidden metrics. + - - detectLocalMode [Required]
LocalMode - DetectLocalMode determines mode to use for detecting local traffic, defaults to LocalModeClusterCIDR + DetectLocalMode determines mode to use for detecting local traffic, defaults to LocalModeClusterCIDR + - - - - ## `KubeProxyConntrackConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration} - - **Appears in:** - [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) - KubeProxyConntrackConfiguration contains conntrack settings for the Kubernetes proxy server. @@ -240,60 +209,50 @@ the Kubernetes proxy server. FieldDescription - maxPerCore [Required]
int32 maxPerCore is the maximum number of NAT connections to track -per CPU core (0 to leave the limit as-is and ignore min). +per CPU core (0 to leave the limit as-is and ignore min). + - - min [Required]
int32 min is the minimum value of connect-tracking records to allocate, -regardless of conntrackMaxPerCore (set maxPerCore=0 to leave the limit as-is). +regardless of conntrackMaxPerCore (set maxPerCore=0 to leave the limit as-is). + - - tcpEstablishedTimeout [Required]
meta/v1.Duration tcpEstablishedTimeout is how long an idle TCP connection will be kept open -(e.g. '2s'). Must be greater than 0 to set. +(e.g. '2s'). Must be greater than 0 to set. + - - tcpCloseWaitTimeout [Required]
meta/v1.Duration tcpCloseWaitTimeout is how long an idle conntrack entry in CLOSE_WAIT state will remain in the conntrack -table. (e.g. '60s'). Must be greater than 0 to set. +table. (e.g. '60s'). Must be greater than 0 to set. + - - - - ## `KubeProxyIPTablesConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration} - - **Appears in:** - [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) - KubeProxyIPTablesConfiguration contains iptables-related configuration details for the Kubernetes proxy server. @@ -301,58 +260,48 @@ details for the Kubernetes proxy server. FieldDescription - masqueradeBit [Required]
int32 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]. +the pure iptables proxy mode. Values must be within the range [0, 31]. + - - masqueradeAll [Required]
bool - masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode. + masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode. + - - syncPeriod [Required]
meta/v1.Duration syncPeriod is the period that iptables rules are refreshed (e.g. '5s', '1m', -'2h22m'). Must be greater than 0. +'2h22m'). Must be greater than 0. + - - minSyncPeriod [Required]
meta/v1.Duration minSyncPeriod is the minimum period that iptables rules are refreshed (e.g. '5s', '1m', -'2h22m'). +'2h22m'). + - - - - ## `KubeProxyIPVSConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration} - - **Appears in:** - [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) - KubeProxyIPVSConfiguration contains ipvs-related configuration details for the Kubernetes proxy server. @@ -360,94 +309,80 @@ details for the Kubernetes proxy server. FieldDescription - syncPeriod [Required]
meta/v1.Duration syncPeriod is the period that ipvs rules are refreshed (e.g. '5s', '1m', -'2h22m'). Must be greater than 0. +'2h22m'). Must be greater than 0. + - - minSyncPeriod [Required]
meta/v1.Duration minSyncPeriod is the minimum period that ipvs rules are refreshed (e.g. '5s', '1m', -'2h22m'). +'2h22m'). + - - scheduler [Required]
string - ipvs scheduler + ipvs scheduler + - - excludeCIDRs [Required]
[]string excludeCIDRs is a list of CIDR's which the ipvs proxier should not touch -when cleaning up ipvs services. +when cleaning up ipvs services. + - - strictARP [Required]
bool strict ARP configure arp_ignore and arp_announce to avoid answering ARP queries -from kube-ipvs0 interface +from kube-ipvs0 interface + - - tcpTimeout [Required]
meta/v1.Duration 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. +The default value is 0, which preserves the current timeout value on the system. + - - tcpFinTimeout [Required]
meta/v1.Duration 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. +The default value is 0, which preserves the current timeout value on the system. + - - udpTimeout [Required]
meta/v1.Duration udpTimeout is the timeout value used for IPVS UDP packets. -The default value is 0, which preserves the current timeout value on the system. +The default value is 0, which preserves the current timeout value on the system. + - - - - ## `KubeProxyWinkernelConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration} - - **Appears in:** - [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) - KubeProxyWinkernelConfiguration contains Windows/HNS settings for the Kubernetes proxy server. @@ -455,66 +390,52 @@ the Kubernetes proxy server. FieldDescription - networkName [Required]
string networkName is the name of the network kube-proxy will use -to create endpoints and policies +to create endpoints and policies + - - sourceVip [Required]
string sourceVip is the IP address of the source VIP endoint used for -NAT when loadbalancing +NAT when loadbalancing + - - enableDSR [Required]
bool enableDSR tells kube-proxy whether HNS policies should be created -with DSR +with DSR + - - - - ## `LocalMode` {#kubeproxy-config-k8s-io-v1alpha1-LocalMode} (Alias of `string`) - - **Appears in:** - [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) - LocalMode represents modes to detect local traffic from the node - - ## `ProxyMode` {#kubeproxy-config-k8s-io-v1alpha1-ProxyMode} (Alias of `string`) - - **Appears in:** - [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) - 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' @@ -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. - @@ -540,122 +460,62 @@ this always falls back to the userspace proxy. ## `ClientConnectionConfiguration` {#ClientConnectionConfiguration} - - **Appears in:** - [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. - + kubeconfig is the path to a KubeConfig file. + - - +client. + - - + contentType is the content type used when sending data to the server from this client. + - - + qps controls the number of queries per second allowed for this connection. + - - - - - - -
FieldDescription
kubeconfig [Required]
string 		- kubeconfig is the path to a KubeConfig file.
acceptContentTypes [Required]
string 		acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular -client.
contentType [Required]
string 		- contentType is the content type used when sending data to the server from this client.
qps [Required]
float32 		- qps controls the number of queries per second allowed for this connection.
burst [Required]
int32 		- burst allows extra queries to accumulate when a client is exceeding its rate.
- -## `DebuggingConfiguration` {#DebuggingConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - -- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) - - -DebuggingConfiguration holds configuration for Debugging related features. - - - - - - - - - - - - - - - -
FieldDescription
enableProfiling [Required]
-bool + burst allows extra queries to accumulate when a client is exceeding its rate. 		- enableProfiling enables profiling via web interface host:port/debug/pprof/
enableContentionProfiling [Required]
-bool -		 - enableContentionProfiling enables lock contention profiling, if -enableProfiling is true.
## `FormatOptions` {#FormatOptions} - - **Appears in:** -- [LoggingConfiguration](#LoggingConfiguration) FormatOptions contains options for the different logging formats. @@ -664,36 +524,30 @@ FormatOptions contains options for the different logging formats. FieldDescription - json [Required]
JSONOptions - [Experimental] JSON contains options for logging format "json". + [Experimental] JSON contains options for logging format "json". + - - ## `JSONOptions` {#JSONOptions} - - **Appears in:** - [FormatOptions](#FormatOptions) - JSONOptions contains options for logging format "json". - +both to stdout, without buffering. + - - - - - - -
FieldDescription
splitStream [Required]
bool @@ -701,206 +555,25 @@ JSONOptions contains options for logging format "json". 		[Experimental] SplitStream redirects error messages to stderr while info messages go to stdout, with buffering. The default is to write -both to stdout, without buffering.
infoBufferSize [Required]
-k8s.io/apimachinery/pkg/api/resource.QuantityValue +k8s.io/apimachinery/pkg/api/resource.QuantityValue 		[Experimental] InfoBufferSize sets the size of the info stream when -using split streams. The default is zero, which disables buffering.
- -## `LeaderElectionConfiguration` {#LeaderElectionConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) - -- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration) - - -LeaderElectionConfiguration defines the configuration of leader election -clients for components that can run with leader election enabled. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
leaderElect [Required]
-bool +using split streams. The default is zero, which disables buffering. 		- leaderElect enables a leader election client to gain leadership -before executing the main loop. Enable this when running replicated -components for high availability.
leaseDuration [Required]
-meta/v1.Duration -		 - leaseDuration is the duration that non-leader candidates will wait -after observing a leadership renewal until attempting to acquire -leadership of a led but unrenewed leader slot. This is effectively the -maximum duration that a leader can be stopped before it is replaced -by another candidate. This is only applicable if leader election is -enabled.
renewDeadline [Required]
-meta/v1.Duration -		 - renewDeadline is the interval between attempts by the acting master to -renew a leadership slot before it stops leading. This must be less -than or equal to the lease duration. This is only applicable if leader -election is enabled.
retryPeriod [Required]
-meta/v1.Duration -		 - retryPeriod is the duration the clients should wait between attempting -acquisition and renewal of a leadership. This is only applicable if -leader election is enabled.
resourceLock [Required]
-string -		 - resourceLock indicates the resource object type that will be used to lock -during leader election cycles.
resourceName [Required]
-string -		 - resourceName indicates the name of resource object that will be used to lock -during leader election cycles.
resourceNamespace [Required]
-string -		 - resourceName indicates the namespace of resource object that will be used to lock -during leader election cycles.
- -## `LoggingConfiguration` {#LoggingConfiguration} - - - - -**Appears in:** - -- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) - - -LoggingConfiguration contains logging options -Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
format [Required]
-string -		 - Format Flag specifies the structure of log messages. -default value of format is `text`
flushFrequency [Required]
-time.Duration -		 - Maximum number of seconds between log flushes. Ignored if the -selected logging backend writes log messages without buffering.
verbosity [Required]
-uint32 -		 - Verbosity is the threshold that determines which log messages are -logged. Default is zero which logs only the most important -messages. Higher values enable additional messages. Error messages -are always logged.
vmodule [Required]
-VModuleConfiguration -		 - VModule overrides the verbosity threshold for individual files. -Only supported for "text" log format.
sanitization [Required]
-bool -		 - [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). -Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
options [Required]
-FormatOptions -		 - [Experimental] Options holds additional parameters that are specific -to the different logging formats. Only the options for the selected -format get used, but all of them get validated.
## `VModuleConfiguration` {#VModuleConfiguration} (Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`) - - **Appears in:** -- [LoggingConfiguration](#LoggingConfiguration) VModuleConfiguration is a collection of individual file names or patterns diff --git a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta1.md b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta1.md deleted file mode 100644 index ac32e65674..0000000000 --- a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta1.md +++ /dev/null @@ -1,2156 +0,0 @@ ---- -title: kube-scheduler Configuration (v1beta1) -content_type: tool-reference -package: kubescheduler.config.k8s.io/v1 -auto_generated: true ---- - - -## Resource Types - - -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) -- [DefaultPreemptionArgs](#kubescheduler-config-k8s-io-v1beta1-DefaultPreemptionArgs) -- [InterPodAffinityArgs](#kubescheduler-config-k8s-io-v1beta1-InterPodAffinityArgs) -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) -- [NodeAffinityArgs](#kubescheduler-config-k8s-io-v1beta1-NodeAffinityArgs) -- [NodeLabelArgs](#kubescheduler-config-k8s-io-v1beta1-NodeLabelArgs) -- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesFitArgs) -- [NodeResourcesLeastAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesLeastAllocatedArgs) -- [NodeResourcesMostAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesMostAllocatedArgs) -- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadArgs) -- [RequestedToCapacityRatioArgs](#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs) -- [ServiceAffinityArgs](#kubescheduler-config-k8s-io-v1beta1-ServiceAffinityArgs) -- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta1-VolumeBindingArgs) - - - - -## `Policy` {#kubescheduler-config-k8s-io-v1-Policy} - - - - - -Policy describes a struct for a policy resource used in api. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1
kind
string		Policy
predicates [Required]
-[]PredicatePolicy -		 - Holds the information to configure the fit predicate functions
priorities [Required]
-[]PriorityPolicy -		 - Holds the information to configure the priority functions
extenders [Required]
-[]LegacyExtender -		 - Holds the information to communicate with the extender(s)
hardPodAffinitySymmetricWeight [Required]
-int32 -		 - RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule -corresponding to every RequiredDuringScheduling affinity rule. -HardPodAffinitySymmetricWeight represents the weight of implicit PreferredDuringScheduling affinity rule, in the range 1-100.
alwaysCheckAllPredicates [Required]
-bool -		 - When AlwaysCheckAllPredicates is set to true, scheduler checks all -the configured predicates even after one or more of them fails. -When the flag is set to false, scheduler skips checking the rest -of the predicates after it finds one predicate that failed.
- - - -## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1-ExtenderManagedResource} - - - - -**Appears in:** - -- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) - -- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) - - -ExtenderManagedResource describes the arguments of extended resources -managed by an extender. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Name is the extended resource name.
ignoredByScheduler [Required]
-bool -		 - IgnoredByScheduler indicates whether kube-scheduler should ignore this -resource when applying predicates.
- - - -## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1-ExtenderTLSConfig} - - - - -**Appears in:** - -- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) - -- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) - - -ExtenderTLSConfig contains settings to enable TLS with extender - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
insecure [Required]
-bool -		 - Server should be accessed without verifying the TLS certificate. For testing only.
serverName [Required]
-string -		 - ServerName is passed to the server for SNI and is used in the client to check server -certificates against. If ServerName is empty, the hostname used to contact the -server is used.
certFile [Required]
-string -		 - Server requires TLS client certificate authentication
keyFile [Required]
-string -		 - Server requires TLS client certificate authentication
caFile [Required]
-string -		 - Trusted root certificates for server
certData [Required]
-[]byte -		 - CertData holds PEM-encoded bytes (typically read from a client certificate file). -CertData takes precedence over CertFile
keyData [Required]
-[]byte -		 - KeyData holds PEM-encoded bytes (typically read from a client certificate key file). -KeyData takes precedence over KeyFile
caData [Required]
-[]byte -		 - CAData holds PEM-encoded bytes (typically read from a root certificates bundle). -CAData takes precedence over CAFile
- - - -## `LabelPreference` {#kubescheduler-config-k8s-io-v1-LabelPreference} - - - - -**Appears in:** - -- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) - - -LabelPreference holds the parameters that are used to configure the corresponding priority function - - - - - - - - - - - - - - - - - - -
FieldDescription
label [Required]
-string -		 - Used to identify node "groups"
presence [Required]
-bool -		 - This is a boolean flag -If true, higher priority is given to nodes that have the label -If false, higher priority is given to nodes that do not have the label
- - - -## `LabelsPresence` {#kubescheduler-config-k8s-io-v1-LabelsPresence} - - - - -**Appears in:** - -- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) - - -LabelsPresence holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. - - - - - - - - - - - - - - - - - - -
FieldDescription
labels [Required]
-[]string -		 - The list of labels that identify node "groups" -All of the labels should be either present (or absent) for the node to be considered a fit for hosting the pod
presence [Required]
-bool -		 - The boolean flag that indicates whether the labels should be present or absent from the node
- - - -## `LegacyExtender` {#kubescheduler-config-k8s-io-v1-LegacyExtender} - - - - -**Appears in:** - -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) - - -LegacyExtender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, -it is assumed that the extender chose not to provide that extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
urlPrefix [Required]
-string -		 - URLPrefix at which the extender is available
filterVerb [Required]
-string -		 - Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
preemptVerb [Required]
-string -		 - Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
prioritizeVerb [Required]
-string -		 - Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
weight [Required]
-int64 -		 - The numeric multiplier for the node scores that the prioritize call generates. -The weight should be a positive integer
bindVerb [Required]
-string -		 - Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender. -If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender -can implement this function.
enableHttps [Required]
-bool -		 - EnableHTTPS specifies whether https should be used to communicate with the extender
tlsConfig [Required]
-ExtenderTLSConfig -		 - TLSConfig specifies the transport layer security config
httpTimeout [Required]
-time.Duration -		 - HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize -timeout is ignored, k8s/other extenders priorities are used to select the node.
nodeCacheCapable [Required]
-bool -		 - NodeCacheCapable specifies that the extender is capable of caching node information, -so the scheduler should only send minimal information about the eligible nodes -assuming that the extender already cached full details of all nodes in the cluster
managedResources
-[]ExtenderManagedResource -		 - ManagedResources is a list of extended resources that are managed by -this extender. -- A pod will be sent to the extender on the Filter, Prioritize and Bind - (if the extender is the binder) phases iff the pod requests at least - one of the extended resources in this list. If empty or unspecified, - all pods will be sent to this extender. -- If IgnoredByScheduler is set to true for a resource, kube-scheduler - will skip checking the resource in predicates.
ignorable [Required]
-bool -		 - Ignorable specifies if the extender is ignorable, i.e. scheduling should not -fail when the extender returns an error or is not reachable.
- - - -## `PredicateArgument` {#kubescheduler-config-k8s-io-v1-PredicateArgument} - - - - -**Appears in:** - -- [PredicatePolicy](#kubescheduler-config-k8s-io-v1-PredicatePolicy) - - -PredicateArgument represents the arguments to configure predicate functions in scheduler policy configuration. -Only one of its members may be specified - - - - - - - - - - - - - - - - - - -
FieldDescription
serviceAffinity [Required]
-ServiceAffinity -		 - The predicate that provides affinity for pods belonging to a service -It uses a label to identify nodes that belong to the same "group"
labelsPresence [Required]
-LabelsPresence -		 - The predicate that checks whether a particular node has a certain label -defined or not, regardless of value
- - - -## `PredicatePolicy` {#kubescheduler-config-k8s-io-v1-PredicatePolicy} - - - - -**Appears in:** - -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) - - -PredicatePolicy describes a struct of a predicate policy. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Identifier of the predicate policy -For a custom predicate, the name can be user-defined -For the Kubernetes provided predicates, the name is the identifier of the pre-defined predicate
argument [Required]
-PredicateArgument -		 - Holds the parameters to configure the given predicate
- - - -## `PriorityArgument` {#kubescheduler-config-k8s-io-v1-PriorityArgument} - - - - -**Appears in:** - -- [PriorityPolicy](#kubescheduler-config-k8s-io-v1-PriorityPolicy) - - -PriorityArgument represents the arguments to configure priority functions in scheduler policy configuration. -Only one of its members may be specified - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
serviceAntiAffinity [Required]
-ServiceAntiAffinity -		 - The priority function that ensures a good spread (anti-affinity) for pods belonging to a service -It uses a label to identify nodes that belong to the same "group"
labelPreference [Required]
-LabelPreference -		 - The priority function that checks whether a particular node has a certain label -defined or not, regardless of value
requestedToCapacityRatioArguments [Required]
-RequestedToCapacityRatioArguments -		 - The RequestedToCapacityRatio priority function is parametrized with function shape.
- - - -## `PriorityPolicy` {#kubescheduler-config-k8s-io-v1-PriorityPolicy} - - - - -**Appears in:** - -- [Policy](#kubescheduler-config-k8s-io-v1-Policy) - - -PriorityPolicy describes a struct of a priority policy. - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Identifier of the priority policy -For a custom priority, the name can be user-defined -For the Kubernetes provided priority functions, the name is the identifier of the pre-defined priority function
weight [Required]
-int64 -		 - The numeric multiplier for the node scores that the priority function generates -The weight should be non-zero and can be a positive or a negative integer
argument [Required]
-PriorityArgument -		 - Holds the parameters to configure the given priority function
- - - -## `RequestedToCapacityRatioArguments` {#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments} - - - - -**Appears in:** - -- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) - - -RequestedToCapacityRatioArguments holds arguments specific to RequestedToCapacityRatio priority function. - - - - - - - - - - - - - - - - - - -
FieldDescription
shape [Required]
-[]UtilizationShapePoint -		 - Array of point defining priority function shape.
resources [Required]
-[]ResourceSpec -		 - No description provided. -
- - - -## `ResourceSpec` {#kubescheduler-config-k8s-io-v1-ResourceSpec} - - - - -**Appears in:** - -- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) - - -ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Name of the resource to be managed by RequestedToCapacityRatio function.
weight [Required]
-int64 -		 - Weight of the resource.
- - - -## `ServiceAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAffinity} - - - - -**Appears in:** - -- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) - - -ServiceAffinity holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. - - - - - - - - - - - - - -
FieldDescription
labels [Required]
-[]string -		 - The list of labels that identify node "groups" -All of the labels should match for the node to be considered a fit for hosting the pod
- - - -## `ServiceAntiAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAntiAffinity} - - - - -**Appears in:** - -- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) - - -ServiceAntiAffinity holds the parameters that are used to configure the corresponding priority function - - - - - - - - - - - - - -
FieldDescription
label [Required]
-string -		 - Used to identify node "groups"
- - - -## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1-UtilizationShapePoint} - - - - -**Appears in:** - -- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) - - -UtilizationShapePoint represents single point of priority function shape. - - - - - - - - - - - - - - - - - - -
FieldDescription
utilization [Required]
-int32 -		 - Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
score [Required]
-int32 -		 - Score assigned to given utilization (y axis). Valid values are 0 to 10.
- - - - - -## `ClientConnectionConfiguration` {#ClientConnectionConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) - - -ClientConnectionConfiguration contains details for constructing a client. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
kubeconfig [Required]
-string -		 - kubeconfig is the path to a KubeConfig file.
acceptContentTypes [Required]
-string -		 - acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the -default value of 'application/json'. This field will control all connections to the server used by a particular -client.
contentType [Required]
-string -		 - contentType is the content type used when sending data to the server from this client.
qps [Required]
-float32 -		 - qps controls the number of queries per second allowed for this connection.
burst [Required]
-int32 -		 - burst allows extra queries to accumulate when a client is exceeding its rate.
- -## `DebuggingConfiguration` {#DebuggingConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) - - -DebuggingConfiguration holds configuration for Debugging related features. - - - - - - - - - - - - - - - - - - -
FieldDescription
enableProfiling [Required]
-bool -		 - enableProfiling enables profiling via web interface host:port/debug/pprof/
enableContentionProfiling [Required]
-bool -		 - enableContentionProfiling enables lock contention profiling, if -enableProfiling is true.
- -## `LeaderElectionConfiguration` {#LeaderElectionConfiguration} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) - - -LeaderElectionConfiguration defines the configuration of leader election -clients for components that can run with leader election enabled. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
leaderElect [Required]
-bool -		 - leaderElect enables a leader election client to gain leadership -before executing the main loop. Enable this when running replicated -components for high availability.
leaseDuration [Required]
-meta/v1.Duration -		 - leaseDuration is the duration that non-leader candidates will wait -after observing a leadership renewal until attempting to acquire -leadership of a led but unrenewed leader slot. This is effectively the -maximum duration that a leader can be stopped before it is replaced -by another candidate. This is only applicable if leader election is -enabled.
renewDeadline [Required]
-meta/v1.Duration -		 - renewDeadline is the interval between attempts by the acting master to -renew a leadership slot before it stops leading. This must be less -than or equal to the lease duration. This is only applicable if leader -election is enabled.
retryPeriod [Required]
-meta/v1.Duration -		 - retryPeriod is the duration the clients should wait between attempting -acquisition and renewal of a leadership. This is only applicable if -leader election is enabled.
resourceLock [Required]
-string -		 - resourceLock indicates the resource object type that will be used to lock -during leader election cycles.
resourceName [Required]
-string -		 - resourceName indicates the name of resource object that will be used to lock -during leader election cycles.
resourceNamespace [Required]
-string -		 - resourceName indicates the namespace of resource object that will be used to lock -during leader election cycles.
- -## `LoggingConfiguration` {#LoggingConfiguration} - - - - -**Appears in:** - -- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) - - -LoggingConfiguration contains logging options -Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. - - - - - - - - - - - - - - - - - - -
FieldDescription
format [Required]
-string -		 - Format Flag specifies the structure of log messages. -default value of format is `text`
sanitization [Required]
-bool -		 - [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). -Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
- - - - -## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1beta1-DefaultPreemptionArgs} - - - - - -DefaultPreemptionArgs holds arguments used to configure the -DefaultPreemption plugin. - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		DefaultPreemptionArgs
minCandidateNodesPercentage [Required]
-int32 -		 - MinCandidateNodesPercentage is the minimum number of candidates to -shortlist when dry running preemption as a percentage of number of nodes. -Must be in the range [0, 100]. Defaults to 10% of the cluster size if -unspecified.
minCandidateNodesAbsolute [Required]
-int32 -		 - MinCandidateNodesAbsolute is the absolute minimum number of candidates to -shortlist. The likely number of candidates enumerated for dry running -preemption is given by the formula: -numCandidates = max(numNodes ∗ minCandidateNodesPercentage, minCandidateNodesAbsolute) -We say "likely" because there are other factors such as PDB violations -that play a role in the number of candidates shortlisted. Must be at least -0 nodes. Defaults to 100 nodes if unspecified.
- - - -## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta1-InterPodAffinityArgs} - - - - - -InterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin. - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		InterPodAffinityArgs
hardPodAffinityWeight [Required]
-int32 -		 - HardPodAffinityWeight is the scoring weight for existing pods with a -matching hard affinity to the incoming pod.
- - - -## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration} - - - - - -KubeSchedulerConfiguration configures a scheduler - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		KubeSchedulerConfiguration
parallelism [Required]
-int32 -		 - Parallelism defines the amount of parallelism in algorithms for scheduling a Pods. Must be greater than 0. Defaults to 16
leaderElection [Required]
-LeaderElectionConfiguration -		 - LeaderElection defines the configuration of leader election client.
clientConnection [Required]
-ClientConnectionConfiguration -		 - ClientConnection specifies the kubeconfig file and client connection -settings for the proxy server to use when communicating with the apiserver.
healthzBindAddress [Required]
-string -		 - HealthzBindAddress is the IP address and port for the health check server to serve on, -defaulting to 0.0.0.0:10251
metricsBindAddress [Required]
-string -		 - MetricsBindAddress is the IP address and port for the metrics server to -serve on, defaulting to 0.0.0.0:10251.
DebuggingConfiguration [Required]
-DebuggingConfiguration -		(Members of DebuggingConfiguration are embedded into this type.) - DebuggingConfiguration holds configuration for Debugging related features -TODO: We might wanna make this a substruct like Debugging componentbaseconfigv1alpha1.DebuggingConfiguration
percentageOfNodesToScore [Required]
-int32 -		 - PercentageOfNodesToScore is the percentage of all nodes that once found feasible -for running a pod, the scheduler stops its search for more feasible nodes in -the cluster. This helps improve scheduler's performance. Scheduler always tries to find -at least "minFeasibleNodesToFind" feasible nodes no matter what the value of this flag is. -Example: if the cluster size is 500 nodes and the value of this flag is 30, -then scheduler stops finding further feasible nodes once it finds 150 feasible ones. -When the value is 0, default percentage (5%--50% based on the size of the cluster) of the -nodes will be scored.
podInitialBackoffSeconds [Required]
-int64 -		 - PodInitialBackoffSeconds is the initial backoff for unschedulable pods. -If specified, it must be greater than 0. If this value is null, the default value (1s) -will be used.
podMaxBackoffSeconds [Required]
-int64 -		 - PodMaxBackoffSeconds is the max backoff for unschedulable pods. -If specified, it must be greater than podInitialBackoffSeconds. If this value is null, -the default value (10s) will be used.
profiles [Required]
-[]KubeSchedulerProfile -		 - Profiles are scheduling profiles that kube-scheduler supports. Pods can -choose to be scheduled under a particular profile by setting its associated -scheduler name. Pods that don't specify any scheduler name are scheduled -with the "default-scheduler" profile, if present here.
extenders [Required]
-[]Extender -		 - Extenders are the list of scheduler extenders, each holding the values of how to communicate -with the extender. These extenders are shared by all scheduler profiles.
- - - -## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeAffinityArgs} - - - - - -NodeAffinityArgs holds arguments to configure the NodeAffinity plugin. - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		NodeAffinityArgs
addedAffinity
-core/v1.NodeAffinity -		 - AddedAffinity is applied to all Pods additionally to the NodeAffinity -specified in the PodSpec. That is, Nodes need to satisfy AddedAffinity -AND .spec.NodeAffinity. AddedAffinity is empty by default (all Nodes -match). -When AddedAffinity is used, some Pods with affinity requirements that match -a specific Node (such as Daemonset Pods) might remain unschedulable.
- - - -## `NodeLabelArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeLabelArgs} - - - - - -NodeLabelArgs holds arguments used to configure the NodeLabel plugin. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		NodeLabelArgs
presentLabels [Required]
-[]string -		 - PresentLabels should be present for the node to be considered a fit for hosting the pod
absentLabels [Required]
-[]string -		 - AbsentLabels should be absent for the node to be considered a fit for hosting the pod
presentLabelsPreference [Required]
-[]string -		 - Nodes that have labels in the list will get a higher score.
absentLabelsPreference [Required]
-[]string -		 - Nodes that don't have labels in the list will get a higher score.
- - - -## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeResourcesFitArgs} - - - - - -NodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin. - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		NodeResourcesFitArgs
ignoredResources [Required]
-[]string -		 - IgnoredResources is the list of resources that NodeResources fit filter -should ignore.
ignoredResourceGroups [Required]
-[]string -		 - IgnoredResourceGroups defines the list of resource groups that NodeResources fit filter should ignore. -e.g. if group is ["example.com"], it will ignore all resource names that begin -with "example.com", such as "example.com/aaa" and "example.com/bbb". -A resource group name can't contain '/'.
- - - -## `NodeResourcesLeastAllocatedArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeResourcesLeastAllocatedArgs} - - - - - -NodeResourcesLeastAllocatedArgs holds arguments used to configure NodeResourcesLeastAllocated plugin. - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		NodeResourcesLeastAllocatedArgs
resources [Required]
-[]ResourceSpec -		 - Resources to be managed, if no resource is provided, default resource set with both -the weight of "cpu" and "memory" set to "1" will be applied. -Resource with "0" weight will not accountable for the final score.
- - - -## `NodeResourcesMostAllocatedArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeResourcesMostAllocatedArgs} - - - - - -NodeResourcesMostAllocatedArgs holds arguments used to configure NodeResourcesMostAllocated plugin. - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		NodeResourcesMostAllocatedArgs
resources [Required]
-[]ResourceSpec -		 - Resources to be managed, if no resource is provided, default resource set with both -the weight of "cpu" and "memory" set to "1" will be applied. -Resource with "0" weight will not accountable for the final score.
- - - -## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadArgs} - - - - - -PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin. - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		PodTopologySpreadArgs
defaultConstraints
-[]core/v1.TopologySpreadConstraint -		 - DefaultConstraints defines topology spread constraints to be applied to -Pods that don't define any in `pod.spec.topologySpreadConstraints`. -`.defaultConstraints[∗].labelSelectors` must be empty, as they are -deduced from the Pod's membership to Services, ReplicationControllers, -ReplicaSets or StatefulSets. -When not empty, .defaultingType must be "List".
defaultingType
-PodTopologySpreadConstraintsDefaulting -		 - DefaultingType determines how .defaultConstraints are deduced. Can be one -of "System" or "List". - -- "System": Use kubernetes defined constraints that spread Pods among - Nodes and Zones. -- "List": Use constraints defined in .defaultConstraints. - -Defaults to "List" if feature gate DefaultPodTopologySpread is disabled -and to "System" if enabled.
- - - -## `RequestedToCapacityRatioArgs` {#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs} - - - - - -RequestedToCapacityRatioArgs holds arguments used to configure RequestedToCapacityRatio plugin. - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		RequestedToCapacityRatioArgs
shape [Required]
-[]UtilizationShapePoint -		 - Points defining priority function shape
resources [Required]
-[]ResourceSpec -		 - Resources to be managed
- - - -## `ServiceAffinityArgs` {#kubescheduler-config-k8s-io-v1beta1-ServiceAffinityArgs} - - - - - -ServiceAffinityArgs holds arguments used to configure the ServiceAffinity plugin. - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		ServiceAffinityArgs
affinityLabels [Required]
-[]string -		 - AffinityLabels are homogeneous for pods that are scheduled to a node. -(i.e. it returns true IFF this pod can be added to this node such that all other pods in -the same service are running on nodes with the exact same values for Labels).
antiAffinityLabelsPreference [Required]
-[]string -		 - AntiAffinityLabelsPreference are the labels to consider for service anti affinity scoring.
- - - -## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta1-VolumeBindingArgs} - - - - - -VolumeBindingArgs holds arguments used to configure the VolumeBinding plugin. - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubescheduler.config.k8s.io/v1beta1
kind
string		VolumeBindingArgs
bindTimeoutSeconds [Required]
-int64 -		 - BindTimeoutSeconds is the timeout in seconds in volume binding operation. -Value must be non-negative integer. The value zero indicates no waiting. -If this value is nil, the default value (600) will be used.
- - - -## `Extender` {#kubescheduler-config-k8s-io-v1beta1-Extender} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) - - -Extender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, -it is assumed that the extender chose not to provide that extension. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
urlPrefix [Required]
-string -		 - URLPrefix at which the extender is available
filterVerb [Required]
-string -		 - Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
preemptVerb [Required]
-string -		 - Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
prioritizeVerb [Required]
-string -		 - Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
weight [Required]
-int64 -		 - The numeric multiplier for the node scores that the prioritize call generates. -The weight should be a positive integer
bindVerb [Required]
-string -		 - Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender. -If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender -can implement this function.
enableHTTPS [Required]
-bool -		 - EnableHTTPS specifies whether https should be used to communicate with the extender
tlsConfig [Required]
-ExtenderTLSConfig -		 - TLSConfig specifies the transport layer security config
httpTimeout [Required]
-meta/v1.Duration -		 - HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize -timeout is ignored, k8s/other extenders priorities are used to select the node.
nodeCacheCapable [Required]
-bool -		 - NodeCacheCapable specifies that the extender is capable of caching node information, -so the scheduler should only send minimal information about the eligible nodes -assuming that the extender already cached full details of all nodes in the cluster
managedResources
-[]ExtenderManagedResource -		 - ManagedResources is a list of extended resources that are managed by -this extender. -- A pod will be sent to the extender on the Filter, Prioritize and Bind - (if the extender is the binder) phases iff the pod requests at least - one of the extended resources in this list. If empty or unspecified, - all pods will be sent to this extender. -- If IgnoredByScheduler is set to true for a resource, kube-scheduler - will skip checking the resource in predicates.
ignorable [Required]
-bool -		 - Ignorable specifies if the extender is ignorable, i.e. scheduling should not -fail when the extender returns an error or is not reachable.
- - - -## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerProfile} - - - - -**Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) - - -KubeSchedulerProfile is a scheduling profile. - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
schedulerName [Required]
-string -		 - SchedulerName is the name of the scheduler associated to this profile. -If SchedulerName matches with the pod's "spec.schedulerName", then the pod -is scheduled with this profile.
plugins [Required]
-Plugins -		 - Plugins specify the set of plugins that should be enabled or disabled. -Enabled plugins are the ones that should be enabled in addition to the -default plugins. Disabled plugins are any of the default plugins that -should be disabled. -When no enabled or disabled plugin is specified for an extension point, -default plugins for that extension point will be used if there is any. -If a QueueSort plugin is specified, the same QueueSort Plugin and -PluginConfig must be specified for all profiles.
pluginConfig [Required]
-[]PluginConfig -		 - PluginConfig is an optional set of custom plugin arguments for each plugin. -Omitting config args for a plugin is equivalent to using the default config -for that plugin.
- - - -## `Plugin` {#kubescheduler-config-k8s-io-v1beta1-Plugin} - - - - -**Appears in:** - -- [PluginSet](#kubescheduler-config-k8s-io-v1beta1-PluginSet) - - -Plugin specifies a plugin name and its weight when applicable. Weight is used only for Score plugins. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Name defines the name of plugin
weight [Required]
-int32 -		 - Weight defines the weight of plugin, only used for Score plugins.
- - - -## `PluginConfig` {#kubescheduler-config-k8s-io-v1beta1-PluginConfig} - - - - -**Appears in:** - -- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerProfile) - - -PluginConfig specifies arguments that should be passed to a plugin at the time of initialization. -A plugin that is invoked at multiple extension points is initialized once. Args can have arbitrary structure. -It is up to the plugin to process these Args. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Name defines the name of plugin being configured
args [Required]
-k8s.io/apimachinery/pkg/runtime.RawExtension -		 - Args defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.
- - - -## `PluginSet` {#kubescheduler-config-k8s-io-v1beta1-PluginSet} - - - - -**Appears in:** - -- [Plugins](#kubescheduler-config-k8s-io-v1beta1-Plugins) - - -PluginSet specifies enabled and disabled plugins for an extension point. -If an array is empty, missing, or nil, default plugins at that extension point will be used. - - - - - - - - - - - - - - - - - - -
FieldDescription
enabled [Required]
-[]Plugin -		 - Enabled specifies plugins that should be enabled in addition to default plugins. -These are called after default plugins and in the same order specified here.
disabled [Required]
-[]Plugin -		 - Disabled specifies default plugins that should be disabled. -When all default plugins need to be disabled, an array containing only one "∗" should be provided.
- - - -## `Plugins` {#kubescheduler-config-k8s-io-v1beta1-Plugins} - - - - -**Appears in:** - -- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerProfile) - - -Plugins include multiple extension points. When specified, the list of plugins for -a particular extension point are the only ones enabled. If an extension point is -omitted from the config, then the default set of plugins is used for that extension point. -Enabled plugins are called in the order specified here, after default plugins. If they need to -be invoked before default plugins, default plugins must be disabled and re-enabled here in desired order. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
queueSort [Required]
-PluginSet -		 - QueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue.
preFilter [Required]
-PluginSet -		 - PreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.
filter [Required]
-PluginSet -		 - Filter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod.
postFilter [Required]
-PluginSet -		 - PostFilter is a list of plugins that are invoked after filtering phase, no matter whether filtering succeeds or not.
preScore [Required]
-PluginSet -		 - PreScore is a list of plugins that are invoked before scoring.
score [Required]
-PluginSet -		 - Score is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase.
reserve [Required]
-PluginSet -		 - Reserve is a list of plugins invoked when reserving/unreserving resources -after a node is assigned to run the pod.
permit [Required]
-PluginSet -		 - Permit is a list of plugins that control binding of a Pod. These plugins can prevent or delay binding of a Pod.
preBind [Required]
-PluginSet -		 - PreBind is a list of plugins that should be invoked before a pod is bound.
bind [Required]
-PluginSet -		 - Bind is a list of plugins that should be invoked at "Bind" extension point of the scheduling framework. -The scheduler call these plugins in order. Scheduler skips the rest of these plugins as soon as one returns success.
postBind [Required]
-PluginSet -		 - PostBind is a list of plugins that should be invoked after a pod is successfully bound.
- - - -## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadConstraintsDefaulting} - -(Alias of `string`) - - -**Appears in:** - -- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadArgs) - - -PodTopologySpreadConstraintsDefaulting defines how to set default constraints -for the PodTopologySpread plugin. - - - - - -## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta1-ResourceSpec} - - - - -**Appears in:** - -- [NodeResourcesLeastAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesLeastAllocatedArgs) - -- [NodeResourcesMostAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesMostAllocatedArgs) - -- [RequestedToCapacityRatioArgs](#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs) - - -ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments. - - - - - - - - - - - - - - - - - - -
FieldDescription
name [Required]
-string -		 - Name of the resource to be managed by RequestedToCapacityRatio function.
weight [Required]
-int64 -		 - Weight of the resource.
- - - -## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta1-UtilizationShapePoint} - - - - -**Appears in:** - -- [RequestedToCapacityRatioArgs](#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs) - - -UtilizationShapePoint represents single point of priority function shape. - - - - - - - - - - - - - - - - - - -
FieldDescription
utilization [Required]
-int32 -		 - Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
score [Required]
-int32 -		 - Score assigned to given utilization (y axis). Valid values are 0 to 10.
- - diff --git a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md index 5479abcf36..6e04ce3879 100644 --- a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md +++ b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta2.md @@ -20,7 +20,6 @@ auto_generated: true - ## `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 - - ## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta2-InterPodAffinityArgs} @@ -99,8 +96,6 @@ matching hard affinity to the incoming pod. - - ## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration} @@ -229,8 +224,6 @@ with the extender. These extenders are shared by all scheduler profiles. - - ## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeAffinityArgs} @@ -251,7 +244,7 @@ NodeAffinityArgs holds arguments to configure the NodeAffinity plugin. addedAffinity
-core/v1.NodeAffinity +core/v1.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. - - ## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeResourcesBalancedAllocationArgs} @@ -296,8 +287,6 @@ NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResour - - ## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta2-NodeResourcesFitArgs} @@ -348,8 +337,6 @@ The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.< - - ## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadArgs} @@ -370,7 +357,7 @@ PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread pl defaultConstraints
-[]core/v1.TopologySpreadConstraint +[]core/v1.TopologySpreadConstraint DefaultConstraints defines topology spread constraints to be applied to @@ -400,8 +387,6 @@ and to "System" if enabled. - - ## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta2-VolumeBindingArgs} @@ -451,8 +436,6 @@ All points must be sorted in increasing order by utilization. - - ## `Extender` {#kubescheduler-config-k8s-io-v1beta2-Extender} @@ -460,7 +443,6 @@ All points must be sorted in increasing order by utilization. **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) @@ -585,8 +567,6 @@ fail when the extender returns an error or is not reachable. - - ## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta2-ExtenderManagedResource} @@ -594,7 +574,6 @@ fail when the extender returns an error or is not reachable. **Appears in:** - - [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) @@ -626,8 +605,6 @@ resource when applying predicates. - - ## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta2-ExtenderTLSConfig} @@ -635,7 +612,6 @@ resource when applying predicates. **Appears in:** - - [Extender](#kubescheduler-config-k8s-io-v1beta2-Extender) @@ -718,8 +694,6 @@ CAData takes precedence over CAFile - - ## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile} @@ -727,7 +701,6 @@ CAData takes precedence over CAFile **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) @@ -776,8 +749,6 @@ for that plugin. - - ## `Plugin` {#kubescheduler-config-k8s-io-v1beta2-Plugin} @@ -785,7 +756,6 @@ for that plugin. **Appears in:** - - [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 - - ## `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:** - - [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerProfile) @@ -856,8 +823,6 @@ It is up to the plugin to process these Args. - - ## `PluginSet` {#kubescheduler-config-k8s-io-v1beta2-PluginSet} @@ -865,7 +830,6 @@ It is up to the plugin to process these Args. **Appears in:** - - [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 - - ## `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:** - - [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 - - ## `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:** - - [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta2-PodTopologySpreadArgs) @@ -1042,8 +1000,6 @@ PodTopologySpreadConstraintsDefaulting defines how to set default constraints for the PodTopologySpread plugin. - - ## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1beta2-RequestedToCapacityRatioParam} @@ -1051,7 +1007,6 @@ for the PodTopologySpread plugin. **Appears in:** - - [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy) @@ -1073,8 +1028,6 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters - - ## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta2-ResourceSpec} @@ -1082,9 +1035,7 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters **Appears in:** - - [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta2-NodeResourcesBalancedAllocationArgs) - - [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy) @@ -1114,8 +1065,6 @@ ResourceSpec represents a single resource. - - ## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy} @@ -1123,7 +1072,6 @@ ResourceSpec represents a single resource. **Appears in:** - - [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta2-NodeResourcesFitArgs) @@ -1164,8 +1112,6 @@ Weight defaults to 1 if not specified or explicitly set to 0. - - ## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1beta2-ScoringStrategyType} @@ -1173,15 +1119,12 @@ Weight defaults to 1 if not specified or explicitly set to 0. **Appears in:** - - [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta2-ScoringStrategy) ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin. - - ## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta2-UtilizationShapePoint} @@ -1189,9 +1132,7 @@ ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin **Appears in:** - - [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta2-VolumeBindingArgs) - - [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1beta2-RequestedToCapacityRatioParam) @@ -1221,7 +1162,6 @@ UtilizationShapePoint represents single point of priority function shape. - @@ -1232,7 +1172,6 @@ UtilizationShapePoint represents single point of priority function shape. **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) @@ -1295,7 +1234,6 @@ client. **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) @@ -1333,7 +1271,6 @@ enableProfiling is true. **Appears in:** - - [LoggingConfiguration](#LoggingConfiguration) @@ -1362,7 +1299,6 @@ FormatOptions contains options for the different logging formats. **Appears in:** - - [FormatOptions](#FormatOptions) @@ -1385,7 +1321,7 @@ both to stdout, without buffering. infoBufferSize [Required]
-k8s.io/apimachinery/pkg/api/resource.QuantityValue +k8s.io/apimachinery/pkg/api/resource.QuantityValue [Experimental] InfoBufferSize sets the size of the info stream when @@ -1402,7 +1338,6 @@ using split streams. The default is zero, which disables buffering. **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) @@ -1495,7 +1430,6 @@ during leader election cycles. **Appears in:** - - [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) @@ -1574,7 +1508,6 @@ format get used, but all of them get validated. **Appears in:** - - [LoggingConfiguration](#LoggingConfiguration) diff --git a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md index f9ca9e5bd8..55ae376feb 100644 --- a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md +++ b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta3.md @@ -20,7 +20,6 @@ auto_generated: true - ## `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 - - ## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-InterPodAffinityArgs} @@ -99,8 +96,6 @@ matching hard affinity to the incoming pod. - - ## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration} @@ -211,8 +206,6 @@ with the extender. These extenders are shared by all scheduler profiles. - - ## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeAffinityArgs} @@ -233,7 +226,7 @@ NodeAffinityArgs holds arguments to configure the NodeAffinity plugin. addedAffinity
-core/v1.NodeAffinity +core/v1.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. - - ## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs} @@ -278,8 +269,6 @@ NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResour - - ## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs} @@ -330,8 +319,6 @@ The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.< - - ## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs} @@ -352,7 +339,7 @@ PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread pl defaultConstraints
-[]core/v1.TopologySpreadConstraint +[]core/v1.TopologySpreadConstraint DefaultConstraints defines topology spread constraints to be applied to @@ -382,8 +369,6 @@ and to "System" if enabled. - - ## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs} @@ -433,8 +418,6 @@ All points must be sorted in increasing order by utilization. - - ## `Extender` {#kubescheduler-config-k8s-io-v1beta3-Extender} @@ -442,7 +425,6 @@ All points must be sorted in increasing order by utilization. **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) @@ -567,8 +549,6 @@ fail when the extender returns an error or is not reachable. - - ## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1beta3-ExtenderManagedResource} @@ -576,7 +556,6 @@ fail when the extender returns an error or is not reachable. **Appears in:** - - [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender) @@ -608,8 +587,6 @@ resource when applying predicates. - - ## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1beta3-ExtenderTLSConfig} @@ -617,7 +594,6 @@ resource when applying predicates. **Appears in:** - - [Extender](#kubescheduler-config-k8s-io-v1beta3-Extender) @@ -700,8 +676,6 @@ CAData takes precedence over CAFile - - ## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile} @@ -709,7 +683,6 @@ CAData takes precedence over CAFile **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) @@ -758,8 +731,6 @@ for that plugin. - - ## `Plugin` {#kubescheduler-config-k8s-io-v1beta3-Plugin} @@ -767,7 +738,6 @@ for that plugin. **Appears in:** - - [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 - - ## `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:** - - [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile) @@ -838,8 +805,6 @@ It is up to the plugin to process these Args. - - ## `PluginSet` {#kubescheduler-config-k8s-io-v1beta3-PluginSet} @@ -847,7 +812,6 @@ It is up to the plugin to process these Args. **Appears in:** - - [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 - - ## `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:** - - [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerProfile) @@ -1022,8 +983,6 @@ plugin through MultiPoint. This follows the same behavior as all other extension - - ## `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:** - - [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta3-PodTopologySpreadArgs) @@ -1039,8 +997,6 @@ PodTopologySpreadConstraintsDefaulting defines how to set default constraints for the PodTopologySpread plugin. - - ## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam} @@ -1048,7 +1004,6 @@ for the PodTopologySpread plugin. **Appears in:** - - [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy) @@ -1070,8 +1025,6 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters - - ## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta3-ResourceSpec} @@ -1079,9 +1032,7 @@ RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters **Appears in:** - - [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesBalancedAllocationArgs) - - [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy) @@ -1111,8 +1062,6 @@ ResourceSpec represents a single resource. - - ## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy} @@ -1120,7 +1069,6 @@ ResourceSpec represents a single resource. **Appears in:** - - [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta3-NodeResourcesFitArgs) @@ -1161,8 +1109,6 @@ Weight defaults to 1 if not specified or explicitly set to 0. - - ## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1beta3-ScoringStrategyType} @@ -1170,15 +1116,12 @@ Weight defaults to 1 if not specified or explicitly set to 0. **Appears in:** - - [ScoringStrategy](#kubescheduler-config-k8s-io-v1beta3-ScoringStrategy) ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin. - - ## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta3-UtilizationShapePoint} @@ -1186,9 +1129,7 @@ ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin **Appears in:** - - [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta3-VolumeBindingArgs) - - [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1beta3-RequestedToCapacityRatioParam) @@ -1218,7 +1159,6 @@ UtilizationShapePoint represents single point of priority function shape. - @@ -1229,9 +1169,7 @@ UtilizationShapePoint represents single point of priority function shape. **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) @@ -1294,10 +1232,8 @@ client. **Appears in:** - -- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) DebuggingConfiguration holds configuration for Debugging related features. @@ -1334,7 +1270,6 @@ enableProfiling is true. **Appears in:** - - [LoggingConfiguration](#LoggingConfiguration) @@ -1363,7 +1298,6 @@ FormatOptions contains options for the different logging formats. **Appears in:** - - [FormatOptions](#FormatOptions) @@ -1386,7 +1320,7 @@ both to stdout, without buffering. infoBufferSize [Required]
-k8s.io/apimachinery/pkg/api/resource.QuantityValue +k8s.io/apimachinery/pkg/api/resource.QuantityValue [Experimental] InfoBufferSize sets the size of the info stream when @@ -1403,9 +1337,7 @@ using split streams. The default is zero, which disables buffering. **Appears in:** - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta2-KubeSchedulerConfiguration) - - [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta3-KubeSchedulerConfiguration) @@ -1498,7 +1430,6 @@ during leader election cycles. **Appears in:** - - [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) @@ -1577,7 +1508,6 @@ format get used, but all of them get validated. **Appears in:** - - [LoggingConfiguration](#LoggingConfiguration) diff --git a/content/en/docs/reference/config-api/kubeadm-config.v1beta2.md b/content/en/docs/reference/config-api/kubeadm-config.v1beta2.md index 77595b4599..f3c5b521ab 100644 --- a/content/en/docs/reference/config-api/kubeadm-config.v1beta2.md +++ b/content/en/docs/reference/config-api/kubeadm-config.v1beta2.md @@ -4,18 +4,21 @@ content_type: tool-reference package: kubeadm.k8s.io/v1beta2 auto_generated: true --- +## Overview + Package v1beta2 defines the v1beta2 version of the kubeadm configuration file format. This version improves on the v1beta1 format by fixing some minor issues and adding a few new fields. A list of changes since v1beta1: -- `certificateKey" field is added to InitConfiguration and JoinConfiguration. +- "certificateKey" field is added to InitConfiguration and JoinConfiguration. - "ignorePreflightErrors" field is added to the NodeRegistrationOptions. - The JSON "omitempty" tag is used in a more places where appropriate. - The JSON "omitempty" tag of the "taints" field (inside NodeRegistrationOptions) is removed. + See the Kubernetes 1.15 changelog for further details. -## Migration from old kubeadm config versions +Migration from old kubeadm config versions Please convert your v1beta1 configuration files to v1beta2 using the "kubeadm config migrate" command of kubeadm v1.15.x (conversion from older releases of kubeadm config files requires older release of kubeadm as well e.g. @@ -27,11 +30,11 @@ Nevertheless, kubeadm v1.15.x will support reading from v1beta1 version of the k ## Basics -The preferred way to configure kubeadm is to pass an YAML configuration file with the --config option. Some of the +The preferred way to configure kubeadm is to pass an YAML configuration file with the `--config` option. Some of the configuration options defined in the kubeadm config file are also available as command line flags, but only the most common/simple use case are supported with this approach. -A kubeadm config file could contain multiple configuration types separated using three dashes (“---”). +A kubeadm config file could contain multiple configuration types separated using three dashes (`---`). kubeadm supports the following configuration types: @@ -60,14 +63,14 @@ kubeadm config print join-defaults ``` The list of configuration types that must be included in a configuration file depends by the action you are -performing (init or join) and by the configuration options you are going to use (defaults or advanced customization). +performing (`init` or `join`) and by the configuration options you are going to use (defaults or advanced customization). If some configuration types are not provided, or provided only partially, kubeadm will use default values; defaults provided by kubeadm includes also enforcing consistency of values across components when required (e.g. -cluster-cidr flag on controller manager and clusterCIDR on kube-proxy). +`--cluster-cidr` flag on controller manager and `clusterCIDR` on kube-proxy). Users are always allowed to override default values, with the only exception of a small subset of setting with -relevance for security (e.g. enforce authorization-mode Node and RBAC on api server) +relevance for security (e.g. enforce authorization-mode Node and RBAC on API server) If the user provides a configuration types that is not expected for the action you are performing, kubeadm will ignore those types and print a warning. @@ -82,20 +85,20 @@ between InitConfiguration and ClusterConfiguration is mandatory. apiVersion: kubeadm.k8s.io/v1beta2 kind: InitConfiguration bootstrapTokens: - ... + ... nodeRegistration: - ... + ... ``` -The InitConfiguration type should be used to configure runtime settings, that in case of kubeadm init +The InitConfiguration type should be used to configure runtime settings, that in case of `kubeadm init` are the configuration of the bootstrap token and all the setting which are specific to the node where kubeadm is executed, including: -- NodeRegistration, that holds fields that relate to registering the new node to the cluster; +- `nodeRegistration`, that holds fields that relate to registering the new node to the cluster; use it to customize the node name, the CRI socket to use or any other settings that should apply to this node only (e.g. the node ip). -- LocalAPIEndpoint, that represents the endpoint of the instance of the API server to be deployed on this node; +- `apiServer`, that represents the endpoint of the instance of the API server to be deployed on this node; use it e.g. to customize the API server advertise address. ```yaml @@ -110,6 +113,7 @@ is executed, including: ... extraVolumes: ... + ... ``` The ClusterConfiguration type should be used to configure cluster-wide settings, @@ -117,33 +121,37 @@ including settings for: - Networking, that holds configuration for the networking topology of the cluster; use it e.g. to customize pod subnet or services subnet. + - Etcd configurations; use it e.g. to customize the local etcd or to configure the API server for using an external etcd cluster. + - kube-apiserver, kube-scheduler, kube-controller-manager configurations; use it to customize control-plane components by adding customized setting or overriding kubeadm default settings. ```yaml apiVersion: kubeproxy.config.k8s.io/v1alpha1 kind: KubeProxyConfiguration - ... + ... ``` The KubeProxyConfiguration type should be used to change the configuration passed to kube-proxy instances deployed in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults. -See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ or https://godoc.org/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration +See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ or +https://godoc.org/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration for kube proxy official documentation. ```yaml apiVersion: kubelet.config.k8s.io/v1beta1 kind: KubeletConfiguration -... + ... ``` The KubeletConfiguration type should be used to change the configurations that will be passed to all kubelet instances deployed in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults. -See https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/ or https://godoc.org/k8s.io/kubelet/config/v1beta1#KubeletConfiguration +See https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/ or +https://godoc.org/k8s.io/kubelet/config/v1beta1#KubeletConfiguration for kubelet official documentation. Here is a fully populated example of a single YAML file containing multiple @@ -171,7 +179,7 @@ nodeRegistration: value: "master" effect: "NoSchedule" kubeletExtraArgs: - cgroup-driver: "cgroupfs" + v: 4 ignorePreflightErrors: - IsPrivilegedUser localAPIEndpoint: @@ -183,60 +191,60 @@ apiVersion: kubeadm.k8s.io/v1beta2 kind: ClusterConfiguration etcd: # one of local or external - local: - imageRepository: "k8s.gcr.io" - imageTag: "3.2.24" - dataDir: "/var/lib/etcd" - extraArgs: - listen-client-urls: "http://10.100.0.1:2379" - serverCertSANs: - - "ec2-10-100-0-1.compute-1.amazonaws.com" - peerCertSANs: - - "10.100.0.1" - # external: - # endpoints: - # - "10.100.0.1:2379" - # - "10.100.0.2:2379" - # caFile: "/etcd/kubernetes/pki/etcd/etcd-ca.crt" - # certFile: "/etcd/kubernetes/pki/etcd/etcd.crt" - # keyFile: "/etcd/kubernetes/pki/etcd/etcd.key" - networking: - serviceSubnet: "10.96.0.0/12" - podSubnet: "10.100.0.1/24" - dnsDomain: "cluster.local" - kubernetesVersion: "v1.12.0" - controlPlaneEndpoint: "10.100.0.1:6443" - apiServer: - extraArgs: - authorization-mode: "Node,RBAC" - extraVolumes: - - name: "some-volume" - hostPath: "/etc/some-path" - mountPath: "/etc/some-pod-path" - readOnly: false - pathType: File - certSANs: - - "10.100.1.1" - - "ec2-10-100-0-1.compute-1.amazonaws.com" - timeoutForControlPlane: 4m0s - controllerManager: - extraArgs: - "node-cidr-mask-size": "20" - extraVolumes: - - name: "some-volume" - hostPath: "/etc/some-path" - mountPath: "/etc/some-pod-path" - readOnly: false - pathType: File - scheduler: - extraArgs: - address: "10.100.0.1" - extraVolumes: - - name: "some-volume" - hostPath: "/etc/some-path" - mountPath: "/etc/some-pod-path" - readOnly: false - pathType: File +local: + imageRepository: "k8s.gcr.io" + imageTag: "3.2.24" + dataDir: "/var/lib/etcd" + extraArgs: + listen-client-urls: "http://10.100.0.1:2379" + serverCertSANs: + - "ec2-10-100-0-1.compute-1.amazonaws.com" + peerCertSANs: + - "10.100.0.1" +# external: +# endpoints: +# - "10.100.0.1:2379" +# - "10.100.0.2:2379" +# caFile: "/etcd/kubernetes/pki/etcd/etcd-ca.crt" +# certFile: "/etcd/kubernetes/pki/etcd/etcd.crt" +# keyFile: "/etcd/kubernetes/pki/etcd/etcd.key" +networking: + serviceSubnet: "10.96.0.0/16" + podSubnet: "10.244.0.0/24" + dnsDomain: "cluster.local" +kubernetesVersion: "v1.12.0" +controlPlaneEndpoint: "10.100.0.1:6443" +apiServer: + extraArgs: + authorization-mode: "Node,RBAC" + extraVolumes: + - name: "some-volume" + hostPath: "/etc/some-path" + mountPath: "/etc/some-pod-path" + readOnly: false + pathType: File + certSANs: + - "10.100.1.1" + - "ec2-10-100-0-1.compute-1.amazonaws.com" + timeoutForControlPlane: 4m0s +controllerManager: + extraArgs: + "node-cidr-mask-size": "20" + extraVolumes: + - name: "some-volume" + hostPath: "/etc/some-path" + mountPath: "/etc/some-pod-path" + readOnly: false + pathType: File +scheduler: + extraArgs: + address: "10.100.0.1" + extraVolumes: + - name: "some-volume" + hostPath: "/etc/some-path" + mountPath: "/etc/some-pod-path" + readOnly: false + pathType: File certificatesDir: "/etc/kubernetes/pki" imageRepository: "k8s.gcr.io" useHyperKubeImage: false @@ -258,18 +266,18 @@ When executing kubeadm join with the `--config` option, the JoinConfiguration ty ```yaml apiVersion: kubeadm.k8s.io/v1beta2 kind: JoinConfiguration -... + ... ``` -The JoinConfiguration type should be used to configure runtime settings, that in case of kubeadm join +The JoinConfiguration type should be used to configure runtime settings, that in case of `kubeadm join` are the discovery method used for accessing the cluster info and all the setting which are specific to the node where kubeadm is executed, including: -- NodeRegistration, that holds fields that relate to registering the new node to the cluster; +- `NodeRegistration`, that holds fields that relate to registering the new node to the cluster; use it to customize the node name, the CRI socket to use or any other settings that should apply to this - node only (e.g. the node ip). + node only (e.g. the node IP). -- APIEndpoint, that represents the endpoint of the instance of the API server to be eventually deployed on this node. +- `APIEndpoint`, that represents the endpoint of the instance of the API server to be eventually deployed on this node. ## Resource Types @@ -281,7 +289,6 @@ to the node where kubeadm is executed, including: - ## `ClusterConfiguration` {#kubeadm-k8s-io-v1beta2-ClusterConfiguration} @@ -330,15 +337,15 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster `controlPlaneEndpoint` sets a stable IP address or DNS name for the control plane; it can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. -In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort -are used; in case the ControlPlaneEndpoint is specified but without a TCP port, -the BindPort is used. +In case the `controlPlaneEndpoint` is not specified, the `advertiseAddress` + `bindPort` +are used; in case the `controlPlaneEndpoint` is specified but without a TCP port, +the `bindPort` is used. Possible usages are: - In a cluster with more than one control plane instances, this field should be assigned the address of the external load balancer in front of the control plane instances. -- In environments with enforced node recycling, the ControlPlaneEndpoint +- In environments with enforced node recycling, the `controlPlaneEndpoint` could be used for assigning a stable DNS to the control plane. @@ -371,7 +378,7 @@ Possible usages are: DNS - `dns` defines the options for the DNS add-on. + `dns` defines the options for the DNS add-on installed in the cluster. @@ -387,11 +394,11 @@ Possible usages are: string - `imageRepository` sets the container registry to pull images from. + `mageRepository` sets the container registry to pull images from. If empty, `k8s.gcr.io` will be used by default; in case of kubernetes version is -a CI build (kubernetes version starts with `ci/` or `ci-cross/`) -`gcr.io/k8s-staging-ci-images` will be used as a default for control plane -components and for kube-proxy, while `k8s.gcr.io` will be used for all the other images. +a CI build (kubernetes version starts with `ci/`) `gcr.io/k8s-staging-ci-images` +is used as a default for control plane components and for kube-proxy, while +`k8s.gcr.io` will be used for all the other images. @@ -399,11 +406,11 @@ components and for kube-proxy, while `k8s.gcr.io` will be used for all the other bool - `useHyperKubeImage` controls if hyperkube should be used for Kubernetes -components instead of their respective separate images -DEPRECATED: As hyperkube is itself deprecated, this fields is too. It will -be removed in future kubeadm config versions, kubeadm will print multiple -warnings when this is set to true, and at some point it may become ignored. + `useHyperKubeImage` controls if hyperkube should be used for Kubernetes components +instead of their respective separate images. +DEPRECATED: As `hyperkube` is itself deprecated, this fields is too. It will be +removed in future kubeadm config versions, kubeadm will print multiple warnings +when this set to true, and at some point it may become ignored. @@ -411,7 +418,7 @@ warnings when this is set to true, and at some point it may become ignored. map[string]bool - Feature gates enabled by the user. + `featureGates` contains the feature gates enabled by the user. @@ -419,14 +426,12 @@ warnings when this is set to true, and at some point it may become ignored. string - The cluster name + The cluster name. - - ## `ClusterStatus` {#kubeadm-k8s-io-v1beta2-ClusterStatus} @@ -434,8 +439,9 @@ warnings when this is set to true, and at some point it may become ignored. -ClusterStatus contains the cluster status. The ClusterStatus will be stored in the kubeadm-config -ConfigMap in the cluster, and then updated by kubeadm when additional control plane instance joins or leaves the cluster. +ClusterStatus contains the cluster status. The ClusterStatus will be stored in +the kubeadm-config ConfigMap in the cluster, and then updated by kubeadm when +additional control plane instance joins or leaves the cluster. @@ -452,14 +458,13 @@ ConfigMap in the cluster, and then updated by kubeadm when additional control pl +plane/API server instance. +The key of the map is the IP of the host's default interface.
FieldDescription
`apiEndpoints` currently available in the cluster, one for each control -plane/API server instance. The key of the map is the IP of the host's default interface
- - ## `InitConfiguration` {#kubeadm-k8s-io-v1beta2-InitConfiguration} @@ -484,8 +489,8 @@ information. []BootstrapToken - `bootstrapTokens` is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. -This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature + `bootstrapTokens` is respected at `kubeadm init` time and describes a set of bootstrap tokens to create. +This information IS NOT uploaded to the kubeadm cluster ConfigMap, partly because of its sensitive nature. @@ -493,7 +498,7 @@ This information IS NOT uploaded to the kubeadm cluster configmap, partly becaus NodeRegistrationOptions - `nodeRegistration` holds fields that relate to registering the new control-plane node to the cluster + `nodeRegistration` holds fields that relate to registering the new control-plane node to the cluster. @@ -501,9 +506,9 @@ This information IS NOT uploaded to the kubeadm cluster configmap, partly becaus APIEndpoint - `localAPIEndpoint` represents the endpoint of the API server instance that's deployed on this control plane node -In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint -is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This + `localAPIEndpoint` represents the endpoint of the API server instance that's deployed on this control plane node. +In HA setups, this differs from `ClusterConfiguration.controlPlaneEndpoint` in the sense that ControlPlaneEndpoint +is the global endpoint for the cluster, which then load-balances the requests to each individual API server. This configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible on. By default, kubeadm tries to auto-detect the IP of the default interface and use that, but in case that process fails you may set the desired value here. @@ -515,14 +520,12 @@ fails you may set the desired value here. `certificateKey` sets the key with which certificates and keys are encrypted prior to being uploaded in -a Secret in the cluster during the "uploadcerts" init phase. +a secret in the cluster during the `uploadcerts init` phase. - - ## `JoinConfiguration` {#kubeadm-k8s-io-v1beta2-JoinConfiguration} @@ -546,8 +549,8 @@ JoinConfiguration contains elements describing a particular node. NodeRegistrationOptions - `nodeRegistration` holds fields that relate to registering the new control-plane -node to the cluster + `nodeRegistration` holds fields that relate to registering the new +control-plane node to the cluster @@ -556,7 +559,7 @@ node to the cluster `caCertPath` is the path to the SSL certificate authority used to -secure comunications between node and control-plane. +secure comunications between a node and the control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". @@ -565,8 +568,8 @@ Defaults to "/etc/kubernetes/pki/ca.crt". Discovery - `discovery` specifies the options for the kubelet to use during the TLS Bootstrap -process + `discovery` specifies the options for the kubelet to use during the TLS +bootstrap process. @@ -574,15 +577,13 @@ process JoinControlPlane - `controlPlane` defines the additional control plane instance to be deployed on the -joining node. If nil, no additional control plane instance will be deployed. + `controlPlane` defines the additional control plane instance to be deployed +on the joining node. If nil, no additional control plane instance will be deployed. - - ## `APIEndpoint` {#kubeadm-k8s-io-v1beta2-APIEndpoint} @@ -590,11 +591,8 @@ joining node. If nil, no additional control plane instance will be deployed.int32 - `bindPort` sets the secure port for the API Server to bind to. Defaults to 6443. + `bindPort` sets the secure port for the API Server to bind to. +Defaults to 6443. - - ## `APIServer` {#kubeadm-k8s-io-v1beta2-APIServer} @@ -633,11 +630,10 @@ APIEndpoint struct contains elements of API server instance deployed on a node. **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta2-ClusterConfiguration) -APIServer holds settings necessary for API server deployments in the cluster +APIServer holds settings necessary for API server deployments in the cluster. @@ -658,7 +654,8 @@ APIServer holds settings necessary for API server deployments in the cluster []string + `certSANs` sets extra Subject Alternative Names (SANs) for the API Server +signing certificate. @@ -666,14 +663,13 @@ APIServer holds settings necessary for API server deployments in the cluster meta/v1.Duration + `timeoutForControlPlane` controls the timeout that we wait for the API server +to appear.
FieldDescription
- `certSANs` sets extra Subject Alternative Names for the API Server signing cert.
- `timeoutForControlPlane` controls the timeout that we use for API server to appear
- - ## `BootstrapToken` {#kubeadm-k8s-io-v1beta2-BootstrapToken} @@ -681,7 +677,6 @@ APIServer holds settings necessary for API server deployments in the cluster **Appears in:** - - [InitConfiguration](#kubeadm-k8s-io-v1beta2-InitConfiguration) @@ -697,7 +692,7 @@ BootstrapToken describes one bootstrap token, stored as a Secret in the cluster BootstrapTokenString - `token` used for establishing bidirectional trust between nodes and control-planes. + `token` is used for establishing bidirectional trust between nodes and control-planes. Used for joining nodes in the cluster. @@ -715,13 +710,13 @@ for, so other administrators can know its purpose. meta/v1.Duration - `ttl` defines the time to live for this token. Defaults to "24h". + `ttl` defines the time to live for this token. Defaults to '24h'. `expires` and `ttl` are mutually exclusive. expires [Required]
-meta/v1.Time +meta/v1.Time `expires` specifies the timestamp when this token expires. Defaults to being set @@ -743,14 +738,12 @@ for establishing bidirectional trust, but that can be changed here. `groups` specifies the extra groups that this token will authenticate as when/if -used for authentication +used for authentication. - - ## `BootstrapTokenDiscovery` {#kubeadm-k8s-io-v1beta2-BootstrapTokenDiscovery} @@ -758,7 +751,6 @@ used for authentication **Appears in:** - - [Discovery](#kubeadm-k8s-io-v1beta2-Discovery) @@ -774,7 +766,8 @@ BootstrapTokenDiscovery is used to set the options for bootstrap token based dis string - `token` is a token used to validate cluster information fetched from the control-plane. + `token` is a token used to validate cluster information fetched from +the control-plane. @@ -782,8 +775,8 @@ BootstrapTokenDiscovery is used to set the options for bootstrap token based dis string - `apiServerEndpoint` is an IP or domain name to the API server from which -information will be fetched. + `apiServerEndpoint` is an IP or domain name to the API server from which information +will be fetched. @@ -791,12 +784,12 @@ information will be fetched. []string - discovery is used. The root CA found during discovery must match one of these -values. Specifying an empty set disables root CA pinning, which can be unsafe. -Each hash is specified as `:`, where the only currently supported -type is "sha256". This is a hex-encoded SHA-256 hash of the Subject Public Key -Info (SPKI) object in DER-encoded ASN.1. These hashes can be calculated using, -for example, OpenSSL. + `caCertHashes` specifies a set of public key pins to verify when token-based discovery +is used. The root CA found during discovery must match one of these values. +Specifying an empty set disables root CA pinning, which can be unsafe. +Each hash is specified as ":", where the only currently supported type is "sha256". +This is a hex-encoded SHA-256 hash of the Subject Public Key Info (SPKI) object in +DER-encoded ASN.1. These hashes can be calculated using, for example, OpenSSL. @@ -804,16 +797,14 @@ for example, OpenSSL. bool - `unsafeSkipCAVerification` allows token-based discovery without CA verification -via `caCertHashes`. This can weaken the security of kubeadm since other nodes -can impersonate the control-plane. + `unsafeSkipCAVerification` allows token-based discovery without CA verification via +`caCertHashes`. This can weaken the security of kubeadm since other nodes can +impersonate the control-plane. - - ## `BootstrapTokenString` {#kubeadm-k8s-io-v1beta2-BootstrapTokenString} @@ -821,7 +812,6 @@ can impersonate the control-plane. **Appears in:** - - [BootstrapToken](#kubeadm-k8s-io-v1beta2-BootstrapToken) @@ -856,8 +846,6 @@ of view and as an authentication method for the node in the bootstrap phase of - - ## `ControlPlaneComponent` {#kubeadm-k8s-io-v1beta2-ControlPlaneComponent} @@ -865,9 +853,7 @@ of view and as an authentication method for the node in the bootstrap phase of **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta2-ClusterConfiguration) - - [APIServer](#kubeadm-k8s-io-v1beta2-APIServer) @@ -883,7 +869,9 @@ ControlPlaneComponent holds settings common to control plane component of the cl map[string]string - `extraArgs` is an extra set of flags to pass to the control plane component. + `extraArgs` is an extra set of flags to pass to a control plane component. +A key in this map is the flag name as it appears on the command line except +without leading dash(es). @@ -891,14 +879,13 @@ ControlPlaneComponent holds settings common to control plane component of the cl []HostPathMount - `extraVolumes` is an extra set of host volumes, mounted to the control plane component. + `extraVolumes` is an extra set of host volumes mounted to the control plane +component. - - ## `DNS` {#kubeadm-k8s-io-v1beta2-DNS} @@ -906,7 +893,6 @@ ControlPlaneComponent holds settings common to control plane component of the cl **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta2-ClusterConfiguration) @@ -922,7 +908,7 @@ DNS defines the DNS addon that should be used in the cluster DNSAddOnType - `type` defines the DNS add-on to use. + `type` defines the DNS add-on to be used. @@ -930,14 +916,12 @@ DNS defines the DNS addon that should be used in the cluster ImageMeta (Members of ImageMeta are embedded into this type.) - `imageMeta` allows to customize the image used for the DNS. + ImageMeta allows to customize the image used for the DNS component - - ## `DNSAddOnType` {#kubeadm-k8s-io-v1beta2-DNSAddOnType} @@ -945,15 +929,12 @@ DNS defines the DNS addon that should be used in the cluster **Appears in:** - - [DNS](#kubeadm-k8s-io-v1beta2-DNS) -DNSAddOnType defines string identifying DNS add-on types +DNSAddOnType defines string identifying DNS add-on types. - - ## `Discovery` {#kubeadm-k8s-io-v1beta2-Discovery} @@ -961,7 +942,6 @@ DNSAddOnType defines string identifying DNS add-on types **Appears in:** - - [JoinConfiguration](#kubeadm-k8s-io-v1beta2-JoinConfiguration) @@ -986,7 +966,8 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap FileDiscovery - `file` specifies a file or URL to a kubeconfig file from which to load cluster information. + `file` is used to specify a file or URL to a kubeconfig file from which to load +cluster information. `bootstrapToken` and `file` are mutually exclusive. @@ -996,10 +977,10 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap `tlsBootstrapToken` is a token used for TLS bootstrapping. -If `bootstrapToken` is set, this field is defaulted to `bootstrapToken.token`, +If `bootstrapToken` is set, this field is defaulted to `.bootstrapToken.token, but can be overridden. -If `file` is set, this field ∗∗must be set∗∗ in case the KubeConfigFile does -not contain any other authentication information +If `file` is set, this field ∗∗must be set∗∗ in case the KubeConfigFile does not +contain any other authentication information. @@ -1013,8 +994,6 @@ not contain any other authentication information - - ## `Etcd` {#kubeadm-k8s-io-v1beta2-Etcd} @@ -1022,7 +1001,6 @@ not contain any other authentication information **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta2-ClusterConfiguration) @@ -1054,8 +1032,6 @@ Etcd contains elements describing Etcd configuration. - - ## `ExternalEtcd` {#kubeadm-k8s-io-v1beta2-ExternalEtcd} @@ -1063,7 +1039,6 @@ Etcd contains elements describing Etcd configuration. **Appears in:** - - [Etcd](#kubeadm-k8s-io-v1beta2-Etcd) @@ -1080,7 +1055,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli []string - `endpoints` are endpoints of etcd members. This field is required. + `endpoints` of etcd members. @@ -1088,7 +1063,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli string - `caFile` is an SSL Certificate Authority file used to secure etcd communication. + `caFile` is an SSL Certificate Authority (CA) file used to secure etcd communication. Required if using a TLS connection. @@ -1113,8 +1088,6 @@ Required if using a TLS connection. - - ## `FileDiscovery` {#kubeadm-k8s-io-v1beta2-FileDiscovery} @@ -1122,7 +1095,6 @@ Required if using a TLS connection. **Appears in:** - - [Discovery](#kubeadm-k8s-io-v1beta2-Discovery) @@ -1138,15 +1110,13 @@ FileDiscovery is used to specify a file or URL to a kubeconfig file from which t string - `kubeConfigPath` specifies the actual file path or URL to the kubeconfig file -from which to load cluster information + `kubeConfigPath` is used to specify the actual file path or URL to the kubeconfig file +from which to load cluster information. - - ## `HostPathMount` {#kubeadm-k8s-io-v1beta2-HostPathMount} @@ -1154,7 +1124,6 @@ from which to load cluster information **Appears in:** - - [ControlPlaneComponent](#kubeadm-k8s-io-v1beta2-ControlPlaneComponent) @@ -1170,7 +1139,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos string - `name` is the volume name inside the Pod template. + `name` of the volume inside the Pod template. @@ -1186,7 +1155,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos string - `mountPath` is the path inside the Pod where the `hostPath` volume is mounted. + `mountPath`is the path inside the Pod where hostPath volume will be mounted. @@ -1199,17 +1168,15 @@ HostPathMount contains elements describing volumes that are mounted from the hos pathType [Required]
-core/v1.HostPathType +core/v1.HostPathType - `pathType` is the type of the `hostPath` volume. + `pathType` is the type of the HostPath. - - ## `ImageMeta` {#kubeadm-k8s-io-v1beta2-ImageMeta} @@ -1217,9 +1184,7 @@ HostPathMount contains elements describing volumes that are mounted from the hos **Appears in:** - - [DNS](#kubeadm-k8s-io-v1beta2-DNS) - - [LocalEtcd](#kubeadm-k8s-io-v1beta2-LocalEtcd) @@ -1236,8 +1201,8 @@ originated from the Kubernetes/Kubernetes release process string - `imageRepository` sets the container registry to pull images from. -If not set, the ImageRepository defined in ClusterConfiguration will be used instead. + `mageRepository` sets the container registry to pull images from. +If not set, the `imageRepository` defined in ClusterConfiguration will be used. @@ -1245,7 +1210,7 @@ If not set, the ImageRepository defined in ClusterConfiguration will be used ins string - `imageTag` allows to specify a tag for the image. + `imageTag` allows for specifying a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. @@ -1253,8 +1218,6 @@ version of the above components during upgrades. - - ## `JoinControlPlane` {#kubeadm-k8s-io-v1beta2-JoinControlPlane} @@ -1262,11 +1225,11 @@ version of the above components during upgrades. **Appears in:** - - [JoinConfiguration](#kubeadm-k8s-io-v1beta2-JoinConfiguration) -JoinControlPlane contains elements describing an additional control plane instance to be deployed on the joining node. +JoinControlPlane contains elements describing an additional control plane instance +to be deployed on the joining node. @@ -1278,8 +1241,8 @@ JoinControlPlane contains elements describing an additional control plane instan APIEndpoint + `localAPIEndpoint` represents the endpoint of the API server instance +to be deployed on this node. @@ -1287,16 +1250,14 @@ on this node.string + `certificateKey` is the key that is used for decryption of certificates after +they are downloaded from the secret upon joining a new control plane node. +The corresponding encryption key is in the InitConfiguration.
FieldDescription
- `localAPIEndpoint` represents the endpoint of the API server instance to be deployed -on this node.
- `certificateKey` is the key that is used for decryption of certificates after they -are downloaded from the secret upon joining a new control plane node. The -corresponding encryption key is in the InitConfiguration.
- - ## `LocalEtcd` {#kubeadm-k8s-io-v1beta2-LocalEtcd} @@ -1304,11 +1265,10 @@ corresponding encryption key is in the InitConfiguration. **Appears in:** - - [Etcd](#kubeadm-k8s-io-v1beta2-Etcd) -LocalEtcd describes that kubeadm should run an etcd cluster locally +LocalEtcd describes that kubeadm should run an etcd cluster locally. @@ -1320,7 +1280,7 @@ LocalEtcd describes that kubeadm should run an etcd cluster locally ImageMeta + ImageMeta allows to customize the container used for etcd. @@ -1337,8 +1297,10 @@ Defaults to "/var/lib/etcd".map[string]string + `extraArgs` are extra arguments provided to the etcd binary when run +inside a static pod. +A key in this map is the flag name as it appears on the +command line except without leading dash(es). @@ -1346,7 +1308,8 @@ when run inside a static pod.[]string + `serverCertSANs` sets extra Subject Alternative Names (SANs) for the +etcd server signing certificate. @@ -1354,14 +1317,13 @@ when run inside a static pod.[]string + `peerCertSANs` sets extra Subject Alternative Names (SANs) for the +etcd peer signing certificate.
FieldDescription
(Members of ImageMeta are embedded into this type.) - `ImageMeta` allows to customize the container used for etcd.
- `extraArgs` are extra arguments provided to the etcd binary -when run inside a static pod.
- `serverCertSANs` sets extra Subject Alternative Names for the etcd server signing cert.
- `peerCertSANs` sets extra Subject Alternative Names for the etcd peer signing cert.
- - ## `Networking` {#kubeadm-k8s-io-v1beta2-Networking} @@ -1369,7 +1331,6 @@ when run inside a static pod. **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta2-ClusterConfiguration) @@ -1385,7 +1346,7 @@ Networking contains elements describing cluster's networking configuration string - `serviceSubnet` is the subnet used by k8s services. Defaults to "10.96.0.0/12". + `serviceSubnet` is the subnet used by kubernetes Services. Defaults to "10.96.0.0/12". @@ -1401,14 +1362,12 @@ Networking contains elements describing cluster's networking configuration string - `dnsDomain` is the DNS domain used by k8s services. Defaults to "cluster.local". + `dnsDomain` is the DNS domain used by kubernetes Services. Defaults to "cluster.local". - - ## `NodeRegistrationOptions` {#kubeadm-k8s-io-v1beta2-NodeRegistrationOptions} @@ -1416,13 +1375,12 @@ Networking contains elements describing cluster's networking configuration **Appears in:** - - [InitConfiguration](#kubeadm-k8s-io-v1beta2-InitConfiguration) - - [JoinConfiguration](#kubeadm-k8s-io-v1beta2-JoinConfiguration) -NodeRegistrationOptions holds fields that relate to registering a new control-plane or node to the cluster, either via "kubeadm init" or "kubeadm join" +NodeRegistrationOptions holds fields that relate to registering a new control-plane +or node to the cluster, either via "kubeadm init" or "kubeadm join". @@ -1434,10 +1392,11 @@ NodeRegistrationOptions holds fields that relate to registering a new control-pl string + `name` is the `.Metadata.Name` field of the Node API object that will be created +in this `kubeadm init` or `kubeadm join` operation. +This field is also used in the `CommonName` field of the kubelet's client certificate +to the API server. +Defaults to the hostname of the node if not provided. @@ -1445,20 +1404,20 @@ API server. Defaults to the hostname of the node if not provided.string + `criSocket is used to retrieve container runtime information. This information will +be annotated to the Node API object, for later re-use. + `taints` specifies the taints the Node API object should be registered with. +If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to +`'node-role.kubernetes.io/master=""'`. If you don't want to taint your control-plane node, +set this field to an empty list, i.e. `taints: []` in the YAML file. This field is +solely used for Node registration. @@ -1466,11 +1425,13 @@ file. This field is solely used for Node registration.map[string]string + `kubeletExtraArgs` passes through extra arguments to the kubelet. The arguments here are +passed to the kubelet command line via the environment file kubeadm writes at runtime for +the kubelet to source. This overrides the generic base-level configuration in the +'kubelet-config-1.X' ConfigMap. +Flags have higher priority when parsing. These values are local and specific to the node +kubeadm is executing on. +A key in this map is the flag name as it appears on the command line except without leading dash(es). @@ -1478,12 +1439,11 @@ parsing. These values are local and specific to the node kubeadm is executing on []string + `ignorePreflightErrors` provides a list of pre-flight errors to be ignored when the +current node is registered.
FieldDescription
- `name` is the `.metadata.name` field of the Node API object that will be created in this -`kubeadm init` or `kubeadm join` operation. -This field is also used in the CommonName field of the kubelet's client certificate to the -API server. Defaults to the hostname of the node if not provided.
- `criSocket` is used to retrieve container runtime info. This information will be -annotated to the Node API object, for later re-use.
taints [Required]
-[]core/v1.Taint +[]core/v1.Taint 		- `taints` specifies the taints the Node API object should be registered with. If -this field is unset, i.e. nil, in the `kubeadm init` process, it will be defaulted -to `['"node-role.kubernetes.io/master"=""']`. If you don't want to taint your -control-plane node, set this field to an empty list, i.e. `taints: []` in the YAML -file. This field is solely used for Node registration.
- `kubeletExtraArgs` passes through extra arguments to the kubelet. The arguments here -are passed to the kubelet command line via the environment file kubeadm writes at -runtime for the kubelet to source. This overrides the generic base-level -configuration in the "kubelet-config-1.X" ConfigMap. Flags have higher priority when -parsing. These values are local and specific to the node kubeadm is executing on.
- `ignorePreflightErrors` provides a slice of pre-flight errors to be ignored when -the current node is registered.
- diff --git a/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md b/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md index 602f646e84..024a4a6f0a 100644 --- a/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md +++ b/content/en/docs/reference/config-api/kubeadm-config.v1beta3.md @@ -163,6 +163,7 @@ for kubelet official documentation. Here is a fully populated example of a single YAML file containing multiple configuration types to be used during a `kubeadm init` run. +```yaml apiVersion: kubeadm.k8s.io/v1beta3 kind: InitConfiguration bootstrapTokens: @@ -264,6 +265,7 @@ kind: KubeletConfiguration apiVersion: kubeproxy.config.k8s.io/v1alpha1 kind: KubeProxyConfiguration # kube-proxy specific options here +``` ## Kubeadm join configuration types @@ -289,12 +291,10 @@ to the node where kubeadm is executed, including: - [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-ClusterConfiguration) -- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration) - [JoinConfiguration](#kubeadm-k8s-io-v1beta3-JoinConfiguration) - ## `ClusterConfiguration` {#kubeadm-k8s-io-v1beta3-ClusterConfiguration} @@ -317,7 +317,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster Etcd - Etcd holds configuration for etcd. + `etcd` holds the configuration for etcd. @@ -325,7 +325,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster Networking - Networking holds configuration for the networking topology of the cluster. + `networking` holds configuration for the networking topology of the cluster. @@ -333,7 +333,7 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster string - KubernetesVersion is the target version of the control plane. + `kubernetesVersion` is the target version of the control plane. @@ -341,17 +341,18 @@ ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster string - ControlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it -can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. -In case the ControlPlaneEndpoint is not specified, the AdvertiseAddress + BindPort -are used; in case the ControlPlaneEndpoint is specified but without a TCP port, -the BindPort is used. + `controlPlaneEndpoint` sets a stable IP address or DNS name for the control plane. +It can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port. +In case the `controlPlaneEndpoint` is not specified, the `advertiseAddress` + `bindPort` +are used; in case the `controlPlaneEndpoint` is specified but without a TCP port, +the `bindPort` is used. Possible usages are: -e.g. In a cluster with more than one control plane instances, this field should be -assigned the address of the external load balancer in front of the -control plane instances. -e.g. in environments with enforced node recycling, the ControlPlaneEndpoint -could be used for assigning a stable DNS to the control plane. + +- In a cluster with more than one control plane instances, this field should be + assigned the address of the external load balancer in front of the + control plane instances. +- In environments with enforced node recycling, the `controlPlaneEndpoint` could + be used for assigning a stable DNS to the control plane. @@ -359,7 +360,7 @@ could be used for assigning a stable DNS to the control plane. APIServer - APIServer contains extra settings for the API server control plane component + `apiServer` contains extra settings for the API server. @@ -367,7 +368,7 @@ could be used for assigning a stable DNS to the control plane. ControlPlaneComponent - ControllerManager contains extra settings for the controller manager control plane component + `controllerManager` contains extra settings for the controller manager. @@ -375,7 +376,7 @@ could be used for assigning a stable DNS to the control plane. ControlPlaneComponent - Scheduler contains extra settings for the scheduler control plane component + `scheduler` contains extra settings for the scheduler. @@ -383,7 +384,7 @@ could be used for assigning a stable DNS to the control plane. DNS - DNS defines the options for the DNS add-on installed in the cluster. + `dns` defines the options for the DNS add-on installed in the cluster. @@ -391,7 +392,7 @@ could be used for assigning a stable DNS to the control plane. string - CertificatesDir specifies where to store or look for all required certificates. + `certificatesDir` specifies where to store or look for all required certificates. @@ -399,10 +400,11 @@ could be used for assigning a stable DNS to the control plane. string - ImageRepository sets the container registry to pull images from. -If empty, `k8s.gcr.io` will be used by default; in case of kubernetes version is a CI build (kubernetes version starts with `ci/`) -`gcr.io/k8s-staging-ci-images` will be used as a default for control plane components and for kube-proxy, while `k8s.gcr.io` -will be used for all the other images. + `imageRepository` sets the container registry to pull images from. +If empty, `k8s.gcr.io` will be used by default. +In case of kubernetes version is a CI build (kubernetes version starts with `ci/`) +`gcr.io/k8s-staging-ci-images` will be used as a default for control plane components +and for kube-proxy, while `k8s.gcr.io` will be used for all the other images. @@ -410,7 +412,7 @@ will be used for all the other images. map[string]bool - FeatureGates enabled by the user. + `featureGates` contains the feature gates enabled by the user. @@ -418,96 +420,12 @@ will be used for all the other images. string - The cluster name + The cluster name. - - - -## `InitConfiguration` {#kubeadm-k8s-io-v1beta3-InitConfiguration} - - - - - -InitConfiguration contains a list of elements that is specific "kubeadm init"-only runtime -information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
apiVersion
string		kubeadm.k8s.io/v1beta3
kind
string		InitConfiguration
bootstrapTokens
-[]BootstrapToken -		 - BootstrapTokens is respected at `kubeadm init` time and describes a set of Bootstrap Tokens to create. -This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature
nodeRegistration
-NodeRegistrationOptions -		 - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster
localAPIEndpoint
-APIEndpoint -		 - LocalAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node -In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint -is the global endpoint for the cluster, which then loadbalances the requests to each individual API server. This -configuration object lets you customize what IP/DNS name and port the local API server advertises it's accessible -on. By default, kubeadm tries to auto-detect the IP of the default interface and use that, but in case that process -fails you may set the desired value here.
certificateKey
-string -		 - CertificateKey sets the key with which certificates and keys are encrypted prior to being uploaded in -a secret in the cluster during the uploadcerts init phase.
skipPhases
-[]string -		 - SkipPhases is a list of phases to skip during command execution. -The list of phases can be obtained with the "kubeadm init --help" command. -The flag "--skip-phases" takes precedence over this field.
patches
-Patches -		 - Patches contains options related to applying patches to components deployed by kubeadm during -"kubeadm init".
- - ## `JoinConfiguration` {#kubeadm-k8s-io-v1beta3-JoinConfiguration} @@ -531,7 +449,8 @@ JoinConfiguration contains elements describing a particular node. NodeRegistrationOptions - NodeRegistration holds fields that relate to registering the new control-plane node to the cluster + `nodeRegistration` holds fields that relate to registering the new +control-plane node to the cluster. @@ -539,8 +458,8 @@ JoinConfiguration contains elements describing a particular node. string - CACertPath is the path to the SSL certificate authority used to -secure comunications between node and control-plane. + `caCertPath` is the path to the SSL certificate authority used to secure +comunications between a node and the control-plane. Defaults to "/etc/kubernetes/pki/ca.crt". @@ -549,7 +468,8 @@ Defaults to "/etc/kubernetes/pki/ca.crt". Discovery - Discovery specifies the options for the kubelet to use during the TLS Bootstrap process + `discovery` specifies the options for the kubelet to use during the TLS +bootstrap process. @@ -557,8 +477,8 @@ Defaults to "/etc/kubernetes/pki/ca.crt". JoinControlPlane - ControlPlane defines the additional control plane instance to be deployed on the joining node. -If nil, no additional control plane instance will be deployed. + `controlPlane` defines the additional control plane instance to be deployed +on the joining node. If nil, no additional control plane instance will be deployed. @@ -566,9 +486,9 @@ If nil, no additional control plane instance will be deployed. []string - SkipPhases is a list of phases to skip during command execution. -The list of phases can be obtained with the "kubeadm join --help" command. -The flag "--skip-phases" takes precedence over this field. + `skipPhases` is a list of phases to skip during command execution. +The list of phases can be obtained with the `kubeadm join --help` command. +The flag `--skip-phases` takes precedence over this field. @@ -576,15 +496,13 @@ The flag "--skip-phases" takes precedence over this field. Patches - Patches contains options related to applying patches to components deployed by kubeadm during -"kubeadm join". + `patches` contains options related to applying patches to components deployed +by kubeadm during `kubeadm join`. - - ## `APIEndpoint` {#kubeadm-k8s-io-v1beta3-APIEndpoint} @@ -592,9 +510,6 @@ The flag "--skip-phases" takes precedence over this field. **Appears in:** - -- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration) - - [JoinControlPlane](#kubeadm-k8s-io-v1beta3-JoinControlPlane) @@ -610,7 +525,7 @@ APIEndpoint struct contains elements of API server instance deployed on a node. string - AdvertiseAddress sets the IP address for the API server to advertise. + `advertiseAddress` sets the IP address for the API server to advertise. @@ -618,15 +533,13 @@ APIEndpoint struct contains elements of API server instance deployed on a node. int32 - BindPort sets the secure port for the API Server to bind to. + `bindPorti` sets the secure port for the API Server to bind to. Defaults to 6443. - - ## `APIServer` {#kubeadm-k8s-io-v1beta3-APIServer} @@ -634,7 +547,6 @@ Defaults to 6443. **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-ClusterConfiguration) @@ -659,7 +571,8 @@ APIServer holds settings necessary for API server deployments in the cluster []string - CertSANs sets extra Subject Alternative Names for the API Server signing cert. + `certSANs` sets extra Subject Alternative Names (SANs) for the API Server signing +certificate. @@ -667,14 +580,12 @@ APIServer holds settings necessary for API server deployments in the cluster meta/v1.Duration - TimeoutForControlPlane controls the timeout that we use for API server to appear + `timeoutForControlPlane` controls the timeout that we wait for API server to appear. - - ## `BootstrapTokenDiscovery` {#kubeadm-k8s-io-v1beta3-BootstrapTokenDiscovery} @@ -682,7 +593,6 @@ APIServer holds settings necessary for API server deployments in the cluster **Appears in:** - - [Discovery](#kubeadm-k8s-io-v1beta3-Discovery) @@ -698,8 +608,8 @@ BootstrapTokenDiscovery is used to set the options for bootstrap token based dis string - Token is a token used to validate cluster information -fetched from the control-plane. + `token` is a token used to validate cluster information fetched from the +control-plane. @@ -707,7 +617,8 @@ fetched from the control-plane. string - APIServerEndpoint is an IP or domain name to the API server from which info will be fetched. + `apiServerEndpoint` is an IP or domain name to the API server from which +information will be fetched. @@ -715,13 +626,12 @@ fetched from the control-plane. []string - CACertHashes specifies a set of public key pins to verify -when token-based discovery is used. The root CA found during discovery -must match one of these values. Specifying an empty set disables root CA -pinning, which can be unsafe. Each hash is specified as ":", -where the only currently supported type is "sha256". This is a hex-encoded -SHA-256 hash of the Subject Public Key Info (SPKI) object in DER-encoded -ASN.1. These hashes can be calculated using, for example, OpenSSL. + `caCertHashes` specifies a set of public key pins to verify when token-based discovery +is used. The root CA found during discovery must match one of these values. +Specifying an empty set disables root CA pinning, which can be unsafe. +Each hash is specified as ":", where the only currently supported type is +"sha256". This is a hex-encoded SHA-256 hash of the Subject Public Key Info (SPKI) +object in DER-encoded ASN.1. These hashes can be calculated using, for example, OpenSSL. @@ -729,16 +639,14 @@ ASN.1. These hashes can be calculated using, for example, OpenSSL. bool - UnsafeSkipCAVerification allows token-based discovery -without CA verification via CACertHashes. This can weaken -the security of kubeadm since other nodes can impersonate the control-plane. + `unsafeSkipCAVerification` allows token-based discovery without CA verification +via `caCertHashes`. This can weaken the security of kubeadm since other nodes can +impersonate the control-plane. - - ## `ControlPlaneComponent` {#kubeadm-k8s-io-v1beta3-ControlPlaneComponent} @@ -746,9 +654,7 @@ the security of kubeadm since other nodes can impersonate the control-plane.map[string]string - ExtraArgs is an extra set of flags to pass to the control plane component. -A key in this map is the flag name as it appears on the -command line except without leading dash(es). -TODO: This is temporary and ideally we would like to switch all components to -use ComponentConfig + ConfigMaps. + `extraArgs` is an extra set of flags to pass to the control plane component. +A key in this map is the flag name as it appears on the command line except +without leading dash(es). @@ -776,14 +680,12 @@ use ComponentConfig + ConfigMaps. []HostPathMount - ExtraVolumes is an extra set of host volumes, mounted to the control plane component. + `extraVolumes` is an extra set of host volumes, mounted to the control plane component. - - ## `DNS` {#kubeadm-k8s-io-v1beta3-DNS} @@ -791,7 +693,6 @@ use ComponentConfig + ConfigMaps. **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-ClusterConfiguration) @@ -807,26 +708,12 @@ DNS defines the DNS addon that should be used in the cluster ImageMeta (Members of ImageMeta are embedded into this type.) - ImageMeta allows to customize the image used for the DNS component + `imageMeta` allows to customize the image used for the DNS component. - - - -## `DNSAddOnType` {#kubeadm-k8s-io-v1beta3-DNSAddOnType} - -(Alias of `string`) - - - -DNSAddOnType defines string identifying DNS add-on types - - - - ## `Discovery` {#kubeadm-k8s-io-v1beta3-Discovery} @@ -834,11 +721,10 @@ DNSAddOnType defines string identifying DNS add-on types **Appears in:** - - [JoinConfiguration](#kubeadm-k8s-io-v1beta3-JoinConfiguration) -Discovery specifies the options for the kubelet to use during the TLS Bootstrap process +Discovery specifies the options for the kubelet to use during the TLS Bootstrap process. @@ -850,8 +736,8 @@ Discovery specifies the options for the kubelet to use during the TLS Bootstrap BootstrapTokenDiscovery + `bootstrapToken` is used to set the options for bootstrap token based discovery. +`bootstrapToken` and `file` are mutually exclusive. @@ -859,8 +745,9 @@ BootstrapToken and File are mutually exclusiveFileDiscovery + `file` is used to specify a file or URL to a kubeconfig file from which to load +cluster information. +`bootstrapToken` and `file` are mutually exclusive. @@ -868,9 +755,10 @@ BootstrapToken and File are mutually exclusivestring + `tlsBootstrapToken` is a token used for TLS bootstrapping. +If `bootstrapToken` is set, this field is defaulted to `.bootstrapToken.token`, but +can be overridden. If `file` is set, this field ∗∗must be set∗∗ in case the KubeConfigFile +does not contain any other authentication information @@ -878,14 +766,12 @@ If .File is set, this field ∗∗must be set∗∗ in case meta/v1.Duration + `timeout` modifies the discovery timeout.
FieldDescription
- BootstrapToken is used to set the options for bootstrap token based discovery -BootstrapToken and File are mutually exclusive
- File is used to specify a file or URL to a kubeconfig file from which to load cluster information -BootstrapToken and File are mutually exclusive
- TLSBootstrapToken is a token used for TLS bootstrapping. -If .BootstrapToken is set, this field is defaulted to .BootstrapToken.Token, but can be overridden. -If .File is set, this field ∗∗must be set∗∗ in case the KubeConfigFile does not contain any other authentication information
- Timeout modifies the discovery timeout
- - ## `Etcd` {#kubeadm-k8s-io-v1beta3-Etcd} @@ -893,7 +779,6 @@ If .File is set, this field ∗∗must be set∗∗ in case **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-ClusterConfiguration) @@ -909,8 +794,8 @@ Etcd contains elements describing Etcd configuration. LocalEtcd - Local provides configuration knobs for configuring the local etcd instance -Local and External are mutually exclusive + `local` provides configuration knobs for configuring the local etcd instance. +`local` and `external` are mutually exclusive. @@ -918,15 +803,13 @@ Local and External are mutually exclusive ExternalEtcd - External describes how to connect to an external etcd cluster -Local and External are mutually exclusive + `external` describes how to connect to an external etcd cluster. +`local` and `external` are mutually exclusive. - - ## `ExternalEtcd` {#kubeadm-k8s-io-v1beta3-ExternalEtcd} @@ -934,7 +817,6 @@ Local and External are mutually exclusive **Appears in:** - - [Etcd](#kubeadm-k8s-io-v1beta3-Etcd) @@ -951,7 +833,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli []string - Endpoints of etcd members. Required for ExternalEtcd. + `endpoints` contains the list of etcd members. @@ -959,7 +841,7 @@ Kubeadm has no knowledge of where certificate files live and they must be suppli string - CAFile is an SSL Certificate Authority file used to secure etcd communication. + `caFile` is an SSL Certificate Authority (CA) file used to secure etcd communication. Required if using a TLS connection. @@ -968,7 +850,7 @@ Required if using a TLS connection. string - CertFile is an SSL certification file used to secure etcd communication. + `certFile` is an SSL certification file used to secure etcd communication. Required if using a TLS connection. @@ -977,15 +859,13 @@ Required if using a TLS connection. string - KeyFile is an SSL key file used to secure etcd communication. + `keyFile` is an SSL key file used to secure etcd communication. Required if using a TLS connection. - - ## `FileDiscovery` {#kubeadm-k8s-io-v1beta3-FileDiscovery} @@ -993,11 +873,11 @@ Required if using a TLS connection. **Appears in:** - - [Discovery](#kubeadm-k8s-io-v1beta3-Discovery) -FileDiscovery is used to specify a file or URL to a kubeconfig file from which to load cluster information +FileDiscovery is used to specify a file or URL to a kubeconfig file from which to load +cluster information. @@ -1009,14 +889,13 @@ FileDiscovery is used to specify a file or URL to a kubeconfig file from which t string + `kubeConfigPath` is used to specify the actual file path or URL to the kubeconfig +file from which to load cluster information.
FieldDescription
- KubeConfigPath is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information
- - ## `HostPathMount` {#kubeadm-k8s-io-v1beta3-HostPathMount} @@ -1024,12 +903,10 @@ FileDiscovery is used to specify a file or URL to a kubeconfig file from which t **Appears in:** - - [ControlPlaneComponent](#kubeadm-k8s-io-v1beta3-ControlPlaneComponent) -HostPathMount contains elements describing volumes that are mounted from the -host. +HostPathMount contains elements describing volumes that are mounted from the host. @@ -1041,7 +918,7 @@ host. string + `name` is the name of the volume inside the Pod template. @@ -1049,8 +926,7 @@ host. string + `hostPath` is the path in the host that will be mounted inside the Pod. @@ -1058,7 +934,7 @@ the pod.string + `mountPath` is the path inside the Pod where `hostPath` will be mounted. @@ -1066,22 +942,20 @@ the pod.bool + `readOnly` controls write access to the volume. + `pathType` is the type of the `hostPath`.
FieldDescription
- Name of the volume inside the pod template.
- HostPath is the path in the host that will be mounted inside -the pod.
- MountPath is the path inside the pod where hostPath will be mounted.
- ReadOnly controls write access to the volume
pathType
-core/v1.HostPathType +core/v1.HostPathType 		- PathType is the type of the HostPath.
- - ## `ImageMeta` {#kubeadm-k8s-io-v1beta3-ImageMeta} @@ -1089,9 +963,7 @@ the pod. **Appears in:** - - [DNS](#kubeadm-k8s-io-v1beta3-DNS) - - [LocalEtcd](#kubeadm-k8s-io-v1beta3-LocalEtcd) @@ -1108,8 +980,8 @@ originated from the Kubernetes/Kubernetes release process string - ImageRepository sets the container registry to pull images from. -if not set, the ImageRepository defined in ClusterConfiguration will be used instead. + `imageRepository` sets the container registry to pull images from. +If not set, the `imageRepository` defined in ClusterConfiguration will be used instead. @@ -1117,15 +989,14 @@ if not set, the ImageRepository defined in ClusterConfiguration will be used ins string - ImageTag allows to specify a tag for the image. -In case this value is set, kubeadm does not change automatically the version of the above components during upgrades. + `imageTag` allows to specify a tag for the image. +In case this value is set, kubeadm does not change automatically the version of +the above components during upgrades. - - ## `JoinControlPlane` {#kubeadm-k8s-io-v1beta3-JoinControlPlane} @@ -1133,11 +1004,11 @@ In case this value is set, kubeadm does not change automatically the version of **Appears in:** - - [JoinConfiguration](#kubeadm-k8s-io-v1beta3-JoinConfiguration) -JoinControlPlane contains elements describing an additional control plane instance to be deployed on the joining node. +JoinControlPlane contains elements describing an additional control plane instance +to be deployed on the joining node. @@ -1149,7 +1020,8 @@ JoinControlPlane contains elements describing an additional control plane instan APIEndpoint + `localAPIEndpoint` represents the endpoint of the API server instance to be +deployed on this node. @@ -1157,15 +1029,14 @@ JoinControlPlane contains elements describing an additional control plane instan string + `certificateKey` is the key that is used for decryption of certificates after +they are downloaded from the secret upon joining a new control plane node. +The corresponding encryption key is in the InitConfiguration.
FieldDescription
- LocalAPIEndpoint represents the endpoint of the API server instance to be deployed on this node.
- CertificateKey is the key that is used for decryption of certificates after they are downloaded from the secret -upon joining a new control plane node. The corresponding encryption key is in the InitConfiguration.
- - ## `LocalEtcd` {#kubeadm-k8s-io-v1beta3-LocalEtcd} @@ -1173,7 +1044,6 @@ upon joining a new control plane node. The corresponding encryption key is in th **Appears in:** - - [Etcd](#kubeadm-k8s-io-v1beta3-Etcd) @@ -1189,7 +1059,7 @@ LocalEtcd describes that kubeadm should run an etcd cluster locally ImageMeta (Members of ImageMeta are embedded into this type.) - ImageMeta allows to customize the container used for etcd + ImageMeta allows to customize the container used for etcd. @@ -1197,7 +1067,7 @@ LocalEtcd describes that kubeadm should run an etcd cluster locally string - DataDir is the directory etcd will place its data. + `dataDir` is the directory etcd will place its data. Defaults to "/var/lib/etcd". @@ -1206,9 +1076,8 @@ Defaults to "/var/lib/etcd". map[string]string - ExtraArgs are extra arguments provided to the etcd binary -when run inside a static pod. -A key in this map is the flag name as it appears on the + `extraArgs` are extra arguments provided to the etcd binary when run +inside a static Pod. A key in this map is the flag name as it appears on the command line except without leading dash(es). @@ -1217,7 +1086,8 @@ command line except without leading dash(es). []string - ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert. + `serverCertSANs` sets extra Subject Alternative Names (SANs) for the etcd +server signing certificate. @@ -1225,14 +1095,13 @@ command line except without leading dash(es). []string - PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert. + `peerCertSANs` sets extra Subject Alternative Names (SANs) for the etcd peer +signing certificate. - - ## `Networking` {#kubeadm-k8s-io-v1beta3-Networking} @@ -1240,7 +1109,6 @@ command line except without leading dash(es). **Appears in:** - - [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-ClusterConfiguration) @@ -1256,7 +1124,7 @@ Networking contains elements describing cluster's networking configuration string - ServiceSubnet is the subnet used by k8s services. Defaults to "10.96.0.0/12". + `serviceSubnet` is the subnet used by Kubernetes Services. Defaults to "10.96.0.0/12". @@ -1264,7 +1132,7 @@ Networking contains elements describing cluster's networking configuration string - PodSubnet is the subnet used by pods. + `podSubnet` is the subnet used by Pods. @@ -1272,14 +1140,12 @@ Networking contains elements describing cluster's networking configuration string - DNSDomain is the dns domain used by k8s services. Defaults to "cluster.local". + `dnsDomain` is the DNS domain used by Kubernetes Services. Defaults to "cluster.local". - - ## `NodeRegistrationOptions` {#kubeadm-k8s-io-v1beta3-NodeRegistrationOptions} @@ -1287,13 +1153,11 @@ Networking contains elements describing cluster's networking configuration **Appears in:** - -- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration) - - [JoinConfiguration](#kubeadm-k8s-io-v1beta3-JoinConfiguration) -NodeRegistrationOptions holds fields that relate to registering a new control-plane or node to the cluster, either via "kubeadm init" or "kubeadm join" +NodeRegistrationOptions holds fields that relate to registering a new control-plane or +node to the cluster, either via "kubeadm init" or "kubeadm join" @@ -1305,8 +1169,10 @@ NodeRegistrationOptions holds fields that relate to registering a new control-pl string @@ -1315,17 +1181,20 @@ Defaults to the hostname of the node if not provided.string + `criSocket` is used to retrieve container runtime info. +This information will be annotated to the Node API object, for later re-use + `tains` specifies the taints the Node API object should be registered with. +If this field is unset, i.e. nil, in the `kubeadm init` process it will be defaulted to +`taints: ["node-role.kubernetes.io/master:""]`. +If you don't want to taint your control-plane node, set this field to an empty slice, +i.e. `taints: []` in the YAML file. This field is solely used for Node registration. @@ -1333,10 +1202,12 @@ empty slice, i.e. `taints: []` in the YAML file. This field is solely used for N map[string]string @@ -1345,24 +1216,25 @@ command line except without leading dash(es).[]string + `ignorePreflightErrors` provides a list of pre-flight errors to be ignored when +the current node is registered. +If this field is unset kubeadm will default it to "IfNotPresent", or pull the required +images if not present on the host.
FieldDescription
- Name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation. -This field is also used in the CommonName field of the kubelet's client certificate to the API server. + `name` is the `.metadata.name` field of the Node API object that will be created in this +`kubeadm init` or `kubeadm join` operation. +This field is also used in the `CommonName` field of the kubelet's client certificate to +the API server. Defaults to the hostname of the node if not provided.
- CRISocket is used to retrieve container runtime info. This information will be annotated to the Node API object, for later re-use
taints [Required]
-[]core/v1.Taint +[]core/v1.Taint 		- Taints specifies the taints the Node API object should be registered with. If this field is unset, i.e. nil, in the `kubeadm init` process -it will be defaulted to []v1.Taint{'node-role.kubernetes.io/master=""'}. If you don't want to taint your control-plane node, set this field to an -empty slice, i.e. `taints: []` in the YAML file. This field is solely used for Node registration.
- KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file -kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap -Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. -A key in this map is the flag name as it appears on the + `kubeletExtraArgs` passes through extra arguments to the kubelet. +The arguments here are passed to the kubelet command line via the environment file +kubeadm writes at runtime for the kubelet to source. +This overrides the generic base-level configuration in the 'kubelet-config-1.X' ConfigMap. +Flags have higher priority when parsing. These values are local and specific to the node +kubeadm is executing on. A key in this map is the flag name as it appears on the command line except without leading dash(es).
- IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered.
imagePullPolicy
-core/v1.PullPolicy +core/v1.PullPolicy 		- ImagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. + `imagePullPolicy` specifies the policy for image pulling during kubeadm "init" and +"join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". -If this field is unset kubeadm will default it to "IfNotPresent", or pull the required images if not present on the host.
- - ## `Patches` {#kubeadm-k8s-io-v1beta3-Patches} @@ -1370,9 +1242,6 @@ If this field is unset kubeadm will default it to "IfNotPresent", or pull the re **Appears in:** - -- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration) - - [JoinConfiguration](#kubeadm-k8s-io-v1beta3-JoinConfiguration) @@ -1388,10 +1257,12 @@ Patches contains options related to applying patches to components deployed by k string - Directory is a path to a directory that contains files named "target[suffix][+patchtype].extension". + `directory` is a path to a directory that contains files named +"target[suffix][+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of -"kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can be one -of "strategic" "merge" or "json" and they match the patch formats supported by kubectl. +"kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd". "patchtype" can +be one of "strategic" "merge" or "json" and they match the patch formats supported by +kubectl. The default "patchtype" is "strategic". "extension" must be either "json" or "yaml". "suffix" is an optional string that can be used to determine which patches are applied first alpha-numerically. @@ -1400,7 +1271,6 @@ first alpha-numerically. - @@ -1412,8 +1282,6 @@ first alpha-numerically. **Appears in:** -- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration) - BootstrapToken describes one bootstrap token, stored as a Secret in the cluster @@ -1451,7 +1319,7 @@ for, so other administrators can know its purpose. expires
-meta/v1.Time +meta/v1.Time `expires` specifies the timestamp when this token expires. Defaults to being set @@ -1486,7 +1354,6 @@ used for authentication **Appears in:** - - [BootstrapToken](#BootstrapToken) diff --git a/content/en/docs/reference/config-api/kubelet-config.v1beta1.md b/content/en/docs/reference/config-api/kubelet-config.v1beta1.md index 619b8d70f6..c299c56470 100644 --- a/content/en/docs/reference/config-api/kubelet-config.v1beta1.md +++ b/content/en/docs/reference/config-api/kubelet-config.v1beta1.md @@ -14,6 +14,166 @@ auto_generated: true +## `FormatOptions` {#FormatOptions} + + + + +**Appears in:** +- [LoggingConfiguration](#LoggingConfiguration) + + +FormatOptions contains options for the different logging formats. + + + + + + + + + + + + + +
FieldDescription
json [Required]
+JSONOptions +		 + [Experimental] JSON contains options for logging format "json".
+ +## `JSONOptions` {#JSONOptions} + + + + +**Appears in:** +- [FormatOptions](#FormatOptions) + + +JSONOptions contains options for logging format "json". + + + + + + + + + + + + + + + + + + +
FieldDescription
splitStream [Required]
+bool +		 + [Experimental] SplitStream redirects error messages to stderr while +info messages go to stdout, with buffering. The default is to write +both to stdout, without buffering.
infoBufferSize [Required]
+k8s.io/apimachinery/pkg/api/resource.QuantityValue +		 + [Experimental] InfoBufferSize sets the size of the info stream when +using split streams. The default is zero, which disables buffering.
+ +## `LoggingConfiguration` {#LoggingConfiguration} + + + + +**Appears in:** +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +LoggingConfiguration contains logging options +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
format [Required]
+string +		 + Format Flag specifies the structure of log messages. +default value of format is `text`
flushFrequency [Required]
+time.Duration +		 + Maximum number of seconds between log flushes. Ignored if the +selected logging backend writes log messages without buffering.
verbosity [Required]
+uint32 +		 + Verbosity is the threshold that determines which log messages are +logged. Default is zero which logs only the most important +messages. Higher values enable additional messages. Error messages +are always logged.
vmodule [Required]
+VModuleConfiguration +		 + VModule overrides the verbosity threshold for individual files. +Only supported for "text" log format.
sanitization [Required]
+bool +		 + [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). +Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
options [Required]
+FormatOptions +		 + [Experimental] Options holds additional parameters that are specific +to the different logging formats. Only the options for the selected +format get used, but all of them get validated.
+ +## `VModuleConfiguration` {#VModuleConfiguration} + +(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`) + + +**Appears in:** +- [LoggingConfiguration](#LoggingConfiguration) + + +VModuleConfiguration is a collection of individual file names or patterns +and the corresponding verbosity threshold. + + + + ## `KubeletConfiguration` {#kubelet-config-k8s-io-v1beta1-KubeletConfiguration} @@ -1517,7 +1677,7 @@ Default: 0.8 registerWithTaints
-[]core/v1.Taint +[]core/v1.Taint registerWithTaints are an array of taints to add to a node object when @@ -1538,8 +1698,6 @@ Default: true - - ## `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 source
-core/v1.NodeConfigSource +core/v1.NodeConfigSource source is the source that we are serializing. @@ -1571,21 +1729,6 @@ It exists in the kubeletconfig API group because it is classified as a versioned - - - -## `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} @@ -1593,7 +1736,6 @@ hairpin packets. **Appears in:** - - [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) @@ -1619,8 +1761,6 @@ Anonymous requests have a username of `system:anonymous`, and a group name of - - ## `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:** - - [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) @@ -1666,8 +1805,6 @@ Anonymous requests have a username of `system:anonymous`, and a group name of - - ## `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:** - - [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) @@ -1707,8 +1843,6 @@ Webhook mode uses the SubjectAccessReview API to determine authorization. - - ## `KubeletAuthorizationMode` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorizationMode} @@ -1716,15 +1850,12 @@ Webhook mode uses the SubjectAccessReview API to determine authorization. **Appears in:** - - [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization) - - ## `KubeletWebhookAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthentication} @@ -1732,7 +1863,6 @@ Webhook mode uses the SubjectAccessReview API to determine authorization. **Appears in:** - - [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) @@ -1763,8 +1893,6 @@ tokenreviews.authentication.k8s.io API. - - ## `KubeletWebhookAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthorization} @@ -1772,7 +1900,6 @@ tokenreviews.authentication.k8s.io API. **Appears in:** - - [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization) @@ -1804,8 +1931,6 @@ the webhook authorizer. - - ## `KubeletX509Authentication` {#kubelet-config-k8s-io-v1beta1-KubeletX509Authentication} @@ -1813,7 +1938,6 @@ the webhook authorizer. **Appears in:** - - [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) @@ -1838,8 +1962,6 @@ and groups corresponding to the Organization in the client certificate. - - ## `MemoryReservation` {#kubelet-config-k8s-io-v1beta1-MemoryReservation} @@ -1847,7 +1969,6 @@ and groups corresponding to the Organization in the client certificate. **Appears in:** - - [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) @@ -1869,7 +1990,7 @@ MemoryReservation specifies the memory reservation of different types for each N limits [Required]
-core/v1.ResourceList +core/v1.ResourceList No description provided. @@ -1879,8 +2000,6 @@ MemoryReservation specifies the memory reservation of different types for each N - - ## `MemorySwapConfiguration` {#kubelet-config-k8s-io-v1beta1-MemorySwapConfiguration} @@ -1888,7 +2007,6 @@ MemoryReservation specifies the memory reservation of different types for each N **Appears in:** - - [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) @@ -1912,8 +2030,6 @@ MemoryReservation specifies the memory reservation of different types for each N - - ## `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy} @@ -1921,7 +2037,6 @@ MemoryReservation specifies the memory reservation of different types for each N **Appears in:** - - [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. - - ## `ShutdownGracePeriodByPodPriority` {#kubelet-config-k8s-io-v1beta1-ShutdownGracePeriodByPodPriority} @@ -1938,7 +2051,6 @@ managers (secret, configmap) are discovering object changes. **Appears in:** - - [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) @@ -1968,170 +2080,4 @@ ShutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods ba - - - - -## `FormatOptions` {#FormatOptions} - - - - -**Appears in:** - -- [LoggingConfiguration](#LoggingConfiguration) - - -FormatOptions contains options for the different logging formats. - - - - - - - - - - - - - -
FieldDescription
json [Required]
-JSONOptions -		 - [Experimental] JSON contains options for logging format "json".
- -## `JSONOptions` {#JSONOptions} - - - - -**Appears in:** - -- [FormatOptions](#FormatOptions) - - -JSONOptions contains options for logging format "json". - - - - - - - - - - - - - - - - - - -
FieldDescription
splitStream [Required]
-bool -		 - [Experimental] SplitStream redirects error messages to stderr while -info messages go to stdout, with buffering. The default is to write -both to stdout, without buffering.
infoBufferSize [Required]
-k8s.io/apimachinery/pkg/api/resource.QuantityValue -		 - [Experimental] InfoBufferSize sets the size of the info stream when -using split streams. The default is zero, which disables buffering.
- -## `LoggingConfiguration` {#LoggingConfiguration} - - - - -**Appears in:** - -- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) - - -LoggingConfiguration contains logging options -Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
format [Required]
-string -		 - Format Flag specifies the structure of log messages. -default value of format is `text`
flushFrequency [Required]
-time.Duration -		 - Maximum number of seconds between log flushes. Ignored if the -selected logging backend writes log messages without buffering.
verbosity [Required]
-uint32 -		 - Verbosity is the threshold that determines which log messages are -logged. Default is zero which logs only the most important -messages. Higher values enable additional messages. Error messages -are always logged.
vmodule [Required]
-VModuleConfiguration -		 - VModule overrides the verbosity threshold for individual files. -Only supported for "text" log format.
sanitization [Required]
-bool -		 - [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). -Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
options [Required]
-FormatOptions -		 - [Experimental] Options holds additional parameters that are specific -to the different logging formats. Only the options for the selected -format get used, but all of them get validated.
- -## `VModuleConfiguration` {#VModuleConfiguration} - -(Alias of `[]k8s.io/component-base/config/v1alpha1.VModuleItem`) - - -**Appears in:** - -- [LoggingConfiguration](#LoggingConfiguration) - - -VModuleConfiguration is a collection of individual file names or patterns -and the corresponding verbosity threshold. - -