Api

This page is automatically generated with gen-crd-api-reference-docs.

Packages:

• logging.netcracker.com/v1

logging.netcracker.com/v1

Resource Types:

Auth

(Appears on:HttpFluentbit, HttpFluentd, LokiFluentbit, LokiFluentd, OtelFluentbit)

Field	Description
user Kubernetes core/v1.SecretKeySelector

AuthProxy

(Appears on:Graylog)

Field	Description
resources Kubernetes core/v1.ResourceRequirements
bindPasswordSecret Kubernetes core/v1.SecretKeySelector
ca CA	CA contains selectors for the Secret containing TLS certificate for LDAP database or OAuth authentication server
cert Cert	Cert contains selectors for the Secret containing TLS certificate for client authentication to LDAP database or OAuth authentication server
key Key	Key contains selectors for the Secret containing TLS private key for client authentication to LDAP database or OAuth authentication server
image string
install bool

CA

(Appears on:AuthProxy, Certificates)

Field	Description
secretName string
secretKey string

Cert

(Appears on:AuthProxy, Certificates, HTTPGraylogTLS)

Field	Description
secretName string
secretKey string

Certificates

(Appears on:FluentbitHttpTLS, FluentbitLokiTLS, FluentdHttpTLS, FluentdLokiTLS, TLS)

Field	Description
ca CA
cert Cert
key Key

CloudEventsReader

(Appears on:LoggingServiceSpec)

CloudEventsReader contains EventsReader-specific configuration

Field	Description
resources Kubernetes core/v1.ResourceRequirements
dockerImage string
priorityClassName string
nodeSelectorKey string
nodeSelectorValue string
affinity Kubernetes core/v1.Affinity
labels map[string]string
annotations map[string]string
args []string
install bool

ConfigmapReload

(Appears on:Fluentbit, FluentbitAggregator, Fluentd)

Field	Description
dockerImage string
resources Kubernetes core/v1.ResourceRequirements

ContentPackPathHTTPConfig

Field	Description
tls HTTPConfig
url string

Credentials

(Appears on:HTTPConfig)

Field	Description
username Kubernetes core/v1.SecretKeySelector

Fluentbit

(Appears on:LoggingServiceSpec)

Fluentbit contains Fluentbit-specific configuration

Field	Description
resources Kubernetes core/v1.ResourceRequirements
annotations map[string]string
labels map[string]string
extraFields map[string]string
aggregator FluentbitAggregator
memBufLimit string
systemLogType string
graylogHost string
nodeSelectorValue string
graylogProtocol string
dockerImage string
configmapReload ConfigmapReload
priorityClassName string
totalLimitSize string
customInputConf string
customFilterConf string
customOutputConf string
customLuaScriptConf map[string]string
logLevel string
multilineFirstLineRegexp string
nodeSelectorKey string
multilineOtherLinesRegexp string
tls FluentbitTLS
additionalVolumes []Kubernetes core/v1.Volume
additionalVolumeMounts []Kubernetes core/v1.VolumeMount
tolerations []Kubernetes core/v1.Toleration
affinity Kubernetes core/v1.Affinity
graylogPort int
securityContextPrivileged bool
watchKubernetesMetadata bool
mockKubeData bool
systemLogging bool
billCycleConf bool
graylogOutput bool
systemAuditLogging bool
kubeAuditLogging bool
kubeApiserverAuditLogging bool
containerLogging bool
excludePath string
output OutputFluentbit
flush int	Flush is an interval in seconds to flush records to the outputs. Increasing the interval reduces the amount of produced chunks and, as a result, the disk load.
storageProfile string	StorageProfile selects where Fluentbit keeps input read offsets and buffered logs. The default “memory-only” profile avoids writes to the node filesystem. The “persistent-offsets” profile stores read offsets on the node and buffers logs in memory. The “node-persistent” profile stores both read offsets and buffered logs on the node.
memoryOnlyStateSizeLimit string	MemoryOnlyStateSizeLimit limits the memory-backed volume that stores read offset databases for the “memory-only” profile. The default is “32Mi”.
db FluentbitDB	DB contains settings of the SQLite database which the input plugins use to keep the read offsets

