Merge pull request #195 from kube-logging/output-gendoc-updates

fekete-robert · web-flow · commit 22fa7eef1c8f · 2023-10-17T20:44:46.000+02:00
Output gendoc updates
diff --git a/content/docs/configuration/crds/extensions/eventtailer_types.md b/content/docs/configuration/crds/extensions/eventtailer_types.md
@@ -38,6 +38,12 @@ Override container fields for the given statefulset
 
 Default: -
 
+### image (*tailer.ImageSpec, optional) {#eventtailerspec-image}
+
+Override image related fields for the given statefulset, highest precedence 
+
+Default: -
+
 
 ## EventTailerStatus
 
diff --git a/content/docs/configuration/crds/extensions/hosttailer_types.md b/content/docs/configuration/crds/extensions/hosttailer_types.md
@@ -38,6 +38,10 @@ Override podSpec fields for the given daemonset
 
 Default: -
 
+### image (tailer.ImageSpec, optional) {#hosttailerspec-image}
+
+Default: -
+
 
 ## HostTailerStatus
 
diff --git a/content/docs/configuration/crds/v1beta1/_index.md b/content/docs/configuration/crds/v1beta1/_index.md
@@ -14,9 +14,10 @@ For more information please click on the name
 | **[ClusterOutput](clusteroutput_types/)** | ClusterOutput is the Schema for the clusteroutputs API | v1beta1 |
 | **[Common](common_types/)** | ImageSpec Metrics Security | v1beta1 |
 | **[FlowSpec](flow_types/)** | FlowSpec is the Kubernetes spec for Flows | v1beta1 |
-| **[FluentbitSpec](fluentbit_types/)** | FluentbitSpec defines the desired state of Fluentbit | v1beta1 |
+| **[FluentbitSpec](fluentbit_types/)** | FluentbitSpec defines the desired state of FluentbitAgent | v1beta1 |
 | **[FluentdSpec](fluentd_types/)** | FluentdSpec defines the desired state of Fluentd | v1beta1 |
 | **[Logging](logging_types/)** | Logging system configuration | v1beta1 |
+| **[LoggingRouteSpec](loggingroute_types/)** | LoggingRouteSpec defines the desired state of LoggingRoute | v1beta1 |
 | **[NodeAgent](node_agent_types/)** |  | v1beta1 |
 | **[OutputSpec](output_types/)** | OutputSpec defines the desired state of Output | v1beta1 |
 | **[SyslogNGClusterFlow](syslogng_clusterflow_types/)** | SyslogNGClusterFlow is the Schema for the syslog-ng clusterflows API | v1beta1 |
