Skip to content

Commit da74847

Browse files
Robert FeketeRobert Fekete
authored andcommitted
More generated file updates
1 parent 4d11600 commit da74847

File tree

4 files changed

+100
-63
lines changed

4 files changed

+100
-63
lines changed

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

Lines changed: 77 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,9 @@ FluentbitSpec defines the desired state of FluentbitAgent
6565
### bufferVolumeResources (corev1.ResourceRequirements, optional) {#fluentbitspec-buffervolumeresources}
6666

6767

68+
### configHotReload (*HotReload, optional) {#fluentbitspec-confighotreload}
69+
70+
6871
### coroStackSize (int32, optional) {#fluentbitspec-corostacksize}
6972

7073
Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small value (say 4096), or coroutine threads can overrun the stack buffer. Do not change the default value of this parameter unless you know what you are doing. (default: 24576)
@@ -179,7 +182,7 @@ Available in Logging operator version 4.4 and later.
179182
180183
### logLevel (string, optional) {#fluentbitspec-loglevel}
181184
182-
Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that trace mode is only available if Fluent Bit was built with the WITH_TRACE option enabled. (default: info)
185+
Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that trace mode is only available if Fluent Bit was built with the WITH_TRACE option enabled.
183186
184187
Default: info
185188
@@ -290,57 +293,57 @@ FluentbitNetwork defines network configuration for fluentbit
290293
291294
### connectTimeout (*uint32, optional) {#fluentbitnetwork-connecttimeout}
292295
293-
Sets the timeout for connecting to an upstream
296+
Sets the timeout for connecting to an upstream
294297
295-
Default: 10
298+
Default: 10
296299
297300
### connectTimeoutLogError (*bool, optional) {#fluentbitnetwork-connecttimeoutlogerror}
298301
299-
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message
302+
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message
300303
301-
Default: true
304+
Default: true
302305
303306
### dnsMode (string, optional) {#fluentbitnetwork-dnsmode}
304307
305-
Sets the primary transport layer protocol used by the asynchronous DNS resolver for connections established
308+
Sets the primary transport layer protocol used by the asynchronous DNS resolver for connections established
306309
307-
Default: UDP, UDP or TCP
310+
Default: UDP, UDP or TCP
308311
309312
### dnsPreferIpv4 (*bool, optional) {#fluentbitnetwork-dnspreferipv4}
310313
311-
Prioritize IPv4 DNS results when trying to establish a connection
314+
Prioritize IPv4 DNS results when trying to establish a connection
312315
313-
Default: false
316+
Default: false
314317
315318
### dnsResolver (string, optional) {#fluentbitnetwork-dnsresolver}
316319
317-
Select the primary DNS resolver type
320+
Select the primary DNS resolver type
318321
319-
Default: ASYNC, LEGACY or ASYNC
322+
Default: ASYNC, LEGACY or ASYNC
320323
321324
### keepalive (*bool, optional) {#fluentbitnetwork-keepalive}
322325
323-
Whether or not TCP keepalive is used for the upstream connection
326+
Whether or not TCP keepalive is used for the upstream connection
324327
325-
Default: true
328+
Default: true
326329
327330
### keepaliveIdleTimeout (*uint32, optional) {#fluentbitnetwork-keepaliveidletimeout}
328331
329-
How long in seconds a TCP keepalive connection can be idle before being recycled
332+
How long in seconds a TCP keepalive connection can be idle before being recycled
330333
331-
Default: 30
334+
Default: 30
332335
333336
### keepaliveMaxRecycle (*uint32, optional) {#fluentbitnetwork-keepalivemaxrecycle}
334337
335-
How many times a TCP keepalive connection can be used before being recycled
338+
How many times a TCP keepalive connection can be used before being recycled
336339
337-
Default: 0, disabled
340+
Default: 0, disabled
338341
339342
### sourceAddress (string, optional) {#fluentbitnetwork-sourceaddress}
340343
341-
Specify network address (interface) to use for connection and data traffic.
344+
Specify network address (interface) to use for connection and data traffic.
342345
343-
Default: disabled
346+
Default: disabled
344347
345348
346349
## BufferStorage
@@ -349,13 +352,19 @@ BufferStorage is the Service Section Configuration of fluent-bit
349352
350353
### storage.backlog.mem_limit (string, optional) {#bufferstorage-storage.backlog.mem_limit}
351354
352-
If storage.path is set, Fluent Bit will look for data chunks that were not delivered and are still in the storage layer, these are called backlog data. This option configure a hint of maximum value of memory to use when processing these records.
355+
If storage.path is set, Fluent Bit will look for data chunks that were not delivered and are still in the storage layer, these are called backlog data. This option configure a hint of maximum value of memory to use when processing these records.
353356
354357
Default: 5M
355358
356359
### storage.checksum (string, optional) {#bufferstorage-storage.checksum}
357360
358-
Enable the data integrity check when writing and reading data from the filesystem. The storage layer uses the CRC32 algorithm.
361+
Enable the data integrity check when writing and reading data from the filesystem. The storage layer uses the CRC32 algorithm.
362+
363+
Default: Off
364+
365+
### storage.delete_irrecoverable_chunks (string, optional) {#bufferstorage-storage.delete_irrecoverable_chunks}
366+
367+
When enabled, irrecoverable chunks will be deleted during runtime, and any other irrecoverable chunk located in the configured storage path directory will be deleted when Fluent Bit starts.
359368
360369
Default: Off
361370
@@ -372,7 +381,7 @@ Set an optional location in the file system to store streams and chunks of data.
372381

