1KUBERNETES(1)               General Commands Manual              KUBERNETES(1)
2
3
4

NAME

6       kube-scheduler - Schedules containers on hosts.
7
8
9

SYNOPSIS

11       kube-scheduler [OPTIONS]
12
13
14

DESCRIPTION

16       The Kubernetes scheduler is a policy-rich, topology-aware,
17       workload-specific function that significantly impacts availability,
18       performance, and capacity. The scheduler needs to take into account
19       individual and collective resource requirements, quality of service
20       requirements, hardware/software/policy constraints, affinity and
21       anti-affinity specifications, data locality, inter-workload
22       interference, deadlines, and so on. Workload-specific requirements will
23       be exposed through the API as necessary.
24
25
26       kube-scheduler [flags]
27
28
29

OPTIONS

31       --address string                           DEPRECATED
32            the IP address on which to listen for the --port port (set to
33       0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See
34       --bind-address instead. (default "0.0.0.0")
35
36
37       --algorithm-provider string                DEPRECATED
38            the scheduling algorithm provider to use, one of:
39       ClusterAutoscalerProvider | DefaultProvider
40
41
42                --azure-container-registry-config string   Path to the file containing Azure container registry configuration information.
43                --config string                            The path to the configuration file. Flags override values in this file.
44
45
46
47       --contention-profiling                     DEPRECATED
48            enable lock contention profiling, if profiling is enabled
49
50
51       --feature-gates mapStringBool              A set of key=value pairs
52       that describe feature gates for alpha/experimental features. Options
53       are
54
55
56                                                           APIListChunking=true|false (BETA - default=true)
57                                                           APIResponseCompression=true|false (ALPHA - default=false)
58                                                           AllAlpha=true|false (ALPHA - default=false)
59                                                           AppArmor=true|false (BETA - default=true)
60                                                           AttachVolumeLimit=true|false (BETA - default=true)
61                                                           BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
62                                                           BlockVolume=true|false (ALPHA - default=false)
63                                                           CPUManager=true|false (BETA - default=true)
64                                                           CRIContainerLogRotation=true|false (BETA - default=true)
65                                                           CSIBlockVolume=true|false (ALPHA - default=false)
66                                                           CSIDriverRegistry=true|false (ALPHA - default=false)
67                                                           CSINodeInfo=true|false (ALPHA - default=false)
68                                                           CSIPersistentVolume=true|false (BETA - default=true)
69                                                           CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
70                                                           CustomPodDNS=true|false (BETA - default=true)
71                                                           CustomResourceSubresources=true|false (BETA - default=true)
72                                                           CustomResourceValidation=true|false (BETA - default=true)
73                                                           DebugContainers=true|false (ALPHA - default=false)
74                                                           DevicePlugins=true|false (BETA - default=true)
75                                                           DryRun=true|false (ALPHA - default=false)
76                                                           DynamicKubeletConfig=true|false (BETA - default=true)
77                                                           EnableEquivalenceClassCache=true|false (ALPHA - default=false)
78                                                           ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
79                                                           ExpandPersistentVolumes=true|false (BETA - default=true)
80                                                           ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
81                                                           ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
82                                                           GCERegionalPersistentDisk=true|false (BETA - default=true)
83                                                           HugePages=true|false (BETA - default=true)
84                                                           HyperVContainer=true|false (ALPHA - default=false)
85                                                           Initializers=true|false (ALPHA - default=false)
86                                                           KubeletPluginsWatcher=true|false (BETA - default=true)
87                                                           LocalStorageCapacityIsolation=true|false (BETA - default=true)
88                                                           MountContainers=true|false (ALPHA - default=false)
89                                                           NodeLease=true|false (ALPHA - default=false)
90                                                           PersistentLocalVolumes=true|false (BETA - default=true)
91                                                           PodPriority=true|false (BETA - default=true)
92                                                           PodReadinessGates=true|false (BETA - default=true)
93                                                           PodShareProcessNamespace=true|false (BETA - default=true)
94                                                           ProcMountType=true|false (ALPHA - default=false)
95                                                           QOSReserved=true|false (ALPHA - default=false)
96                                                           ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
97                                                           ResourceQuotaScopeSelectors=true|false (BETA - default=true)
98                                                           RotateKubeletClientCertificate=true|false (BETA - default=true)
99                                                           RotateKubeletServerCertificate=true|false (BETA - default=true)
100                                                           RunAsGroup=true|false (ALPHA - default=false)
101                                                           RuntimeClass=true|false (ALPHA - default=false)
102                                                           SCTPSupport=true|false (ALPHA - default=false)
103                                                           ScheduleDaemonSetPods=true|false (BETA - default=true)
104                                                           ServiceNodeExclusion=true|false (ALPHA - default=false)
105                                                           StreamingProxyRedirects=true|false (BETA - default=true)
106                                                           SupportPodPidsLimit=true|false (ALPHA - default=false)
107                                                           Sysctls=true|false (BETA - default=true)
108                                                           TTLAfterFinished=true|false (ALPHA - default=false)
109                                                           TaintBasedEvictions=true|false (ALPHA - default=false)
110                                                           TaintNodesByCondition=true|false (BETA - default=true)
111                                                           TokenRequest=true|false (BETA - default=true)
112                                                           TokenRequestProjection=true|false (BETA - default=true)
113                                                           ValidateProxyRedirects=true|false (ALPHA - default=false)
114                                                           VolumeScheduling=true|false (BETA - default=true)
115                                                           VolumeSnapshotDataSource=true|false (ALPHA - default=false)
116                                                           VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
117
118
119
120       -h, --help                                     help for kube-scheduler
121       --kube-api-burst int32                     DEPRECATED
122            burst to use while talking with kubernetes apiserver (default 100)
123
124
125       --kube-api-content-type string             DEPRECATED
126            content type of requests sent to apiserver. (default
127       "application/vnd.kubernetes.protobuf")
128
129
130       --kube-api-qps float32                     DEPRECATED
131            QPS to use while talking with kubernetes apiserver (default 50)
132
133
134       --kubeconfig string                        DEPRECATED
135            path to kubeconfig file with authorization and master location
136       information.
137
138
139                --leader-elect                             Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. (default true)
140                --leader-elect-lease-duration duration     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. (default 15s)
141                --leader-elect-renew-deadline duration     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. (default 10s)
142                --leader-elect-resource-lock endpoints     The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`. (default "endpoints")
143                --leader-elect-retry-period duration       The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s)
144
145
146
147       --lock-object-name string                  DEPRECATED
148            define the name of the lock object. (default "kube-scheduler")
149
150
151       --lock-object-namespace string             DEPRECATED
152            define the namespace of the lock object. (default "kube-system")
153
154
155                --log-flush-frequency duration             Maximum number of seconds between log flushes (default 5s)
156                --master string                            The address of the Kubernetes API server (overrides any value in kubeconfig)
157
158
159
160       --policy-config-file string                DEPRECATED
161            file with scheduler policy configuration. This file is used if
162       policy ConfigMap is not provided or --use-legacy-policy-config=true
163
164
165       --policy-configmap string                  DEPRECATED
166            name of the ConfigMap object that contains scheduler's policy
167       configuration. It must exist in the system namespace before scheduler
168       initialization if --use-legacy-policy-config=false. The config must be
169       provided as the value of an element in 'Data' map with the
170       key='policy.cfg'
171
172
173       --policy-configmap-namespace string        DEPRECATED
174            the namespace where policy ConfigMap is located. The kube-system
175       namespace will be used if this is not provided or is empty. (default
176       "kube-system")
177
178
179       --port int                                 DEPRECATED
180            the port on which to serve HTTP insecurely without authentication
181       and authorization. If 0, don't serve HTTPS at all. See --secure-port
182       instead. (default 10251)
183
184
185       --profiling                                DEPRECATED
186            enable profiling via web interface host:port/debug/pprof/
187
188
189       --scheduler-name string                    DEPRECATED
190            name of the scheduler, used to select which pods will be processed
191       by this scheduler, based on pod's "spec.schedulerName". (default
192       "default-scheduler")
193
194
195       --use-legacy-policy-config                 DEPRECATED
196            when set to true, scheduler will ignore policy ConfigMap and uses
197       policy config file
198
199
200                --version version[=true]                   Print version information and quit
201                --write-config-to string                   If set, write the configuration values to this file and exit.
202
203
204
205

EXAMPLES

207       /usr/bin/kube-scheduler --logtostderr=true --v=0
208       --master=127.0.0.1:8080
209
210
211
212                            kubernetes User Manuals              KUBERNETES(1)
Impressum