diff --git a/content/docs/configuration/crds/v1beta1/fluentbit_types.md b/content/docs/configuration/crds/v1beta1/fluentbit_types.md
@@ -297,6 +297,12 @@ spec:
           value: message
 ```
 
+### healthCheck (*HealthCheck, optional) {#fluentbitspec-healthcheck}
+
+Available in Logging operator version 4.4 and later.
+
+Default: -
+
 ## FluentbitStatus
 
 FluentbitStatus defines the resource status for FluentbitAgent
@@ -331,6 +337,12 @@ Default: ts
 
 Default: iso8601
 
+### Workers (*int, optional) {#fluentbittcpoutput-workers}
+
+Available in Logging operator version 4.4 and later.
+
+Default: -
+
 
 ## FluentbitNetwork
 
@@ -419,6 +431,39 @@ If storage.path is set, Fluent Bit will look for data chunks that were not deliv
 
 Default: 5M
 
+### storage.metrics (string, optional) {#bufferstorage-storage.metrics}
+
+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.
+
+Default: Off
+
+
+## HealthCheck
+
+Available in Logging operator version 4.4 and later.
+
+HealthCheck configuration
+
+### hcErrorsCount (int, optional) {#healthcheck-hcerrorscount}
+
+The error count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period.
+
+Default: 5
+
+### hcRetryFailureCount (int, optional) {#healthcheck-hcretryfailurecount}
+
+The retry failure count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period
+
+Default: 5
+
+### hcPeriod (int, optional) {#healthcheck-hcperiod}
+
+The time period (in seconds) to count the error and retry failure data point
+
+Default: 60
+
 
 ## InputTail
 
@@ -1066,17 +1111,11 @@ Default: -
 
 Default: -
 
+### Workers (*int, optional) {#forwardoptions-workers}
 
-## FluentbitNameProvider
-
-Defines a FluentbitNameProvider
+Available in Logging operator version 4.4 and later.
 
-### Logging (*Logging, optional) {#fluentbitnameprovider-logging}
+Enables dedicated thread(s) for this output. Default value (2) is set since version 1.8.13. For previous versions is 0. 
 
 Default: -
 
-### FluentbitAgent (*FluentbitAgent, optional) {#fluentbitnameprovider-fluentbitagent}
-
-Default: -
-
-
diff --git a/content/docs/configuration/crds/v1beta1/fluentd_types.md b/content/docs/configuration/crds/v1beta1/fluentd_types.md
@@ -98,7 +98,9 @@ Default: -
 
 ### port (int32, optional) {#fluentdspec-port}
 
-Default: -
+Fluentd port inside the container (24240 by default). The headless service port is controlled by this field as well. Note that the default ClusterIP service port is always 24240, regardless of this field.
+
+Default: 24240
 
 ### tolerations ([]corev1.Toleration, optional) {#fluentdspec-tolerations}
 
@@ -299,14 +301,16 @@ Default: -
 
 ### annotations (map[string]string, optional) {#fluentddrainconfig-annotations}
 
-Container image to use for the drain watch sidecar 
+Annotations to use for the drain watch sidecar 
 
 Default: -
 
 ### labels (map[string]string, optional) {#fluentddrainconfig-labels}
 
 Labels to use for the drain watch sidecar on top of labels added by the operator by default. Default values can be overwritten. 
 
+Default: -
+
 ### deleteVolume (bool, optional) {#fluentddrainconfig-deletevolume}
 
 Should persistent volume claims be deleted after draining is done 
@@ -323,4 +327,20 @@ Container image to use for the fluentd placeholder pod
 
 Default: -
 
+### resources (*corev1.ResourceRequirements, optional) {#fluentddrainconfig-resources}
+
+Available in Logging operator version 4.4 and later.
+
+Configurable resource requirements for the drainer sidecar container. Default 20m cpu request, 20M memory limit 
+
+Default: -
+
+### securityContext (*corev1.SecurityContext, optional) {#fluentddrainconfig-securitycontext}
+
+Available in Logging operator version 4.4 and later.
+
+Configurable security context, uses fluentd pods' security context by default 
+
+Default: -
+
 
diff --git a/content/docs/configuration/crds/v1beta1/logging_types.md b/content/docs/configuration/crds/v1beta1/logging_types.md
@@ -144,10 +144,26 @@ LoggingStatus defines the observed state of Logging
 
 ### configCheckResults (map[string]bool, optional) {#loggingstatus-configcheckresults}
 
+Result of the config check. Under normal conditions there is a single item in the map with a bool value. 
+
 Default: -
 
 ### problems ([]string, optional) {#loggingstatus-problems}
 
+Problems with the logging resource 
+
+Default: -
+
+### problemsCount (int, optional) {#loggingstatus-problemscount}
+
+Count of problems for printcolumn 
+
+Default: -
+
+### watchNamespaces ([]string, optional) {#loggingstatus-watchnamespaces}
+
+List of namespaces that watchNamespaces + watchNamespaceSelector is resolving to. Not set means all namespaces. 
+
 Default: -
 
 
diff --git a/content/docs/configuration/crds/v1beta1/output_types.md b/content/docs/configuration/crds/v1beta1/output_types.md
@@ -72,6 +72,10 @@ Default: -
 
 Default: -
 
+### kinesisFirehose (*output.KinesisFirehoseOutputConfig, optional) {#outputspec-kinesisfirehose}
+
+Default: -
+
 ### kinesisStream (*output.KinesisStreamOutputConfig, optional) {#outputspec-kinesisstream}
 
 Default: -
diff --git a/content/docs/configuration/crds/v1beta1/syslogng_output_types.md b/content/docs/configuration/crds/v1beta1/syslogng_output_types.md
@@ -64,6 +64,12 @@ Default: -
 
 Default: -
 
+### s3 (*output.S3Output, optional) {#syslogngoutputspec-s3}
+
+Available in Logging operator version 4.4 and later.
+
+Default: -
+
 
 ## SyslogNGOutput
 
diff --git a/content/docs/configuration/plugins/_index.md b/content/docs/configuration/plugins/_index.md
@@ -3,8 +3,6 @@ title: Supported Plugins
 generated_file: true
 ---
 
-# Supported Plugins
-
 For more information please click on the plugin name
 <center>
 
diff --git a/content/docs/configuration/plugins/filters/concat.md b/content/docs/configuration/plugins/filters/concat.md
@@ -17,7 +17,7 @@ Specify field name in the record to parse. If you leave empty the Container Runt
 
 Default: -
 
-### separator (string, optional) {#concat-separator}
+### separator (*string, optional) {#concat-separator}
 
 The separator of lines.  
 
diff --git a/content/docs/configuration/plugins/filters/grep.md b/content/docs/configuration/plugins/filters/grep.md
@@ -36,9 +36,9 @@ Default: -
 Default: -
 
 
-## [Regexp Directive](https://docs.fluentd.org/filter/grep#less-than-regexp-greater-than-directive) {#Regexp-Directive}
+## Regexp Directive {#Regexp-Directive}
 
-Specify filtering rule. This directive contains two parameters.
+Specify filtering rule (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-regexp-greater-than-directive)). This directive contains two parameters.
 
 ### key (string, required) {#regexp-directive-key}
 
@@ -83,9 +83,9 @@ spec:
  ```
 
 ---