373382
### storage.sync (string, optional) {#bufferstorage-storage.sync}
374383

375-
Configure the synchronization mode used to store the data into the file system. It can take the values normal or full.
384+
Configure the synchronization mode used to store the data into the file system. It can take the values normal or full.
376385

377386
Default: normal
378387

@@ -400,19 +409,30 @@ The retry failure count to meet the unhealthy requirement, this is a sum for all
400409
Default: 5
401410

402411

412+
## HotReload
413+
414+
HotReload configuration
415+
416+
### image (ImageSpec, optional) {#hotreload-image}
417+
418+
419+
### resources (corev1.ResourceRequirements, optional) {#hotreload-resources}
420+
421+
422+
403423
## InputTail
404424

405425
InputTail defines FluentbitAgent tail input configuration The tail input plugin allows to monitor one or several text files. It has a similar behavior like tail -f shell command.
406426

407427
### Buffer_Chunk_Size (string, optional) {#inputtail-buffer_chunk_size}
408428

409-
Set the buffer size for HTTP client when reading responses from Kubernetes API server. The value must be according to the Unit Size specification.
429+
Set the buffer size for HTTP client when reading responses from Kubernetes API server. The value must be according to the Unit Size specification.
410430

411431
Default: 32k
412432

413433
### Buffer_Max_Size (string, optional) {#inputtail-buffer_max_size}
414434

415-
Set the limit of the buffer size per monitored file. When a buffer needs to be increased (e.g: very long lines), this value is used to restrict how much the memory buffer can grow. If reading a file exceed this limit, the file is removed from the monitored file list. The value must be according to the Unit Size specification.
435+
Set the limit of the buffer size per monitored file. When a buffer needs to be increased (e.g: very long lines), this value is used to restrict how much the memory buffer can grow. If reading a file exceed this limit, the file is removed from the monitored file list. The value must be according to the Unit Size specification.
416436

417437
Default: Buffer_Chunk_Size
418438

@@ -423,31 +443,31 @@ Specify the database file to keep track of monitored files and offsets.
423443

424444
### DB.journal_mode (string, optional) {#inputtail-db.journal_mode}
425445

