You are viewing documentation for Kubernetes version: v1.19
Kubernetes v1.19 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.
kube-scheduler
Synopsis
The Kubernetes scheduler is a control plane process which assigns Pods to Nodes. The scheduler determines which Nodes are valid placements for each Pod in the scheduling queue according to constraints and available resources. The scheduler then ranks each valid Node and binds the Pod to a suitable Node. Multiple different schedulers may be used within a cluster; kube-scheduler is the reference implementation. See scheduling for more information about scheduling and the kube-scheduler component.
kube-scheduler [flags]
Options
| --add-dir-header | |
| If true, adds the file directory to the header of the log messages | |
| --address string Default: "0.0.0.0" | |
| DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See --bind-address instead. | |
| --algorithm-provider string | |
| DEPRECATED: the scheduling algorithm provider to use, this sets the default plugins for component config profiles. Choose one of: ClusterAutoscalerProvider | DefaultProvider | |
| --alsologtostderr | |
| log to standard error as well as files | |
| --authentication-kubeconfig string | |
| kubeconfig file pointing at the 'core' kubernetes server with enough rights to create tokenreviews.authentication.k8s.io. This is optional. If empty, all token requests are considered to be anonymous and no client CA is looked up in the cluster. | |
| --authentication-skip-lookup | |
| If false, the authentication-kubeconfig will be used to lookup missing authentication configuration from the cluster. | |
| --authentication-token-webhook-cache-ttl duration Default: 10s | |
| The duration to cache responses from the webhook token authenticator. | |
| --authentication-tolerate-lookup-failure Default: true | |
| If true, failures to look up missing authentication configuration from the cluster are not considered fatal. Note that this can result in authentication that treats all requests as anonymous. | |
| --authorization-always-allow-paths stringSlice Default: [/healthz] | |
| A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server. | |
| --authorization-kubeconfig string | |
| kubeconfig file pointing at the 'core' kubernetes server with enough rights to create subjectaccessreviews.authorization.k8s.io. This is optional. If empty, all requests not skipped by authorization are forbidden. | |
| --authorization-webhook-cache-authorized-ttl duration Default: 10s | |
| The duration to cache 'authorized' responses from the webhook authorizer. | |
| --authorization-webhook-cache-unauthorized-ttl duration Default: 10s | |
| The duration to cache 'unauthorized' responses from the webhook authorizer. | |
| --azure-container-registry-config string | |
| Path to the file containing Azure container registry configuration information. | |
| --bind-address ip Default: 0.0.0.0 | |
| The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces will be used. | |
| --cert-dir string | |
| The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. | |
| --client-ca-file string | |
| If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate. | |
| --config string | |
| The path to the configuration file. The following flags can overwrite fields in this file: --address --port --use-legacy-policy-config --policy-configmap --policy-config-file --algorithm-provider | |
| --contention-profiling Default: true | |
| DEPRECATED: enable lock contention profiling, if profiling is enabled | |
| --feature-gates mapStringBool | |
| A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: APIListChunking=true|false (BETA - default=true) APIPriorityAndFairness=true|false (ALPHA - default=false) APIResponseCompression=true|false (BETA - default=true) AllAlpha=true|false (ALPHA - default=false) AllBeta=true|false (BETA - default=false) AllowInsecureBackendProxy=true|false (BETA - default=true) AnyVolumeDataSource=true|false (ALPHA - default=false) AppArmor=true|false (BETA - default=true) BalanceAttachedNodeVolumes=true|false (ALPHA - default=false) BoundServiceAccountTokenVolume=true|false (ALPHA - default=false) CPUManager=true|false (BETA - default=true) CRIContainerLogRotation=true|false (BETA - default=true) CSIInlineVolume=true|false (BETA - default=true) CSIMigration=true|false (BETA - default=true) CSIMigrationAWS=true|false (BETA - default=false) CSIMigrationAWSComplete=true|false (ALPHA - default=false) CSIMigrationAzureDisk=true|false (BETA - default=false) CSIMigrationAzureDiskComplete=true|false (ALPHA - default=false) CSIMigrationAzureFile=true|false (ALPHA - default=false) CSIMigrationAzureFileComplete=true|false (ALPHA - default=false) CSIMigrationGCE=true|false (BETA - default=false) CSIMigrationGCEComplete=true|false (ALPHA - default=false) CSIMigrationOpenStack=true|false (BETA - default=false) CSIMigrationOpenStackComplete=true|false (ALPHA - default=false) CSIMigrationvSphere=true|false (BETA - default=false) CSIMigrationvSphereComplete=true|false (BETA - default=false) CSIStorageCapacity=true|false (ALPHA - default=false) CSIVolumeFSGroupPolicy=true|false (ALPHA - default=false) ConfigurableFSGroupPolicy=true|false (ALPHA - default=false) CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false) DefaultPodTopologySpread=true|false (ALPHA - default=false) DevicePlugins=true|false (BETA - default=true) DisableAcceleratorUsageMetrics=true|false (ALPHA - default=false) DynamicKubeletConfig=true|false (BETA - default=true) EndpointSlice=true|false (BETA - default=true) EndpointSliceProxying=true|false (BETA - default=true) EphemeralContainers=true|false (ALPHA - default=false) ExpandCSIVolumes=true|false (BETA - default=true) ExpandInUsePersistentVolumes=true|false (BETA - default=true) ExpandPersistentVolumes=true|false (BETA - default=true) ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false) GenericEphemeralVolume=true|false (ALPHA - default=false) HPAScaleToZero=true|false (ALPHA - default=false) HugePageStorageMediumSize=true|false (BETA - default=true) HyperVContainer=true|false (ALPHA - default=false) IPv6DualStack=true|false (ALPHA - default=false) ImmutableEphemeralVolumes=true|false (BETA - default=true) KubeletPodResources=true|false (BETA - default=true) LegacyNodeRoleBehavior=true|false (BETA - default=true) LocalStorageCapacityIsolation=true|false (BETA - default=true) LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false) NodeDisruptionExclusion=true|false (BETA - default=true) NonPreemptingPriority=true|false (BETA - default=true) PodDisruptionBudget=true|false (BETA - default=true) PodOverhead=true|false (BETA - default=true) ProcMountType=true|false (ALPHA - default=false) QOSReserved=true|false (ALPHA - default=false) RemainingItemCount=true|false (BETA - default=true) RemoveSelfLink=true|false (ALPHA - default=false) RotateKubeletServerCertificate=true|false (BETA - default=true) RunAsGroup=true|false (BETA - default=true) RuntimeClass=true|false (BETA - default=true) SCTPSupport=true|false (BETA - default=true) SelectorIndex=true|false (BETA - default=true) ServerSideApply=true|false (BETA - default=true) ServiceAccountIssuerDiscovery=true|false (ALPHA - default=false) ServiceAppProtocol=true|false (BETA - default=true) ServiceNodeExclusion=true|false (BETA - default=true) ServiceTopology=true|false (ALPHA - default=false) SetHostnameAsFQDN=true|false (ALPHA - default=false) StartupProbe=true|false (BETA - default=true) StorageVersionHash=true|false (BETA - default=true) SupportNodePidsLimit=true|false (BETA - default=true) SupportPodPidsLimit=true|false (BETA - default=true) Sysctls=true|false (BETA - default=true) TTLAfterFinished=true|false (ALPHA - default=false) TokenRequest=true|false (BETA - default=true) TokenRequestProjection=true|false (BETA - default=true) TopologyManager=true|false (BETA - default=true) ValidateProxyRedirects=true|false (BETA - default=true) VolumeSnapshotDataSource=true|false (BETA - default=true) WarningHeaders=true|false (BETA - default=true) WinDSR=true|false (ALPHA - default=false) WinOverlay=true|false (ALPHA - default=false) WindowsEndpointSliceProxying=true|false (ALPHA - default=false) | |
| --hard-pod-affinity-symmetric-weight int32 Default: 1 | |
| DEPRECATED: RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule. --hard-pod-affinity-symmetric-weight represents the weight of implicit PreferredDuringScheduling affinity rule. Must be in the range 0-100.This option was moved to the policy configuration file | |
| -h, --help | |
| help for kube-scheduler | |
| --http2-max-streams-per-connection int | |
| The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default. | |
| --kube-api-burst int32 Default: 100 | |
| DEPRECATED: burst to use while talking with kubernetes apiserver | |
| --kube-api-content-type string Default: "application/vnd.kubernetes.protobuf" | |
| DEPRECATED: content type of requests sent to apiserver. | |
| --kube-api-qps float32 Default: 50 | |
| DEPRECATED: QPS to use while talking with kubernetes apiserver | |
| --kubeconfig string | |
| DEPRECATED: path to kubeconfig file with authorization and master location information. | |
| --leader-elect Default: true | |
| Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. | |
| --leader-elect-lease-duration duration Default: 15s | |
| 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. | |
| --leader-elect-renew-deadline duration Default: 10s | |
| 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. | |
| --leader-elect-resource-lock string Default: "endpointsleases" | |
| The type of resource object that is used for locking during leader election. Supported options are 'endpoints', 'configmaps', 'leases', 'endpointsleases' and 'configmapsleases'. | |
| --leader-elect-resource-name string Default: "kube-scheduler" | |
| The name of resource object that is used for locking during leader election. | |
| --leader-elect-resource-namespace string Default: "kube-system" | |
| The namespace of resource object that is used for locking during leader election. | |
| --leader-elect-retry-period duration Default: 2s | |
| The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. | |
| --lock-object-name string Default: "kube-scheduler" | |
| DEPRECATED: define the name of the lock object. Will be removed in favor of leader-elect-resource-name | |
| --lock-object-namespace string Default: "kube-system" | |
| DEPRECATED: define the namespace of the lock object. Will be removed in favor of leader-elect-resource-namespace. | |
| --log-backtrace-at traceLocation Default: :0 | |
| when logging hits line file:N, emit a stack trace | |
| --log-dir string | |
| If non-empty, write log files in this directory | |
| --log-file string | |
| If non-empty, use this log file | |
| --log-file-max-size uint Default: 1800 | |
| Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. | |
| --log-flush-frequency duration Default: 5s | |
| Maximum number of seconds between log flushes | |
| --logging-format string Default: "text" | |
| Sets the log format. Permitted formats: "text", "json". Non-default formats don't honor these flags: --add_dir_header, --alsologtostderr, --log_backtrace_at, --log_dir, --log_file, --log_file_max_size, --logtostderr, --skip_headers, --skip_log_headers, --stderrthreshold, --vmodule, --log-flush-frequency. Non-default choices are currently alpha and subject to change without warning. | |
| --logtostderr Default: true | |
| log to standard error instead of files | |
| --master string | |
| The address of the Kubernetes API server (overrides any value in kubeconfig) | |
| --permit-port-sharing | |
| If true, SO_REUSEPORT will be used when binding the port, which allows more than one instance to bind on the same address and port. [default=false] | |
| --policy-config-file string | |
| DEPRECATED: file with scheduler policy configuration. This file is used if policy ConfigMap is not provided or --use-legacy-policy-config=true. Note: The scheduler will fail if this is combined with Plugin configs | |
| --policy-configmap string | |
| DEPRECATED: name of the ConfigMap object that contains scheduler's policy configuration. It must exist in the system namespace before scheduler initialization if --use-legacy-policy-config=false. The config must be provided as the value of an element in 'Data' map with the key='policy.cfg'. Note: The scheduler will fail if this is combined with Plugin configs | |
| --policy-configmap-namespace string Default: "kube-system" | |
| DEPRECATED: the namespace where policy ConfigMap is located. The kube-system namespace will be used if this is not provided or is empty. Note: The scheduler will fail if this is combined with Plugin configs | |
| --port int Default: 10251 | |
| DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve plain HTTP at all. See --secure-port instead. | |
| --profiling Default: true | |
| DEPRECATED: enable profiling via web interface host:port/debug/pprof/ | |
| --requestheader-allowed-names stringSlice | |
| List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed. | |
| --requestheader-client-ca-file string | |
| Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers. WARNING: generally do not depend on authorization being already done for incoming requests. | |
| --requestheader-extra-headers-prefix stringSlice Default: [x-remote-extra-] | |
| List of request header prefixes to inspect. X-Remote-Extra- is suggested. | |
| --requestheader-group-headers stringSlice Default: [x-remote-group] | |
| List of request headers to inspect for groups. X-Remote-Group is suggested. | |
| --requestheader-username-headers stringSlice Default: [x-remote-user] | |
| List of request headers to inspect for usernames. X-Remote-User is common. | |
| --scheduler-name string Default: "default-scheduler" | |
| DEPRECATED: name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's "spec.schedulerName". | |
| --secure-port int Default: 10259 | |
| The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. | |
| --show-hidden-metrics-for-version string | |
| The previous version for which you want to show hidden metrics. Only the previous minor version is meaningful, other values will not be allowed. The format is <major>.<minor>, e.g.: '1.16'. The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, rather than being surprised when they are permanently removed in the release after that. | |
| --skip-headers | |
| If true, avoid header prefixes in the log messages | |
| --skip-log-headers | |
| If true, avoid headers when opening log files | |
| --stderrthreshold severity Default: 2 | |
| logs at or above this threshold go to stderr | |
| --tls-cert-file string | |
| File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir. | |
| --tls-cipher-suites stringSlice | |
| Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. Preferred values: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384. Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_RC4_128_SHA. | |
| --tls-min-version string | |
| Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 | |
| --tls-private-key-file string | |
| File containing the default x509 private key matching --tls-cert-file. | |
| --tls-sni-cert-key namedCertKey Default: [] | |
| A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. The domain patterns also allow IP addresses, but IPs should only be used if the apiserver has visibility to the IP address requested by a client. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com". | |
| --use-legacy-policy-config | |
| DEPRECATED: when set to true, scheduler will ignore policy ConfigMap and uses policy config file. Note: The scheduler will fail if this is combined with Plugin configs | |
| -v, --v Level | |
| number for the log level verbosity | |
| --version version[=true] | |
| Print version information and quit | |
| --vmodule moduleSpec | |
| comma-separated list of pattern=N settings for file-filtered logging | |
| --write-config-to string | |
| If set, write the configuration values to this file and exit. | |
Last modified August 13, 2020 at 4:45 PM PST: Updating generated files for v1.19.0-rc.4 (50cfe280cd)