Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

components: document jitter flag #1619

Merged
merged 1 commit into from
Aug 24, 2023
Merged

components: document jitter flag #1619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 33 additions & 31 deletions content/en/flux/components/helm/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,39 @@ please see the [bootstrap cheatsheet](../../cheatsheets/bootstrap.md).

## Flags

| Name | Type | Description |
|---------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--concurrent` | int | The number of concurrent HelmRelease 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. |
| `--graceful-shutdown-timeout` | int | The duration given to the reconciler to finish before forcibly stopping. (default 600s) |
| `--health-addr` | string | The address the health endpoint binds to. (default ":9440") |
| `--http-retry` | int | The maximum number of retries when failing to fetch artifacts over HTTP. (default 9) |
| `--insecure-kubeconfig-exec` | boolean | Allow use of the user.exec section in kubeconfigs provided for remote apply. |
| `--insecure-kubeconfig-tls` | boolean | Allow that kubeconfigs provided for remote apply can disable TLS verification. |
| `--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. |
| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) |
| `--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. |
| `--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) |
| `--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) |
| `--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. |
| `--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. |
| Name | Type | Description |
|---------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--concurrent` | int | The number of concurrent HelmRelease 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. |
| `--graceful-shutdown-timeout` | int | The duration given to the reconciler to finish before forcibly stopping. (default 600s) |
| `--health-addr` | string | The address the health endpoint binds to. (default ":9440") |
| `--http-retry` | int | The maximum number of retries when failing to fetch artifacts over HTTP. (default 9) |
| `--insecure-kubeconfig-exec` | boolean | Allow use of the user.exec section in kubeconfigs provided for remote apply. |
| `--insecure-kubeconfig-tls` | boolean | Allow that kubeconfigs provided for remote apply can disable TLS verification. |
| `--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. |
| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) |
| `--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. |
| `--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) |
| `--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) |
| `--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. |
| `--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. |
| `--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) |


### Feature Gates

Expand Down
Loading