kube-apiserver man page

kube-apiserver — Provides the API for kubernetes orchestration.

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.

kube-apiserver

Options

--admission-control stringSlice                           Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of

AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, GenericAdmissionWebhook, ImagePolicyWebhook, InitialResources, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount. (default [AlwaysAdmit])

  --admission-control-config-file string                    File with admission control configuration.
  --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.
  --allow-privileged                                        If true, allow privileged containers. [default=false]
--anonymous-auth                                          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. (default true)

  --apiserver-count int                                     The number of apiservers running in the cluster, must be a positive number. (default 1)
  --audit-log-format string                                 Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Requires the 'AdvancedAuditing' feature gate. Known formats are legacy,json. (default "json")
  --audit-log-maxage int                                    The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
  --audit-log-maxbackup int                                 The maximum number of old audit log files to retain.
  --audit-log-maxsize int                                   The maximum size in megabytes of the audit log file before it gets rotated.
  --audit-log-path string                                   If set, all requests coming to the apiserver will be logged to this file.  '-' means standard out.
  --audit-policy-file string                                Path to the file that defines the audit policy configuration. Requires the 'AdvancedAuditing' feature gate. With AdvancedAuditing, a profile is required to enable auditing.
  --audit-webhook-config-file string                        Path to a kubeconfig formatted file that defines the audit webhook configuration. Requires the 'AdvancedAuditing' feature gate.
  --audit-webhook-mode string                               Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the webhook to buffer and send events asynchronously. Known modes are batch,blocking. (default "batch")
  --authentication-token-webhook-cache-ttl duration         The duration to cache responses from the webhook token authenticator. (default 2m0s)
  --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.
--authorization-mode string                               Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of

AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node. (default "AlwaysAllow")

  --authorization-policy-file string                        File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port.
  --authorization-webhook-cache-authorized-ttl duration     The duration to cache 'authorized' responses from the webhook authorizer. (default 5m0s)
  --authorization-webhook-cache-unauthorized-ttl duration   The duration to cache 'unauthorized' responses from the webhook authorizer. (default 30s)
  --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.
  --azure-container-registry-config string                  Path to the file container Azure container registry configuration information.
  --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.
  --bind-address ip                                         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, all interfaces will be used (0.0.0.0). (default 0.0.0.0)
  --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")
  --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.
  --cloud-config string                                     The path to the cloud provider configuration file. Empty string for no configuration file.
  --cloud-provider string                                   The provider for cloud services. Empty string for no provider.
  --contention-profiling                                    Enable lock contention profiling, if profiling is enabled
  --cors-allowed-origins stringSlice                        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-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)
  --delete-collection-workers int                           Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1)
  --deserialization-cache-size int                          Number of deserialized json objects to cache in memory.
  --enable-aggregator-routing                               Turns on aggregator routing requests to endoints IP rather than cluster IP.
  --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.
  --enable-garbage-collector                                Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. (default true)
  --enable-logs-handler                                     If true, install a /logs handler for the apiserver logs. (default true)
  --enable-swagger-ui                                       Enables swagger ui on the apiserver at /swagger-ui
  --etcd-cafile string                                      SSL Certificate Authority file used to secure etcd communication.
  --etcd-certfile string                                    SSL certification file used to secure etcd communication.
  --etcd-keyfile string                                     SSL key file used to secure etcd communication.
  --etcd-prefix string                                      The prefix to prepend to all resource paths in etcd. (default "/registry")
  --etcd-quorum-read                                        If true, enable quorum read.
--etcd-servers stringSlice                                List of etcd servers to connect with (scheme

//ip:port), comma separated.

--etcd-servers-overrides stringSlice                      Per-resource etcd servers overrides, comma separated. The individual override format

group/resource#servers, where servers are  ⟨http://ip:port⟩, semicolon separated.

  --event-ttl duration                                      Amount of time to retain events. (default 1h0m0s)
  --experimental-encryption-provider-config string          The file containing configuration for encryption providers to be used for storing secrets in etcd
  --experimental-keystone-ca-file string                    If set, the Keystone server's certificate will be verified by one of the authorities in the experimental-keystone-ca-file, otherwise the host's root CA set will be used.
  --experimental-keystone-url string                        If passed, activates the keystone authentication plugin.
  --external-hostname string                                The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).
