kube-apiserver - Man Page

Eric Paris Jan 2015

Synopsis

kube-apiserver [Options]

Description

The Kubernetes API server validates and configures data for the api objects which include pods, services, replicationcontrollers, and others. The API Server services REST operations and provides the frontend to the cluster's shared state through which all other components interact.

Options

--add_dir_header=false If true, adds the file directory to the header of the log messages

--address=127.0.0.1 The IP address on which to serve the insecure port (set to 0.0.0.0 or :: for listening in all interfaces and IP families).

--admission-control=[] Admission is divided into two phases. In the first phase, only mutating admission plugins run. In the second phase, only validating admission plugins run. The names in the below list may represent a validating plugin, a mutating plugin, or both. The order of plugins in which they are passed to this flag does not matter. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, DefaultStorageClass, DefaultTolerationSeconds, DenyServiceExternalIPs, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook.

--admission-control-config-file="" File with admission control configuration.

--advertise-address= 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.

--allow-metric-labels=[] The map from metric-label to value allow-list of this label. The key's format is ,. The value's format is ,...e.g. metric1,label1='v1,v2,v3', metric1,label2='v1,v2,v3' metric2,label1='v1,v2,v3'.

--allow-privileged=false If true, allow privileged containers. [default=false]

--alsologtostderr=false log to standard error as well as files

--anonymous-auth=true Enables anonymous requests to the secure port of the API server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.

--api-audiences=[] 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.

--apiserver-count=1 The number of apiservers running in the cluster, must be a positive number. (In use when --endpoint-reconciler-type=master-count is enabled.)

--audit-log-batch-buffer-size=10000 The size of the buffer to store events before batching and writing. Only used in batch mode.

--audit-log-batch-max-size=1 The maximum size of a batch. Only used in batch mode.

--audit-log-batch-max-wait=0s The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.

--audit-log-batch-throttle-burst=0 Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.

--audit-log-batch-throttle-enable=false Whether batching throttling is enabled. Only used in batch mode.

--audit-log-batch-throttle-qps=0 Maximum average number of batches per second. Only used in batch mode.

--audit-log-compress=false If set, the rotated log files will be compressed using gzip.

--audit-log-format="json" Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Known formats are legacy,json.

--audit-log-maxage=0 The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.

--audit-log-maxbackup=0 The maximum number of old audit log files to retain.

--audit-log-maxsize=0 The maximum size in megabytes of the audit log file before it gets rotated.

--audit-log-mode="blocking" 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.

--audit-log-path="" If set, all requests coming to the apiserver will be logged to this file.  '-' means standard out.

--audit-log-truncate-enabled=false Whether event and batch truncating is enabled.

--audit-log-truncate-max-batch-size=10485760 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.

--audit-log-truncate-max-event-size=102400 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.

--audit-log-version="audit.k8s.io/v1" API group and version used for serializing audit events written to log.

--audit-policy-file="" Path to the file that defines the audit policy configuration.

--audit-webhook-batch-buffer-size=10000 The size of the buffer to store events before batching and writing. Only used in batch mode.

--audit-webhook-batch-initial-backoff=10s The amount of time to wait before retrying the first failed request.

--audit-webhook-batch-max-size=400 The maximum size of a batch. Only used in batch mode.

--audit-webhook-batch-max-wait=30s The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.

--audit-webhook-batch-throttle-burst=15 Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.

--audit-webhook-batch-throttle-enable=true Whether batching throttling is enabled. Only used in batch mode.

--audit-webhook-batch-throttle-qps=10 Maximum average number of batches per second. Only used in batch mode.

--audit-webhook-config-file="" Path to a kubeconfig formatted file that defines the audit webhook configuration.

--audit-webhook-initial-backoff=10s The amount of time to wait before retrying the first failed request.

--audit-webhook-mode="batch" 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.

--audit-webhook-truncate-enabled=false Whether event and batch truncating is enabled.

