Skip to content

Commit b0a427a

Browse files
authored
Merge pull request #909 from fluxcd/backport-907-to-release/v1.1.x
[release/v1.1.x] Document controller options
2 parents 5556b25 + 716b1d4 commit b0a427a

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

docs/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Image Reflector Controller
2+
3+
## Flags
4+
5+
| Name | Type | Description |
6+
|---------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------|
7+
| `--concurrent` | int | The number of concurrent kustomize reconciles. (default 4) |
8+
| `--default-service-account` | string | Default service account to use for workload identity when not specified in resources. |
9+
| `--enable-leader-election` | boolean | Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. |
10+
| `--events-addr` | string | The address of the events receiver. |
11+
| `--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) |
12+
| `--health-addr` | string | The address the health endpoint binds to. (default ":9440") |
13+
| `--leader-election-lease-duration` | duration | Interval at which non-leader candidates will wait to force acquire leadership (duration string). (default 35s) |
14+
| `--leader-election-release-on-cancel` | boolean | Defines if the leader should step down voluntarily on controller manager shutdown. (default true) |
15+
| `--leader-election-renew-deadline` | duration | Duration that the leading controller manager will retry refreshing leadership before giving up (duration string). (default 30s) |
16+
| `--leader-election-retry-period` | duration | Duration the LeaderElector clients should wait between tries of actions (duration string). (default 5s) |
17+
| `--log-encoding` | string | Log encoding format. Can be 'json' or 'console'. (default "json") |
18+
| `--log-level` | string | Log verbosity level. Can be one of 'trace', 'debug', 'info', 'error'. (default "info") |
19+
| `--metrics-addr` | string | The address the metric endpoint binds to. (default ":8080") |
20+
| `--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. |
21+
| `--requeue-dependency` | duration | The interval at which failing dependencies are reevaluated. (default 30s) |
22+
| `--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. |
23+
| `--storage-path` | string | Where to store the persistent database of image metadata. (default "/data") |
24+
| `--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) |
25+
| `--token-cache-max-size` | int | The maximum amount of entries in the LRU cache used for tokens. (default 100, enabled) |
26+
| `--token-cache-max-duration` | duration | The maximum duration for which a token would be considered unexpired. This is capped at 1h. (default 1h) |
27+
| `--watch-all-namespaces` | boolean | Watch for custom resources in all namespaces, if set to false it will only watch the runtime namespace. (default true) |
28+
| `--watch-label-selector` | string | Watch for resources with matching labels e.g. 'sharding.fluxcd.io/key=shard1'. |
29+
| `--feature-gates` | mapStringBool | A comma separated list of key=value pairs defining the state of experimental features. |
30+
31+
### Feature Gates
32+
33+
| Name | Default Value | Description |
34+
|-------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
35+
| `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). |
36+
| `FluxStorage` | `false` | Enables the use of Flux's own storage implementation for the image tags database. |
37+
| `ObjectLevelWorkloadIdentity` | `false` | Enables the use of object-level workload identity for the controller. |

0 commit comments

Comments
 (0)