426-
sets the journal mode for databases (WAL). Enabling WAL provides higher performance. Note that WAL is not compatible with shared network file systems.
446+
sets the journal mode for databases (WAL). Enabling WAL provides higher performance. Note that WAL is not compatible with shared network file systems.
427447

428-
Default: WAL
448+
Default: WAL
429449

430450
### DB.locking (*bool, optional) {#inputtail-db.locking}
431451

432-
Specify that the database will be accessed only by Fluent Bit. Enabling this feature helps to increase performance when accessing the database but it restrict any external tool to query the content.
452+
Specify that the database will be accessed only by Fluent Bit. Enabling this feature helps to increase performance when accessing the database but it restrict any external tool to query the content.
433453

434-
Default: true
454+
Default: true
435455

436456
### DB_Sync (string, optional) {#inputtail-db_sync}
437457

438-
Set a default synchronization (I/O) method. Values: Extra, Full, Normal, Off. This flag affects how the internal SQLite engine do synchronization to disk, for more details about each option please refer to this section.
458+
Set a default synchronization (I/O) method. Values: Extra, Full, Normal, Off. This flag affects how the internal SQLite engine do synchronization to disk, for more details about each option please refer to this section.
439459

440460
Default: Full
441461

442462
### Docker_Mode (string, optional) {#inputtail-docker_mode}
443463

444-
If enabled, the plugin will recombine split Docker log lines before passing them to any parser as configured above. This mode cannot be used at the same time as Multiline.
464+
If enabled, the plugin will recombine split Docker log lines before passing them to any parser as configured above. This mode cannot be used at the same time as Multiline.
445465

446466
Default: Off
447467

448468
### Docker_Mode_Flush (string, optional) {#inputtail-docker_mode_flush}
449469

450-
Wait period time in seconds to flush queued unfinished split lines.
470+
Wait period time in seconds to flush queued unfinished split lines.
451471

452472
Default: 4
453473

@@ -468,7 +488,7 @@ Ignores files that have been last modified before this time in seconds. Supports
468488

469489
### Key (string, optional) {#inputtail-key}
470490

471-
When a message is unstructured (no parser applied), it's appended as a string under the key name log. This option allows to define an alternative name for that key.
491+
When a message is unstructured (no parser applied), it's appended as a string under the key name log. This option allows to define an alternative name for that key.
472492

473493
Default: log
474494

@@ -479,21 +499,21 @@ Set a limit of memory that Tail plugin can use when appending data to the Engine
479499

480500
### Multiline (string, optional) {#inputtail-multiline}
481501

482-
If enabled, the plugin will try to discover multiline messages and use the proper parsers to compose the outgoing messages. Note that when this option is enabled the Parser option is not used.
502+
If enabled, the plugin will try to discover multiline messages and use the proper parsers to compose the outgoing messages. Note that when this option is enabled the Parser option is not used.
483503

484504
Default: Off
485505

486506
### Multiline_Flush (string, optional) {#inputtail-multiline_flush}
487507

488-
Wait period time in seconds to process queued multiline messages
508+
Wait period time in seconds to process queued multiline messages
489509

490510
Default: 4
491511

492512
### multiline.parser ([]string, optional) {#inputtail-multiline.parser}
493513

494-
Specify one or multiple parser definitions to apply to the content. Part of the new Multiline Core support in 1.8
514+
Specify one or multiple parser definitions to apply to the content. Part of the new Multiline Core support in 1.8
495515

496-
Default: ""
516+
Default: ""
497517

498518
### Parser (string, optional) {#inputtail-parser}
499519

@@ -527,19 +547,19 @@ For new discovered files on start (without a database offset/position), read the
527547

528548
### Refresh_Interval (string, optional) {#inputtail-refresh_interval}
529549

530-
The interval of refreshing the list of watched files in seconds.
550+
The interval of refreshing the list of watched files in seconds.
531551

532552
Default: 60
533553