--audit-webhook-truncate-max-batch-size=10485760 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.

--audit-webhook-truncate-max-event-size=102400 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.

--audit-webhook-version="audit.k8s.io/v1" API group and version used for serializing audit events written to webhook.

--authentication-token-webhook-cache-ttl=2m0s The duration to cache responses from the webhook token authenticator.

--authentication-token-webhook-config-file="" File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.

--authentication-token-webhook-version="v1beta1" The API version of the authentication.k8s.io TokenReview to send to and expect from the webhook.

--authorization-mode=[AlwaysAllow] Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node.

--authorization-policy-file="" File with authorization policy in json line by line format, used with --authorization-mode=ABAC, on the secure port.

--authorization-webhook-cache-authorized-ttl=5m0s The duration to cache 'authorized' responses from the webhook authorizer.

--authorization-webhook-cache-unauthorized-ttl=30s The duration to cache 'unauthorized' responses from the webhook authorizer.

--authorization-webhook-config-file="" 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.

--authorization-webhook-version="v1beta1" The API version of the authorization.k8s.io SubjectAccessReview to send to and expect from the webhook.

--azure-container-registry-config="" Path to the file containing Azure container registry configuration information.

--bind-address=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="/var/run/kubernetes" 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="" 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.

--cloud-config="" The path to the cloud provider configuration file. Empty string for no configuration file.

--cloud-provider="" The provider for cloud services. Empty string for no provider.

--cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16 CIDRs opened in GCE firewall for L7 LB traffic proxy health checks

--cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16 CIDRs opened in GCE firewall for L4 LB traffic proxy health checks

--contention-profiling=false Enable lock contention profiling, if profiling is enabled

--cors-allowed-origins=[] 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.

--default-not-ready-toleration-seconds=300 Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.

--default-unreachable-toleration-seconds=300 Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.

--default-watch-cache-size=100 Default watch cache size. If zero, watch cache will be disabled for resources that do not have a default watch size set.

--delete-collection-workers=1 Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup.

--deserialization-cache-size=0 Number of deserialized json objects to cache in memory.