FluentbitAggregator

(Appears on:Fluentbit)

FluentbitAggregator contains Fluentbit-aggregator-specific configuration

Field	Description
labels map[string]string
volume Volume
resources Kubernetes core/v1.ResourceRequirements
annotations map[string]string
extraFields map[string]string
memBufLimit string
dockerImage string
configmapReload ConfigmapReload
nodeSelectorValue string
multilineOtherLinesRegexp string
graylogHost string
multilineFirstLineRegexp string
graylogProtocol string
nodeSelectorKey string
priorityClassName string
totalLimitSize string
customFilterConf string
customOutputConf string
customLuaScriptConf map[string]string
tls FluentbitTLS
tolerations []Kubernetes core/v1.Toleration
affinity Kubernetes core/v1.Affinity
startupTimeout int
replicas int
graylogPort int
install bool
securityContextPrivileged bool
graylogOutput bool
output OutputFluentbit

FluentbitDB

(Appears on:Fluentbit)

FluentbitDB contains settings of the SQLite database which the Fluentbit input plugins use to keep the position of the read files. Details https://docs.fluentbit.io/manual/pipeline/inputs/tail

Field	Description
enabled bool	Enabled defines whether the input plugins keep the read offsets in the database file. Disabling it removes all the database writes to the storage, but Fluentbit loses the read offsets on the restart. Every input then starts from the position set by its own Read_from_Head or Read_from_Tail option: the container log inputs re-read the existing records, and the system and audit log inputs skip the records written while Fluentbit was down. Enabled by default.
journalMode string	JournalMode sets the journal mode of the database. Allowed values are “wal”, “delete”, “truncate”, “persist”, “memory” and “off” in the lower or the upper case.
sync string	Sync sets the synchronization mode of the database. Allowed values are “off”, “normal”, “full” and “extra” in the lower or the upper case.
locking bool	Locking sets the exclusive access mode to the database file. Enabled by default.

FluentbitHTTPRouting

(Appears on:HttpFluentbit)

Field	Description
enabled bool
headerTag string

FluentbitHttpTLS

(Appears on:HttpFluentbit, OtelFluentbit)

Field	Description
ca CA
cert Cert
key Key
keyPasswd string
enabled bool
verify bool

FluentbitLokiTLS

(Appears on:LokiFluentbit)

Field	Description
ca CA
cert Cert
key Key
keyPasswd string
enabled bool
verify bool

FluentbitTLS

(Appears on:Fluentbit, FluentbitAggregator)

Field	Description
generateCerts GenerateCerts
ca CA
cert Cert
key Key
keyPasswd string
enabled bool
verify bool

FluentbitTLSParams

(Appears on:FluentbitHttpTLS, FluentbitLokiTLS, FluentbitTLS)

Field	Description
keyPasswd string
enabled bool
verify bool

Fluentd

(Appears on:LoggingServiceSpec)

Fluentd contains Fluentd-specific configuration

Field	Description
resources Kubernetes core/v1.ResourceRequirements
annotations map[string]string
labels map[string]string
extraFields map[string]string
customFilterConf string
systemLogType string
cloudEventsReaderFormat string
graylogHost string
dockerImage string
configmapReload ConfigmapReload
graylogProtocol string
priorityClassName string
multilineFirstLineRegexp string
logLevel string
totalLimitSize string
customInputConf string
nodeSelectorKey string
customOutputConf string
nodeSelectorValue string
tls FluentdTLS
additionalVolumeMounts []Kubernetes core/v1.VolumeMount
excludePath []string
additionalVolumes []Kubernetes core/v1.Volume
tolerations []Kubernetes core/v1.Toleration
affinity Kubernetes core/v1.Affinity
queueLimitLength int
graylogPort int
billCycleConf bool
systemLogging bool
systemAuditLogging bool
kubeAuditLogging bool
kubeApiserverAuditLogging bool
containerLogging bool
watchKubernetesMetadata bool
securityContextPrivileged bool
useFileStorage bool
graylogOutput bool
graylogBufferFlushInterval string
compress string
mockKubeData bool
output OutputFluentd

