kube-controller-manager
Synopsis
The Kubernetes controller manager is a daemon that embeds the core control loops shipped with Kubernetes. In applications of robotics and automation, a control loop is a non-terminating loop that regulates the state of the system. In Kubernetes, a controller is a control loop that watches the shared state of the cluster through the apiserver and makes changes attempting to move the current state towards the desired state. Examples of controllers that ship with Kubernetes today are the replication controller, endpoints controller, namespace controller, and serviceaccounts controller.
kube-controller-manager [flags]
Options
| --allocate-node-cidrs | |
Should CIDRs for Pods be allocated and set on the cloud provider. |
|
| --allow-metric-labels stringToString Default: [] | |
The map from metric-label to value allow-list of this label. The key's format is <MetricName>,<LabelName>. The value's format is <allowed_value>,<allowed_value>...e.g. metric1,label1='v1,v2,v3', metric1,label2='v1,v2,v3' metric2,label1='v1,v2,v3'. |
|
| --attach-detach-reconcile-sync-period duration Default: 1m0s | |
The reconciler sync wait time between volume attach detach. This duration must be larger than one second, and increasing this value from the default may allow for volumes to be mismatched with pods. |
|
| --authentication-kubeconfig string | |
kubeconfig file pointing at the 'core' kubernetes server with enough rights to create tokenreviews.authentication.k8s.io. This is optional. If empty, all token requests are considered to be anonymous and no client CA is looked up in the cluster. |
|
| --authentication-skip-lookup | |
If false, the authentication-kubeconfig will be used to lookup missing authentication configuration from the cluster. |
|
| --authentication-token-webhook-cache-ttl duration Default: 10s | |
The duration to cache responses from the webhook token authenticator. |
|
| --authentication-tolerate-lookup-failure | |
If true, failures to look up missing authentication configuration from the cluster are not considered fatal. Note that this can result in authentication that treats all requests as anonymous. |
|
| --authorization-always-allow-paths strings Default: "/healthz,/readyz,/livez" | |
A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server. |
|
| --authorization-kubeconfig string | |
kubeconfig file pointing at the 'core' kubernetes server with enough rights to create subjectaccessreviews.authorization.k8s.io. This is optional. If empty, all requests not skipped by authorization are forbidden. |
|
| --authorization-webhook-cache-authorized-ttl duration Default: 10s | |
The duration to cache 'authorized' responses from the webhook authorizer. |
|
| --authorization-webhook-cache-unauthorized-ttl duration Default: 10s | |
The duration to cache 'unauthorized' responses from the webhook authorizer. |
|
| --azure-container-registry-config string | |
Path to the file containing Azure container registry configuration information. |
|
| --bind-address string Default: 0.0.0.0 | |
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces will be used. |
|
| --cert-dir string | |
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. |
|
| --cidr-allocator-type string Default: "RangeAllocator" | |
Type of CIDR allocator to use |
|
| --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. |
|
| --cluster-cidr string | |
CIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be true |
|
| --cluster-name string Default: "kubernetes" | |
The instance prefix for the cluster. |
|
| --cluster-signing-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificates. If specified, no more specific --cluster-signing-* flag may be specified. |
|
| --cluster-signing-duration duration Default: 8760h0m0s | |
The max length of duration signed certificates will be given. Individual CSRs may request shorter certs by setting spec.expirationSeconds. |
|
| --cluster-signing-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificates. If specified, no more specific --cluster-signing-* flag may be specified. |
|
| --cluster-signing-kube-apiserver-client-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/kube-apiserver-client signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --cluster-signing-kube-apiserver-client-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/kube-apiserver-client signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --cluster-signing-kubelet-client-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/kube-apiserver-client-kubelet signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --cluster-signing-kubelet-client-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/kube-apiserver-client-kubelet signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --cluster-signing-kubelet-serving-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/kubelet-serving signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --cluster-signing-kubelet-serving-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/kubelet-serving signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --cluster-signing-legacy-unknown-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/legacy-unknown signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --cluster-signing-legacy-unknown-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/legacy-unknown signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
| --concurrent-deployment-syncs int32 Default: 5 | |
The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load |
|
| --concurrent-endpoint-syncs int32 Default: 5 | |
The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load |
|
| --concurrent-ephemeralvolume-syncs int32 Default: 5 | |
The number of ephemeral volume syncing operations that will be done concurrently. Larger number = faster ephemeral volume updating, but more CPU (and network) load |
|
| --concurrent-gc-syncs int32 Default: 20 | |
The number of garbage collector workers that are allowed to sync concurrently. |
|
| --concurrent-namespace-syncs int32 Default: 10 | |
The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load |
|
| --concurrent-rc-syncs int32 Default: 5 | |
The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load |
|
| --concurrent-replicaset-syncs int32 Default: 5 | |
The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load |
|
| --concurrent-resource-quota-syncs int32 Default: 5 | |
The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load |
|
| --concurrent-service-endpoint-syncs int32 Default: 5 | |
The number of service endpoint syncing operations that will be done concurrently. Larger number = faster endpoint slice updating, but more CPU (and network) load. Defaults to 5. |
|
| --concurrent-service-syncs int32 Default: 1 | |
The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load |
|
| --concurrent-serviceaccount-token-syncs int32 Default: 5 | |
The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load |
|
| --concurrent-statefulset-syncs int32 Default: 5 | |
The number of statefulset objects that are allowed to sync concurrently. Larger number = more responsive statefulsets, but more CPU (and network) load |
|
| --concurrent-ttl-after-finished-syncs int32 Default: 5 | |
The number of TTL-after-finished controller workers that are allowed to sync concurrently. |
|
| --configure-cloud-routes Default: true | |
Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. |
|
| --contention-profiling | |
Enable lock contention profiling, if profiling is enabled |
|
| --controller-start-interval duration | |
Interval between starting controller managers. |
|
| --controllers strings Default: "*" | |
A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'. |
|
| --disable-attach-detach-reconcile-sync | |
Disable volume attach detach reconciler sync. Disabling this may cause volumes to be mismatched with pods. Use wisely. |
|
| --disabled-metrics strings | |
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. |
|
| --enable-dynamic-provisioning Default: true | |
Enable dynamic provisioning for environments that support it. |
|
| --enable-garbage-collector Default: true | |
Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver. |
|
| --enable-hostpath-provisioner | |
Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development. |
|
| --enable-leader-migration | |
Whether to enable controller leader migration. |
|
| --enable-taint-manager Default: true | |
WARNING: Beta feature. If set to true enables NoExecute Taints and will evict all not-tolerating Pod running on Nodes tainted with this kind of Taints. |
|
| --endpoint-updates-batch-period duration | |
The length of endpoint updates batching period. Processing of pod changes will be delayed by this duration to join them with potential upcoming updates and reduce the overall number of endpoints updates. Larger number = higher endpoint programming latency, but lower number of endpoints revision generated |
|
| --endpointslice-updates-batch-period duration | |
The length of endpoint slice updates batching period. Processing of pod changes will be delayed by this duration to join them with potential upcoming updates and reduce the overall number of endpoints updates. Larger number = higher endpoint programming latency, but lower number of endpoints revision generated |
|
| --external-cloud-volume-plugin string | |
The plugin to use when cloud provider is set to external. Can be empty, should only be set when cloud-provider is external. Currently used to allow node and volume controllers to work for in tree cloud providers. |
|
| --feature-gates <comma-separated 'key=True|False' pairs> | |
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: |
|
| --flex-volume-plugin-dir string Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/" | |
Full path of the directory in which the flex volume plugin should search for additional third party volume plugins. |
|
| -h, --help | |
help for kube-controller-manager |
|
| --horizontal-pod-autoscaler-cpu-initialization-period duration Default: 5m0s | |
The period after pod start when CPU samples might be skipped. |
|
| --horizontal-pod-autoscaler-downscale-stabilization duration Default: 5m0s | |
The period for which autoscaler will look backwards and not scale down below any recommendation it made during that period. |
|
| --horizontal-pod-autoscaler-initial-readiness-delay duration Default: 30s | |
The period after pod start during which readiness changes will be treated as initial readiness. |
|
| --horizontal-pod-autoscaler-sync-period duration Default: 15s | |
The period for syncing the number of pods in horizontal pod autoscaler. |
|
| --horizontal-pod-autoscaler-tolerance float Default: 0.1 | |
The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling. |
|
| --http2-max-streams-per-connection int | |
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default. |
|
| --kube-api-burst int32 Default: 30 | |
Burst to use while talking with kubernetes apiserver. |
|
| --kube-api-content-type string Default: "application/vnd.kubernetes.protobuf" | |
Content type of requests sent to apiserver. |
|
| --kube-api-qps float Default: 20 | |
QPS to use while talking with kubernetes apiserver. |
|
| --kubeconfig string | |
Path to kubeconfig file with authorization and master location information. |
|
| --large-cluster-size-threshold int32 Default: 50 | |
Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller. |
|
| --leader-elect Default: true | |
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. |
|
| --leader-elect-lease-duration duration Default: 15s | |
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. |
|
| --leader-elect-renew-deadline duration Default: 10s | |
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. |
|
| --leader-elect-resource-lock string Default: "leases" | |
The type of resource object that is used for locking during leader election. Supported options are 'leases', 'endpointsleases' and 'configmapsleases'. |
|
| --leader-elect-resource-name string Default: "kube-controller-manager" | |
The name of resource object that is used for locking during leader election. |
|
| --leader-elect-resource-namespace string Default: "kube-system" | |
The namespace of resource object that is used for locking during leader election. |
|
| --leader-elect-retry-period duration Default: 2s | |
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. |
|
| --leader-migration-config string | |
Path to the config file for controller leader migration, or empty to use the value that reflects default configuration of the controller manager. The config file should be of type LeaderMigrationConfiguration, group controllermanager.config.k8s.io, version v1alpha1. |
|
| --log-flush-frequency duration Default: 5s | |
Maximum number of seconds between log flushes |
|
| --logging-format string Default: "text" | |
Sets the log format. Permitted formats: "text". |
|
| --master string | |
The address of the Kubernetes API server (overrides any value in kubeconfig). |
|
| --max-endpoints-per-slice int32 Default: 100 | |
The maximum number of endpoints that will be added to an EndpointSlice. More endpoints per slice will result in less endpoint slices, but larger resources. Defaults to 100. |
|
| --min-resync-period duration Default: 12h0m0s | |
The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod. |
|
| --mirroring-concurrent-service-endpoint-syncs int32 Default: 5 | |
The number of service endpoint syncing operations that will be done concurrently by the EndpointSliceMirroring controller. Larger number = faster endpoint slice updating, but more CPU (and network) load. Defaults to 5. |
|
| --mirroring-endpointslice-updates-batch-period duration | |
The length of EndpointSlice updates batching period for EndpointSliceMirroring controller. Processing of EndpointSlice changes will be delayed by this duration to join them with potential upcoming updates and reduce the overall number of EndpointSlice updates. Larger number = higher endpoint programming latency, but lower number of endpoints revision generated |
|
| --mirroring-max-endpoints-per-subset int32 Default: 1000 | |
The maximum number of endpoints that will be added to an EndpointSlice by the EndpointSliceMirroring controller. More endpoints per slice will result in less endpoint slices, but larger resources. Defaults to 100. |
|
| --namespace-sync-period duration Default: 5m0s | |
The period for syncing namespace life-cycle updates |
|
| --node-cidr-mask-size int32 | |
Mask size for node cidr in cluster. Default is 24 for IPv4 and 64 for IPv6. |
|
| --node-cidr-mask-size-ipv4 int32 | |
Mask size for IPv4 node cidr in dual-stack cluster. Default is 24. |
|
| --node-cidr-mask-size-ipv6 int32 | |
Mask size for IPv6 node cidr in dual-stack cluster. Default is 64. |
|
| --node-eviction-rate float Default: 0.1 | |
Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. |
|
| --node-monitor-grace-period duration Default: 40s | |
Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status. |
|
| --node-monitor-period duration Default: 5s | |
The period for syncing NodeStatus in NodeController. |
|
| --node-startup-grace-period duration Default: 1m0s | |
Amount of time which we allow starting Node to be unresponsive before marking it unhealthy. |
|
| --permit-address-sharing | |
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 | |
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] |
|
| --pod-eviction-timeout duration Default: 5m0s | |
The grace period for deleting pods on failed nodes. |
|
| --profiling Default: true | |
Enable profiling via web interface host:port/debug/pprof/ |
|
| --pv-recycler-increment-timeout-nfs int32 Default: 30 | |
the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod |
|
| --pv-recycler-minimum-timeout-hostpath int32 Default: 60 | |
The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster. |
|
| --pv-recycler-minimum-timeout-nfs int32 Default: 300 | |
The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod |
|
| --pv-recycler-pod-template-filepath-hostpath string | |
The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster. |
|
| --pv-recycler-pod-template-filepath-nfs string | |
The file path to a pod definition used as a template for NFS persistent volume recycling |
|
| --pv-recycler-timeout-increment-hostpath int32 Default: 30 | |
the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster. |
|
| --pvclaimbinder-sync-period duration Default: 15s | |
The period for syncing persistent volumes and persistent volume claims |
|
| --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. |
|
| --requestheader-client-ca-file string | |
Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers. WARNING: generally do not depend on authorization being already done for incoming requests. |
|
| --requestheader-extra-headers-prefix strings Default: "x-remote-extra-" | |
List of request header prefixes to inspect. X-Remote-Extra- is suggested. |
|
| --requestheader-group-headers strings Default: "x-remote-group" | |
List of request headers to inspect for groups. X-Remote-Group is suggested. |
|
| --requestheader-username-headers strings Default: "x-remote-user" | |
List of request headers to inspect for usernames. X-Remote-User is common. |
|
| --resource-quota-sync-period duration Default: 5m0s | |
The period for syncing quota usage status in the system |
|
| --root-ca-file string | |
If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle. |
|
| --route-reconciliation-period duration Default: 10s | |
The period for reconciling routes created for Nodes by cloud provider. |
|
| --secondary-node-eviction-rate float Default: 0.01 | |
Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold. |
|
| --secure-port int Default: 10257 | |
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. |
|
| --service-account-private-key-file string | |
Filename containing a PEM-encoded private RSA or ECDSA key used to sign service account tokens. |
|
| --service-cluster-ip-range string | |
CIDR Range for Services in cluster. Requires --allocate-node-cidrs to be true |
|
| --show-hidden-metrics-for-version string | |
The previous version for which you want to show hidden metrics. Only the previous minor version is meaningful, other values will not be allowed. The format is <major>.<minor>, e.g.: '1.16'. The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, rather than being surprised when they are permanently removed in the release after that. |
|
| --terminated-pod-gc-threshold int32 Default: 12500 | |
Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled. |
|
| --tls-cert-file string | |
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir. |
|
| --tls-cipher-suites strings | |
Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. |
|
| --tls-min-version string | |
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 |
|
| --tls-private-key-file string | |
File containing the default x509 private key matching --tls-cert-file. |
|
| --tls-sni-cert-key string | |
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". |
|
| --unhealthy-zone-threshold float Default: 0.55 | |
Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. |
|
| --use-service-account-credentials | |
If true, use individual service account credentials for each controller. |
|
| -v, --v int | |
number for the log level verbosity |
|
| --version version[=true] | |
Print version information and quit |
|
| --vmodule pattern=N,... | |
comma-separated list of pattern=N settings for file-filtered logging (only works for text log format) |
|
| --volume-host-allow-local-loopback Default: true | |
If false, deny local loopback IPs in addition to any CIDR ranges in --volume-host-cidr-denylist |
|
| --volume-host-cidr-denylist strings | |
A comma-separated list of CIDR ranges to avoid from volume plugins. |
|