Rename plugin docs directories to fix doc generation, add missing docs, minor doc improvements

apis/fluentbit/v1alpha2/plugins/custom/custom_types.go

@@ -12,7 +12,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// CustomPlugin is used to support filter plugins that are not implemented yet
+// CustomPlugin is used to support filter plugins that are not implemented yet. <br />
+// **For example usage, refer to https://github.com/jjsiv/fluent-operator/blob/master/docs/best-practice/custom-plugin.md**
 type CustomPlugin struct {
 	Config string `json:"config,omitempty"`
 }

apis/fluentbit/v1alpha2/plugins/filter/aws_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The AWS Filter Enriches logs with AWS Metadata. Currently the plugin adds the EC2 instance ID and availability zone to log records.
+// The AWS Filter Enriches logs with AWS Metadata. Currently the plugin adds the EC2 instance ID and availability zone to log records. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/aws-metadata**
 type AWS struct {
 	plugins.CommonParams `json:",inline"`
 	// Specify which version of the instance metadata service to use. Valid values are 'v1' or 'v2'.

apis/fluentbit/v1alpha2/plugins/filter/grep_types.go

@@ -7,7 +7,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Grep Filter plugin allows to match or exclude specific records based in regular expression patterns.
+// The Grep Filter plugin allows to match or exclude specific records based in regular expression patterns. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/grep**
 type Grep struct {
 	plugins.CommonParams `json:",inline"`
 	// Keep records which field matches the regular expression.

apis/fluentbit/v1alpha2/plugins/filter/kubernetes_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// Kubernetes filter allows to enrich your log files with Kubernetes metadata.
+// Kubernetes filter allows to enrich your log files with Kubernetes metadata. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/kubernetes**
 type Kubernetes struct {
 	plugins.CommonParams `json:",inline"`
 	// Set the buffer size for HTTP client when reading responses from Kubernetes API server.

apis/fluentbit/v1alpha2/plugins/filter/lua_types.go

@@ -11,7 +11,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Lua Filter allows you to modify the incoming records using custom Lua Scripts.
+// The Lua Filter allows you to modify the incoming records using custom Lua Scripts. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/lua**
 type Lua struct {
 	plugins.CommonParams `json:",inline"`
 	// Path to the Lua script that will be used.

apis/fluentbit/v1alpha2/plugins/filter/modify_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Modify Filter plugin allows you to change records using rules and conditions.
+// The Modify Filter plugin allows you to change records using rules and conditions. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/modify**
 type Modify struct {
 	plugins.CommonParams `json:",inline"`
 	// All conditions have to be true for the rules to be applied.

apis/fluentbit/v1alpha2/plugins/filter/multiline_types.go

@@ -7,7 +7,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Multiline Filter helps to concatenate messages that originally belong to one context but were split across multiple records or log lines.
+// The Multiline Filter helps to concatenate messages that originally belong to one context but were split across multiple records or log lines. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/multiline-stacktrace**
 type Multiline struct {
 	plugins.CommonParams `json:",inline"`
 	// The Inline struct helps to concatenate messages that originally belong to one context but were split across multiple records or log lines.

apis/fluentbit/v1alpha2/plugins/filter/nest_types.go

@@ -7,7 +7,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Nest Filter plugin allows you to operate on or with nested data. Its modes of operation are
+// The Nest Filter plugin allows you to operate on or with nested data. Its modes of operation are "nest" and "lift". <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/nest**
 type Nest struct {
 	plugins.CommonParams `json:",inline"`
 	// Select the operation nest or lift

apis/fluentbit/v1alpha2/plugins/filter/parser_types.go

@@ -10,7 +10,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Parser Filter plugin allows to parse field in event records.
+// The Parser Filter plugin allows to parse field in event records. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/parser**
 type Parser struct {
 	plugins.CommonParams `json:",inline"`
 	// Specify field name in record to parse.

apis/fluentbit/v1alpha2/plugins/filter/recordmodifier_types.go

@@ -7,8 +7,9 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Record Modifier Filter plugin allows to append fields or to exclude specific fields.
-// RemoveKeys and WhitelistKeys are exclusive.
+// The Record Modifier Filter plugin allows to append fields or to exclude specific fields. <br />
+// RemoveKeys and WhitelistKeys are exclusive. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/record-modifier**
 type RecordModifier struct {
 	plugins.CommonParams `json:",inline"`
 	// Append fields. This parameter needs key and value pair.

apis/fluentbit/v1alpha2/plugins/filter/rewritetag_types.go

@@ -7,8 +7,9 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// RewriteTag define a `rewrite_tag` filter, allows to re-emit a record under a new Tag.
-// Once a record has been re-emitted, the original record can be preserved or discarded.
+// RewriteTag define a `rewrite_tag` filter, allows to re-emit a record under a new Tag. <br />
+// Once a record has been re-emitted, the original record can be preserved or discarded. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/rewrite-tag**
 type RewriteTag struct {
 	plugins.CommonParams `json:",inline"`
 	// Defines the matching criteria and the format of the Tag for the matching record.

apis/fluentbit/v1alpha2/plugins/filter/throttle_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// Throttle filter allows you to set the average rate of messages per internal, based on leaky bucket and sliding window algorithm.
+// Throttle filter allows you to set the average rate of messages per internal, based on leaky bucket and sliding window algorithm. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/throttle**
 type Throttle struct {
 	plugins.CommonParams `json:",inline"`
 	// Rate is the amount of messages for the time.

apis/fluentbit/v1alpha2/plugins/input/dummy_types.go

@@ -9,8 +9,9 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The dummy input plugin, generates dummy events.
-// It is useful for testing, debugging, benchmarking and getting started with Fluent Bit.
+// The dummy input plugin, generates dummy events. <br />
+// It is useful for testing, debugging, benchmarking and getting started with Fluent Bit. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/inputs/dummy**
 type Dummy struct {
 	// Tag name associated to all records comming from this plugin.
 	Tag string `json:"tag,omitempty"`

apis/fluentbit/v1alpha2/plugins/input/fluent_bit_metrics_types.go

@@ -8,6 +8,11 @@ import (
 
 // +kubebuilder:object:generate:=true
 
+// Fluent Bit exposes its own metrics to allow you to monitor the internals of your pipeline. <br />
+// The collected metrics can be processed similarly to those from the Prometheus Node Exporter input plugin. <br />
+// They can be sent to output plugins including Prometheus Exporter, Prometheus Remote Write or OpenTelemetry. <br />
+// **Important note: Metrics collected with Node Exporter Metrics flow through a separate pipeline from logs and current filters do not operate on top of metrics.** <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/inputs/fluentbit-metrics**
 type FluentbitMetrics struct {
 	Tag string `json:"tag,omitempty"`
 

apis/fluentbit/v1alpha2/plugins/input/node_exporter_metrics_types.go

@@ -7,7 +7,10 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The NodeExporterMetrics input plugin, which based on Prometheus Node Exporter to collect system / host level metrics.
+// A plugin based on Prometheus Node Exporter to collect system / host level metrics. <br />
+// **Note: Metrics collected with Node Exporter Metrics flow through a separate pipeline from logs and current filters do not operate on top of metrics.** <br />
+// This plugin is currently only supported on Linux based operating systems. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/inputs/node-exporter-metrics**
 type NodeExporterMetrics struct {
 	// Tag name associated to all records comming from this plugin.
 	Tag string `json:"tag,omitempty"`

apis/fluentbit/v1alpha2/plugins/input/prometheus_scrape_metrics_type.go

@@ -9,10 +9,10 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-/*  Fluent Bit 1.9 includes additional metrics features to allow you to collect both logs and metrics with the same collector.
- *  The initial release of the Prometheus Scrape metric allows you to collect metrics from a Prometheus-based
- *  endpoint at a set interval. These metrics can be routed to metric supported endpoints such as Prometheus Exporter, InfluxDB, or Prometheus Remote Write
- */
+// Fluent Bit 1.9 includes additional metrics features to allow you to collect both logs and metrics with the same collector. <br />
+// The initial release of the Prometheus Scrape metric allows you to collect metrics from a Prometheus-based <br />
+// endpoint at a set interval. These metrics can be routed to metric supported endpoints such as Prometheus Exporter, InfluxDB, or Prometheus Remote Write. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/inputs/prometheus-scrape-metrics**
 type PrometheusScrapeMetrics struct {
 	// Tag name associated to all records comming from this plugin
 	Tag string `json:"tag,omitempty"`

apis/fluentbit/v1alpha2/plugins/input/systemd_types.go

@@ -7,7 +7,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Systemd input plugin allows to collect log messages from the Journald daemon on Linux environments.
+// The Systemd input plugin allows to collect log messages from the Journald daemon on Linux environments. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/inputs/systemd**
 type Systemd struct {
 	// Optional path to the Systemd journal directory,
 	// if not set, the plugin will use default paths to read local-only logs.

apis/fluentbit/v1alpha2/plugins/input/tail_types.go

@@ -9,8 +9,9 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Tail input plugin allows to monitor one or several text files.
-// It has a similar behavior like tail -f shell command.
+// The Tail input plugin allows to monitor one or several text files. <br />
+// It has a similar behavior like tail -f shell command. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/inputs/tail**
 type Tail struct {
 	// Set the initial buffer size to read files data.
 	// This value is used too to increase buffer size.

apis/fluentbit/v1alpha2/plugins/output/azure_blob_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// Azure Blob is the Azure Blob output plugin, allows to ingest your records into Azure Blob Storage.
+// Azure Blob is the Azure Blob output plugin, allows to ingest your records into Azure Blob Storage. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/azure_blob**
 type AzureBlob struct {
 	// Azure Storage account name
 	AccountName string `json:"accountName"`

apis/fluentbit/v1alpha2/plugins/output/azure_log_analytics_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// Azure Log Analytics is the Azure Log Analytics output plugin, allows you to ingest your records into Azure Log Analytics Workspace.
+// Azure Log Analytics is the Azure Log Analytics output plugin, allows you to ingest your records into Azure Log Analytics Workspace. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/azure**
 type AzureLogAnalytics struct {
 	// Customer ID or Workspace ID
 	CustomerID *plugins.Secret `json:"customerID"`

apis/fluentbit/v1alpha2/plugins/output/cloudwatch_types.go

@@ -8,7 +8,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// CloudWatch is the AWS CloudWatch output plugin, allows you to ingest your records into AWS CloudWatch.
+// CloudWatch is the AWS CloudWatch output plugin, allows you to ingest your records into AWS CloudWatch. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch**
 type CloudWatch struct {
 	// AWS Region
 	Region string `json:"region"`

apis/fluentbit/v1alpha2/plugins/output/datadog_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// DataDog output plugin allows you to ingest your logs into Datadog.
+// DataDog output plugin allows you to ingest your logs into Datadog. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/datadog**
 type DataDog struct {
 	// Host is the Datadog server where you are sending your logs.
 	Host string `json:"host,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/elasticsearch_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// Elasticsearch is the es output plugin, allows to ingest your records into an Elasticsearch database.
+// Elasticsearch is the es output plugin, allows to ingest your records into an Elasticsearch database. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/elasticsearch**
 type Elasticsearch struct {
 	// IP address or hostname of the target Elasticsearch instance
 	Host string `json:"host,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/file_types.go

@@ -7,7 +7,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The file output plugin allows to write the data received through the input plugin to file.
+// The file output plugin allows to write the data received through the input plugin to file. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/file**
 type File struct {
 	// Absolute directory path to store files. If not set, Fluent Bit will write the files on it's own positioned directory.
 	Path string `json:"path,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/firehose_types.go

@@ -9,13 +9,12 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The Firehose output plugin, allows to ingest your records into AWS Firehose.
-// It uses the new high performance kinesis_firehose plugin (written in C) instead
-// of the older firehose plugin (written in Go).
-// The fluent-bit container must have the plugin installed.
-//
-// https://docs.fluentbit.io/manual/pipeline/outputs/firehose
-// https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit
+// The Firehose output plugin, allows to ingest your records into AWS Firehose. <br />
+// It uses the new high performance kinesis_firehose plugin (written in C) instead <br />
+// of the older firehose plugin (written in Go). <br />
+// The fluent-bit container must have the plugin installed. <br />
+// https://docs.fluentbit.io/manual/pipeline/outputs/firehose <br />
+// https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit <br />
 type Firehose struct {
 	// The AWS region.
 	Region string `json:"region"`

apis/fluentbit/v1alpha2/plugins/output/forward_types.go

@@ -9,8 +9,9 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// Forward is the protocol used by Fluentd to route messages between peers.
-// The forward output plugin allows to provide interoperability between Fluent Bit and Fluentd.
+// Forward is the protocol used by Fluentd to route messages between peers. <br />
+// The forward output plugin allows to provide interoperability between Fluent Bit and Fluentd. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/forward**
 type Forward struct {
 	// Target host where Fluent-Bit or Fluentd are listening for Forward messages.
 	Host string `json:"host,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/http_types.go

@@ -9,9 +9,10 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The http output plugin allows to flush your records into a HTTP endpoint.
+// The http output plugin allows to flush your records into a HTTP endpoint. <br />
 // For now the functionality is pretty basic and it issues a POST request
-// with the data records in MessagePack (or JSON) format.
+// with the data records in MessagePack (or JSON) format. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/http**
 type HTTP struct {
 	// IP address or hostname of the target HTTP Server
 	Host string `json:"host,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/kafka_types.go

@@ -9,6 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
+// Kafka output plugin allows to ingest your records into an Apache Kafka service. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/kafka**
 type Kafka struct {
 	// Specify data format, options available: json, msgpack.
 	Format string `json:"format,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/loki_types.go

@@ -10,7 +10,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// The loki output plugin, allows to ingest your records into a Loki service.
+// The loki output plugin, allows to ingest your records into a Loki service. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/loki**
 type Loki struct {
 	// Loki hostname or IP address.
 	Host string `json:"host"`

apis/fluentbit/v1alpha2/plugins/output/open_search_types.go

@@ -8,7 +8,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// OpenSearch is the opensearch output plugin, allows to ingest your records into an OpenSearch database.
+// OpenSearch is the opensearch output plugin, allows to ingest your records into an OpenSearch database. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/opensearch**
 type OpenSearch struct {
 	// IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
 	Host string `json:"host,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/open_telemetry_types.go

@@ -8,8 +8,9 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// OpenTelemetry is An output plugin to submit Metrics to an OpenTelemetry endpoint,
-// allows taking metrics from Fluent Bit and submit them to an OpenTelemetry HTTP endpoint.
+// OpenTelemetry is An output plugin to submit Metrics to an OpenTelemetry endpoint, <br />
+// allows taking metrics from Fluent Bit and submit them to an OpenTelemetry HTTP endpoint. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/opentelemetry**
 type OpenTelemetry struct {
 	// IP address or hostname of the target HTTP Server, default `127.0.0.1`
 	Host string `json:"host,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/prometheus_remote_write_types.go

@@ -9,7 +9,10 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// An output plugin to submit Prometheus Metrics using the remote write protocol
+// An output plugin to submit Prometheus Metrics using the remote write protocol. <br />
+// The prometheus remote write plugin allows you to take metrics from Fluent Bit and submit them to a Prometheus server through the remote write mechanism. <br />
+// **Important Note: The prometheus exporter only works with metric plugins, such as Node Exporter Metrics** <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/prometheus-remote-write**
 type PrometheusRemoteWrite struct {
 	// IP address or hostname of the target HTTP Server, default: 127.0.0.1
 	Host string `json:"host"`

apis/fluentbit/v1alpha2/plugins/output/splunk_types.go

@@ -9,7 +9,9 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// OpenSearch is the opensearch output plugin, allows to ingest your records into an OpenSearch database.
+// Splunk output plugin allows to ingest your records into a Splunk Enterprise service
+// through the HTTP Event Collector (HEC) interface. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/splunk**
 type Splunk struct {
 	// IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
 	Host string `json:"host,omitempty"`

apis/fluentbit/v1alpha2/plugins/output/stackdriver_types.go

@@ -9,7 +9,8 @@ import (
 
 // +kubebuilder:object:generate:=true
 
-// Stackdriver is the Stackdriver output plugin, allows you to ingest your records into GCP Stackdriver.
+// Stackdriver is the Stackdriver output plugin, allows you to ingest your records into GCP Stackdriver. <br />
+// **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/outputs/stackdriver**
 type Stackdriver struct {
 	// Path to GCP Credentials JSON file
 	GoogleServiceCredentials string `json:"googleServiceCredentials,omitempty"`