FluentdHTTPRouting

(Appears on:HttpFluentd)

Field	Description
enabled bool
logCategoryHeader string

FluentdHttpTLS

(Appears on:HttpFluentd)

Field	Description
ca CA
cert Cert
key Key
enabled bool
verifyMode string
version string
ciphers string

FluentdHttpTLSParams

(Appears on:FluentdHttpTLS)

Field	Description
enabled bool
verifyMode string
version string
ciphers string

FluentdLokiTLS

(Appears on:LokiFluentd)

Field	Description
ca CA
cert Cert
key Key
version string
enabled bool
noDefaultCA bool
allCiphers bool
rescueSslErrors bool
noVerify bool

FluentdTLS

(Appears on:Fluentd)

Field	Description
generateCerts GenerateCerts
ca CA
cert Cert
key Key
version string
enabled bool
noDefaultCA bool
allCiphers bool
rescueSslErrors bool
noVerify bool

FluentdTLSParams

(Appears on:FluentdLokiTLS, FluentdTLS)

Field	Description
version string
enabled bool
noDefaultCA bool
allCiphers bool
rescueSslErrors bool
noVerify bool

GenerateCerts

(Appears on:HTTPGraylogTLS, TLS)

GenerateCerts define settings for cert-manager.

Field	Description
secretName string
enabled bool

Graylog

(Appears on:LoggingServiceSpec)

Graylog contains Graylog-specific configuration

Field	Description
graylogResources Kubernetes core/v1.ResourceRequirements
mongoResources Kubernetes core/v1.ResourceRequirements
initResources Kubernetes core/v1.ResourceRequirements
mongoDBUpgrade MongoDBUpgrade
authProxy AuthProxy
tls GraylogTLS
openSearch OpenSearch
affinity Kubernetes core/v1.Affinity
annotations map[string]string
labels map[string]string
nodeSelectorValue string
pathRepo string
priorityClassName string
dockerImage string
mongoDBImage string
logLevel string
contentDeployPolicy string
javaOpts string
contentPackPaths string
customPluginsPaths string
host string
initSetupImage string
- string
- string
nodeSelectorKey string
initContainerDockerImage string
graylogSecretName string
contentPacks []*./v1/.ContentPackPathHTTPConfig
streams []Stream
processbufferProcessors int
outputbufferProcessorThreadsMaxPoolSize int
ringSize int
elasticsearchMaxTotalConnectionsPerRoute int
elasticsearchMaxTotalConnections int
outputBatchSize int
inputbufferRingSize int
outputbufferProcessors int
maxSize int
inputbufferProcessors int
startupTimeout int
indexShards int
indexReplicas int
maxNumberOfIndices int
logsRotationSizeGb int
inputPort int
replicas int
s3Archive bool

GraylogTLS

(Appears on:Graylog)

Field	Description
http HTTPGraylogTLS
input InputGraylogTLS

HTTPConfig

(Appears on:ContentPackPathHTTPConfig, OpenSearch)

Field	Description
credentials Credentials
tlsConfig TLSConfig

HTTPGraylogTLS

(Appears on:GraylogTLS)

Field	Description
generateCerts GenerateCerts
cert Cert
key Key
cacerts string
keyFilePassword string
enabled bool
insecureSkipVerify bool

HttpFluentbit

(Appears on:OutputFluentbit)

Field	Description
enabled bool
routing FluentbitHTTPRouting
host string
port int
uri string
auth Auth
compress string
tls FluentbitHttpTLS
jsonDateFormat string
format string
extraParams string

HttpFluentd

(Appears on:OutputFluentd)

Field	Description
enabled bool
routing FluentdHTTPRouting
host string
path string
compress string
headers map[string]string
auth Auth
tls FluentdHttpTLS
extraParams string

InputGraylogTLS

(Appears on:GraylogTLS)

Field	Description
generateCerts GenerateCerts
ca CA
cert Cert
key Key
keyFilePassword string
enabled bool
insecureSkipVerify bool

Key