--disable-admission-plugins=[] admission plugins that should be disabled although they are in the default enabled plugins list (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, Priority, DefaultTolerationSeconds, DefaultStorageClass, StorageObjectInUseProtection, PersistentVolumeClaimResize, RuntimeClass, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, DefaultStorageClass, DefaultTolerationSeconds, DenyServiceExternalIPs, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.

--disabled-metrics=[] This flag provides an escape hatch for misbehaving metrics. You must provide the fully qualified metric name in order to disable it. Disclaimer: disabling metrics is higher in precedence than showing hidden metrics.

--egress-selector-config-file="" File with apiserver egress selector configuration.

--enable-admission-plugins=[] admission plugins that should be enabled in addition to default enabled ones (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, Priority, DefaultTolerationSeconds, DefaultStorageClass, StorageObjectInUseProtection, PersistentVolumeClaimResize, RuntimeClass, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, DefaultStorageClass, DefaultTolerationSeconds, DenyServiceExternalIPs, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.

--enable-aggregator-routing=false Turns on aggregator routing requests to endpoints IP rather than cluster IP.

--enable-bootstrap-token-auth=false Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication.

--enable-garbage-collector=true Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.

--enable-logs-handler=true If true, install a /logs handler for the apiserver logs.

--enable-priority-and-fairness=true If true and the APIPriorityAndFairness feature gate is enabled, replace the max-in-flight handler with an enhanced one that queues and dispatches with priority and fairness

--enable-swagger-ui=false Enables swagger ui on the apiserver at /swagger-ui

--encryption-provider-config="" The file containing configuration for encryption providers to be used for storing secrets in etcd

--endpoint-reconciler-type="lease" Use an endpoint reconciler (master-count, lease, none)

--etcd-cafile="" SSL Certificate Authority file used to secure etcd communication.

--etcd-certfile="" SSL certification file used to secure etcd communication.

--etcd-compaction-interval=5m0s The interval of compaction requests. If 0, the compaction request from apiserver is disabled.

--etcd-count-metric-poll-period=1m0s Frequency of polling etcd for number of resources per type. 0 disables the metric collection.

--etcd-db-metric-poll-interval=30s The interval of requests to poll etcd and update metric. 0 disables the metric collection

--etcd-healthcheck-timeout=2s The timeout to use when checking etcd health.

--etcd-keyfile="" SSL key file used to secure etcd communication.

--etcd-prefix="/registry" The prefix to prepend to all resource paths in etcd.

--etcd-servers=[] List of etcd servers to connect with (scheme://ip:port), comma separated.

--etcd-servers-overrides=[] Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are URLs, semicolon separated. Note that this applies only to resources compiled into this server binary.

--event-ttl=1h0m0s Amount of time to retain events.

--experimental-encryption-provider-config="" The file containing configuration for encryption providers to be used for storing secrets in etcd

--experimental-logging-sanitization=false [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.

--external-hostname="" The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs or OpenID Discovery).

--feature-gates= 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 (BETA - default=true) APIResponseCompression=true|false (BETA - default=true) APIServerIdentity=true|false (ALPHA - default=false) AllAlpha=true|false (ALPHA - default=false) AllBeta=true|false (BETA - default=false) AnyVolumeDataSource=true|false (ALPHA - default=false) AppArmor=true|false (BETA - default=true) BalanceAttachedNodeVolumes=true|false (ALPHA - default=false) BoundServiceAccountTokenVolume=true|false (BETA - default=true) CPUManager=true|false (BETA - default=true) CSIInlineVolume=true|false (BETA - default=true) CSIMigration=true|false (BETA - default=true) CSIMigrationAWS=true|false (BETA - default=false) CSIMigrationAzureDisk=true|false (BETA - default=false) CSIMigrationAzureFile=true|false (BETA - default=false) CSIMigrationGCE=true|false (BETA - default=false) CSIMigrationOpenStack=true|false (BETA - default=true) CSIMigrationvSphere=true|false (BETA - default=false) CSIMigrationvSphereComplete=true|false (BETA - default=false) CSIServiceAccountToken=true|false (BETA - default=true) CSIStorageCapacity=true|false (BETA - default=true) CSIVolumeFSGroupPolicy=true|false (BETA - default=true) CSIVolumeHealth=true|false (ALPHA - default=false) ConfigurableFSGroupPolicy=true|false (BETA - default=true) ControllerManagerLeaderMigration=true|false (ALPHA - default=false) CronJobControllerV2=true|false (BETA - default=true) CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false) DaemonSetUpdateSurge=true|false (ALPHA - default=false) DefaultPodTopologySpread=true|false (BETA - default=true) DevicePlugins=true|false (BETA - default=true) DisableAcceleratorUsageMetrics=true|false (BETA - default=true) DownwardAPIHugePages=true|false (BETA - default=false) DynamicKubeletConfig=true|false (BETA - default=true) EfficientWatchResumption=true|false (BETA - default=true) EndpointSliceProxying=true|false (BETA - default=true) EndpointSliceTerminatingCondition=true|false (ALPHA - default=false) 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 (BETA - default=true) GracefulNodeShutdown=true|false (BETA - default=true) HPAContainerMetrics=true|false (ALPHA - default=false) HPAScaleToZero=true|false (ALPHA - default=false) HugePageStorageMediumSize=true|false (BETA - default=true) IPv6DualStack=true|false (BETA - default=true) InTreePluginAWSUnregister=true|false (ALPHA - default=false) InTreePluginAzureDiskUnregister=true|false (ALPHA - default=false) InTreePluginAzureFileUnregister=true|false (ALPHA - default=false) InTreePluginGCEUnregister=true|false (ALPHA - default=false) InTreePluginOpenStackUnregister=true|false (ALPHA - default=false) InTreePluginvSphereUnregister=true|false (ALPHA - default=false) IndexedJob=true|false (ALPHA - default=false) IngressClassNamespacedParams=true|false (ALPHA - default=false) KubeletCredentialProviders=true|false (ALPHA - default=false) KubeletPodResources=true|false (BETA - default=true) KubeletPodResourcesGetAllocatable=true|false (ALPHA - default=false) LocalStorageCapacityIsolation=true|false (BETA - default=true) LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false) LogarithmicScaleDown=true|false (ALPHA - default=false) MemoryManager=true|false (ALPHA - default=false) MixedProtocolLBService=true|false (ALPHA - default=false) NamespaceDefaultLabelName=true|false (BETA - default=true) NetworkPolicyEndPort=true|false (ALPHA - default=false) NonPreemptingPriority=true|false (BETA - default=true) PodAffinityNamespaceSelector=true|false (ALPHA - default=false) PodDeletionCost=true|false (ALPHA - default=false) PodOverhead=true|false (BETA - default=true) PreferNominatedNode=true|false (ALPHA - default=false) ProbeTerminationGracePeriod=true|false (ALPHA - default=false) ProcMountType=true|false (ALPHA - default=false) QOSReserved=true|false (ALPHA - default=false) RemainingItemCount=true|false (BETA - default=true) RemoveSelfLink=true|false (BETA - default=true) RotateKubeletServerCertificate=true|false (BETA - default=true) ServerSideApply=true|false (BETA - default=true) ServiceInternalTrafficPolicy=true|false (ALPHA - default=false) ServiceLBNodePortControl=true|false (ALPHA - default=false) ServiceLoadBalancerClass=true|false (ALPHA - default=false) ServiceTopology=true|false (ALPHA - default=false) SetHostnameAsFQDN=true|false (BETA - default=true) SizeMemoryBackedVolumes=true|false (ALPHA - default=false) StorageVersionAPI=true|false (ALPHA - default=false) StorageVersionHash=true|false (BETA - default=true) SuspendJob=true|false (ALPHA - default=false) TTLAfterFinished=true|false (BETA - default=true) TopologyAwareHints=true|false (ALPHA - default=false) TopologyManager=true|false (BETA - default=true) ValidateProxyRedirects=true|false (BETA - default=true) VolumeCapacityPriority=true|false (ALPHA - default=false) WarningHeaders=true|false (BETA - default=true) WinDSR=true|false (ALPHA - default=false) WinOverlay=true|false (BETA - default=true) WindowsEndpointSliceProxying=true|false (BETA - default=true)

--goaway-chance=0 To prevent HTTP/2 clients from getting stuck on a single apiserver, randomly close a connection (GOAWAY). The client's other in-flight requests won't be affected, and the client will reconnect, likely landing on a different apiserver after going through the load balancer again. This argument sets the fraction of requests that will be sent a GOAWAY. Clusters with single apiservers, or which don't use a load balancer, should NOT enable this. Min is 0 (off), Max is .02 (1/50 requests); .001 (1/1000) is a recommended starting point.

-h, --help=false help for kube-apiserver

--http2-max-streams-per-connection=0 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.

--identity-lease-duration-seconds=3600 The duration of kube-apiserver lease in seconds, must be a positive number. (In use when the APIServerIdentity feature gate is enabled.)

--identity-lease-renew-interval-seconds=10 The interval of kube-apiserver renewing its lease in seconds, must be a positive number. (In use when the APIServerIdentity feature gate is enabled.)

--insecure-bind-address=127.0.0.1 The IP address on which to serve the insecure port (set to 0.0.0.0 or :: for listening in all interfaces and IP families).

--insecure-port=0 The port on which to serve unsecured, unauthenticated access.

--kubelet-certificate-authority="" Path to a cert file for the certificate authority.

--kubelet-client-certificate="" Path to a client cert file for TLS.

--kubelet-client-key="" Path to a client key file for TLS.

--kubelet-https=true Use https for kubelet connections.

--kubelet-port=10250 DEPRECATED: kubelet port.

--kubelet-preferred-address-types=[Hostname,InternalDNS,InternalIP,ExternalDNS,ExternalIP] List of the preferred NodeAddressTypes to use for kubelet connections.

--kubelet-read-only-port=10255 DEPRECATED: kubelet read only port.

--kubelet-timeout=5s Timeout for kubelet operations.

--kubernetes-service-node-port=0 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.

--lease-reuse-duration-seconds=60 The time in seconds that each lease is reused. A lower value could avoid large number of objects reusing the same lease. Notice that a too small value may cause performance problems at storage layer.

--livez-grace-period=0s This option represents the maximum amount of time it should take for apiserver to complete its startup sequence and become live. From apiserver's start time to when this amount of time has elapsed, /livez will assume that unfinished post-start hooks will complete successfully and therefore return true.

--log-flush-frequency=5s Maximum number of seconds between log flushes

--log_backtrace_at=:0 when logging hits line file:N, emit a stack trace

--log_dir="" If non-empty, write log files in this directory

--log_file="" If non-empty, use this log file

--log_file_max_size=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.

--logging-format="text" Sets the log format. Permitted formats: "json", "text". Non-default formats don't honor these flags: --add_dir_header, --alsologtostderr, --log_backtrace_at, --log_dir, --log_file, --log_file_max_size, --logtostderr, --one_output, --skip_headers, --skip_log_headers, --stderrthreshold, --vmodule, --log-flush-frequency. Non-default choices are currently alpha and subject to change without warning.

--logtostderr=true log to standard error instead of files

--master-service-namespace="default" DEPRECATED: the namespace from which the Kubernetes master services should be injected into pods.

--max-connection-bytes-per-sec=0 If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.

--max-mutating-requests-inflight=200 The maximum number of mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.

--max-requests-inflight=400 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.

--min-request-timeout=1800 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.

--oidc-ca-file="" 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.

--oidc-client-id="" The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.

--oidc-groups-claim="" 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.

--oidc-groups-prefix="" If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.

--oidc-issuer-url="" 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).

