Skip to content

Commit c9be426

Browse files
stefanprodanstefanprodan
authored
Merge pull request #2229 from fluxcd/update-controller-options
Update controller flags and feature gates
2 parents 047f9e6 + 756b6a0 commit c9be426

File tree

5 files changed

+20
-31
lines changed

5 files changed

+20
-31
lines changed

‎content/en/flux/components/helm/options.md‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ please see the [bootstrap customization guide](/flux/installation/configuration/
2121
| `--http-retry` | int | The maximum number of retries when failing to fetch artifacts over HTTP. (default 9) |
2222
| `--insecure-kubeconfig-exec` | boolean | Allow use of the user.exec section in kubeconfigs provided for remote apply. |
2323
| `--insecure-kubeconfig-tls` | boolean | Allow that kubeconfigs provided for remote apply can disable TLS verification. |
24-
| `--kube-api-burst` | int | The maximum burst queries-per-second of requests sent to the Kubernetes API. (default 100) |
25-
| `--kube-api-qps` | float32 | The maximum queries-per-second of requests sent to the Kubernetes API. (default 50) |
24+
| `--interval-jitter-percentage` | uint8 | Percentage of jitter to apply to interval durations. A value of 10 will apply a jitter of +/-10% to the interval duration. It cannot be negative, and must be less than 100. (default 5) |
2625
| `--leader-election-lease-duration` | duration | Interval at which non-leader candidates will wait to force acquire leadership (duration string). (default 35s) |
2726
| `--leader-election-release-on-cancel` | boolean | Defines if the leader should step down voluntarily on controller manager shutdown. (default true) |
2827
| `--leader-election-renew-deadline` | duration | Duration that the leading controller manager will retry refreshing leadership before giving up (duration string). (default 30s) |
@@ -33,23 +32,22 @@ please see the [bootstrap customization guide](/flux/installation/configuration/
3332
| `--metrics-addr` | string | The address the metric endpoint binds to. (default ":8080") |
3433
| `--min-retry-delay` | duration | The minimum amount of time for which an object being reconciled will have to wait before a retry. (default 750ms) |
3534
| `--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. |
36-
| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) |
37-
| `--watch-all-namespaces` | boolean | Watch for custom resources in all namespaces, if set to false it will only watch the runtime namespace. (default true) |
38-
| `--watch-label-selector` | string | Watch for resources with matching labels e.g. 'sharding.fluxcd.io/key=shard1'. |
39-
| `--feature-gates` | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. |
4035
| `--oom-watch-interval` | duration | The interval at which the OOM watcher will check for memory usage. Requires feature gate 'OOMWatch' to be enabled. (default 500ms) |
4136
| `--oom-watch-memory-threshold` | unit8 | The memory threshold in percentage at which the OOM watcher will trigger a graceful shutdown. Requires feature gate 'OOMWatch' to be enabled. (default 95) |
4237
| `--oom-watch-max-memory-path` | string | The path to the cgroup memory limit file. Requires feature gate 'OOMWatch' to be enabled. If not set, the path will be automatically detected. |
4338
| `--oom-watch-current-memory-path` | string | The path to the cgroup current memory usage file. Requires feature gate 'OOMWatch' to be enabled. If not set, the path will be automatically detected. |
44-
| `--interval-jitter-percentage` | uint8 | Percentage of jitter to apply to interval durations. A value of 10 will apply a jitter of +/-10% to the interval duration. It cannot be negative, and must be less than 100. (default 5) |
39+
| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) |
4540
| `--snapshot-digest-algo` | string | The algorithm to use to calculate the digest of Helm release storage snapshots. (default "sha256") |
46-
41+
| `--watch-all-namespaces` | boolean | Watch for custom resources in all namespaces, if set to false it will only watch the runtime namespace. (default true) |
42+
| `--watch-label-selector` | string | Watch for resources with matching labels e.g. 'sharding.fluxcd.io/key=shard1'. |
43+
| `--feature-gates` | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. |
4744

4845
### Feature Gates
4946

50-
| Name | Default Value | Description |
51-
|-----------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
52-
| `AllowDNSLookups` | `false` | Allows the controller to perform DNS lookups when rendering Helm templates. This is disabled by default, as it can be a security risk. |
53-
| `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). |
54-
| `OOMWatch` | `false` | Enables the OOM watcher, which will gracefully shut down the controller when the memory usage exceeds the configured limit. This is disabled by default. |
55-
| `AdoptLegacyReleases` | `true` | Enables the adoption of the historical Helm release based on the status fields from a v2beta1 HelmRelease object. This is enabled by default to support an upgrade path from v2beta1 to v2beta2 without the need to upgrade the Helm release. |
47+
| Name | Default Value | Description |
48+
|------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
49+
| `AdoptLegacyReleases` | `true` | Enables the adoption of the historical Helm release based on the status fields from a v2beta1 HelmRelease object. This is enabled by default to support an upgrade path from v2beta1 to v2beta2 without the need to upgrade the Helm release. |
50+
| `AllowDNSLookups` | `false` | Allows the controller to perform DNS lookups when rendering Helm templates. This is disabled by default, as it can be a security risk. |
51+
| `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). |
52+
| `DisableChartDigestTracking` | `false` | Disables the tracking of digest changes for Helm OCI charts. When set to `true`, the controller will not append the OCI digest to the chart version in `Chart.yaml`. |
53+
| `OOMWatch` | `false` | Enables the OOM watcher, which will gracefully shut down the controller when the memory usage exceeds the configured limit. This is disabled by default. |

‎content/en/flux/components/image/options.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ please see the [bootstrap customization guide](/flux/installation/configuration/
1717
| `--enable-leader-election` | boolean | Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. |
1818
| `--events-addr` | string | The address of the events receiver. |
1919
| `--health-addr` | string | The address the health endpoint binds to. (default ":9440") |
20-
| `--kube-api-burst` | int | The maximum burst queries-per-second of requests sent to the Kubernetes API. (default 100) |
21-
| `--kube-api-qps` | float32 | The maximum queries-per-second of requests sent to the Kubernetes API. (default 50) |
2220
| `--leader-election-lease-duration` | duration | Interval at which non-leader candidates will wait to force acquire leadership (duration string). (default 35s) |
2321
| `--leader-election-release-on-cancel` | boolean | Defines if the leader should step down voluntarily on controller manager shutdown. (default true) |
2422
| `--leader-election-renew-deadline` | duration | Duration that the leading controller manager will retry refreshing leadership before giving up (duration string). (default 30s) |
@@ -55,8 +53,6 @@ please see the [bootstrap customization guide](/flux/installation/configuration/
5553
| `--enable-leader-election` | boolean | Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. |
5654
| `--events-addr` | string | The address of the events receiver. |
5755
| `--health-addr` | string | The address the health endpoint binds to. (default ":9440") |
58-
| `--kube-api-burst` | int | The maximum burst queries-per-second of requests sent to the Kubernetes API. (default 100) |
59-
| `--kube-api-qps` | float32 | The maximum queries-per-second of requests sent to the Kubernetes API. (default 50) |
6056
| `--leader-election-lease-duration` | duration | Interval at which non-leader candidates will wait to force acquire leadership (duration string). (default 35s) |
6157
| `--leader-election-release-on-cancel` | boolean | Defines if the leader should step down voluntarily on controller manager shutdown. (default true) |
6258
| `--leader-election-renew-deadline` | duration | Duration that the leading controller manager will retry refreshing leadership before giving up (duration string). (default 30s) |
@@ -75,7 +71,7 @@ please see the [bootstrap customization guide](/flux/installation/configuration/
7571

7672
### Feature Gates
7773

78-
| Name | Default Value | Description |
79-
|-----------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
74+
| Name | Default Value | Description |
75+
|-------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
8076
| `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). |
8177
| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. |

0 commit comments

Comments
 (0)