(Appears on:AuthProxy, Certificates, HTTPGraylogTLS)

Field	Description
secretName string
secretKey string

LoggingService

LoggingService is the Schema for the loggingservices API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec LoggingServiceSpec	graylog Graylog fluentd Fluentd fluentbit Fluentbit cloudEventsReader CloudEventsReader monitoringAgentLoggingPlugin MonitoringAgentLoggingPlugin cloudURL string osKind string containerRuntimeType string ipv6 bool openshiftDeploy bool
status LoggingServiceStatus

LoggingServiceCondition

(Appears on:LoggingServiceStatus)

LoggingServiceCondition contains description of status of LoggingService

Field	Description
type string
reason string
message string
lastTransitionTime string
status bool

LoggingServiceParameters

Field	Description
Release Release
Values LoggingServiceSpec

LoggingServiceSpec

(Appears on:LoggingService, LoggingServiceParameters)

LoggingServiceSpec defines the desired state of LoggingService

Field	Description
graylog Graylog
fluentd Fluentd
fluentbit Fluentbit
cloudEventsReader CloudEventsReader
monitoringAgentLoggingPlugin MonitoringAgentLoggingPlugin
cloudURL string
osKind string
containerRuntimeType string
ipv6 bool
openshiftDeploy bool

LoggingServiceStatus

(Appears on:LoggingService)

LoggingServiceStatus defines the observed state of LoggingService

Field	Description
conditions []LoggingServiceCondition

LokiFluentbit

(Appears on:OutputFluentbit)

Field	Description
enabled bool
host string
tenant string
auth Auth
staticLabels string
labelsMapping string
tls FluentbitLokiTLS
extraParams string

LokiFluentd

(Appears on:OutputFluentd)

Field	Description
enabled bool
host string
tenant string
auth Auth
staticLabels string
labelsMapping string
tls FluentdLokiTLS
extraParams string

MongoDBUpgrade

(Appears on:Graylog)

MongoDBUpgrade is used for the sequential MongoDB upgrading from 3.6 to 5.0

Field	Description
mongoDBImage40 string
mongoDBImage42 string
mongoDBImage44 string

MonitoringAgentLoggingPlugin

(Appears on:LoggingServiceSpec)

MonitoringAgentLoggingPlugin contains MonitoringAgentLoggingPlugin-specific configuration

Field	Description
resources Kubernetes core/v1.ResourceRequirements
annotations map[string]string
labels map[string]string
influxDBName string
influxDBSecretName string
influxDBHost string
nodeSelectorKey string
nodeSelectorValue string
saSecret string
saSecretVolume string
priorityClassName string
dockerImage string
influxDBPort int
influxDBMode bool

OpenSearch

(Appears on:Graylog)

Field	Description
tls HTTPConfig
url string

OtelFluentbit

(Appears on:OutputFluentbit)

Field	Description
enabled bool
host string
port int
logsUri string
target string
logSuppressInterval int
auth Auth
compress string
tls FluentbitHttpTLS
extraParams string

OutputFluentbit

(Appears on:Fluentbit, FluentbitAggregator)

Field	Description
loki LokiFluentbit
http HttpFluentbit
otel OtelFluentbit

OutputFluentd

(Appears on:Fluentd)

Field	Description
loki LokiFluentd
http HttpFluentd

Release

(Appears on:LoggingServiceParameters)

Field	Description
Namespace string

Stream

(Appears on:Graylog)

Field	Description
name string
rotationStrategy string
rotationPeriod string
maxSize int
maxNumberOfIndices int
install bool

TLS

(Appears on:FluentbitTLS, FluentdTLS, InputGraylogTLS)

Field	Description
generateCerts GenerateCerts
ca CA
cert Cert
key Key

TLSConfig

(Appears on:HTTPConfig)

Field	Description
ca Kubernetes core/v1.SecretKeySelector
cert Kubernetes core/v1.SecretKeySelector
key Kubernetes core/v1.SecretKeySelector
insecureSkipVerify bool

Volume

(Appears on:FluentbitAggregator)

Field	Description
storageClassName string
storageSize string
bind bool

---