--oidc-required-claim= 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.

--oidc-signing-algs=[RS256] Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1.

--oidc-username-claim="sub" 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.

--oidc-username-prefix="" 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 '-'.

--one_output=false If true, only write logs to their native severity level (vs also writing to each lower severity level)

--permit-address-sharing=false If true, SO_REUSEADDR will be used when binding the port. This allows binding to wildcard IPs like 0.0.0.0 and specific IPs in parallel, and it avoids waiting for the kernel to release sockets in TIME_WAIT state. [default=false]

--permit-port-sharing=false 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]

--port=0 The port on which to serve unsecured, unauthenticated access.

--profiling=true Enable profiling via web interface host:port/debug/pprof/

--proxy-client-cert-file="" 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.

--proxy-client-key-file="" 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.

--request-timeout=1m0s 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.

--requestheader-allowed-names=[] 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="" 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=[] List of request header prefixes to inspect. X-Remote-Extra- is suggested.

--requestheader-group-headers=[] List of request headers to inspect for groups. X-Remote-Group is suggested.

--requestheader-username-headers=[] List of request headers to inspect for usernames. X-Remote-User is common.

--runtime-config= A set of key=value pairs that enable or disable built-in APIs. Supported options are: v1=true|false for the core API group /=true|false for a specific API group and version (e.g. apps/v1=true) api/all=true|false controls all API versions api/ga=true|false controls all API versions of the form v[0-9]+ api/beta=true|false controls all API versions of the form v[0-9]+beta[0-9]+ api/alpha=true|false controls all API versions of the form v[0-9]+alpha[0-9]+ api/legacy is deprecated, and will be removed in a future version

