Skip to content

Commit

Permalink
Adjust plugin docs (fluent#293)
Browse files Browse the repository at this point in the history
Signed-off-by: Benjamin Huo <[email protected]>
  • Loading branch information
benjaminhuo authored May 17, 2022
1 parent e1a4667 commit c495e63
Show file tree
Hide file tree
Showing 37 changed files with 77 additions and 78 deletions.
70 changes: 4 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Once installed, the Fluent Operator provides the following features:
- [Collect auditd logs](#collect-auditd-logs)
- [Fluentd](#fluentd-1)
- [Monitoring](#monitoring)
- [API Doc](#api-doc)
- [Plugins](#plugins)
- [Fluent Bit](#fluent-bit-1)
- [Fluentd](#fluentd-2)
- [Best Practice](#best-practice)
Expand Down Expand Up @@ -345,77 +345,15 @@ curl <podIP>:2020 | jq .
```


## API Doc
## Plugins

### Fluent Bit

The list below shows supported plugins which are based on Fluent Bit v1.7.x+. For more information, please refer to the API docs of each plugin.

- [Input](docs/fluentbit.md#input)
- [dummy](docs/plugins/fluentbit/input/dummy.md)
- [tail](docs/plugins/fluentbit/input/tail.md)
- [systemd](docs/plugins/fluentbit/input/systemd.md)
- [Parser](docs/fluentbit.md#parser)
- [json](docs/plugins/fluentbit/parser/json.md)
- [logfmt](docs/plugins/fluentbit/parser/logfmt.md)
- [lstv](docs/plugins/fluentbit/parser/lstv.md)
- [regex](docs/plugins/fluentbit/parser/regex.md)
- [Filter](docs/fluentbit.md#filter)
- [kubernetes](docs/plugins/fluentbit/filter/kubernetes.md)
- [modify](docs/plugins/fluentbit/filter/modify.md)
- [nest](docs/plugins/fluentbit/filter/nest.md)
- [parser](docs/plugins/fluentbit/filter/parser.md)
- [grep](docs/plugins/fluentbit/filter/grep.md)
- [record modifier](docs/plugins/fluentbit/filter/recordmodifier.md)
- [lua](docs/plugins/fluentbit/filter/lua.md)
- [throttle](docs/plugins/fluentbit/filter/throttle.md)
- [aws](docs/plugins/fluentbit/filter/aws.md)
- [multiline](docs/plugins/fluentbit/filter/multiline.md)
- [Output](docs/fluentbit.md#output)
- [elasticsearch](docs/plugins/fluentbit/output/elasticsearch.md)
- [file](docs/plugins/fluentbit/output/file.md)
- [forward](docs/plugins/fluentbit/output/forward.md)
- [http](docs/plugins/fluentbit/output/http.md)
- [kafka](docs/plugins/fluentbit/output/kafka.md)
- [null](docs/plugins/fluentbit/output/null.md)
- [stdout](docs/plugins/fluentbit/output/stdout.md)
- [tcp](docs/plugins/fluentbit/output/tcp.md)
- [loki](docs/plugins/fluentbit/output/loki.md)
- [syslog](docs/plugins/fluentbit/output/syslog.md)
- [datadog](docs/plugins/fluentbit/output/datadog.md)
[Here](docs/plugins/fluentbit/index.md) you can find supported Fluent Bit plugins.

### Fluentd

The list below shows supported plugins which are based on Fluentd v1.14.4+. For more information, please refer to the API docs of each plugin.

- Common
- [buffer](docs/plugins/fluentd/common/buffer.md)
- [format](docs/plugins/fluentd/common/format.md)
- [parse](docs/plugins/fluentd/common/parse.md)
- [time](docs/plugins/fluentd/common/common.md#time)
- [inject](docs/plugins/fluentd/common/common.md#inject)
- [security](docs/plugins/fluentd/common/common.md#security)
- [user](docs/plugins/fluentd/common/common.md#user)
- [transport](docs/plugins/fluentd/common/common.md#transport)
- [client](docs/plugins/fluentd/common/common.md#client)
- [auth](docs/plugins/fluentd/common/common.md#auth)
- [server](docs/plugins/fluentd/common/common.md#server)
- [service_discovery](docs/plugins/fluentd/common/common.md#ServiceDiscovery)
- [Input](docs/fluentd/input/types.md)
- [http](docs/plugins/fluentd/input/http.md)
- [forward](docs/plugins/fluentd/input/forward.md)
- [Filter](docs/fluentd/filter/types.md)
- [parser](docs/plugins/fluentd/filter/parser.md)
- [grep](docs/plugins/fluentd/filter/grep.md)
- [record modifier](docs/plugins/fluentd/filter/record_modifier.md)
- [stdout](docs/plugins/fluentd/filter/stdout.md)
- [Output](docs/plugins/fluentd/output/types.md)
- [elasticsearch](docs/plugins/fluentd/output/elasticsearch.md)
- [forward](docs/plugins/fluentd/output/forward.md)
- [http](docs/plugins/fluentd/output/http.md)
- [kafka](docs/plugins/fluentd/output/kafka.md)
- stdout

[Here](docs/plugins/fluentd/index.md) you can find supported Fluentd plugins.

## Best Practice

Expand Down
24 changes: 12 additions & 12 deletions docs/fluentbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ This Document documents the types introduced by the fluentbit Operator.
* [ClusterParser](#clusterparser)
* [Decorder](#decorder)
* [FilterItem](#filteritem)
* [FilterList](#filterlist)
* [ClusterFilterList](#clusterFilterList)
* [FilterSpec](#filterspec)
* [FluentBit](#fluentbit)
* [FluentBitConfigList](#fluentbitconfiglist)
* [ClusterFluentBitConfigList](#clusterfluentBitconfiglist)
* [FluentBitConfigSpec](#fluentbitconfigspec)
* [FluentBitList](#fluentbitlist)
* [FluentBitSpec](#fluentbitspec)
* [InputList](#inputlist)
* [ClusterInputList](#clusterinputlist)
* [InputSpec](#inputspec)
* [OutputList](#outputlist)
* [ClusterOutputList](#clusteroutputlist)
* [OutputSpec](#outputspec)
* [ParserList](#parserlist)
* [ClusterParserList](#clusterparserlist)
* [ParserSpec](#parserspec)
* [Script](#script)
* [Service](#service)
Expand Down Expand Up @@ -145,9 +145,9 @@ FluentBit is the Schema for the fluentbits API
| status | | FluentBitStatus |

[Back to TOC](#table-of-contents)
# FluentBitConfigList
# ClusterFluentBitConfigList

FluentBitConfigList contains a list of ClusterFluentBitConfig
ClusterFluentBitConfigList contains a list of ClusterFluentBitConfig


| Field | Description | Scheme |
Expand Down Expand Up @@ -207,7 +207,7 @@ FluentBitSpec defines the desired state of FluentBit
| volumesMounts | Pod volumes to mount into the container's filesystem. | []corev1.VolumeMount |

[Back to TOC](#table-of-contents)
# InputList
# ClusterInputList

ClusterInputList contains a list of Input

Expand All @@ -231,9 +231,9 @@ InputSpec defines the desired state of ClusterInput
| systemd | Systemd defines Systemd Input configuration. | *[input.Systemd](plugins/input/systemd.md) |

[Back to TOC](#table-of-contents)
# OutputList
# ClusterOutputList

OutputList contains a list of ClusterOutput
ClusterOutputList contains a list of ClusterOutput


| Field | Description | Scheme |
Expand Down Expand Up @@ -267,9 +267,9 @@ OutputSpec defines the desired state of ClusterOutput
| firehose | Firehose defines Firehose Output configuration. | *[output.Firehose](plugins/output/firehose.md) |

[Back to TOC](#table-of-contents)
# ParserList
# ClusterParserList

ParserList contains a list of ClusterParser
ClusterParserList contains a list of ClusterParser


| Field | Description | Scheme |
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
33 changes: 33 additions & 0 deletions docs/plugins/fluentbit/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
- [ClusterInput](../../fluentbit.md#ClusterInput)
- [dummy](clusterinput/dummy.md)
- [tail](clusterinput/tail.md)
- [systemd](clusterinput/systemd.md)
- [ClusterParser](../../fluentbit.md#ClusterParser)
- [json](clusterparser/json.md)
- [logfmt](clusterparser/logfmt.md)
- [lstv](clusterparser/lstv.md)
- [regex](clusterparser/regex.md)
- [ClusterFilter](../../fluentbit.md#ClusterFilter)
- [kubernetes](clusterfilter/kubernetes.md)
- [modify](clusterfilter/modify.md)
- [nest](clusterfilter/nest.md)
- [parser](clusterfilter/parser.md)
- [grep](clusterfilter/grep.md)
- [record modifier](clusterfilter/recordmodifier.md)
- [lua](clusterfilter/lua.md)
- [throttle](clusterfilter/throttle.md)
- [aws](clusterfilter/aws.md)
- [multiline](clusterfilter/multiline.md)
- [ClusterOutput](../../fluentbit.md#ClusterOutput)
- [elasticsearch](clusteroutput/elasticsearch.md)
- [file](clusteroutput/file.md)
- [forward](clusteroutput/forward.md)
- [http](clusteroutput/http.md)
- [kafka](clusteroutput/kafka.md)
- [null](clusteroutput/null.md)
- [stdout](clusteroutput/stdout.md)
- [tcp](clusteroutput/tcp.md)
- [loki](clusteroutput/loki.md)
- [syslog](clusteroutput/syslog.md)
- [datadog](clusteroutput/datadog.md)

File renamed without changes.
File renamed without changes.
File renamed without changes.
28 changes: 28 additions & 0 deletions docs/plugins/fluentd/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
- [Common](common)
- [buffer](common/buffer.md)
- [format](common/format.md)
- [parse](common/parse.md)
- [time](common/common.md#time)
- [inject](common/common.md#inject)
- [security](common/common.md#security)
- [user](common/common.md#user)
- [transport](common/common.md#transport)
- [client](common/common.md#client)
- [auth](common/common.md#auth)
- [server](common/common.md#server)
- [service_discovery](common/common.md#ServiceDiscovery)
- [Input](globalinputs/types.md)
- [http](globalinputs/http.md)
- [forward](globalinputs/forward.md)
- [Filter](filter/types.md)
- [parser](filter/parser.md)
- [grep](filter/grep.md)
- [record modifier](filter/record_modifier.md)
- [stdout](filter/stdout.md)
- [Output](output/types.md)
- [elasticsearch](output/elasticsearch.md)
- [forward](output/forward.md)
- [http](output/http.md)
- [kafka](output/kafka.md)
- stdout

0 comments on commit c495e63

Please sign in to comment.