-## [Exclude Directive](https://docs.fluentd.org/filter/grep#less-than-exclude-greater-than-directive) {#Exclude-Directive}
+## Exclude Directive
 
-Specify filtering rule to reject events. This directive contains two parameters.
+Specify filtering rule to reject events (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-exclude-greater-than-directive)). This directive contains two parameters.
 
 ### key (string, required) {#exclude-directive-key}
 
@@ -132,7 +132,7 @@ spec:
 ---
 ## [Or Directive](https://docs.fluentd.org/filter/grep#less-than-or-greater-than-directive) {#Or-Directive}
 
-Specify filtering rule. This directive contains either `regexp` or `exclude` directive.
+Specify filtering rule (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-or-greater-than-directive). This directive contains either `regexp` or `exclude` directive.
 
 ### regexp ([]RegexpSection, optional) {#or-directive-regexp}
 
@@ -185,7 +185,7 @@ spec:
 ---
 ## [And Directive](https://docs.fluentd.org/filter/grep#less-than-and-greater-than-directive) {#And-Directive}
 
-Specify filtering rule. This directive contains either `regexp` or `exclude` directive.
+Specify filtering rule (as described in the [Fluentd documentation](https://docs.fluentd.org/filter/grep#less-than-and-greater-than-directive). This directive contains either `regexp` or `exclude` directive.
 
 ### regexp ([]RegexpSection, optional) {#and-directive-regexp}
 
diff --git a/content/docs/configuration/plugins/filters/tagnormaliser.md b/content/docs/configuration/plugins/filters/tagnormaliser.md
@@ -4,9 +4,7 @@ weight: 200
 generated_file: true
 ---
 
-# Fluentd Plugin to re-tag based on log metadata
-## Overview
- More info at https://github.com/kube-logging/fluent-plugin-tag-normaliser
+Fluentd Plugin to re-tag based on log metadata. More info at https://github.com/kube-logging/fluent-plugin-tag-normaliser
 
 Available kubernetes metadata
 
diff --git a/content/docs/configuration/plugins/outputs/elasticsearch.md b/content/docs/configuration/plugins/outputs/elasticsearch.md
@@ -578,3 +578,4 @@ Default: -
 If set to true, the output uses the [legacy index template format](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates-v1.html). Otherwise, it uses the [composable index template](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/index-templates.html) format.
 
 Default:  true
+
diff --git a/content/docs/configuration/plugins/outputs/gelf.md b/content/docs/configuration/plugins/outputs/gelf.md
@@ -42,7 +42,6 @@ TLS Options  - for options see https://github.com/graylog-labs/gelf-rb/blob/7291
 Default:  {}
 
 
-
  ## Example `GELF` output configurations
  ```yaml
 apiVersion: logging.banzaicloud.io/v1beta1
diff --git a/content/docs/configuration/plugins/outputs/sqs.md b/content/docs/configuration/plugins/outputs/sqs.md
@@ -84,7 +84,6 @@ The threshold for chunk flush performance check. Parameter type is float, not ti
 Default: -
 
 
-
  ## Example `SQS` output configurations
  ```yaml
 apiVersion: logging.banzaicloud.io/v1beta1
diff --git a/content/docs/configuration/plugins/outputs/sumologic.md b/content/docs/configuration/plugins/outputs/sumologic.md
@@ -9,8 +9,9 @@ generated_file: true
 This plugin has been designed to output logs or metrics to SumoLogic via a HTTP collector endpoint
 More info at https://github.com/SumoLogic/fluentd-output-sumologic
 
- Example secret for HTTP input URL
- ```
+Example secret for HTTP input URL
+
+```
 export URL='https://endpoint1.collection.eu.sumologic.com/receiver/v1/http/.......'
 kubectl create secret generic sumo-output --from-literal "endpoint=$URL"
 ```
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/auth.md b/content/docs/configuration/plugins/syslog-ng-outputs/auth.md
@@ -0,0 +1,50 @@
+---
+title: Authentication for syslog-ng outputs
+weight: 200
+generated_file: true
+---
+
+## Overview
+GRPC-based outputs use this configuration instead of the simple `tls` field found at most HTTP based destinations. For details, see the documentation of a related syslog-ng destination, for example, [Grafana Loki](https://axoflow.com/docs/axosyslog-core/chapter-destinations/destination-loki/#auth).
+
+## Configuration
+## Auth
+
+### alts (*ALTS, optional) {#auth-alts}
+
+Application Layer Transport Security (ALTS) is a simple to use authentication, only available within Google’s infrastructure. 
+
+Default: -
+
+### adc (*ADC, optional) {#auth-adc}
+
+Application Default Credentials (ADC). 
+
+Default: -
+
+### insecure (*Insecure, optional) {#auth-insecure}
+
+This is the default method, authentication is disabled (`auth(insecure())`). 
+
+Default: -
+
+### tls (*TLS, optional) {#auth-tls}
+
+This option sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. TLS can be used only with tcp-based transport protocols. For details, see [TLS for syslog-ng outputs](../tls/) and the [syslog-ng documentation](https://axoflow.com/docs/axosyslog-core/chapter-encrypted-transport-tls/tlsoptions). 
+
+Default: -
+
+
+## ADC
+
+
+## Insecure
+
+
+## ALTS
+
+### target-service-accounts ([]string, optional) {#alts-target-service-accounts}
+
+Default: -
+
+
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md b/content/docs/configuration/plugins/syslog-ng-outputs/disk_buffer.md
@@ -4,8 +4,6 @@ weight: 200
 generated_file: true
 ---
 
-## DiskBuffer
-
 The parameters of the syslog-ng disk buffer. Using a disk buffer on the output helps avoid message loss in case of a system failure on the destination side.
 For details on how [syslog-ng disk buffers work, see the documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-routing-filters/concepts-diskbuffer/).
 
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/elasticsearch.md b/content/docs/configuration/plugins/syslog-ng-outputs/elasticsearch.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/file.md b/content/docs/configuration/plugins/syslog-ng-outputs/file.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/http.md b/content/docs/configuration/plugins/syslog-ng-outputs/http.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/logscale.md b/content/docs/configuration/plugins/syslog-ng-outputs/logscale.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/loki.md b/content/docs/configuration/plugins/syslog-ng-outputs/loki.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/mongodb.md b/content/docs/configuration/plugins/syslog-ng-outputs/mongodb.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/s3.md b/content/docs/configuration/plugins/syslog-ng-outputs/s3.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/splunk_hec.md b/content/docs/configuration/plugins/syslog-ng-outputs/splunk_hec.md
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md b/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md