--secure-port=6443 The port on which to serve HTTPS with authentication and authorization. It cannot be switched off with 0.

--service-account-api-audiences=[] 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.

--service-account-extend-token-expiration=true Turns on projected service account expiration extension during token generation, which helps safe transition from legacy token to bound service account token feature. If this flag is enabled, admission injected tokens would be extended up to 1 year to prevent unexpected failure during transition, ignoring value of service-account-max-token-expiration.

--service-account-issuer="" 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. If this option is not a valid URI per the OpenID Discovery 1.0 spec, the ServiceAccountIssuerDiscovery feature will remain disabled, even if the feature gate is set to true. It is highly recommended that this value comply with the OpenID spec: https://openid.net/specs/openid-connect-discovery-1_0.html. In practice, this means that service-account-issuer must be an https URL. It is also highly recommended that this URL be capable of serving OpenID discovery documents at {service-account-issuer}/.well-known/openid-configuration.

--service-account-jwks-uri="" Overrides the URI for the JSON Web Key Set in the discovery doc served at /.well-known/openid-configuration. This flag is useful if the discovery docand key set are served to relying parties from a URL other than the API server's external (as auto-detected or overridden with external-hostname). Only valid if the ServiceAccountIssuerDiscovery feature gate is enabled.

--service-account-key-file=[] 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

