You are viewing documentation for Flux version: 2.1
Version 2.1 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
Controller Options
Controller command flags and defaults.
To customise the controller options at install time, please see the bootstrap customization guide.
Image automation flags
| Name | Type | Description |
|---|---|---|
--concurrent | int | The number of concurrent kustomize reconciles. (default 4) |
--default-service-account | string | Default service account used for impersonation. |
--enable-leader-election | boolean | Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. |
--events-addr | string | The address of the events receiver. |
--health-addr | string | The address the health endpoint binds to. (default “:9440”) |
--kube-api-burst | int | The maximum burst queries-per-second of requests sent to the Kubernetes API. (default 100) |
--kube-api-qps | float32 | The maximum queries-per-second of requests sent to the Kubernetes API. (default 50) |
--leader-election-lease-duration | duration | Interval at which non-leader candidates will wait to force acquire leadership (duration string). (default 35s) |
--leader-election-release-on-cancel | boolean | Defines if the leader should step down voluntarily on controller manager shutdown. (default true) |
--leader-election-renew-deadline | duration | Duration that the leading controller manager will retry refreshing leadership before giving up (duration string). (default 30s) |
--leader-election-retry-period | duration | Duration the LeaderElector clients should wait between tries of actions (duration string). (default 5s) |
--log-encoding | string | Log encoding format. Can be ‘json’ or ‘console’. (default “json”) |
--log-level | string | Log verbosity level. Can be one of ’trace’, ‘debug’, ‘info’, ’error’. (default “info”) |
--max-retry-delay | duration | The maximum amount of time for which an object being reconciled will have to wait before a retry. (default 15m0s) |
--metrics-addr | string | The address the metric endpoint binds to. (default “:8080”) |
--min-retry-delay | duration | The minimum amount of time for which an object being reconciled will have to wait before a retry. (default 750ms) |
--no-cross-namespace-refs | boolean | When set to true, references between custom resources are allowed only if the reference and the referee are in the same namespace. |
--ssh-hostkey-algos | strings | The list of hostkey algorithms to use for ssh connections, arranged from most preferred to the least. |
--ssh-kex-algos | strings | The list of key exchange algorithms to use for ssh connections, arranged from most preferred to the least. |
--watch-all-namespaces | boolean | Watch for custom resources in all namespaces, if set to false it will only watch the runtime namespace. (default true) |
--watch-label-selector | string | Watch for resources with matching labels e.g. ‘sharding.fluxcd.io/shard=shard1’. |
--feature-gates | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. |
Feature Gates
| Name | Default Value | Description |
|---|---|---|
GitForcePushBranch | true | Enables the use of “force push” when pushing changes to a separate branch. This fixes issues with stale push branches. |
GitAllBranchReferences | true | Enables the download of all branch head references when push branches are configured. |
CacheSecretsAndConfigMaps | false | Configures the caching of Secrets and ConfigMaps by the controller-runtime client. When enabled, it will cache both object types, resulting in increased memory usage and cluster-wide RBAC permissions (list and watch). |
Image reflector flags
| Name | Type | Description |
|---|---|---|
--concurrent | int | The number of concurrent kustomize reconciles. (default 4) |
--default-service-account | string | Default service account used for impersonation. |
--enable-leader-election | boolean | Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. |
--events-addr | string | The address of the events receiver. |
--health-addr | string | The address the health endpoint binds to. (default “:9440”) |
--kube-api-burst | int | The maximum burst queries-per-second of requests sent to the Kubernetes API. (default 100) |
--kube-api-qps | float32 | The maximum queries-per-second of requests sent to the Kubernetes API. (default 50) |
--leader-election-lease-duration | duration | Interval at which non-leader candidates will wait to force acquire leadership (duration string). (default 35s) |
--leader-election-release-on-cancel | boolean | Defines if the leader should step down voluntarily on controller manager shutdown. (default true) |
--leader-election-renew-deadline | duration | Duration that the leading controller manager will retry refreshing leadership before giving up (duration string). (default 30s) |
--leader-election-retry-period | duration | Duration the LeaderElector clients should wait between tries of actions (duration string). (default 5s) |
--log-encoding | string | Log encoding format. Can be ‘json’ or ‘console’. (default “json”) |
--log-level | string | Log verbosity level. Can be one of ’trace’, ‘debug’, ‘info’, ’error’. (default “info”) |
--metrics-addr | string | The address the metric endpoint binds to. (default “:8080”) |
--no-cross-namespace-refs | boolean | When set to true, references between custom resources are allowed only if the reference and the referee are in the same namespace. |
--storage-path | string | Where to store the persistent database of image metadata. (default “/data”) |
--storage-value-log-file-size | int | Set the database’s memory mapped value log file size in bytes. Effective memory usage is about two times this size. (default 268435456) |
--watch-all-namespaces | boolean | Watch for custom resources in all namespaces, if set to false it will only watch the runtime namespace. (default true) |
--watch-label-selector | string | Watch for resources with matching labels e.g. ‘sharding.fluxcd.io/shard=shard1’. |
--feature-gates | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. |
Feature Gates
| Name | Default Value | Description |
|---|---|---|
CacheSecretsAndConfigMaps | false | Configures the caching of Secrets and ConfigMaps by the controller-runtime client. When enabled, it will cache both object types, resulting in increased memory usage and cluster-wide RBAC permissions (list and watch). |
Last modified 2023-09-14: Fix link to bootstrap customization guide (9c67b79)