Skip to content

Commit edab803

Browse files
Robert FeketeRobert Fekete
authored andcommitted
Updates generated docs
1 parent 5e5803c commit edab803

File tree

7 files changed

+58
-6
lines changed

7 files changed

+58
-6
lines changed

content/docs/configuration/crds/v1beta1/common_types.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ weight: 200
44
generated_file: true
55
---
66

7+
## BasicImageSpec
8+
9+
BasicImageSpec struct hold basic information about image specification
10+
11+
### repository (string, optional) {#basicimagespec-repository}
12+
13+
14+
### tag (string, optional) {#basicimagespec-tag}
15+
16+
17+
718
## ImageSpec
819

920
ImageSpec struct hold information about image specification

content/docs/configuration/crds/v1beta1/fluentbit_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,12 @@ When enabled, irrecoverable chunks will be deleted during runtime, and any other
379379
380380
Default: Off
381381
382+
### storage.max_chunks_up (int, optional) {#bufferstorage-storage.max_chunks_up}
383+
384+
If the input plugin has enabled filesystem storage type, this property sets the maximum number of Chunks that can be up in memory. This is the setting to use to control memory usage when you enable storage.type filesystem.
385+
386+
Default: 128
387+
382388
### storage.metrics (string, optional) {#bufferstorage-storage.metrics}
383389
384390
Available in Logging operator version 4.4 and later. If the `http_server` option has been enabled in the main Service configuration section, this option registers a new endpoint where internal metrics of the storage layer can be consumed.

content/docs/configuration/crds/v1beta1/syslogng_types.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ SyslogNGSpec defines the desired state of SyslogNG
1111
### bufferVolumeMetrics (*BufferMetrics, optional) {#syslogngspec-buffervolumemetrics}
1212

1313

14+
### bufferVolumeMetricsImage (*BasicImageSpec, optional) {#syslogngspec-buffervolumemetricsimage}
15+
16+
1417
### bufferVolumeMetricsService (*typeoverride.Service, optional) {#syslogngspec-buffervolumemetricsservice}
1518

1619

@@ -22,6 +25,9 @@ Overrides the default logging level configCheck setup. This field is not used di
2225
### configCheckPod (*typeoverride.PodSpec, optional) {#syslogngspec-configcheckpod}
2326

2427

28+
### configReloadImage (*BasicImageSpec, optional) {#syslogngspec-configreloadimage}
29+
30+
2531
### globalOptions (*GlobalOptions, optional) {#syslogngspec-globaloptions}
2632

2733

@@ -42,6 +48,9 @@ Available in Logging operator version 4.5 and later. Set the maximum number of c
4248
### metrics (*Metrics, optional) {#syslogngspec-metrics}
4349

4450

51+
### metricsExporterImage (*BasicImageSpec, optional) {#syslogngspec-metricsexporterimage}
52+
53+
4554
### metricsService (*typeoverride.Service, optional) {#syslogngspec-metricsservice}
4655

4756

