diff --git a/content/en/flux/components/helm/options.md b/content/en/flux/components/helm/options.md index e7484d4f8..c9a8d285c 100644 --- a/content/en/flux/components/helm/options.md +++ b/content/en/flux/components/helm/options.md @@ -7,61 +7,3 @@ weight: 1 To customise the controller options at install time, please see the [bootstrap customization guide](/flux/installation/configuration/bootstrap-customization/). - -## Flags - -| Name | Type | Description | -|----------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--concurrent` | int | The number of concurrent HelmRelease reconciles. (default 4) | -| `--default-kubeconfig-service-account` | string | Default service account used for kubeconfig. | -| `--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) | -| `--http-timeout` | duration | The timeout for HTTP requests when fetching artifacts. (default 30s) | -| `--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. | -| `--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) | -| `--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. | -| `--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` | uint8 | 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. | -| `--override-manager` | stringArray | List of field managers to override during drift detection e.g. '--override-manager=kubectl-edit --override-manager=kubectl-patch' | -| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) | -| `--snapshot-digest-algo` | string | The algorithm to use to calculate the digest of Helm release storage snapshots. (default "sha256") | -| `--token-cache-max-size` | int | The maximum amount of entries in the LRU cache used for tokens. (default 100, enabled) | -| `--token-cache-max-duration` | duration | The maximum duration for which a token would be considered unexpired. This is capped at 1h. (default 1h) | -| `--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-configs-label-selector` | string | Watch for ConfigMaps and Secrets with matching labels (default 'reconcile.fluxcd.io/watch=Enabled'). | -| `--watch-label-selector` | string | Watch for resources with matching labels e.g. 'sharding.fluxcd.io/key=shard1'. | -| `--feature-gates` | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. | - -### Feature Gates - -| Name | Default Value | Description | -|----------------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `AdditiveCELDependencyCheck` | `false` | Run both the built-in health checks and the CEL expression `readyExpr` when `readyExpr` is configured on a HelmRelease. | -| `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. | -| `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. | -| `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. | -| `CancelHealthCheckOnNewRevision` | `false` | Cancels ongoing health checks when a new revision is detected. Enabling `DefaultToRetryOnFailure` together is recommended, as HelmReleases are more prone to get stuck after the cancellation when using the default retry configuration (no retries). | -| `DefaultToRetryOnFailure` | `false` | Changes the default failure handling strategy from `RemediateOnFailure` to `RetryOnFailure` for both install and upgrade operations when no strategy is explicitly specified. | -| `DirectSourceFetch` | `false` | Enables fetching source objects directly from the API server using APIReader, bypassing the controller's cache. This can be useful when immediate consistency is required for source object reads. | -| `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`. | -| `DisableConfigWatchers` | `false` | Disables the watchers for ConfigMaps and Secrets. | -| `ExternalArtifact` | `true` | Enables support for the [ExternalArtifact](https://github.com/fluxcd/source-controller/blob/main/docs/spec/v1/externalartifacts.md) source type. | -| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. | -| `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. | -| `UseHelm3Defaults` | `false` | Restores Helm v3 defaults. When enabled, uses client-side apply for installation, Helm's legacy readiness logic, and the `nohooks` post-render strategy instead of the Helm v4 defaults (server-side apply, kstatus-based health checking, and `combined` post-render strategy). | diff --git a/content/en/flux/components/image/options.md b/content/en/flux/components/image/options.md index aab6f1639..c9a8d285c 100644 --- a/content/en/flux/components/image/options.md +++ b/content/en/flux/components/image/options.md @@ -7,76 +7,3 @@ weight: 1 To customise the controller options at install time, please see the [bootstrap customization guide](/flux/installation/configuration/bootstrap-customization/). - -## Image automation flags - -| Name | Type | Description | -|---------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------| -| `--concurrent` | int | The number of concurrent kustomize reconciles. (default 4) | -| `--default-service-account` | string | Default service account to use for workload identity when not specified in resources. | -| `--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") | -| `--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. | -| `--token-cache-max-size` | int | The maximum amount of entries in the LRU cache used for tokens. (default 100, enabled) | -| `--token-cache-max-duration` | duration | The maximum duration for which a token would be considered unexpired. This is capped at 1h. (default 1h) | -| `--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/key=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). | -| `GitAllBranchReferences` | `true` | Enables the download of all branch head references when push branches are configured. | -| `GitForcePushBranch` | `true` | Enables the use of "force push" when pushing changes to a separate branch. This fixes issues with stale push branches. | -| `GitSparseCheckout` | `false` | Enables the use of Git sparse checkout to only fetch the path defined in `.spec.update.path` from the repository. | -| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. | - -## Image reflector flags - -| Name | Type | Description | -|---------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------| -| `--concurrent` | int | The number of concurrent kustomize reconciles. (default 4) | -| `--default-service-account` | string | Default service account to use for workload identity when not specified in resources. | -| `--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. | -| `--gc-interval` | int | The interval in number of minutes at which the garbage collector will run for the tags database. Zero disables GC. (default 10) | -| `--health-addr` | string | The address the health endpoint binds to. (default ":9440") | -| `--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. | -| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) | -| `--storage-compression-threshold` | int | Threshold in KiB for the tags file of a single ImageRepository to make it compressed. Defaults to 64. Requires `FluxStorage` enabled. | -| `--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) | -| `--token-cache-max-size` | int | The maximum amount of entries in the LRU cache used for tokens. (default 100, enabled) | -| `--token-cache-max-duration` | duration | The maximum duration for which a token would be considered unexpired. This is capped at 1h. (default 1h) | -| `--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/key=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). | -| `FluxStorage` | `false` | Enables the use of Flux's own storage implementation for the image tags database. | -| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. | diff --git a/content/en/flux/components/kustomize/options.md b/content/en/flux/components/kustomize/options.md index b2b004f13..c9a8d285c 100644 --- a/content/en/flux/components/kustomize/options.md +++ b/content/en/flux/components/kustomize/options.md @@ -7,59 +7,3 @@ weight: 1 To customise the controller options at install time, please see the [bootstrap customization guide](/flux/installation/configuration/bootstrap-customization/). - -## Flags - -| Name | Type | Description | -|----------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--concurrent` | int | The number of concurrent kustomize reconciles. (default 4) | -| `--concurrent-ssa` | int | The number of concurrent server-side apply operations. (default 4) | -| `--custom-apply-stage-kinds` | string | A comma-separated list of GroupKind (e.g., 'rbac.authorization.k8s.io/Role,some.group.io/SomeResource') resources to be applied in a custom stage during server-side apply running after CRDs and before all namespaced resources not in this list. | -| `--default-decryption-service-account` | string | Default service account used for decryption. | -| `--default-kubeconfig-service-account` | string | Default service account used for kubeconfig. | -| `--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") | -| `--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. | -| `--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) | -| `--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. | -| `--no-remote-bases` | boolean | Disallow remote bases usage in Kustomize overlays. When this flag is enabled, all resources must refer to local files included in the source artifact. | -| `--override-manager` | stringArray | Field manager disallowed to perform changes on managed resources. | -| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) | -| `--sops-age-secret` | string | The name of a Kubernetes secret in the RUNTIME_NAMESPACE containing a SOPS age decryption key for fallback usage. | -| `--sops-vault-configmap` | string | The name of a Kubernetes ConfigMap in the RUNTIME_NAMESPACE containing an OpenBao/Vault configuration with instances and login paths for SOPS decryption. | -| `--token-cache-max-size` | int | The maximum amount of entries in the LRU cache used for tokens. (default 100, enabled) | -| `--token-cache-max-duration` | duration | The maximum duration for which a token would be considered unexpired. This is capped at 1h. (default 1h) | -| `--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-configs-label-selector` | string | Watch for ConfigMaps and Secrets with matching labels (default 'reconcile.fluxcd.io/watch=Enabled'). | -| `--watch-label-selector` | string | Watch for resources with matching labels e.g. 'sharding.fluxcd.io/key=shard1'. | -| `--feature-gates` | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. | - -### Feature Gates - -| Name | Default Value | Description | -|----------------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `AdditiveCELDependencyCheck` | `false` | Run both the built-in health checks and the CEL expression `readyExpr` when `readyExpr` is configured on a Kustomization. | -| `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. | -| `CancelHealthCheckOnNewRevision` | `false` | Cancels ongoing health checks when a new revision is detected. | -| `DirectSourceFetch` | `false` | Enables fetching source objects (GitRepository, OCIRepository, Bucket) directly from the API server using APIReader, bypassing the controller's cache. This can be useful when immediate consistency is required for source object reads. | -| `DisableConfigWatchers` | `false` | Disables the watchers for ConfigMaps and Secrets. | -| `DisableFailFastBehavior` | `false` | Controls whether the fail-fast behavior when waiting for resources to become ready should be disabled. | -| `DisableStatusPollerCache` | `true` | Disables the cache of the status poller, which is used to determine the health of the resources applied by the controller. This may have a positive impact on memory usage on large clusters with many objects, at the cost of an increased number of direct API calls. | -| `ExternalArtifact` | `true` | Enables support for the [ExternalArtifact](https://github.com/fluxcd/source-controller/blob/main/docs/spec/v1/externalartifacts.md) source type. | -| `GroupChangeLog` | `false` | Groups together kubernetes objects in log output. Reduces cardinality for Elasticsearch/Opensearch indexing | -| `MigrateAPIVersion` | `false` | Migrates the API version referenced by the managed fields entries of in-cluster objects to the API version of the applied objects when they differ. Works around server-side apply dry-run failures like `field not declared in schema` after CRD upgrades. | -| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. | -| `StrictPostBuildSubstitutions` | `true` | Controls whether the post-build substitutions should fail if a variable without a default value is declared in files but is missing from the input vars. | diff --git a/content/en/flux/components/notification/options.md b/content/en/flux/components/notification/options.md index 66485ef9b..c9a8d285c 100644 --- a/content/en/flux/components/notification/options.md +++ b/content/en/flux/components/notification/options.md @@ -7,36 +7,3 @@ weight: 1 To customise the controller options at install time, please see the [bootstrap customization guide](/flux/installation/configuration/bootstrap-customization/). - -## Flags - -| Name | Type | Description | -|---------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------| -| `--concurrent` | int | The number of concurrent notification reconciles. (default 4) | -| `--default-service-account` | string | Default service account to use for workload identity when not specified in resources. | -| `--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") | -| `--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. | -| `--rate-limit-interval` | duration | Interval in which rate limit has effect. (default 5m0s) | -| `--receiverAddr` | string | The address the webhook receiver endpoint binds to. (default ":9292") | -| `--token-cache-max-size` | int | The maximum amount of entries in the LRU cache used for tokens. (default 100, enabled) | -| `--token-cache-max-duration` | duration | The maximum duration for which a token would be considered unexpired. This is capped at 1h. (default 1h) | -| `--watch-all-namespaces` | boolean | Watch for custom resources in all namespaces, if set to false it will only watch the runtime namespace. (default true) | -| `--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. | -| `DisableConfigWatchers` | `false` | Disables the watchers for ConfigMaps and Secrets. | -| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. | diff --git a/content/en/flux/components/source/options.md b/content/en/flux/components/source/options.md index 65bef4b56..c9a8d285c 100644 --- a/content/en/flux/components/source/options.md +++ b/content/en/flux/components/source/options.md @@ -7,87 +7,3 @@ weight: 1 To customise the controller options at install time, please see the [bootstrap customization guide](/flux/installation/configuration/bootstrap-customization/). - -## Source controller flags - -| Name | Type | Description | -|---------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--artifact-retention-records` | int | The maximum number of artifacts to be kept in storage after a garbage collection. (default 2) | -| `--artifact-retention-ttl` | duration | The duration of time that artifacts from previous reconciliations will be kept in storage before being garbage collected. (default 1m0s) | -| `--concurrent` | int | The number of concurrent reconciles per controller. (default 2) | -| `--default-service-account` | string | Default service account to use for workload identity when not specified in resources. | -| `--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") | -| `--helm-cache-max-size` | int | The maximum size of the cache in number of indexes. | -| `--helm-cache-purge-interval` | string | The interval at which the cache is purged. Valid time units are ms, s, m. (default "1m") | -| `--helm-cache-ttl` | string | The TTL of an index in the cache. Valid time units are ms, s, m. (default "15m") | -| `--helm-chart-file-max-size` | int | The max allowed size in bytes of a file in a Helm chart. (default 5242880) | -| `--helm-chart-max-size` | int | The max allowed size in bytes of a Helm chart file. (default 10485760) | -| `--helm-index-max-size` | int | The max allowed size in bytes of a Helm repository index file. (default 52428800) | -| `--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) | -| `--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) | -| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) | -| `--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. | -| `--storage-addr` | string | The address the static file server binds to. (default ":9090") | -| `--storage-adv-addr` | string | The advertised address of the static file server. | -| `--storage-path` | string | The local storage path. | -| `--token-cache-max-size` | int | The maximum amount of entries in the LRU cache used for tokens. (default 100, enabled) | -| `--token-cache-max-duration` | duration | The maximum duration for which a token would be considered unexpired. This is capped at 1h. (default 1h) | -| `--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/key=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). | -| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. | -| `OptimizedGitClones` | `true` | Optimises Git resource usage by only cloning repositories when the HEAD commit changed since last reconciliation. | - -## Source watcher flags - -| Name | Type | Description | -|---------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--artifact-digest-algo` | string | The hashing algorithm used to calculate the digest of artifacts. (default "sha256") | -| `--artifact-retention-records` | int | The maximum number of artifacts to be kept in storage after a garbage collection. (default 2) | -| `--artifact-retention-ttl` | duration | The duration of time that artifacts from previous reconciliations will be kept in storage before being garbage collected. (default 1m0s) | -| `--concurrent` | int | The number of concurrent reconciles per controller. (default 10) | -| `--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") | -| `--http-retry` | int | The maximum number of retries when failing to fetch artifacts over HTTP. (default 9) | -| `--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) | -| `--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. (default false) | -| `--reconciliation-timeout` | duration | The maximum duration of a reconciliation. (default 10m0s) | -| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 5s) | -| `--storage-addr` | string | The address the static file server binds to. (default ":9090") | -| `--storage-adv-addr` | string | The advertised address of the static file server. | -| `--storage-path` | string | The local storage path. (default "/data") | -| `--watch-all-namespaces` | boolean | Watch for resources in all namespaces, if set to false it will only watch the runtime namespace. (default true) | -| `--feature-gates` | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. | - -### Feature Gates - -| Name | Default Value | Description | -|----------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `DirectSourceFetch` | `false` | Enables fetching source objects (GitRepository, OCIRepository, Bucket, HelmChart, ExternalArtifact) directly from the API server using APIReader, bypassing the controller's cache. This can be useful when immediate consistency is required for source object reads. | diff --git a/hack/import-flux2-assets.sh b/hack/import-flux2-assets.sh index 1003f613f..ee2fe8a57 100755 --- a/hack/import-flux2-assets.sh +++ b/hack/import-flux2-assets.sh @@ -115,6 +115,86 @@ gen_crd_doc() { fi } +replace_or_append_section() { + local dest="$1" + local heading="$2" + local section="$3" + local tmp + + tmp="$(mktemp)" + if ! awk -v heading="## ${heading}" -v section="${section}" ' + function print_section() { + while ((getline line < section) > 0) { + print line + } + close(section) + } + $0 == heading { + print_section() + in_section = 1 + replaced = 1 + next + } + in_section && /^## / { + in_section = 0 + } + !in_section { + print + } + END { + if (!replaced) { + print "" + print_section() + } + } + ' "$dest" > "$tmp"; then + rm -f "$tmp" + fatal "Unable to update '${heading}' in ${dest}" + fi + mv "$tmp" "$dest" +} + +gen_options_doc() { + local url="$1" + local dest="$2" + local heading="$3" + local tmp + local section + + tmp="$(mktemp)" + section="$(mktemp)" + curl -u "$GITHUB_USER:$GITHUB_TOKEN" -# -Lf "$url" > "$tmp" + + if ! awk -v heading="## ${heading}" ' + /^