Merge pull request #591 from antrema/update_crds_documentation

Fixes #590 Update CRDs description / Documentation, conform to code
fluent · Feb 27, 2023 · 9837bd0 · 9837bd0
2 parents 89ef70d + 7909366
commit 9837bd0
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 16 deletions.
diff --git a/charts/fluent-operator/crds/fluentd.fluent.io_clusterfilters.yaml b/charts/fluent-operator/crds/fluentd.fluent.io_clusterfilters.yaml
@@ -48,6 +48,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin

diff --git a/charts/fluent-operator/crds/fluentd.fluent.io_clusteroutputs.yaml b/charts/fluent-operator/crds/fluentd.fluent.io_clusteroutputs.yaml
@@ -110,8 +110,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -254,6 +254,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     elasticsearch:
                       description: out_es plugin

diff --git a/charts/fluent-operator/crds/fluentd.fluent.io_filters.yaml b/charts/fluent-operator/crds/fluentd.fluent.io_filters.yaml
@@ -48,6 +48,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin

diff --git a/charts/fluent-operator/crds/fluentd.fluent.io_outputs.yaml b/charts/fluent-operator/crds/fluentd.fluent.io_outputs.yaml
@@ -110,8 +110,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -254,6 +254,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     elasticsearch:
                       description: out_es plugin

diff --git a/config/crd/bases/fluentd.fluent.io_clusterfilters.yaml b/config/crd/bases/fluentd.fluent.io_clusterfilters.yaml
@@ -48,6 +48,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin

diff --git a/config/crd/bases/fluentd.fluent.io_clusteroutputs.yaml b/config/crd/bases/fluentd.fluent.io_clusteroutputs.yaml
@@ -110,8 +110,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -254,6 +254,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     elasticsearch:
                       description: out_es plugin

diff --git a/config/crd/bases/fluentd.fluent.io_filters.yaml b/config/crd/bases/fluentd.fluent.io_filters.yaml
@@ -48,6 +48,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin

diff --git a/config/crd/bases/fluentd.fluent.io_outputs.yaml b/config/crd/bases/fluentd.fluent.io_outputs.yaml
@@ -110,8 +110,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -254,6 +254,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     elasticsearch:
                       description: out_es plugin

diff --git a/docs/plugins/fluentbit/common.md b/docs/plugins/fluentbit/common.md
@@ -0,0 +1,9 @@
+# CommonParams
+
+
+
+
+| Field | Description | Scheme |
+| ----- | ----------- | ------ |
+| alias | Alias for the plugin | string |
+| retryLimit | RetryLimit describes how many times fluent-bit should retry to send data to a specific output. If set to false fluent-bit will try indefinetly. If set to any integer N>0 it will try at most N+1 times. Leading zeros are not allowed (values such as 007, 0150, 01 do not work). If this property is not defined fluent-bit will use the default value: 1. | string |
diff --git a/docs/plugins/fluentd/output/es.md b/docs/plugins/fluentd/output/es.md
@@ -0,0 +1,17 @@
+# Elasticsearch
+
+Elasticsearch defines the parameters for out_es output plugin
+
+
+| Field | Description | Scheme |
+| ----- | ----------- | ------ |
+| host | The hostname of your Elasticsearch node (default: localhost). | *string |
+| port | The port number of your Elasticsearch node (default: 9200). | *uint32 |
+| hosts | Hosts defines a list of hosts if you want to connect to more than one Elasticsearch nodes | *string |
+| scheme | Specify https if your Elasticsearch endpoint supports SSL (default: http). | *string |
+| path | Path defines the REST API endpoint of Elasticsearch to post write requests (default: nil). | *string |
+| indexName | IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section. | *string |
+| logstashFormat | If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option. | *bool |
+| logstashPrefix | LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash). | *string |
+| user | Optional, The login credentials to connect to Elasticsearch | *[plugins.Secret](../secret.md) |
+| password | Optional, The login credentials to connect to Elasticsearch | *[plugins.Secret](../secret.md) |
diff --git a/manifests/setup/fluent-operator-crd.yaml b/manifests/setup/fluent-operator-crd.yaml
@@ -755,6 +755,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin
@@ -4367,8 +4369,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -9055,6 +9057,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin
@@ -17735,8 +17739,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -17879,6 +17883,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     elasticsearch:
                       description: out_es plugin

diff --git a/manifests/setup/setup.yaml b/manifests/setup/setup.yaml
@@ -755,6 +755,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin
@@ -4367,8 +4369,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -4511,6 +4513,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     elasticsearch:
                       description: out_es plugin
@@ -9053,6 +9057,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     grep:
                       description: The filter_grep filter plugin
@@ -17733,8 +17739,8 @@ spec:
                           - immediate
                           type: string
                         flushThreadCount:
-                          description: The sleep interval (seconds) for threads to
-                            wait for the next flush try(when no chunks are waiting)
+                          description: The number of threads to flush/write chunks
+                            in parallel
                           pattern: ^\d+$
                           type: string
                         id:
@@ -17877,6 +17883,8 @@ spec:
                       properties:
                         config:
                           type: string
+                      required:
+                      - config
                       type: object
                     elasticsearch:
                       description: out_es plugin