Skip to content

Commit b74366f

Browse files
eschabelleschabell
authored
in_kubernetes_events: add missing parameters and fix defaults. (#2273)
* docs(kubernetes-events): add missing parameters and fix defaults - Add missing config parameters: db.journal_mode, db.locking, dns_retries, dns_wait_time - Fix tls.verify default from 'On' to 'true' to match source - Fix kube_namespace default from 'all' to none - Sort parameters alphabetically - Align table format with other input plugin docs - Expand tls.debug description with all debug levels Fixes #2272. Signed-off-by: Eric D. Schabell <eric@schabell.org> * pipeline: inputs: kubernetes-events: removed two config parameters to match code PR. Signed-off-by: Eric D. Schabell <eric@schabell.org> --------- Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 026c744 commit b74366f

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

‎pipeline/inputs/kubernetes-events.md‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,27 @@ description: Collect Kubernetes events
66

77
Kubernetes exports events through the API server. This input plugin lets you retrieve those events as logs and process them through the pipeline.
88

9-
## Configuration
10-
11-
12-
| Key | Description | Default |
13-
|-----------------------|--------------------------------------------------------------------------------|--------------------------------------------------------|
14-
| `db` | Set a database file to keep track of recorded Kubernetes events. | _none_ |
15-
| `db.sync` | Set a database sync method. Accepted values: `extra`, `full`, `normal`, `off`. | `normal` |
16-
| `interval_sec` | Set the reconnect interval (seconds). | `0` |
17-
| `interval_nsec` | Set the reconnect interval (sub seconds: nanoseconds). | `500000000` |
18-
| `kube_url` | API Server endpoint. | `https://kubernetes.default.svc` |
19-
| `kube_ca_file` | Kubernetes TLS CA file. | `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt` |
20-
| `kube_ca_path` | Kubernetes TLS ca path. | _none_ |
21-
| `kube_token_file` | Kubernetes authorization token file. | `/var/run/secrets/kubernetes.io/serviceaccount/token` |
22-
| `kube_token_ttl` | Kubernetes token time to live, until it's read again from the token file. | `10m` |
23-
| `kube_request_limit` | Kubernetes limit parameter for events query, no limit applied when set to `0`. | `0` |
24-
| `kube_retention_time` | Kubernetes retention time for events. | `1h` |
25-
| `kube_namespace` | Kubernetes namespace to query events from. | `all` |
26-
| `tls.debug` | Debug level between `0` (nothing) and `4` (every detail). | `0` |
27-
| `tls.verify` | Enable or disable verification of TLS peer certificate. | `On` |
28-
| `tls.vhost` | Set optional TLS virtual host. | _none_ |
9+
## Configuration parameters
10+
11+
| Key | Description | Default |
12+
|:----|:------------|:--------|
13+
| `db` | Set a database file to keep track of recorded Kubernetes events. | _none_ |
14+
| `db.journal_mode` | Set the journal mode for databases. Values: `DELETE`, `TRUNCATE`, `PERSIST`, `MEMORY`, `WAL`, `OFF`. | `WAL` |
15+
| `db.locking` | Specify that the database will be accessed only by Fluent Bit. Enabling this feature helps increase performance when accessing the database but restricts external tools from querying the content. | `false` |
16+
| `db.sync` | Set a database sync method. Values: `extra`, `full`, `normal`, `off`. | `normal` |
17+
| `interval_nsec` | Set the reconnect interval (sub seconds: nanoseconds). | `500000000` |
18+
| `interval_sec` | Set the reconnect interval (seconds). | `0` |
19+
| `kube_ca_file` | Kubernetes TLS CA file. | `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt` |
20+
| `kube_ca_path` | Kubernetes TLS CA path. | _none_ |
21+
| `kube_namespace` | Kubernetes namespace to query events from. Gets events from all namespaces by default. | _none_ |
22+
| `kube_request_limit` | Kubernetes limit parameter for events query. No limit applied when set to `0`. | `0` |
23+
| `kube_retention_time` | Kubernetes retention time for events. | `1h` |
24+
| `kube_token_file` | Kubernetes authorization token file. | `/var/run/secrets/kubernetes.io/serviceaccount/token` |
25+
| `kube_token_ttl` | Kubernetes token time to live, until it's read again from the token file. | `10m` |
26+
| `kube_url` | API Server endpoint. | `https://kubernetes.default.svc` |
27+
| `tls.debug` | Set TLS debug level: `0` (no debug), `1` (error), `2` (state change), `3` (info), and `4` (verbose). | `0` |
28+
| `tls.verify` | Enable or disable verification of TLS peer certificate. | `true` |
29+
| `tls.vhost` | Set optional TLS virtual host. | _none_ |
2930

3031
In Fluent Bit 3.1 or later, this plugin uses a Kubernetes watch stream instead of polling. In versions earlier than 3.1, the interval parameters are used for reconnecting the Kubernetes watch stream.
3132

@@ -41,7 +42,7 @@ The Kubernetes service account used by Fluent Bit must have `get`, `list`, and `
4142

4243
### Basic configuration file
4344

44-
In the following configuration file, the Kubernetes events plugin collects events every `5` seconds (default for `interval_nsec`) and exposes them through the [standard output plugin](../outputs/standard-output.md) on the console:
45+
In the following configuration file, the Kubernetes events plugin collects events and exposes them through the [standard output plugin](../outputs/standard-output.md) on the console:
4546

4647

4748
{% tabs %}

0 commit comments

Comments
 (0)