OS Manuals

/usr/bin/controller

cluster-api core components

From cluster-api-1.10-controller 1.10.10-r25 (enterprise-packages), captured 2026-11-08 by running controller --help (exit 2). permalink

Usage of /usr/bin/controller:
      --additional-sync-machine-annotations strings   List of regexes to select an additional set of labels to sync from a Machine to its associated Node. An annotation will be synced as long as it matches at least one of the regexes.
      --additional-sync-machine-labels strings        List of regexes to select an additional set of labels to sync from a Machine to its associated Node. A label will be synced as long as it matches at least one of the regexes.
      --cluster-concurrency int                       Number of clusters to process simultaneously (default 10)
      --clustercache-client-burst int                 Maximum number of queries that should be allowed in one burst from the cluster cache clients to the Kubernetes API server of workload clusters. (default 30)
      --clustercache-client-qps float32               Maximum queries per second from the cluster cache clients to the Kubernetes API server of workload clusters. (default 20)
      --clustercache-concurrency int                  Number of clusters to process simultaneously (default 100)
      --clusterclass-concurrency int                  Number of ClusterClasses to process simultaneously (default 10)
      --clusterresourceset-concurrency int            Number of cluster resource sets to process simultaneously (default 10)
      --clustertopology-concurrency int               Number of clusters to process simultaneously (default 10)
      --contention-profiling                          Enable block profiling
      --diagnostics-address string                    The address the diagnostics endpoint binds to. Per default metrics are served via https and withauthentication/authorization. To serve via http and without authentication/authorization set --insecure-diagnostics. If --insecure-diagnostics is not set the diagnostics endpoint also serves pprof endpoints and an endpoint to change the log level. (default ":8443")
      --extensionconfig-concurrency int               Number of extension configs to process simultaneously (default 10)
      --feature-gates mapStringBool                   A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
                                                      AllAlpha=true|false (ALPHA - default=false)
                                                      AllBeta=true|false (BETA - default=false)
                                                      ClusterTopology=true|false (ALPHA - default=false)
                                                      KubeadmBootstrapFormatIgnition=true|false (ALPHA - default=false)
                                                      MachinePool=true|false (BETA - default=true)
                                                      MachineSetPreflightChecks=true|false (BETA - default=true)
                                                      MachineWaitForVolumeDetachConsiderVolumeAttachments=true|false (BETA - default=true)
                                                      PriorityQueue=true|false (ALPHA - default=false)
                                                      RuntimeSDK=true|false (ALPHA - default=false)
      --health-addr string                            The address the health endpoint binds to. (default ":9440")
      --insecure-diagnostics                          Enable insecure diagnostics serving. For more details see the description of --diagnostics-address.
      --kube-api-burst int                            Maximum number of queries that should be allowed in one burst from the controller client to the Kubernetes API server. (default 30)
      --kube-api-qps float32                          Maximum queries per second from the controller client to the Kubernetes API server. (default 20)
      --kubeconfig string                             Paths to a kubeconfig. Only required if out-of-cluster.
      --leader-elect                                  Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.
      --leader-elect-lease-duration duration          Interval at which non-leader candidates will wait to force acquire leadership (duration string) (default 15s)
      --leader-elect-renew-deadline duration          Duration that the leading controller manager will retry refreshing leadership before giving up (duration string) (default 10s)
      --leader-elect-retry-period duration            Duration the LeaderElector clients should wait between tries of actions (duration string) (default 2s)
      --log-flush-frequency duration                  Maximum number of seconds between log flushes (default 5s)
      --log-json-info-buffer-size quantity            [Alpha] In JSON 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-json-split-stream                         [Alpha] In JSON 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.
      --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: "json" (gated by LoggingBetaOptions), "text". (default "text")
      --machine-concurrency int                       Number of machines to process simultaneously (default 10)
      --machinedeployment-concurrency int             Number of machine deployments to process simultaneously (default 10)
      --machinehealthcheck-concurrency int            Number of machine health checks to process simultaneously (default 10)
      --machinepool-concurrency int                   Number of machine pools to process simultaneously (default 10)
      --machineset-concurrency int                    Number of machine sets to process simultaneously (default 10)
      --machineset-preflight-checks strings           List of MachineSet preflight checks that should be run. Per default all of them are enabled.Set this flag to only enable a subset of them. The MachineSet preflight checks can be then also disabledon MachineSets via the 'machineset.cluster.x-k8s.io/skip-preflight-checks' annotation.Valid values are: All or a list of KubeadmVersionSkew, KubernetesVersionSkew, ControlPlaneIsStable, ControlPlaneVersionSkew (default [All])
      --namespace string                              Namespace that the controller watches to reconcile cluster-api objects. If unspecified, the controller watches for cluster-api objects across all namespaces.
      --profiler-address string                       Bind address to expose the pprof profiler (e.g. localhost:6060)
      --remote-conditions-grace-period NodeHealthy    Grace period after which remote conditions (e.g. NodeHealthy) are set to `Unknown`, the grace period starts from the last successful health probe to the workload cluster (default 5m0s)
      --remote-connection-grace-period False          Grace period after which the RemoteConnectionProbe condition on a Cluster goes to False, the grace period starts from the last successful health probe to the workload cluster (default 50s)
      --runtime-extension-client-cert-file string     Path of the PEM-encoded client certificate to be used when calling runtime extensions.
      --runtime-extension-client-key-file string      Path of the PEM-encoded client key to be used when calling runtime extensions.
      --skip-crd-migration-phases strings             List of CRD migration phases to skip. Valid values are: StorageVersionMigration, CleanupManagedFields.
      --sync-period duration                          The minimum interval at which watched resources are reconciled (e.g. 15m) (default 10m0s)
      --tls-cipher-suites strings                     Comma-separated list of cipher suites for the webhook server and metrics server (the latter only if --insecure-diagnostics is not set to true). 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                        The minimum TLS version in use by the webhook server and metrics server (the latter only if --insecure-diagnostics is not set to true).
                                                      Possible values are VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13. (default "VersionTLS12")
  -v, --v Level                                       number for the log level verbosity (default 0)
      --vmodule pattern=N,...                         comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
      --watch-filter string                           Label value that the controller watches to reconcile cluster-api objects. Label key is always cluster.x-k8s.io/watch-filter. If unspecified, the controller watches for all cluster-api objects.
      --webhook-cert-dir string                       Webhook cert dir. (default "/tmp/k8s-webhook-server/serving-certs/")
      --webhook-cert-name string                      Name of the file for webhook's server certificate; the file must be placed under webhook-cert-dir. (default "tls.crt")
      --webhook-key-name string                       Name of the file for webhook's server key; the file must be placed under webhook-cert-dir. (default "tls.key")
      --webhook-port int                              Webhook Server port (default 9443)