--feature-gates mapStringBool                             A set of key=value pairs that describe feature gates for alpha/experimental features. Options are
APIListChunking=true|false (ALPHA - default=false) APIResponseCompression=true|false (ALPHA - default=false) Accelerators=true|false (ALPHA - default=false) AdvancedAuditing=true|false (BETA - default=true) AllAlpha=true|false (ALPHA - default=false) AllowExtTrafficLocalEndpoints=true|false (default=true) AppArmor=true|false (BETA - default=true) CPUManager=true|false (ALPHA - default=false) CustomResourceValidation=true|false (ALPHA - default=false) DebugContainers=true|false (ALPHA - default=false) DevicePlugins=true|false (ALPHA - default=false) DynamicKubeletConfig=true|false (ALPHA - default=false) EnableEquivalenceClassCache=true|false (ALPHA - default=false) ExpandPersistentVolumes=true|false (ALPHA - default=false) ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false) ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false) HugePages=true|false (ALPHA - default=false) Initializers=true|false (ALPHA - default=false) KubeletConfigFile=true|false (ALPHA - default=false) LocalStorageCapacityIsolation=true|false (ALPHA - default=false) MountPropagation=true|false (ALPHA - default=false) PersistentLocalVolumes=true|false (ALPHA - default=false) PodPriority=true|false (ALPHA - default=false) RotateKubeletClientCertificate=true|false (BETA - default=true) RotateKubeletServerCertificate=true|false (ALPHA - default=false) StreamingProxyRedirects=true|false (BETA - default=true) SupportIPVSProxyMode=true|false (ALPHA - default=false) TaintBasedEvictions=true|false (ALPHA - default=false) TaintNodesByCondition=true|false (ALPHA - default=false)
     --google-json-key string                                  The Google Cloud Platform Service Account JSON Key to use for authentication.
     --insecure-bind-address ip                                The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). (default 127.0.0.1)
     --insecure-port int                                       The port on which to serve unsecured, unauthenticated access. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup. (default 8080)
     --kubelet-certificate-authority string                    Path to a cert file for the certificate authority.
     --kubelet-client-certificate string                       Path to a client cert file for TLS.
     --kubelet-client-key string                               Path to a client key file for TLS.
     --kubelet-https                                           Use https for kubelet connections. (default true)
     --kubelet-preferred-address-types stringSlice             List of the preferred NodeAddressTypes to use for kubelet connections. (default [Hostname,InternalDNS,InternalIP,ExternalDNS,ExternalIP]) --kubelet-read-only-port uint                             DEPRECATED
    kubelet port. (default 10255)
  --kubelet-timeout duration                                Timeout for kubelet operations. (default 5s)
  --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.
--master-service-namespace string                         DEPRECATED

the namespace from which the kubernetes master services should be injected into pods. (default "default")

  --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.
  --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)
  --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)
  --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)
  --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.
  --oidc-client-id string                                   The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
  --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.
  --oidc-groups-prefix string                               If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.
  --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).
  --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")
  --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 '-'.
--profiling                                               Enable profiling via web interface host

port/debug/pprof/ (default true)

  --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 recieving calls from kube-aggregator should use that CA to perform their half of the mutual TLS verification.
  --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.
  --repair-malformed-updates                                If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates. (default true)
  --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)
  --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
  --requestheader-extra-headers-prefix stringSlice          List of request header prefixes to inspect. X-Remote-Extra- is suggested.
  --requestheader-group-headers stringSlice                 List of request headers to inspect for groups. X-Remote-Group is suggested.
  --requestheader-username-headers stringSlice              List of request headers to inspect for usernames. X-Remote-User is common.
  --runtime-config mapStringString                          A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/<groupVersion> key can be used to turn on/off specific api versions. apis/<groupVersion>/<resource> can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.
  --secure-port int                                         The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. (default 6443)
  --service-account-key-file stringArray                    File containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used. The specified file can contain multiple keys, and the flag can be specified multiple times with different files.
  --service-account-lookup                                  If true, validate ServiceAccount tokens exist in etcd as part of authentication. (default true)
  --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.
--service-node-port-range portRange                       A port range to reserve for services with NodePort visibility. Example

'30000-32767'. Inclusive at both ends of the range. (default 30000-32767)

  --ssh-keyfile string                                      If non-empty, use secure SSH proxy to the nodes, using this user keyfile
  --ssh-user string                                         If non-empty, use secure SSH proxy to the nodes, using this user name
--storage-backend string                                  The storage backend for persistence. Options

'etcd3' (default), 'etcd2'.

  --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")
  --storage-versions string                                 The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "admission.k8s.io/v1alpha1,admissionregistration.k8s.io/v1alpha1,apps/v1beta1,authentication.k8s.io/v1,authorization.k8s.io/v1,autoscaling/v1,batch/v1,certificates.k8s.io/v1beta1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1beta1,imagepolicy.k8s.io/v1alpha1,networking.k8s.io/v1,policy/v1beta1,rbac.authorization.k8s.io/v1beta1,scheduling.k8s.io/v1alpha1,settings.k8s.io/v1alpha1,storage.k8s.io/v1,v1")
  --target-ram-mb int                                       Memory limit for apiserver in MB (used to configure sizes of caches, etc.)
  --tls-ca-file string                                      If set, this certificate authority will used for secure access from Admission Controllers. This must be a valid PEM-encoded CA bundle. Altneratively, the certificate authority can be appended to the certificate provided by --tls-cert-file.
  --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 /var/run/kubernetes.
  --tls-private-key-file string                             File containing the default x509 private key matching --tls-cert-file.
--tls-sni-cert-key namedCertKey                           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. 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". (default [])

  --token-auth-file string                                  If set, the file that will be used to secure the secure port of the API server via token authentication.
  --version version[=true]                                  Print version information and quit
  --watch-cache                                             Enable watch caching in the apiserver (default true)
--watch-cache-sizes stringSlice                           List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format

resource#size, where size is a number. It takes effect when watch-cache is enabled.

Examples

/usr/bin/kube-apiserver --logtostderr=true --v=0 --etcd_servers= ⟨http://127.0.0.1:4001⟩ --insecure_bind_address=127.0.0.1 --insecure_port=8080 --kubelet_port=10250 --service-cluster-ip-range=10.1.1.0/24 --allow_privileged=false

Info

kubernetes User Manuals