Skip to content

Commit d074eac

Browse files
authored
Merge pull request #272 from kube-logging/feat/install-deployments-args
feat: add section about deployment arguments to install page
2 parents 92121e4 + 11a71e7 commit d074eac

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

Diff for: content/docs/install/_index.md

+40
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,46 @@ aliases:
2828

2929
{{< include-headless "note-helm-chart-logging-resource.md" >}}
3030

31+
## Operator arguments {#arguments}
32+
33+
### Metrics and Performance
34+
35+
- `--metrics-addr` (string, default `:8080`): Address for metric endpoint
36+
- `--pprof` (boolean, default `false`): Enable performance profiling
37+
38+
### Logging Configuration
39+
40+
- `--verbose` (boolean, default `false`): Enable verbose logging
41+
- `--klogLevel` (integer, default `0`): Global log level for klog (0-9)
42+
- `--output-format` (string, default `""`): Logging output format (`json` or `console`)
43+
44+
### Resource Watching
45+
46+
- `--watch-namespace` (string, default `""`): Filter watched objects by namespace
47+
- `--watch-logging-name` (string, default `""`): Filter objects by logging resource name
48+
- `--watch-labeled-children` (boolean, default `false`): Watch child resources only with logging operator's name label (`app.kubernetes.io/name: fluentd|fluentbit|syslog-ng`)
49+
- `--watch-labeled-secrets` (boolean, default `false`): Watch secrets only with `logging.banzaicloud.io/watch: enabled` label
50+
51+
> **Note on Combinations:**
52+
> - If `watch-namespace` is set, it narrows the scope for ALL watched resources
53+
> - `watch-logging-name` and `watch-labeled-children` can be combined to further restrict child resource watching
54+
> - `watch-labeled-children` and `watch-labeled-secrets` apply independent label filters
55+
> - Using multiple filters creates an increasingly restrictive watch scope
56+
> - Most restrictive scenario: All three flags set will significantly limit the operator's resource visibility
57+
58+
### Controller Management
59+
60+
- `--enable-leader-election` (boolean, default `false`): Ensure only one active controller manager
61+
- `--finalizer-cleanup` (boolean, default `false`): Remove finalizers during operator shutdown, useful for `Helm` uninstallation
62+
- `--enable-telemetry-controller-route` (boolean, default `false`): Enable Telemetry Controller routing for Logging resources
63+
- `--sync-period` (string, default `""`): Minimum frequency for reconciling watched resources, for example, `30s`, or `2h45m`. Valid time units are "ms", "s", "m", "h".
64+
65+
To add arguments with `Helm` you can use the `extraArgs` field e.g:
66+
67+
```bash
68+
helm install logging-operator ./charts/logging-operator/ --set extraArgs='{"-enable-leader-election=true","-enable-telemetry-controller-route"}'
69+
```
70+
3171
## Validate the deployment {#validate}
3272

3373
To verify that the installation was successful, complete the following steps.

0 commit comments

Comments
 (0)