pflag: help requested
Options (51)
OptionDescriptionSource
--additional-sync-machine-annotations stringsList of regexes to select an additional set of labels to sync from a Machine to its associated Node.help
--additional-sync-machine-labels stringsList of regexes to select an additional set of labels to sync from a Machine to its associated Node.help
--cluster-concurrency intNumber of clusters to process simultaneously (default 10)help
--clustercache-client-burst intMaximum number of queries that should be allowed in one burst from the cluster cache clients to the Kubernetes API server of workload clusters.help
--clustercache-client-qps float32Maximum queries per second from the cluster cache clients to the Kubernetes API server of workload clusters.help
--clustercache-concurrency intNumber of clusters to process simultaneously (default 100)help
--clusterclass-concurrency intNumber of ClusterClasses to process simultaneously (default 10)help
--clusterresourceset-concurrency intNumber of cluster resource sets to process simultaneously (default 10)help
--clustertopology-concurrency intNumber of clusters to process simultaneously (default 10)help
--contention-profilingEnable block profilinghelp
--diagnostics-address stringThe address the diagnostics endpoint binds to.help
--extensionconfig-concurrency intNumber of extension configs to process simultaneously (default 10)help
--feature-gates mapStringBoolA set of key=value pairs that describe feature gates for alpha/experimental features.help
--health-addr stringThe address the health endpoint binds to.help
--insecure-diagnosticsEnable insecure diagnostics serving.help
--kube-api-burst intMaximum number of queries that should be allowed in one burst from the controller client to the Kubernetes API server.help
--kube-api-qps float32Maximum queries per second from the controller client to the Kubernetes API server.help
--kubeconfig stringPaths to a kubeconfig.help
--leader-electEnable leader election for controller manager.help
--leader-elect-lease-duration durationInterval at which non-leader candidates will wait to force acquire leadership (duration string) (default 15s)help
--leader-elect-renew-deadline durationDuration that the leading controller manager will retry refreshing leadership before giving up (duration string) (default 10s)help
--leader-elect-retry-period durationDuration the LeaderElector clients should wait between tries of actions (duration string) (default 2s)help
--log-flush-frequency durationMaximum number of seconds between log flushes (default 5s)help
--log-json-info-buffer-size quantity[Alpha] In JSON format with split output streams, the info messages can be buffered for a while to increase performance.help
--log-json-split-stream[Alpha] In JSON format, write error messages to stderr and info messages to stdout.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 stringSets the log format.help
--machine-concurrency intNumber of machines to process simultaneously (default 10)help
--machinedeployment-concurrency intNumber of machine deployments to process simultaneously (default 10)help
--machinehealthcheck-concurrency intNumber of machine health checks to process simultaneously (default 10)help
--machinepool-concurrency intNumber of machine pools to process simultaneously (default 10)help
--machineset-concurrency intNumber of machine sets to process simultaneously (default 10)help
--machineset-preflight-checks stringsList of MachineSet preflight checks that should be run.help
--namespace stringNamespace that the controller watches to reconcile cluster-api objects.help
--profiler-address stringBind address to expose the pprof profiler (e.g. localhost:6060)help
--remote-conditions-grace-period NodeHealthyGrace period after which remote conditions (e.g. NodeHealthy) are set to `Unknown`, the grace period starts from the last successful health probe to the workload cluster (default 5m0s)help
--remote-connection-grace-period FalseGrace period after which the RemoteConnectionProbe condition on a Cluster goes to False, the grace period starts from the last successful health probe to the workload cluster (default 50s)help
--runtime-extension-client-cert-file stringPath of the PEM-encoded client certificate to be used when calling runtime extensions.help
--runtime-extension-client-key-file stringPath of the PEM-encoded client key to be used when calling runtime extensions.help
--skip-crd-migration-phases stringsList of CRD migration phases to skip.help
--sync-period durationThe minimum interval at which watched resources are reconciled (e.g. 15m) (default 10m0s)help
--tls-cipher-suites stringsComma-separated list of cipher suites for the webhook server and metrics server (the latter only if --insecure-diagnostics is not set to true).help
--tls-min-version stringThe minimum TLS version in use by the webhook server and metrics server (the latter only if --insecure-diagnostics is not set to true).help
-v, --v Levelnumber for the log level verbosity (default 0)help
--vmodule pattern=Ncomma-separated list of pattern=N settings for file-filtered logging (only works for text log format)help
--watch-filter stringLabel value that the controller watches to reconcile cluster-api objects.help
--webhook-cert-dir stringWebhook cert dir.help
--webhook-cert-name stringName of the file for webhook's server certificate;help
--webhook-key-name stringName of the file for webhook's server key;help
--webhook-port intWebhook Server port (default 9443)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.