crd.md

API Docs

This Document documents the types introduced by the Fluent Bit Operator to be consumed by users.

Note this document is generated from code comments. When contributing a change to this document please do so by changing the code comments.

Table of Contents

• Decorder
• Filter
• FilterItem
• FilterList
• FilterSpec
• FluentBit
• FluentBitConfig
• FluentBitConfigList
• FluentBitConfigSpec
• FluentBitList
• FluentBitSpec
• Input
• InputList
• InputSpec
• Output
• OutputList
• OutputSpec
• Parser
• ParserList
• ParserSpec
• Service

Decorder

Field	Description	Scheme
decodeField	If the content can be decoded in a structured message, append that structure message (keys and values) to the original log message.	string
decodeFieldAs	Any content decoded (unstructured or structured) will be replaced in the same key/value, no extra keys are added.	string

Back to TOC

Filter

Filter defines a Filter configuration.

Field	Description	Scheme
metadata		metav1.ObjectMeta
spec	Specification of desired Filter configuration.	FilterSpec

Back to TOC

FilterItem

Field	Description	Scheme
grep	Grep defines Grep Filter configuration.	*filter.Grep
recordModifier	RecordModifier defines Record Modifier Filter configuration.	*filter.RecordModifier
kubernetes	Kubernetes defines Kubernetes Filter configuration.	*filter.Kubernetes
modify	Modify defines Modify Filter configuration.	*filter.Modify
nest	Nest defines Nest Filter configuration.	*filter.Nest
parser	Parser defines Parser Filter configuration.	*filter.Parser
lua	Lua defines Lua Filter configuration.	*filter.Lua

Back to TOC

FilterList

FilterList contains a list of Filter

Field	Description	Scheme
metadata		metav1.ListMeta
items		[]Filter

Back to TOC

FilterSpec

FilterSpec defines the desired state of Filter

Field	Description	Scheme
match	A pattern to match against the tags of incoming records. It's case sensitive and support the star (*) character as a wildcard.	string
matchRegex	A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.	string
filters	A set of filter plugins in order.	[]FilterItem

Back to TOC

FluentBit

FluentBit is the Schema for the fluentbits API

Field	Description	Scheme
metadata		metav1.ObjectMeta
spec		FluentBitSpec
status		FluentBitStatus

Back to TOC

FluentBitConfig

FluentBitConfig is the Schema for the fluentbitconfigs API

Field	Description	Scheme
metadata		metav1.ObjectMeta
spec		FluentBitConfigSpec

Back to TOC

FluentBitConfigList

FluentBitConfigList contains a list of FluentBitConfig

Field	Description	Scheme
metadata		metav1.ListMeta
items		[]FluentBitConfig

Back to TOC

FluentBitConfigSpec

FluentBitConfigSpec defines the desired state of FluentBitConfig

Field	Description	Scheme
service	Service defines the global behaviour of the Fluent Bit engine.	*Service
inputSelector	Select input plugins	metav1.LabelSelector
filterSelector	Select filter plugins	metav1.LabelSelector
outputSelector	Select output plugins	metav1.LabelSelector
parserSelector	Select parser plugins	metav1.LabelSelector

Back to TOC

FluentBitList

FluentBitList contains a list of FluentBit

Field	Description	Scheme
metadata		metav1.ListMeta
items		[]FluentBit

Back to TOC

FluentBitSpec

FluentBitSpec defines the desired state of FluentBit

Field	Description	Scheme
image	Fluent Bit image.	string
imagePullPolicy	Fluent Bit image pull policy.	corev1.PullPolicy
positionDB	Storage for position db. You will use it if tail input is enabled.	corev1.VolumeSource
containerLogRealPath	Container log path	string
nodeSelector	NodeSelector	map[string]string
tolerations	Tolerations	[]corev1.Toleration
fluentBitConfigName	Fluentbitconfig object associated with this Fluentbit	string
secrets	The Secrets are mounted into /fluent-bit/secrets/.	[]string
runtimeClassName	The runtimeClassName represents the container runtime configuration.	string
priorityClassName	The priorityClassName represents the pod's priority.	string

Back to TOC

Input

Input is the Schema for the inputs API

Field	Description	Scheme
metadata		metav1.ObjectMeta
spec		InputSpec

Back to TOC

InputList

InputList contains a list of Input

Field	Description	Scheme
metadata		metav1.ListMeta
items		[]Input

Back to TOC

InputSpec

InputSpec defines the desired state of Input

Field	Description	Scheme
alias	A user friendly alias name for this input plugin.	string
dummy	Dummy defines Dummy Input configuration.	*input.Dummy
tail	Tail defines Tail Input configuration.	*input.Tail
systemd	Systemd defines Systemd Input configuration.	*input.Systemd

Back to TOC

Output

Output is the Schema for the outputs API

Field	Description	Scheme
metadata		metav1.ObjectMeta
spec		OutputSpec

Back to TOC

OutputList

OutputList contains a list of Output

Field	Description	Scheme
metadata		metav1.ListMeta
items		[]Output

Back to TOC

OutputSpec

OutputSpec defines the desired state of Output

Field	Description	Scheme
match	A pattern to match against the tags of incoming records. It's case sensitive and support the star (*) character as a wildcard.	string
matchRegex	A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.	string
alias	A user friendly alias name for this output plugin.	string
retry_limit	This option allows to disable retries or impose a limit to try N times and then discard the data after reaching that limit.	string
es	Elasticsearch defines Elasticsearch Output configuration.	*output.Elasticsearch
file	File defines File Output configuration.	*output.File
forward	Forward defines Forward Output configuration.	*output.Forward
http	HTTP defines HTTP Output configuration.	*output.HTTP
kafka	Kafka defines Kafka Output configuration.	*output.Kafka
null	Null defines Null Output configuration.	*output.Null
stdout	Stdout defines Stdout Output configuration.	*output.Stdout
tcp	TCP defines TCP Output configuration.	*output.TCP
loki	Loki defines Loki Output configuration.	*output.Loki
syslog	Syslog defines Syslog Output configuration.	*output.Syslog

Back to TOC

Parser

Parser is the Schema for the parsers API

Field	Description	Scheme
metadata		metav1.ObjectMeta
spec		ParserSpec

Back to TOC

ParserList

ParserList contains a list of Parser

Field	Description	Scheme
metadata		metav1.ListMeta
items		[]Parser

Back to TOC

ParserSpec

ParserSpec defines the desired state of Parser

Field	Description	Scheme
json	JSON defines json parser configuration.	*parser.JSON
regex	Regex defines regex parser configuration.	*parser.Regex
ltsv	LTSV defines ltsv parser configuration.	*parser.LSTV
logfmt	Logfmt defines logfmt parser configuration.	*parser.Logfmt
decoders	Decoders are a built-in feature available through the Parsers file, each Parser definition can optionally set one or multiple decoders. There are two type of decoders type: Decode_Field and Decode_Field_As.	[]Decorder

Back to TOC

Service

Field	Description	Scheme
daemon	If true go to background on start	*bool
flushSeconds	Interval to flush output	*int64
graceSeconds	Wait time on exit	*int64
httpListen	Address to listen	string
httpPort	Port to listen	*int32
httpServer	If true enable statistics HTTP server	*bool
logFile	File to log diagnostic output	string
logLevel	Diagnostic level (error/warning/info/debug/trace)	string
parsersFile	Optional 'parsers' config file (can be multiple)	string

Back to TOC