API Reference¶
Packages¶
logging.netcracker.com/v1¶
Package v1 contains API Schema definitions for the cache v1 API group
Resource Types¶
Auth¶
Appears in: - HttpFluentbit - HttpFluentd - LokiFluentbit - LokiFluentd - OtelFluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
user SecretKeySelector |
AuthProxy¶
Appears in: - Graylog
| Field | Description | Default | Validation |
|---|---|---|---|
resources ResourceRequirements |
|||
bindPasswordSecret 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 boolean |
CA¶
Appears in: - AuthProxy - Certificates - FluentbitHttpTLS - FluentbitLokiTLS - FluentbitTLS - FluentdHttpTLS - FluentdLokiTLS - FluentdTLS - InputGraylogTLS - TLS
| Field | Description | Default | Validation |
|---|---|---|---|
secretName string |
|||
secretKey string |
Cert¶
Appears in: - AuthProxy - Certificates - FluentbitHttpTLS - FluentbitLokiTLS - FluentbitTLS - FluentdHttpTLS - FluentdLokiTLS - FluentdTLS - HTTPGraylogTLS - InputGraylogTLS - TLS
| Field | Description | Default | Validation |
|---|---|---|---|
secretName string |
|||
secretKey string |
Certificates¶
Appears in: - FluentbitHttpTLS - FluentbitLokiTLS - FluentbitTLS - FluentdHttpTLS - FluentdLokiTLS - FluentdTLS - InputGraylogTLS - TLS
| Field | Description | Default | Validation |
|---|---|---|---|
ca CA |
|||
cert Cert |
|||
key Key |
CloudEventsReader¶
CloudEventsReader contains EventsReader-specific configuration
Appears in: - LoggingServiceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
resources ResourceRequirements |
|||
dockerImage string |
|||
priorityClassName string |
|||
nodeSelectorKey string |
|||
nodeSelectorValue string |
|||
affinity Affinity |
|||
labels object (keys:string, values:string) |
|||
annotations object (keys:string, values:string) |
|||
args string array |
|||
install boolean |
ConfigmapReload¶
Appears in: - Fluentbit - FluentbitAggregator - Fluentd
| Field | Description | Default | Validation |
|---|---|---|---|
dockerImage string |
|||
resources ResourceRequirements |
ContentPackPathHTTPConfig¶
Appears in: - Graylog
| Field | Description | Default | Validation |
|---|---|---|---|
tls HTTPConfig |
|||
url string |
Credentials¶
Appears in: - HTTPConfig
Fluentbit¶
Fluentbit contains Fluentbit-specific configuration
Appears in: - LoggingServiceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
resources ResourceRequirements |
|||
annotations object (keys:string, values:string) |
|||
labels object (keys:string, values:string) |
|||
extraFields object (keys:string, values: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 object (keys:string, values:string) |
|||
logLevel string |
|||
multilineFirstLineRegexp string |
|||
nodeSelectorKey string |
|||
multilineOtherLinesRegexp string |
|||
tls FluentbitTLS |
|||
additionalVolumes Volume array |
|||
additionalVolumeMounts VolumeMount array |
|||
tolerations Toleration array |
|||
affinity Affinity |
|||
graylogPort integer |
|||
securityContextPrivileged boolean |
|||
watchKubernetesMetadata boolean |
|||
mockKubeData boolean |
|||
systemLogging boolean |
|||
billCycleConf boolean |
|||
graylogOutput boolean |
|||
systemAuditLogging boolean |
|||
kubeAuditLogging boolean |
|||
kubeApiserverAuditLogging boolean |
|||
containerLogging boolean |
|||
excludePath string |
|||
selfLogging boolean |
SelfLogging enables the collection of logs from the FluentBit collector pods. It is disabled by default to prevent feedback loops. |
||
output OutputFluentbit |
|||
flush integer |
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. |
Minimum: 1 |
|
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. |
Enum: [memory-only persistent-offsets node-persistent] |
|
memoryOnlyStateSizeLimit string |
MemoryOnlyStateSizeLimit limits the memory-backed volume that stores read offset databases for the "memory-only" profile. The default is "32Mi". |
||
inputMemBufLimit string |
InputMemBufLimit is the amount of memory that a single input plugin can hold for records that are not flushed to the outputs yet. The input pauses reading when it reaches the limit. Size it so that the sum over the enabled inputs, the emitter buffers of the multiline filters, and the base footprint of Fluentbit fit into the container memory limit. The default is "10M". See Mem_Buf_Limit in https://docs.fluentbit.io/manual/pipeline/inputs/tail |
||
db FluentbitDB |
DB contains settings of the SQLite database which the input plugins use to keep the read offsets |
FluentbitAggregator¶
FluentbitAggregator contains Fluentbit-aggregator-specific configuration
Appears in: - Fluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
labels object (keys:string, values:string) |
|||
volume Volume |
|||
resources ResourceRequirements |
|||
annotations object (keys:string, values:string) |
|||
extraFields object (keys:string, values:string) |
|||
memBufLimit string |
|||
dockerImage string |
|||
configmapReload ConfigmapReload |
|||
nodeSelectorValue string |
|||
multilineOtherLinesRegexp string |
|||
graylogHost string |
|||
multilineFirstLineRegexp string |
|||
graylogProtocol string |
|||
nodeSelectorKey string |
|||
priorityClassName string |
|||
totalLimitSize string |
|||
storageSizeLimit string |
|||
customFilterConf string |
|||
customOutputConf string |
|||
customLuaScriptConf object (keys:string, values:string) |
|||
tls FluentbitTLS |
|||
tolerations Toleration array |
|||
affinity Affinity |
|||
startupTimeout integer |
|||
replicas integer |
|||
graylogPort integer |
|||
install boolean |
|||
securityContextPrivileged boolean |
|||
graylogOutput boolean |
|||
output OutputFluentbit |
|||
inputMemBufLimit string |
InputMemBufLimit is the amount of memory that the forward input can hold for records that are not flushed to the outputs yet. The input stops accepting data from the forwarders when it reaches the limit, and the forwarders keep the records in their own buffers. The default is "200M". See Mem_Buf_Limit in https://docs.fluentbit.io/manual/pipeline/inputs/forward |
FluentbitDB¶
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
Appears in: - Fluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
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. |
Enum: [wal delete truncate persist memory off WAL DELETE TRUNCATE PERSIST MEMORY OFF] |
|
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. |
Enum: [off normal full extra OFF NORMAL FULL EXTRA] |
|
locking boolean |
Locking sets the exclusive access mode to the database file. Enabled by default. |
FluentbitHTTPRouting¶
Appears in: - HttpFluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
headerTag string |
FluentbitHttpTLS¶
Appears in: - HttpFluentbit - OtelFluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
ca CA |
|||
cert Cert |
|||
key Key |
|||
keyPasswd string |
|||
enabled boolean |
|||
verify boolean |
FluentbitLokiTLS¶
Appears in: - LokiFluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
ca CA |
|||
cert Cert |
|||
key Key |
|||
keyPasswd string |
|||
enabled boolean |
|||
verify boolean |
FluentbitTLS¶
Appears in: - Fluentbit - FluentbitAggregator
| Field | Description | Default | Validation |
|---|---|---|---|
generateCerts GenerateCerts |
|||
ca CA |
|||
cert Cert |
|||
key Key |
|||
keyPasswd string |
|||
enabled boolean |
|||
verify boolean |
FluentbitTLSParams¶
Appears in: - FluentbitHttpTLS - FluentbitLokiTLS - FluentbitTLS
| Field | Description | Default | Validation |
|---|---|---|---|
keyPasswd string |
|||
enabled boolean |
|||
verify boolean |
Fluentd¶
Fluentd contains Fluentd-specific configuration
Appears in: - LoggingServiceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
resources ResourceRequirements |
|||
annotations object (keys:string, values:string) |
|||
labels object (keys:string, values:string) |
|||
extraFields object (keys:string, values: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 VolumeMount array |
|||
excludePath string array |
|||
additionalVolumes Volume array |
|||
tolerations Toleration array |
|||
affinity Affinity |
|||
queueLimitLength integer |
|||
graylogPort integer |
|||
billCycleConf boolean |
|||
systemLogging boolean |
|||
systemAuditLogging boolean |
|||
kubeAuditLogging boolean |
|||
kubeApiserverAuditLogging boolean |
|||
containerLogging boolean |
|||
watchKubernetesMetadata boolean |
|||
securityContextPrivileged boolean |
|||
useFileStorage boolean |
|||
graylogOutput boolean |
|||
graylogBufferFlushInterval string |
|||
compress string |
|||
mockKubeData boolean |
|||
output OutputFluentd |
FluentdHTTPRouting¶
Appears in: - HttpFluentd
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
logCategoryHeader string |
FluentdHttpTLS¶
Appears in: - HttpFluentd
| Field | Description | Default | Validation |
|---|---|---|---|
ca CA |
|||
cert Cert |
|||
key Key |
|||
enabled boolean |
|||
verifyMode string |
|||
version string |
|||
ciphers string |
FluentdHttpTLSParams¶
Appears in: - FluentdHttpTLS
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
verifyMode string |
|||
version string |
|||
ciphers string |
FluentdLokiTLS¶
Appears in: - LokiFluentd
| Field | Description | Default | Validation |
|---|---|---|---|
ca CA |
|||
cert Cert |
|||
key Key |
|||
version string |
|||
enabled boolean |
|||
noDefaultCA boolean |
|||
allCiphers boolean |
|||
rescueSslErrors boolean |
|||
noVerify boolean |
FluentdTLS¶
Appears in: - Fluentd
| Field | Description | Default | Validation |
|---|---|---|---|
generateCerts GenerateCerts |
|||
ca CA |
|||
cert Cert |
|||
key Key |
|||
version string |
|||
enabled boolean |
|||
noDefaultCA boolean |
|||
allCiphers boolean |
|||
rescueSslErrors boolean |
|||
noVerify boolean |
FluentdTLSParams¶
Appears in: - FluentdLokiTLS - FluentdTLS
| Field | Description | Default | Validation |
|---|---|---|---|
version string |
|||
enabled boolean |
|||
noDefaultCA boolean |
|||
allCiphers boolean |
|||
rescueSslErrors boolean |
|||
noVerify boolean |
GenerateCerts¶
GenerateCerts define settings for cert-manager.
Appears in: - FluentbitTLS - FluentdTLS - HTTPGraylogTLS - InputGraylogTLS - TLS
| Field | Description | Default | Validation |
|---|---|---|---|
secretName string |
|||
enabled boolean |
Graylog¶
Graylog contains Graylog-specific configuration
Appears in: - LoggingServiceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
graylogResources ResourceRequirements |
|||
mongoResources ResourceRequirements |
|||
initResources ResourceRequirements |
|||
mongoDBUpgrade MongoDBUpgrade |
Deprecated: the operator ignores this field. It will be removed in a future release. | ||
authProxy AuthProxy |
|||
tls GraylogTLS |
|||
openSearch OpenSearch |
|||
affinity Affinity |
|||
annotations object (keys:string, values:string) |
|||
labels object (keys:string, values: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 |
|||
nodeSelectorKey string |
|||
initContainerDockerImage string |
|||
graylogSecretName string |
|||
contentPacks ContentPackPathHTTPConfig array |
|||
streams Stream array |
|||
processbufferProcessors integer |
|||
outputbufferProcessorThreadsMaxPoolSize integer |
|||
ringSize integer |
|||
elasticsearchMaxTotalConnectionsPerRoute integer |
|||
elasticsearchMaxTotalConnections integer |
|||
outputBatchSize integer |
|||
inputbufferRingSize integer |
|||
outputbufferProcessors integer |
|||
maxSize integer |
|||
inputbufferProcessors integer |
|||
startupTimeout integer |
|||
indexShards integer |
|||
indexReplicas integer |
|||
maxNumberOfIndices integer |
|||
logsRotationSizeGb integer |
|||
inputPort integer |
|||
replicas integer |
|||
s3Archive boolean |
GraylogTLS¶
Appears in: - Graylog
| Field | Description | Default | Validation |
|---|---|---|---|
http HTTPGraylogTLS |
|||
input InputGraylogTLS |
HTTPConfig¶
Appears in: - ContentPackPathHTTPConfig - OpenSearch
| Field | Description | Default | Validation |
|---|---|---|---|
credentials Credentials |
|||
tlsConfig TLSConfig |
HTTPGraylogTLS¶
Appears in: - GraylogTLS
| Field | Description | Default | Validation |
|---|---|---|---|
generateCerts GenerateCerts |
|||
cert Cert |
|||
key Key |
|||
cacerts string |
|||
keyFilePassword string |
|||
enabled boolean |
|||
insecureSkipVerify boolean |
HttpFluentbit¶
Appears in: - OutputFluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
routing FluentbitHTTPRouting |
|||
host string |
|||
port integer |
|||
uri string |
|||
auth Auth |
|||
compress string |
|||
tls FluentbitHttpTLS |
|||
jsonDateFormat string |
|||
format string |
|||
extraParams string |
HttpFluentd¶
Appears in: - OutputFluentd
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
routing FluentdHTTPRouting |
|||
host string |
|||
path string |
|||
compress string |
|||
headers object (keys:string, values:string) |
|||
auth Auth |
|||
tls FluentdHttpTLS |
|||
extraParams string |
InputGraylogTLS¶
Appears in: - GraylogTLS
| Field | Description | Default | Validation |
|---|---|---|---|
generateCerts GenerateCerts |
|||
ca CA |
|||
cert Cert |
|||
key Key |
|||
keyFilePassword string |
|||
enabled boolean |
|||
insecureSkipVerify boolean |
Key¶
Appears in: - AuthProxy - Certificates - FluentbitHttpTLS - FluentbitLokiTLS - FluentbitTLS - FluentdHttpTLS - FluentdLokiTLS - FluentdTLS - HTTPGraylogTLS - InputGraylogTLS - TLS
| Field | Description | Default | Validation |
|---|---|---|---|
secretName string |
|||
secretKey string |
LoggingService¶
LoggingService is the Schema for the loggingservices API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
logging.netcracker.com/v1 |
||
kind string |
LoggingService |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec LoggingServiceSpec |
|||
status LoggingServiceStatus |
LoggingServiceCondition¶
LoggingServiceCondition contains description of status of LoggingService
Appears in: - LoggingServiceStatus
| Field | Description | Default | Validation |
|---|---|---|---|
type string |
|||
reason string |
|||
message string |
|||
lastTransitionTime string |
|||
status boolean |
LoggingServiceSpec¶
LoggingServiceSpec defines the desired state of LoggingService
Appears in: - LoggingService - LoggingServiceParameters
| Field | Description | Default | Validation |
|---|---|---|---|
graylog Graylog |
|||
fluentd Fluentd |
|||
fluentbit Fluentbit |
|||
cloudEventsReader CloudEventsReader |
|||
monitoringAgentLoggingPlugin MonitoringAgentLoggingPlugin |
|||
cloudURL string |
|||
osKind string |
|||
containerRuntimeType string |
|||
ipv6 boolean |
|||
openshiftDeploy boolean |
LoggingServiceStatus¶
LoggingServiceStatus defines the observed state of LoggingService
Appears in: - LoggingService
| Field | Description | Default | Validation |
|---|---|---|---|
conditions LoggingServiceCondition array |
LokiFluentbit¶
Appears in: - OutputFluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
host string |
|||
tenant string |
|||
auth Auth |
|||
staticLabels string |
|||
labelsMapping string |
|||
tls FluentbitLokiTLS |
|||
extraParams string |
LokiFluentd¶
Appears in: - OutputFluentd
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
host string |
|||
tenant string |
|||
auth Auth |
|||
staticLabels string |
|||
labelsMapping string |
|||
tls FluentdLokiTLS |
|||
extraParams string |
MongoDBUpgrade¶
MongoDBUpgrade held the images for the step-by-step MongoDB upgrade from 3.6 to 5.0.
Deprecated: the operator no longer runs the upgrade and ignores these fields. The type will be removed in a future release.
Appears in: - Graylog
| Field | Description | Default | Validation |
|---|---|---|---|
mongoDBImage40 string |
|||
mongoDBImage42 string |
|||
mongoDBImage44 string |
MonitoringAgentLoggingPlugin¶
MonitoringAgentLoggingPlugin contains MonitoringAgentLoggingPlugin-specific configuration
Appears in: - LoggingServiceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
resources ResourceRequirements |
|||
annotations object (keys:string, values:string) |
|||
labels object (keys:string, values:string) |
|||
influxDBName string |
|||
influxDBSecretName string |
|||
influxDBHost string |
|||
nodeSelectorKey string |
|||
nodeSelectorValue string |
|||
saSecret string |
|||
saSecretVolume string |
|||
priorityClassName string |
|||
dockerImage string |
|||
influxDBPort integer |
|||
influxDBMode boolean |
OpenSearch¶
Appears in: - Graylog
| Field | Description | Default | Validation |
|---|---|---|---|
tls HTTPConfig |
|||
url string |
OtelFluentbit¶
Appears in: - OutputFluentbit
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
host string |
|||
port integer |
|||
logsUri string |
|||
target string |
|||
logSuppressInterval integer |
|||
auth Auth |
|||
compress string |
|||
tls FluentbitHttpTLS |
|||
extraParams string |
OutputFluentbit¶
Appears in: - Fluentbit - FluentbitAggregator
| Field | Description | Default | Validation |
|---|---|---|---|
loki LokiFluentbit |
|||
http HttpFluentbit |
|||
otel OtelFluentbit |
OutputFluentd¶
Appears in: - Fluentd
| Field | Description | Default | Validation |
|---|---|---|---|
loki LokiFluentd |
|||
http HttpFluentd |
Release¶
Appears in: - LoggingServiceParameters
| Field | Description | Default | Validation |
|---|---|---|---|
Namespace string |
Stream¶
Appears in: - Graylog
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
|||
rotationStrategy string |
|||
rotationPeriod string |
|||
maxSize integer |
|||
maxNumberOfIndices integer |
|||
install boolean |
TLS¶
Appears in: - FluentbitTLS - FluentdTLS - InputGraylogTLS
| Field | Description | Default | Validation |
|---|---|---|---|
generateCerts GenerateCerts |
|||
ca CA |
|||
cert Cert |
|||
key Key |
TLSConfig¶
Appears in: - HTTPConfig
| Field | Description | Default | Validation |
|---|---|---|---|
ca SecretKeySelector |
|||
cert SecretKeySelector |
|||
key SecretKeySelector |
|||
insecureSkipVerify boolean |
Volume¶
Appears in: - FluentbitAggregator
| Field | Description | Default | Validation |
|---|---|---|---|
storageClassName string |
|||
storageSize string |
|||
bind boolean |