1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2
3
4
6 kube-apiserver - Provides the API for kubernetes orchestration.
7
8
9
11 kube-apiserver [OPTIONS]
12
13
14
16 The Kubernetes API server validates and configures data for the api
17 objects which include pods, services, replicationcontrollers, and oth‐
18 ers. The API Server services REST operations and provides the frontend
19 to the cluster's shared state through which all other components inter‐
20 act.
21
22
23 kube-apiserver [flags]
24
25
26
28 **--address ip The IP
29 address on which to serve the insecure --port (set to 0.0.0.0 for all
30 IPv4 interfaces and ** : for all IPv6 interfaces). (default
31 127.0.0.1) (DEPRECATED: see --bind-address instead.)
32
33
34 --admission-control strings Admission is
35 divided into two phases. In the first phase, only mutating admission
36 plugins run. In the second phase, only validating admission plugins
37 run. The names in the below list may represent a validating plugin, a
38 mutating plugin, or both. The order of plugins in which they are passed
39 to this flag does not matter. Comma-delimited list of AlwaysAd‐
40 mit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolera‐
41 tionSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit,
42 ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffini‐
43 tyTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvi‐
44 sion, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerRefer‐
45 encesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVol‐
46 umeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolera‐
47 tionRestriction, Priority, ResourceQuota, SecurityContextDeny, Ser‐
48 viceAccount, StorageObjectInUseProtection, TaintNodesByCondition, Vali‐
49 datingAdmissionWebhook. (DEPRECATED: Use --enable-admission-plugins or
50 --disable-admission-plugins instead. Will be removed in a future ver‐
51 sion.)
52
53
54 --admission-control-config-file string File with admission control configuration.
55 --advertise-address ip The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
56 --allow-privileged If true, allow privileged containers. [default=false]
57 --alsologtostderr log to standard error as well as files
58
59
60
61 --anonymous-auth Enables
62 anonymous requests to the secure port of the API server. Requests that
63 are not rejected by another authentication method are treated as anony‐
64 mous requests. Anonymous requests have a username of system anony‐
65 mous, and a group name of system:unauthenticated. (default true)
66
67
68 --api-audiences strings Identifiers of the API. The service account token authenticator will validate that tokens used against the API are bound to at least one of these audiences. If the --service-account-issuer flag is configured and this flag is not, this field defaults to a single element list containing the issuer URL .
69 --apiserver-count int The number of apiservers running in the cluster, must be a positive number. (In use when --endpoint-reconciler-type=master-count is enabled.) (default 1)
70 --audit-dynamic-configuration Enables dynamic audit configuration. This feature also requires the DynamicAuditing feature flag
71 --audit-log-batch-buffer-size int The size of the buffer to store events before batching and writing. Only used in batch mode. (default 10000)
72 --audit-log-batch-max-size int The maximum size of a batch. Only used in batch mode. (default 1)
73 --audit-log-batch-max-wait duration The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.
74 --audit-log-batch-throttle-burst int Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.
75 --audit-log-batch-throttle-enable Whether batching throttling is enabled. Only used in batch mode.
76 --audit-log-batch-throttle-qps float32 Maximum average number of batches per second. Only used in batch mode.
77 --audit-log-format string Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Known formats are legacy,json. (default "json")
78 --audit-log-maxage int The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
79 --audit-log-maxbackup int The maximum number of old audit log files to retain.
80 --audit-log-maxsize int The maximum size in megabytes of the audit log file before it gets rotated.
81 --audit-log-mode string Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking,blocking-strict. (default "blocking")
82 --audit-log-path string If set, all requests coming to the apiserver will be logged to this file. '-' means standard out.
83 --audit-log-truncate-enabled Whether event and batch truncating is enabled.
84 --audit-log-truncate-max-batch-size int Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size. (default 10485760)
85 --audit-log-truncate-max-event-size int Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, and if this doesn't reduce the size enough, event is discarded. (default 102400)
86 --audit-log-version string API group and version used for serializing audit events written to log. (default "audit.k8s.io/v1")
87 --audit-policy-file string Path to the file that defines the audit policy configuration.
88 --audit-webhook-batch-buffer-size int The size of the buffer to store events before batching and writing. Only used in batch mode. (default 10000)
89 --audit-webhook-batch-max-size int The maximum size of a batch. Only used in batch mode. (default 400)
90 --audit-webhook-batch-max-wait duration The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode. (default 30s)
91 --audit-webhook-batch-throttle-burst int Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode. (default 15)
92 --audit-webhook-batch-throttle-enable Whether batching throttling is enabled. Only used in batch mode. (default true)
93 --audit-webhook-batch-throttle-qps float32 Maximum average number of batches per second. Only used in batch mode. (default 10)
94 --audit-webhook-config-file string Path to a kubeconfig formatted file that defines the audit webhook configuration.
95 --audit-webhook-initial-backoff duration The amount of time to wait before retrying the first failed request. (default 10s)
96 --audit-webhook-mode string Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking,blocking-strict. (default "batch")
97 --audit-webhook-truncate-enabled Whether event and batch truncating is enabled.
98 --audit-webhook-truncate-max-batch-size int Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size. (default 10485760)
99 --audit-webhook-truncate-max-event-size int Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, and if this doesn't reduce the size enough, event is discarded. (default 102400)
100 --audit-webhook-version string API group and version used for serializing audit events written to webhook. (default "audit.k8s.io/v1")
101 --authentication-token-webhook-cache-ttl duration The duration to cache responses from the webhook token authenticator. (default 2m0s)
102 --authentication-token-webhook-config-file string File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.
103
104
105
106 --authorization-mode strings Ordered list
107 of plug-ins to do authorization on secure port. Comma-delimited list of
108 AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node. (default
109 [AlwaysAllow])
110
111
112 --authorization-policy-file string File with authorization policy in json line by line format, used with --authorization-mode=ABAC, on the secure port.
113 --authorization-webhook-cache-authorized-ttl duration The duration to cache 'authorized' responses from the webhook authorizer. (default 5m0s)
114 --authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. (default 30s)
115 --authorization-webhook-config-file string File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port.
116 --azure-container-registry-config string Path to the file containing Azure container registry configuration information.
117 --basic-auth-file string If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
118
119
120
121 **--bind-address ip The IP
122 address on which to listen for the --secure-port port. The associated
123 interface(s) must be reachable by the rest of the cluster, and by
124 CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all
125 IPv4 interfaces and ** : for all IPv6 interfaces). (default
126 0.0.0.0)
127
128
129 --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. (default "/var/run/kubernetes")
130 --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.
131 --cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file.
132 --cloud-provider string The provider for cloud services. Empty string for no provider.
133 --cloud-provider-gce-lb-src-cidrs cidrs CIDRs opened in GCE firewall for LB traffic proxy health checks (default 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16)
134 --contention-profiling Enable lock contention profiling, if profiling is enabled
135 --cors-allowed-origins strings List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
136
137
138
139 --default-not-ready-toleration-seconds int Indicates the
140 tolerationSeconds of the toleration for notReady NoExecute that is
141 added by default to every pod that does not already have such a tolera‐
142 tion. (default 300)
143
144
145 --default-unreachable-toleration-seconds int Indicates the
146 tolerationSeconds of the toleration for unreachable NoExecute that
147 is added by default to every pod that does not already have such a tol‐
148 eration. (default 300)
149
150
151 --default-watch-cache-size int Default watch cache size. If zero, watch cache will be disabled for resources that do not have a default watch size set. (default 100)
152 --delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1)
153
154
155
156 --disable-admission-plugins strings admission
157 plugins that should be disabled although they are in the default
158 enabled plugins list (NamespaceLifecycle, LimitRanger, ServiceAccount,
159 TaintNodesByCondition, Priority, DefaultTolerationSeconds, DefaultStor‐
160 ageClass, StorageObjectInUseProtection, PersistentVolumeClaimResize,
161 MutatingAdmissionWebhook, ValidatingAdmissionWebhook, ResourceQuota).
162 Comma-delimited list of admission plugins AlwaysAdmit, Always‐
163 Deny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds,
164 DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, Extende‐
165 dResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopol‐
166 ogy, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision,
167 NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferences‐
168 PermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLa‐
169 bel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRe‐
170 striction, Priority, ResourceQuota, SecurityContextDeny, ServiceAc‐
171 count, StorageObjectInUseProtection, TaintNodesByCondition, Validatin‐
172 gAdmissionWebhook. The order of plugins in this flag does not matter.
173
174
175 --enable-admission-plugins strings admission
176 plugins that should be enabled in addition to default enabled ones
177 (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondi‐
178 tion, Priority, DefaultTolerationSeconds, DefaultStorageClass, Stora‐
179 geObjectInUseProtection, PersistentVolumeClaimResize, MutatingAdmis‐
180 sionWebhook, ValidatingAdmissionWebhook, ResourceQuota). Comma-delim‐
181 ited list of admission plugins AlwaysAdmit, AlwaysDeny,
182 AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds,
183 DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, Extende‐
184 dResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopol‐
185 ogy, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision,
186 NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferences‐
187 PermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLa‐
188 bel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRe‐
189 striction, Priority, ResourceQuota, SecurityContextDeny, ServiceAc‐
190 count, StorageObjectInUseProtection, TaintNodesByCondition, Validatin‐
191 gAdmissionWebhook. The order of plugins in this flag does not matter.
192
193
194 --enable-aggregator-routing Turns on aggregator routing requests to endpoints IP rather than cluster IP.
195 --enable-bootstrap-token-auth Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication.
196 --enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. (default true)
197 --enable-inflight-quota-handler If true, replace the max-in-flight handler with an enhanced one that queues and dispatches with priority and fairness
198 --encryption-provider-config string The file containing configuration for encryption providers to be used for storing secrets in etcd
199 --endpoint-reconciler-type string Use an endpoint reconciler (master-count, lease, none) (default "lease")
200 --etcd-cafile string SSL Certificate Authority file used to secure etcd communication.
201 --etcd-certfile string SSL certification file used to secure etcd communication.
202 --etcd-compaction-interval duration The interval of compaction requests. If 0, the compaction request from apiserver is disabled. (default 5m0s)
203 --etcd-count-metric-poll-period duration Frequency of polling etcd for number of resources per type. 0 disables the metric collection. (default 1m0s)
204 --etcd-keyfile string SSL key file used to secure etcd communication.
205 --etcd-prefix string The prefix to prepend to all resource paths in etcd. (default "/registry")
206
207
208
209 --etcd-servers strings List of etcd
210 servers to connect with (scheme //ip:port), comma separated.
211
212
213 --etcd-servers-overrides strings Per-resource
214 etcd servers overrides, comma separated. The individual override format
215 group/resource#servers, where servers are URLs, semicolon sepa‐
216 rated.
217
218
219 --event-ttl duration Amount of time to retain events. (default 1h0m0s)
220 --external-hostname string The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).
221
222
223
224 --feature-gates mapStringBool A set of
225 key=value pairs that describe feature gates for alpha/experimental fea‐
226 tures. Options are
227
228
229 APIListChunking=true|false (BETA - default=true)
230 APIResponseCompression=true|false (ALPHA - default=false)
231 AllAlpha=true|false (ALPHA - default=false)
232 AppArmor=true|false (BETA - default=true)
233 AttachVolumeLimit=true|false (BETA - default=true)
234 BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
235 BlockVolume=true|false (BETA - default=true)
236 BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
237 CPUManager=true|false (BETA - default=true)
238 CRIContainerLogRotation=true|false (BETA - default=true)
239 CSIBlockVolume=true|false (BETA - default=true)
240 CSIDriverRegistry=true|false (BETA - default=true)
241 CSIInlineVolume=true|false (ALPHA - default=false)
242 CSIMigration=true|false (ALPHA - default=false)
243 CSIMigrationAWS=true|false (ALPHA - default=false)
244 CSIMigrationAzureDisk=true|false (ALPHA - default=false)
245 CSIMigrationAzureFile=true|false (ALPHA - default=false)
246 CSIMigrationGCE=true|false (ALPHA - default=false)
247 CSIMigrationOpenStack=true|false (ALPHA - default=false)
248 CSINodeInfo=true|false (BETA - default=true)
249 CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
250 CustomResourceDefaulting=true|false (ALPHA - default=false)
251 CustomResourcePublishOpenAPI=true|false (BETA - default=true)
252 CustomResourceSubresources=true|false (BETA - default=true)
253 CustomResourceValidation=true|false (BETA - default=true)
254 CustomResourceWebhookConversion=true|false (BETA - default=true)
255 DebugContainers=true|false (ALPHA - default=false)
256 DevicePlugins=true|false (BETA - default=true)
257 DryRun=true|false (BETA - default=true)
258 DynamicAuditing=true|false (ALPHA - default=false)
259 DynamicKubeletConfig=true|false (BETA - default=true)
260 ExpandCSIVolumes=true|false (ALPHA - default=false)
261 ExpandInUsePersistentVolumes=true|false (BETA - default=true)
262 ExpandPersistentVolumes=true|false (BETA - default=true)
263 ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
264 ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
265 HyperVContainer=true|false (ALPHA - default=false)
266 KubeletPodResources=true|false (BETA - default=true)
267 LocalStorageCapacityIsolation=true|false (BETA - default=true)
268 LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
269 MountContainers=true|false (ALPHA - default=false)
270 NodeLease=true|false (BETA - default=true)
271 NonPreemptingPriority=true|false (ALPHA - default=false)
272 PodShareProcessNamespace=true|false (BETA - default=true)
273 ProcMountType=true|false (ALPHA - default=false)
274 QOSReserved=true|false (ALPHA - default=false)
275 RemainingItemCount=true|false (ALPHA - default=false)
276 RequestManagement=true|false (ALPHA - default=false)
277 ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
278 ResourceQuotaScopeSelectors=true|false (BETA - default=true)
279 RotateKubeletClientCertificate=true|false (BETA - default=true)
280 RotateKubeletServerCertificate=true|false (BETA - default=true)
281 RunAsGroup=true|false (BETA - default=true)
282 RuntimeClass=true|false (BETA - default=true)
283 SCTPSupport=true|false (ALPHA - default=false)
284 ScheduleDaemonSetPods=true|false (BETA - default=true)
285 ServerSideApply=true|false (ALPHA - default=false)
286 ServiceLoadBalancerFinalizer=true|false (ALPHA - default=false)
287 ServiceNodeExclusion=true|false (ALPHA - default=false)
288 StorageVersionHash=true|false (BETA - default=true)
289 StreamingProxyRedirects=true|false (BETA - default=true)
290 SupportNodePidsLimit=true|false (BETA - default=true)
291 SupportPodPidsLimit=true|false (BETA - default=true)
292 Sysctls=true|false (BETA - default=true)
293 TTLAfterFinished=true|false (ALPHA - default=false)
294 TaintBasedEvictions=true|false (BETA - default=true)
295 TaintNodesByCondition=true|false (BETA - default=true)
296 TokenRequest=true|false (BETA - default=true)
297 TokenRequestProjection=true|false (BETA - default=true)
298 ValidateProxyRedirects=true|false (BETA - default=true)
299 VolumePVCDataSource=true|false (ALPHA - default=false)
300 VolumeSnapshotDataSource=true|false (ALPHA - default=false)
301 VolumeSubpathEnvExpansion=true|false (BETA - default=true)
302 WatchBookmark=true|false (ALPHA - default=false)
303 WinDSR=true|false (ALPHA - default=false)
304 WinOverlay=true|false (ALPHA - default=false)
305 WindowsGMSA=true|false (ALPHA - default=false)
306
307
308
309 -h, --help help for
310 kube-apiserver
311 --http2-max-streams-per-connection int The
312 limit that the server gives to clients for the maximum number of
313 streams in an HTTP/2 connection. Zero means to use golang's default.
314 **--insecure-bind-address ip The IP
315 address on which to serve the --insecure-port (set to 0.0.0.0 for all
316 IPv4 interfaces and ** : for all IPv6 interfaces). (default
317 127.0.0.1) (DEPRECATED: This flag will be removed in a future version.)
318
319
320 --insecure-port int The port on
321 which to serve unsecured, unauthenticated access. (default 8080) (DEP‐
322 RECATED This flag will be removed in a future version.)
323
324
325 --kubelet-certificate-authority string Path to a cert file for the certificate authority.
326 --kubelet-client-certificate string Path to a client cert file for TLS.
327 --kubelet-client-key string Path to a client key file for TLS.
328 --kubelet-https Use https for kubelet connections. (default true)
329 --kubelet-preferred-address-types strings List of the preferred NodeAddressTypes to use for kubelet connections. (default [Hostname,InternalDNS,InternalIP,ExternalDNS,ExternalIP])
330
331
332
333 --kubelet-read-only-port uint DEPRECATED
334 kubelet port. (default 10255)
335
336
337 --kubelet-timeout duration Timeout for kubelet operations. (default 5s)
338 --kubernetes-service-node-port int If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.
339
340
341
342 --log-backtrace-at traceLocation when logging
343 hits line file N, emit a stack trace (default :0)
344
345
346 --log-dir string If non-empty, write log files in this directory
347 --log-file string If non-empty, use this log file
348 --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
349 --log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
350 --logtostderr log to standard error instead of files (default true)
351
352
353
354 --master-service-namespace string DEPRECATED
355 the namespace from which the kubernetes master services should be
356 injected into pods. (default "default")
357
358
359 --max-connection-bytes-per-sec int If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.
360 --max-mutating-requests-inflight int The maximum number of mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit. (default 200)
361 --max-requests-inflight int The maximum number of non-mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit. (default 400)
362 --min-request-timeout int An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load. (default 1800)
363 --oidc-ca-file string If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used.
364 --oidc-client-id string The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
365 --oidc-groups-claim string If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.
366 --oidc-groups-prefix string If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.
367 --oidc-issuer-url string The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).
368 --oidc-required-claim mapStringString A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
369
370
371
372 --oidc-signing-algs strings Comma-sepa‐
373 rated list of allowed JOSE asymmetric signing algorithms. JWTs with a
374 'alg' header value not in this list will be rejected. Values are
375 defined by RFC 7518 https //tools.ietf.org/html/rfc7518#sec‐
376 tion-3.1. (default [RS256])
377
378
379 --oidc-username-claim string The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. (default "sub")
380 --oidc-username-prefix string If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'.
381
382
383
384 --port int The port on
385 which to serve unsecured, unauthenticated access. Set to 0 to disable.
386 (default 8080) (DEPRECATED see --secure-port instead.)
387
388
389 --profiling Enable pro‐
390 filing via web interface host port/debug/pprof/ (default true)
391
392
393 --proxy-client-cert-file string Client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins. It is expected that this cert includes a signature from the CA in the --requestheader-client-ca-file flag. That CA is published in the 'extension-apiserver-authentication' configmap in the kube-system namespace. Components receiving calls from kube-aggregator should use that CA to perform their half of the mutual TLS verification.
394 --proxy-client-key-file string Private key for the client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins.
395 --request-timeout duration An optional field indicating the duration a handler must keep a request open before timing it out. This is the default request timeout for requests but may be overridden by flags such as --min-request-timeout for specific types of requests. (default 1m0s)
396 --requestheader-allowed-names strings 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.
397
398
399
400 --requestheader-client-ca-file string Root certifi‐
401 cate bundle to use to verify client certificates on incoming requests
402 before trusting usernames in headers specified by --requestheader-user‐
403 name-headers. WARNING generally do not depend on authorization
404 being already done for incoming requests.
405
406
407 --requestheader-extra-headers-prefix strings List of request header prefixes to inspect. X-Remote-Extra- is suggested.
408 --requestheader-group-headers strings List of request headers to inspect for groups. X-Remote-Group is suggested.
409 --requestheader-username-headers strings List of request headers to inspect for usernames. X-Remote-User is common.
410 --runtime-config mapStringString A set of key=value pairs that describe runtime configuration that may be passed to apiserver. <group>/<version> (or <version> for the core group) key can be used to turn on/off specific api versions. api/all is special key to control all api versions, be careful setting it false, unless you know what you do. api/legacy is deprecated, we will remove it in the future, so stop using it.
411 --secure-port int The port on which to serve HTTPS with authentication and authorization.It cannot be switched off with 0. (default 6443)
412 --service-account-issuer string Identifier of the service account token issuer. The issuer will assert this identifier in "iss" claim of issued tokens. This value is a string or URI.
413 --service-account-key-file stringArray File containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. The specified file can contain multiple keys, and the flag can be specified multiple times with different files. If unspecified, --tls-private-key-file is used. Must be specified when --service-account-signing-key is provided
414 --service-account-lookup If true, validate ServiceAccount tokens exist in etcd as part of authentication. (default true)
415 --service-account-max-token-expiration duration The maximum validity duration of a token created by the service account token issuer. If an otherwise valid TokenRequest with a validity duration larger than this value is requested, a token will be issued with a validity duration of this value.
416 --service-account-signing-key-file string Path to the file that contains the current private key of the service account token issuer. The issuer will sign issued ID tokens with this private key. (Requires the 'TokenRequest' feature gate.)
417 --service-cluster-ip-range ipNet A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods. (default 10.0.0.0/24)
418
419
420
421 --service-node-port-range portRange A port range
422 to reserve for services with NodePort visibility. Example
423 '30000-32767'. Inclusive at both ends of the range. (default
424 30000-32767)
425
426
427 --skip-headers If true, avoid header prefixes in the log messages
428 --skip-log-headers If true, avoid headers when opening log files
429 --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
430
431
432
433 --storage-backend string The storage
434 backend for persistence. Options 'etcd3' (default).
435
436
437 --storage-media-type string The media type to use to store objects in storage. Some resources or storage backends may only support a specific media type and will ignore this setting. (default "application/vnd.kubernetes.protobuf")
438 --target-ram-mb int Memory limit for apiserver in MB (used to configure sizes of caches, etc.)
439 --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.
440
441
442
443 --tls-cipher-suites strings Comma-sepa‐
444 rated list of cipher suites for the server. If omitted, the default Go
445 cipher suites will be use. Possible values
446 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,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_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,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_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
447
448
449 --tls-min-version string Minimum TLS
450 version supported. Possible values VersionTLS10, VersionTLS11,
451 VersionTLS12, VersionTLS13
452
453
454 --tls-private-key-file string File containing the default x509 private key matching --tls-cert-file.
455
456
457
458 --tls-sni-cert-key namedCertKey A pair of
459 x509 certificate and private key file paths, optionally suffixed with a
460 list of domain patterns which are fully qualified domain names, possi‐
461 bly with prefixed wildcard segments. If no domain patterns are pro‐
462 vided, the names of the certificate are extracted. Non-wildcard matches
463 trump over wildcard matches, explicit domain patterns trump over
464 extracted names. For multiple key/certificate pairs, use the
465 --tls-sni-cert-key multiple times. Examples "example.crt,exam‐
466 ple.key" or "foo.crt,foo.key:*.foo.com,foo.com". (default [])
467
468
469 --token-auth-file string If set, the file that will be used to secure the secure port of the API server via token authentication.
470
471
472
473 -v, --v Level number
474 for the log level verbosity
475 --version version[=true] Print
476 version information and quit
477 --vmodule moduleSpec
478 comma-separated list of pattern=N settings for file-filtered logging
479 --watch-cache Enable
480 watch caching in the apiserver (default true) --watch-cache-sizes
481 strings Watch cache size settings for
482 some resources (pods, nodes, etc.), comma separated. The individual
483 setting format resource[.group]#size, where resource is lowercase
484 plural (no version), group is omitted for resources of apiVersion v1
485 (the legacy core API) and included for others, and size is a number. It
486 takes effect when watch-cache is enabled. Some resources (replication‐
487 controllers, endpoints, nodes, pods, services, apiservices.apiregistra‐
488 tion.k8s.io) have system defaults set by heuristics, others default to
489 default-watch-cache-size
490
491
492
494 /usr/bin/kube-apiserver --logtostderr=true --v=0
495 --etcd_servers=http://127.0.0.1:4001 --insecure_bind_address=127.0.0.1
496 --insecure_port=8080 --kubelet_port=10250 --service-clus‐
497 ter-ip-range=10.1.1.0/24 --allow_privileged=false
498
499
500
501Manuals User KUBERNETES(1)(kubernetes)