The Cloud controller manager is a daemon that embeds
the cloud specific control loops shipped with Kubernetes.
Usage:
cloud-controller-manager [flags]
Debugging flags:
--contention-profiling Enable block profiling, if profiling is enabled
--profiling Enable profiling via web interface host:port/debug/pprof/ (default true)
Leader-migration flags:
--enable-leader-migration Whether to enable controller leader migration.
--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.
Generic flags:
--allocate-node-cidrs Should CIDRs for Pods be allocated and set on the cloud provider.
--cidr-allocator-type string Type of CIDR allocator to use (default "RangeAllocator")
--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 The instance prefix for the cluster. (default "kubernetes")
--configure-cloud-routes Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. (default true)
--controller-start-interval duration Interval between starting controller managers.
--controllers strings A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.
All controllers: cloud-node-controller, cloud-node-lifecycle-controller, node-route-controller, service-lb-controller, tagging
Disabled-by-default controllers: tagging (default [*])
--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-ipam-controller, persistentvolume-binder-controller, persistentvolume-expander-controller and attach-detach-controller to work for in tree cloud providers.
--feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIResponseCompression=true|false (BETA - default=true)
APIServerIdentity=true|false (BETA - default=true)
APIServerTracing=true|false (BETA - default=true)
APIServingWithRoutine=true|false (ALPHA - default=false)
AllAlpha=true|false (ALPHA - default=false)
AllBeta=true|false (BETA - default=false)
AnonymousAuthConfigurableEndpoints=true|false (ALPHA - default=false)
AuthorizeWithSelectors=true|false (ALPHA - default=false)
CloudControllerManagerWebhook=true|false (ALPHA - default=false)
ComponentSLIs=true|false (BETA - default=true)
ConcurrentWatchObjectDecode=true|false (BETA - default=false)
ConsistentListFromCache=true|false (BETA - default=true)
ContextualLogging=true|false (BETA - default=true)
CoordinatedLeaderElection=true|false (ALPHA - default=false)
InPlacePodVerticalScaling=true|false (ALPHA - default=false)
LoggingAlphaOptions=true|false (ALPHA - default=false)
LoggingBetaOptions=true|false (BETA - default=true)
OpenAPIEnums=true|false (BETA - default=true)
ResilientWatchCacheInitialization=true|false (BETA - default=true)
RetryGenerateName=true|false (BETA - default=true)
SeparateCacheWatchRPC=true|false (BETA - default=true)
StorageVersionAPI=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
StrictCostEnforcementForVAP=true|false (BETA - default=false)
StrictCostEnforcementForWebhooks=true|false (BETA - default=false)
StructuredAuthenticationConfiguration=true|false (BETA - default=true)
StructuredAuthorizationConfiguration=true|false (BETA - default=true)
UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)
WatchCacheInitializationPostStartHook=true|false (BETA - default=false)
WatchFromStorageWithoutResourceVersion=true|false (BETA - default=false)
WatchList=true|false (ALPHA - default=false)
--kube-api-burst int32 Burst to use while talking with kubernetes apiserver. (default 30)
--kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
--kube-api-qps float32 QPS to use while talking with kubernetes apiserver. (default 20)
--leader-elect Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. (default true)
--leader-elect-lease-duration duration The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. (default 15s)
--leader-elect-renew-deadline duration The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than the lease duration. This is only applicable if leader election is enabled. (default 10s)
--leader-elect-resource-lock string The type of resource object that is used for locking during leader election. Supported options are 'leases', 'endpointsleases' and 'configmapsleases'. (default "leases")
--leader-elect-resource-name string The name of resource object that is used for locking during leader election. (default "cloud-controller-manager")
--leader-elect-resource-namespace string The namespace of resource object that is used for locking during leader election. (default "kube-system")
--leader-elect-retry-period duration The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s)
--min-resync-period duration The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod. (default 12h0m0s)
--node-monitor-period duration The period for syncing NodeStatus in cloud-node-lifecycle-controller. (default 5s)
--route-reconciliation-period duration The period for reconciling routes created for Nodes by cloud provider. (default 10s)
--use-service-account-credentials If true, use individual service account credentials for each controller.
Cloud-node-controller flags:
--concurrent-node-syncs int32 Number of workers concurrently synchronizing nodes. (default 1)
Service-lb-controller flags:
--concurrent-service-syncs int32 The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load (default 1)
Webhook flags:
--webhooks strings A list of webhooks to enable. '*' enables all on-by-default webhooks, 'foo' enables the webhook named 'foo', '-foo' disables the webhook named 'foo'.
All webhooks:
Disabled-by-default webhooks:
Webhook serving flags:
--webhook-bind-address ip The IP address on which to listen for the --webhook-secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If set to an unspecified address (0.0.0.0 or ::), all interfaces will be used. If unset, defaults to 0.0.0.0. (default 0.0.0.0)
--webhook-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.
--webhook-secure-port int Secure port to serve cloud provider webhooks. If 0, don't serve webhooks at all. (default 10260)
--webhook-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.
--webhook-tls-private-key-file string File containing the default x509 private key matching --tls-cert-file.
Secure serving flags:
--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 or an unspecified address (0.0.0.0 or ::), all interfaces and IP address families will be used. (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.
--disable-http2-serving If true, HTTP2 serving will be disabled [default=false]
--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.
--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]
--secure-port int The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. (default 10258)
--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.
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_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.
Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, 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.
--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 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. 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". (default [])
Authentication flags:
--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 The duration to cache responses from the webhook token authenticator. (default 10s)
--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.
--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.
--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 List of request header prefixes to inspect. X-Remote-Extra- is suggested. (default [x-remote-extra-])
--requestheader-group-headers strings List of request headers to inspect for groups. X-Remote-Group is suggested. (default [x-remote-group])
--requestheader-username-headers strings List of request headers to inspect for usernames. X-Remote-User is common. (default [x-remote-user])
Authorization flags:
--authorization-always-allow-paths strings A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server. (default [/healthz,/readyz,/livez])
--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 The duration to cache 'authorized' responses from the webhook authorizer. (default 10s)
--authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. (default 10s)
Misc flags:
--kubeconfig string Path to kubeconfig file with authorization and master location information (the master location can be overridden by the master flag).
--master string The address of the Kubernetes API server (overrides any value in kubeconfig).
--node-status-update-frequency duration Specifies how often the controller updates nodes' status. (default 5m0s)
Global flags:
-h, --help help for cloud-controller-manager
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
--log-text-info-buffer-size quantity [Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.
--log-text-split-stream [Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.
--logging-format string Sets the log format. Permitted formats: "text". (default "text")
-v, --v Level number for the log level verbosity
--version version[=true] --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version
--vmodule pattern=N,... comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
Tagging controller flags:
--resources stringArray AWS resources name to add/remove tags in the tagging controller.
--tagging-controller-burst-limit int Burst limit at which the controller processes items in its queue. A value of zero (default) disables rate limiting.
--tagging-controller-rate-limit float Steady-state rate limit (per sec) at which the controller processes items in its queue. A value of zero (default) disables rate limiting.
--tags stringToString Tags to apply to AWS resources in the tagging controller, in a form of key=value. (default [])
Options (78)
| Option | Description | Source |
|---|---|---|
--contention-profiling | Enable block profiling, if profiling is enabled | help |
--profiling | Enable profiling via web interface host:port/debug/pprof/ (default true) | help |
--enable-leader-migration | Whether to enable controller leader migration. | help |
--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. | help |
--allocate-node-cidrs | Should CIDRs for Pods be allocated and set on the cloud provider. | help |
--cidr-allocator-type string | Type of CIDR allocator to use (default "RangeAllocator") | help |
--cloud-config string | The path to the cloud provider configuration file. | help |
--cloud-provider string | The provider for cloud services. | help |
--cluster-cidr string | CIDR Range for Pods in cluster. | help |
--cluster-name string | The instance prefix for the cluster. | help |
--configure-cloud-routes | Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. | help |
--controller-start-interval duration | Interval between starting controller managers. | help |
--controllers strings | A list of controllers to enable. | help |
--external-cloud-volume-plugin string | The plugin to use when cloud provider is set to external. | help |
--feature-gates mapStringBool | A set of key=value pairs that describe feature gates for alpha/experimental features. | help |
--kube-api-burst int32 | Burst to use while talking with kubernetes apiserver. | help |
--kube-api-content-type string | Content type of requests sent to apiserver. | help |
--kube-api-qps float32 | QPS to use while talking with kubernetes apiserver. | help |
--leader-elect | Start a leader election client and gain leadership before executing the main loop. | help |
--leader-elect-lease-duration duration | The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. | help |
--leader-elect-renew-deadline duration | The interval between attempts by the acting master to renew a leadership slot before it stops leading. | help |
--leader-elect-resource-lock string | The type of resource object that is used for locking during leader election. | help |
--leader-elect-resource-name string | The name of resource object that is used for locking during leader election. | help |
--leader-elect-resource-namespace string | The namespace of resource object that is used for locking during leader election. | help |
--leader-elect-retry-period duration | The duration the clients should wait between attempting acquisition and renewal of a leadership. | help |
--min-resync-period duration | The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod. | help |
--node-monitor-period duration | The period for syncing NodeStatus in cloud-node-lifecycle-controller. | help |
--route-reconciliation-period duration | The period for reconciling routes created for Nodes by cloud provider. | help |
--use-service-account-credentials | If true, use individual service account credentials for each controller. | help |
--concurrent-node-syncs int32 | Number of workers concurrently synchronizing nodes. | help |
--concurrent-service-syncs int32 | The number of services that are allowed to sync concurrently. | help |
--webhooks strings | A list of webhooks to enable. | help |
--webhook-bind-address ip | The IP address on which to listen for the --webhook-secure-port port. | help |
--webhook-cert-dir string | The directory where the TLS certs are located. | help |
--webhook-secure-port int | Secure port to serve cloud provider webhooks. | help |
--webhook-tls-cert-file string | File containing the default x509 Certificate for HTTPS. | help |
--webhook-tls-private-key-file string | File containing the default x509 private key matching --tls-cert-file. | help |
--bind-address ip | The IP address on which to listen for the --secure-port port. | help |
--cert-dir string | The directory where the TLS certs are located. | help |
--disable-http2-serving | If true, HTTP2 serving will be disabled [default=false] | help |
--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. | help |
--permit-address-sharing | If true, SO_REUSEADDR will be used when binding the port. | help |
--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. | help |
--secure-port int | The port on which to serve HTTPS with authentication and authorization. | help |
--tls-cert-file string | File containing the default x509 Certificate for HTTPS. | help |
--tls-cipher-suites strings | Comma-separated list of cipher suites for the server. | help |
--tls-min-version string | Minimum TLS version supported. | help |
--tls-private-key-file string | File containing the default x509 private key matching --tls-cert-file. | help |
--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. | help |
--authentication-kubeconfig string | kubeconfig file pointing at the 'core' kubernetes server with enough rights to create tokenreviews.authentication.k8s.io. | help |
--authentication-skip-lookup | If false, the authentication-kubeconfig will be used to lookup missing authentication configuration from the cluster. | help |
--authentication-token-webhook-cache-ttl duration | The duration to cache responses from the webhook token authenticator. | help |
--authentication-tolerate-lookup-failure | If true, failures to look up missing authentication configuration from the cluster are not considered fatal. | help |
--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. | help |
--requestheader-allowed-names strings | List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. | help |
--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. | help |
--requestheader-extra-headers-prefix strings | List of request header prefixes to inspect. | help |
--requestheader-group-headers strings | List of request headers to inspect for groups. | help |
--requestheader-username-headers strings | List of request headers to inspect for usernames. | help |
--authorization-always-allow-paths strings | A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server. | help |
--authorization-kubeconfig string | kubeconfig file pointing at the 'core' kubernetes server with enough rights to create subjectaccessreviews.authorization.k8s.io. | help |
--authorization-webhook-cache-authorized-ttl duration | The duration to cache 'authorized' responses from the webhook authorizer. | help |
--authorization-webhook-cache-unauthorized-ttl duration | The duration to cache 'unauthorized' responses from the webhook authorizer. | help |
--kubeconfig string | Path to kubeconfig file with authorization and master location information (the master location can be overridden by the master flag). | help |
--master string | The address of the Kubernetes API server (overrides any value in kubeconfig). | help |
--node-status-update-frequency duration | Specifies how often the controller updates nodes' status. | help |
-h, --help | help for cloud-controller-manager | help |
--log-flush-frequency duration | Maximum number of seconds between log flushes (default 5s) | help |
--log-text-info-buffer-size quantity | [Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. | help |
--log-text-split-stream | [Alpha] In text format, write error messages to stderr and info messages to stdout. | help |
--logging-format string | Sets the log format. | help |
-v, --v Level | number for the log level verbosity | help |
--version version[=true | --version, --version=raw prints version information and quits; | help |
--vmodule pattern=N | comma-separated list of pattern=N settings for file-filtered logging (only works for text log format) | help |
--resources stringArray | AWS resources name to add/remove tags in the tagging controller. | help |
--tagging-controller-burst-limit int | Burst limit at which the controller processes items in its queue. | help |
--tagging-controller-rate-limit float | Steady-state rate limit (per sec) at which the controller processes items in its queue. | help |
--tags stringToString | Tags to apply to AWS resources in the tagging controller, in a form of key=value. | help |