534554
### Rotate_Wait (string, optional) {#inputtail-rotate_wait}
535555

536-
Specify the number of extra time in seconds to monitor a file once is rotated in case some pending data is flushed.
556+
Specify the number of extra time in seconds to monitor a file once is rotated in case some pending data is flushed.
537557

538558
Default: 5
539559

540560
### Skip_Long_Lines (string, optional) {#inputtail-skip_long_lines}
541561

542-
When a monitored file reach it buffer capacity due to a very long line (Buffer_Max_Size), the default behavior is to stop monitoring that file. Skip_Long_Lines alter that behavior and instruct Fluent Bit to skip long lines and continue processing other lines that fits into the buffer size.
562+
When a monitored file reach it buffer capacity due to a very long line (Buffer_Max_Size), the default behavior is to stop monitoring that file. Skip_Long_Lines alter that behavior and instruct Fluent Bit to skip long lines and continue processing other lines that fits into the buffer size.
543563

544564
Default: Off
545565

@@ -566,55 +586,55 @@ FilterKubernetes Fluent Bit Kubernetes Filter allows to enrich your log files wi
566586

567587
### Annotations (string, optional) {#filterkubernetes-annotations}
568588

569-
Include Kubernetes resource annotations in the extra metadata.
589+
Include Kubernetes resource annotations in the extra metadata.
570590

571591
Default: On
572592

573593
### Buffer_Size (string, optional) {#filterkubernetes-buffer_size}
574594

575-
Set the buffer size for HTTP client when reading responses from Kubernetes API server. The value must be according to the Unit Size specification. A value of 0 results in no limit, and the buffer will expand as-needed. Note that if pod specifications exceed the buffer limit, the API response will be discarded when retrieving metadata, and some kubernetes metadata will fail to be injected to the logs. If this value is empty we will set it "0".
595+
Set the buffer size for HTTP client when reading responses from Kubernetes API server. The value must be according to the Unit Size specification. A value of 0 results in no limit, and the buffer will expand as-needed. Note that if pod specifications exceed the buffer limit, the API response will be discarded when retrieving metadata, and some kubernetes metadata will fail to be injected to the logs. If this value is empty we will set it "0".
576596

577597
Default: "0"
578598

579599
### Cache_Use_Docker_Id (string, optional) {#filterkubernetes-cache_use_docker_id}
580600

581-
When enabled, metadata will be fetched from K8s when docker_id is changed.
601+
When enabled, metadata will be fetched from K8s when docker_id is changed.
582602

583603
Default: Off
584604

585605
### DNS_Retries (string, optional) {#filterkubernetes-dns_retries}
586606

587-
DNS lookup retries N times until the network start working
607+
DNS lookup retries N times until the network start working
588608

589609
Default: 6
590610

591611
### DNS_Wait_Time (string, optional) {#filterkubernetes-dns_wait_time}
592612

593-
DNS lookup interval between network status checks
613+
DNS lookup interval between network status checks
594614

595615
Default: 30
596616

597617
### Dummy_Meta (string, optional) {#filterkubernetes-dummy_meta}
598618

599-
If set, use dummy-meta data (for test/dev purposes)
619+
If set, use dummy-meta data (for test/dev purposes)
600620

601621
Default: Off
602622

603623
### K8S-Logging.Exclude (string, optional) {#filterkubernetes-k8s-logging.exclude}
604624

605-
Allow Kubernetes Pods to exclude their logs from the log processor (read more about it in Kubernetes Annotations section).
625+
Allow Kubernetes Pods to exclude their logs from the log processor (read more about it in Kubernetes Annotations section).
606626

607627
Default: On
608628

609629
### K8S-Logging.Parser (string, optional) {#filterkubernetes-k8s-logging.parser}
610630

611-
Allow Kubernetes Pods to suggest a pre-defined Parser (read more about it in Kubernetes Annotations section)
631+
Allow Kubernetes Pods to suggest a pre-defined Parser (read more about it in Kubernetes Annotations section)
612632