--service-account-lookup=true If true, validate ServiceAccount tokens exist in etcd as part of authentication.

--service-account-max-token-expiration=0s 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.

--service-account-signing-key-file="" 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.

--service-cluster-ip-range="" A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes or pods. Max of two dual-stack CIDRs is allowed.

--service-node-port-range=30000-32767 A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range.

--show-hidden-metrics-for-version="" 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 ., 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.

--shutdown-delay-duration=0s Time to delay the termination. During that time the server keeps serving requests normally. The endpoints /healthz and /livez will return success, but /readyz immediately returns failure. Graceful termination starts after this delay has elapsed. This can be used to allow load balancer to stop sending traffic to this server.

--skip_headers=false If true, avoid header prefixes in the log messages

--skip_log_headers=false If true, avoid headers when opening log files

--ssh-keyfile="" If non-empty, use secure SSH proxy to the nodes, using this user keyfile

--ssh-user="" If non-empty, use secure SSH proxy to the nodes, using this user name

--stderrthreshold=2 logs at or above this threshold go to stderr

--storage-backend="" The storage backend for persistence. Options: 'etcd3' (default).

--storage-media-type="application/vnd.kubernetes.protobuf" 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.

--strict-transport-security-directives=[] List of directives for HSTS, comma separated. If this list is empty, then HSTS directives will not be added. Example: 'max-age=31536000,includeSubDomains,preload'

--target-ram-mb=0 DEPRECATED: Memory limit for apiserver in MB (used to configure sizes of caches, etc.)

--tls-cert-file="" 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=[] 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="" Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

--tls-private-key-file="" File containing the default x509 private key matching --tls-cert-file.

--tls-sni-cert-key=[] 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".

--token-auth-file="" If set, the file that will be used to secure the secure port of the API server via token authentication.

-v, --v=0 number for the log level verbosity

--version=false Print version information and quit

--vmodule= comma-separated list of pattern=N settings for file-filtered logging

--watch-cache=true Enable watch caching in the apiserver

--watch-cache-sizes=[] Watch cache size settings for some resources (pods, nodes, etc.), comma separated. The individual setting format: resource[.group]#size, where resource is lowercase plural (no version), group is omitted for resources of apiVersion v1 (the legacy core API) and included for others, and size is a number. It takes effect when watch-cache is enabled. Some resources (replicationcontrollers, endpoints, nodes, pods, services, apiservices.apiregistration.k8s.io) have system defaults set by heuristics, others default to default-watch-cache-size

History

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

Info

User Manuals