@@ -70,6 +79,9 @@ Available in Logging operator version 4.5 and later. Create [custom log metrics
7079
### statefulSet (*typeoverride.StatefulSet, optional) {#syslogngspec-statefulset}
7180

7281

82+
### syslogNGImage (*BasicImageSpec, optional) {#syslogngspec-syslogngimage}
83+
84+
7385
### tls (SyslogNGTLS, optional) {#syslogngspec-tls}
7486

7587

content/docs/configuration/plugins/outputs/forward.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Default: 0
6969

7070
### phi_failure_detector (bool, optional) {#forwardoutput-phi_failure_detector}
7171

72-
Use the "Phi accrual failure detector" to detect server failure.
72+
Use the "Phi accrual failure detector" to detect server failure.
7373

7474
Default: true
7575

@@ -115,6 +115,7 @@ The threshold for chunk flush performance check. Parameter type is float, not ti
115115

116116
Format forwarded events time as an epoch Integer with second resolution. Useful when forwarding to old ( <= 0.12 ) Fluentd servers.
117117

118+
118119
### tls_allow_self_signed_cert (bool, optional) {#forwardoutput-tls_allow_self_signed_cert}
119120

120121
Allow self signed certificates or not.

content/docs/configuration/plugins/outputs/gelf.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ generated_file: true
66

77
# [GELF Output](https://github.com/hotschedules/fluent-plugin-gelf-hs)
88
## Overview
9-
Fluentd output plugin for GELF.
9+
Fluentd output plugin for GELF. For details, see [https://github.com/bmichalkiewicz/fluent-plugin-gelf-best](https://github.com/bmichalkiewicz/fluent-plugin-gelf-best).
10+
11+
## Example
12+
```yaml
13+
spec:
14+
gelf:
15+
host: gelf-host
16+
port: 12201
17+
```
18+
1019
1120
## Configuration
1221
## Output Config
@@ -21,6 +30,12 @@ Available since ghcr.io/kube-logging/fluentd:v1.16-full-build.139 [Buffer](../bu
2130
Destination host
2231
2332
33+
### max_bytes (int, optional) {#output config-max_bytes}
34+
35+
MaxBytes specifies the maximum size, in bytes, of each individual log message. For details, see [https://github.com/Graylog2/graylog2-server/issues/873](https://github.com/Graylog2/graylog2-server/issues/873) Available since ghcr.io/kube-logging/fluentd:v1.16-4.10-full
36+
37+
Default: 3200
38+
2439
### port (int, required) {#output-config-port}
2540
2641
Destination host port
@@ -40,7 +55,7 @@ Default: false
4055
4156
### tls_options (map[string]string, optional) {#output-config-tls_options}
4257
43-
TLS options. For details, see [https://github.com/graylog-labs/gelf-rb/blob/72916932b789f7a6768c3cdd6ab69a3c942dbcef/lib/gelf/transport/tcp_tls.rb#L7-L12](https://github.com/graylog-labs/gelf-rb/blob/72916932b789f7a6768c3cdd6ab69a3c942dbcef/lib/gelf/transport/tcp_tls.rb#L7-L12).
58+
TLS Options. For details, see [https://github.com/graylog-labs/gelf-rb/blob/72916932b789f7a6768c3cdd6ab69a3c942dbcef/lib/gelf/transport/tcp_tls.rb#L7-L12](https://github.com/graylog-labs/gelf-rb/blob/72916932b789f7a6768c3cdd6ab69a3c942dbcef/lib/gelf/transport/tcp_tls.rb#L7-L12).
4459
4560
Default: {}
4661

content/docs/configuration/plugins/outputs/kafka.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ spec:
3333
## Configuration
3434
## Kafka
3535
36-
Send your logs to Kafka. Set `use_rdkafka` to `true` to use the rdkafka2 client, which offers higher performance than ruby-kafka.
36+
Send your logs to Kafka. Set `use_rdkafka` to `true` to use the rdkafka2 client, which offers higher performance than ruby-kafka. (Note: requires fluentd image version v1.16-4.9-full or higher)
37+
-[more info](https://github.com/fluent/fluent-plugin-kafka#output-plugin)
3738

3839
### ack_timeout (int, optional) {#kafka-ack_timeout}
3940

@@ -143,6 +144,12 @@ Default: nil
143144
### keytab (*secret.Secret, optional) {#kafka-keytab}
144145

145146

147+
### max_send_limit_bytes (int, optional) {#kafka-max_send_limit_bytes}
148+
149+
Max byte size to send message to avoid MessageSizeTooLarge. Messages over the limit will be dropped
150+
151+
Default: no limit
152+
146153
### max_send_retries (int, optional) {#kafka-max_send_retries}
147154

148155
Number of times to retry sending of messages to a leader
@@ -212,7 +219,7 @@ Client certificate key
212219
Verify certificate hostname
213220

214221

215-
### sasl_over_ssl (bool, required) {#kafka-sasl_over_ssl}
222+
### sasl_over_ssl (*bool, optional) {#kafka-sasl_over_ssl}
216223

217224
SASL over SSL
218225

content/docs/configuration/plugins/syslog-ng-outputs/sumologic_syslog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Default: 6514
3737

3838
### tag (string, optional) {#sumologicsyslogoutput-tag}
3939

40-
This option specifies the list of tags to add as the tags fields of Sumo Logic messages. If not specified, syslog-ng OSE automatically adds the tags already assigned to the message. If you set the tag() option, only the tags you specify will be added to the messages.
40+
This option specifies the list of tags to add as the tags fields of Sumo Logic messages. If not specified, syslog-ng OSE automatically adds the tags already assigned to the message. If you set the tag() option, only the tags you specify will be added to the messages.
4141

4242
Default: tag
4343

0 commit comments

Comments
 (0)