613633
Default: Off
614634

615635
### Keep_Log (string, optional) {#filterkubernetes-keep_log}
616636

617-
When Keep_Log is disabled, the log field is removed from the incoming message once it has been successfully merged (Merge_Log must be enabled as well).
637+
When Keep_Log is disabled, the log field is removed from the incoming message once it has been successfully merged (Merge_Log must be enabled as well).
618638

619639
Default: On
620640

@@ -631,7 +651,7 @@ Absolute path to scan for certificate files
631651

632652
### Kube_Meta_Cache_TTL (string, optional) {#filterkubernetes-kube_meta_cache_ttl}
633653

634-
Configurable TTL for K8s cached metadata. By default, it is set to 0 which means TTL for cache entries is disabled and cache entries are evicted at random when capacity is reached. In order to enable this option, you should set the number to a time interval. For example, set this value to 60 or 60s and cache entries which have been created more than 60s will be evicted.
654+
Configurable TTL for K8s cached metadata. By default, it is set to 0 which means TTL for cache entries is disabled and cache entries are evicted at random when capacity is reached. In order to enable this option, you should set the number to a time interval. For example, set this value to 60 or 60s and cache entries which have been created more than 60s will be evicted.
635655

636656
Default: 0
637657

@@ -660,19 +680,19 @@ Default: 600
660680

661681
### Kube_URL (string, optional) {#filterkubernetes-kube_url}
662682

663-
API Server end-point.
683+
API Server end-point.
664684

665685
Default: `https://kubernetes.default.svc:443`
666686

667687
### Kubelet_Port (string, optional) {#filterkubernetes-kubelet_port}
668688

669-
kubelet port using for HTTP request, this only works when Use_Kubelet set to On
689+
kubelet port using for HTTP request, this only works when Use_Kubelet set to On
670690

671691
Default: 10250
672692

673693
### Labels (string, optional) {#filterkubernetes-labels}
674694

675-
Include Kubernetes resource labels in the extra metadata.
695+
Include Kubernetes resource labels in the extra metadata.
676696

677697
Default: On
678698

@@ -695,7 +715,7 @@ When Merge_Log is enabled, the filter tries to assume the log field from the inc
695715

696716
### Merge_Log_Trim (string, optional) {#filterkubernetes-merge_log_trim}
697717

698-
When Merge_Log is enabled, trim (remove possible \n or \r) field values.
718+
When Merge_Log is enabled, trim (remove possible \n or \r) field values.
699719

700720
Default: On
701721

@@ -711,25 +731,25 @@ Set an alternative Parser to process record Tag and extract pod_name, namespace_
711731

712732
### tls.debug (string, optional) {#filterkubernetes-tls.debug}
713733

714-
Debug level between 0 (nothing) and 4 (every detail).
734+
Debug level between 0 (nothing) and 4 (every detail).
715735

716736
Default: -1
717737

718738
### tls.verify (string, optional) {#filterkubernetes-tls.verify}
719739

720-
When enabled, turns on certificate validation when connecting to the Kubernetes API server.
740+
When enabled, turns on certificate validation when connecting to the Kubernetes API server.
721741

722742
Default: On
723743

724744
### Use_Journal (string, optional) {#filterkubernetes-use_journal}
725745

726-
When enabled, the filter reads logs coming in Journald format.
746+
When enabled, the filter reads logs coming in Journald format.
727747

728748
Default: Off
729749

730750
### Use_Kubelet (string, optional) {#filterkubernetes-use_kubelet}
731751

732-
This is an optional feature flag to get metadata information from kubelet instead of calling Kube Server API to enhance the log.
752+
This is an optional feature flag to get metadata information from kubelet instead of calling Kube Server API to enhance the log.
733753

734754
Default: Off
735755

0 commit comments

Comments
 (0)