Chapter 21. API reference
21.1. 5.6 Logging API reference
21.1.1. Logging 5.6 API reference
21.1.1.1. ClusterLogForwarder
ClusterLogForwarder is an API to configure forwarding logs.
You configure forwarding by specifying a list of pipelines
, which forward from a set of named inputs to a set of named outputs.
There are built-in input names for common log categories, and you can define custom inputs to do additional filtering.
There is a built-in output name for the default openshift log store, but you can define your own outputs with a URL and other connection information to forward logs to other stores or processors, inside or outside the cluster.
For more details see the documentation on the API fields.
Property | Type | Description |
---|---|---|
spec | object | Specification of the desired behavior of ClusterLogForwarder |
status | object | Status of the ClusterLogForwarder |
21.1.1.1.1. .spec
21.1.1.1.1.1. Description
ClusterLogForwarderSpec defines how logs should be forwarded to remote targets.
21.1.1.1.1.1.1. Type
- object
Property | Type | Description |
---|---|---|
inputs | array | (optional) Inputs are named filters for log messages to be forwarded. |
outputDefaults | object | (optional) DEPRECATED OutputDefaults specify forwarder config explicitly for the default store. |
outputs | array | (optional) Outputs are named destinations for log messages. |
pipelines | array | Pipelines forward the messages selected by a set of inputs to a set of outputs. |
21.1.1.1.2. .spec.inputs[]
21.1.1.1.2.1. Description
InputSpec defines a selector of log messages.
21.1.1.1.2.1.1. Type
- array
Property | Type | Description |
---|---|---|
application | object |
(optional) Application, if present, enables named set of |
name | string |
Name used to refer to the input of a |
21.1.1.1.3. .spec.inputs[].application
21.1.1.1.3.1. Description
Application log selector. All conditions in the selector must be satisfied (logical AND) to select logs.
21.1.1.1.3.1.1. Type
- object
Property | Type | Description |
---|---|---|
namespaces | array | (optional) Namespaces from which to collect application logs. |
selector | object | (optional) Selector for logs from pods with matching labels. |
21.1.1.1.4. .spec.inputs[].application.namespaces[]
21.1.1.1.4.1. Description
21.1.1.1.4.1.1. Type
- array
21.1.1.1.5. .spec.inputs[].application.selector
21.1.1.1.5.1. Description
A label selector is a label query over a set of resources.
21.1.1.1.5.1.1. Type
- object
Property | Type | Description |
---|---|---|
matchLabels | object | (optional) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels |
21.1.1.1.6. .spec.inputs[].application.selector.matchLabels
21.1.1.1.6.1. Description
21.1.1.1.6.1.1. Type
- object
21.1.1.1.7. .spec.outputDefaults
21.1.1.1.7.1. Description
21.1.1.1.7.1.1. Type
- object
Property | Type | Description |
---|---|---|
elasticsearch | object | (optional) Elasticsearch OutputSpec default values |
21.1.1.1.8. .spec.outputDefaults.elasticsearch
21.1.1.1.8.1. Description
ElasticsearchStructuredSpec is spec related to structured log changes to determine the elasticsearch index
21.1.1.1.8.1.1. Type
- object
Property | Type | Description |
---|---|---|
enableStructuredContainerLogs | bool | (optional) EnableStructuredContainerLogs enables multi-container structured logs to allow |
structuredTypeKey | string | (optional) StructuredTypeKey specifies the metadata key to be used as name of elasticsearch index |
structuredTypeName | string | (optional) StructuredTypeName specifies the name of elasticsearch schema |
21.1.1.1.9. .spec.outputs[]
21.1.1.1.9.1. Description
Output defines a destination for log messages.
21.1.1.1.9.1.1. Type
- array
Property | Type | Description |
---|---|---|
syslog | object | (optional) |
fluentdForward | object | (optional) |
elasticsearch | object | (optional) |
kafka | object | (optional) |
cloudwatch | object | (optional) |
loki | object | (optional) |
googleCloudLogging | object | (optional) |
splunk | object | (optional) |
name | string |
Name used to refer to the output from a |
secret | object | (optional) Secret for authentication. |
tls | object | TLS contains settings for controlling options on TLS client connections. |
type | string | Type of output plugin. |
url | string | (optional) URL to send log records to. |
21.1.1.1.10. .spec.outputs[].secret
21.1.1.1.10.1. Description
OutputSecretSpec is a secret reference containing name only, no namespace.
21.1.1.1.10.1.1. Type
- object
Property | Type | Description |
---|---|---|
name | string | Name of a secret in the namespace configured for log forwarder secrets. |
21.1.1.1.11. .spec.outputs[].tls
21.1.1.1.11.1. Description
OutputTLSSpec contains options for TLS connections that are agnostic to the output type.
21.1.1.1.11.1.1. Type
- object
Property | Type | Description |
---|---|---|
insecureSkipVerify | bool | If InsecureSkipVerify is true, then the TLS client will be configured to ignore errors with certificates. |
21.1.1.1.12. .spec.pipelines[]
21.1.1.1.12.1. Description
PipelinesSpec link a set of inputs to a set of outputs.
21.1.1.1.12.1.1. Type
- array
Property | Type | Description |
---|---|---|
detectMultilineErrors | bool | (optional) DetectMultilineErrors enables multiline error detection of container logs |
inputRefs | array |
InputRefs lists the names ( |
labels | object | (optional) Labels applied to log records passing through this pipeline. |
name | string |
(optional) Name is optional, but must be unique in the |
outputRefs | array |
OutputRefs lists the names ( |
parse | string | (optional) Parse enables parsing of log entries into structured logs |
21.1.1.1.13. .spec.pipelines[].inputRefs[]
21.1.1.1.13.1. Description
21.1.1.1.13.1.1. Type
- array
21.1.1.1.14. .spec.pipelines[].labels
21.1.1.1.14.1. Description
21.1.1.1.14.1.1. Type
- object
21.1.1.1.15. .spec.pipelines[].outputRefs[]
21.1.1.1.15.1. Description
21.1.1.1.15.1.1. Type
- array
21.1.1.1.16. .status
21.1.1.1.16.1. Description
ClusterLogForwarderStatus defines the observed state of ClusterLogForwarder
21.1.1.1.16.1.1. Type
- object
Property | Type | Description |
---|---|---|
conditions | object | Conditions of the log forwarder. |
inputs | Conditions | Inputs maps input name to condition of the input. |
outputs | Conditions | Outputs maps output name to condition of the output. |
pipelines | Conditions | Pipelines maps pipeline name to condition of the pipeline. |
21.1.1.1.17. .status.conditions
21.1.1.1.17.1. Description
21.1.1.1.17.1.1. Type
- object
21.1.1.1.18. .status.inputs
21.1.1.1.18.1. Description
21.1.1.1.18.1.1. Type
- Conditions
21.1.1.1.19. .status.outputs
21.1.1.1.19.1. Description
21.1.1.1.19.1.1. Type
- Conditions
21.1.1.1.20. .status.pipelines
21.1.1.1.20.1. Description
21.1.1.1.20.1.1. Type
- Conditions== ClusterLogging A Red Hat OpenShift Logging instance. ClusterLogging is the Schema for the clusterloggings API
Property | Type | Description |
---|---|---|
spec | object | Specification of the desired behavior of ClusterLogging |
status | object | Status defines the observed state of ClusterLogging |
21.1.1.1.21. .spec
21.1.1.1.21.1. Description
ClusterLoggingSpec defines the desired state of ClusterLogging
21.1.1.1.21.1.1. Type
- object
Property | Type | Description |
---|---|---|
collection | object | Specification of the Collection component for the cluster |
curation | object | (DEPRECATED) (optional) Deprecated. Specification of the Curation component for the cluster |
forwarder | object | (DEPRECATED) (optional) Deprecated. Specification for Forwarder component for the cluster |
logStore | object | (optional) Specification of the Log Storage component for the cluster |
managementState | string | (optional) Indicator if the resource is 'Managed' or 'Unmanaged' by the operator |
visualization | object | (optional) Specification of the Visualization component for the cluster |
21.1.1.1.22. .spec.collection
21.1.1.1.22.1. Description
This is the struct that will contain information pertinent to Log and event collection
21.1.1.1.22.1.1. Type
- object
Property | Type | Description |
---|---|---|
resources | object | (optional) The resource requirements for the collector |
nodeSelector | object | (optional) Define which Nodes the Pods are scheduled on. |
tolerations | array | (optional) Define the tolerations the Pods will accept |
fluentd | object | (optional) Fluentd represents the configuration for forwarders of type fluentd. |
logs | object | (DEPRECATED) (optional) Deprecated. Specification of Log Collection for the cluster |
type | string | (optional) The type of Log Collection to configure |
21.1.1.1.23. .spec.collection.fluentd
21.1.1.1.23.1. Description
FluentdForwarderSpec represents the configuration for forwarders of type fluentd.
21.1.1.1.23.1.1. Type
- object
Property | Type | Description |
---|---|---|
buffer | object | |
inFile | object |
21.1.1.1.24. .spec.collection.fluentd.buffer
21.1.1.1.24.1. Description
FluentdBufferSpec represents a subset of fluentd buffer parameters to tune the buffer configuration for all fluentd outputs. It supports a subset of parameters to configure buffer and queue sizing, flush operations and retry flushing.
For general parameters refer to: https://docs.fluentd.org/configuration/buffer-section#buffering-parameters
For flush parameters refer to: https://docs.fluentd.org/configuration/buffer-section#flushing-parameters
For retry parameters refer to: https://docs.fluentd.org/configuration/buffer-section#retries-parameters
21.1.1.1.24.1.1. Type
- object
Property | Type | Description |
---|---|---|
chunkLimitSize | string | (optional) ChunkLimitSize represents the maximum size of each chunk. Events will be |
flushInterval | string | (optional) FlushInterval represents the time duration to wait between two consecutive flush |
flushMode | string | (optional) FlushMode represents the mode of the flushing thread to write chunks. The mode |
flushThreadCount | int | (optional) FlushThreadCount represents the number of threads used by the fluentd buffer |
overflowAction | string | (optional) OverflowAction represents the action for the fluentd buffer plugin to |
retryMaxInterval | string | (optional) RetryMaxInterval represents the maximum time interval for exponential backoff |
retryTimeout | string | (optional) RetryTimeout represents the maximum time interval to attempt retries before giving up |
retryType | string | (optional) RetryType represents the type of retrying flush operations. Flush operations can |
retryWait | string | (optional) RetryWait represents the time duration between two consecutive retries to flush |
totalLimitSize | string | (optional) TotalLimitSize represents the threshold of node space allowed per fluentd |
21.1.1.1.25. .spec.collection.fluentd.inFile
21.1.1.1.25.1. Description
FluentdInFileSpec represents a subset of fluentd in-tail plugin parameters to tune the configuration for all fluentd in-tail inputs.
For general parameters refer to: https://docs.fluentd.org/input/tail#parameters
21.1.1.1.25.1.1. Type
- object
Property | Type | Description |
---|---|---|
readLinesLimit | int | (optional) ReadLinesLimit represents the number of lines to read with each I/O operation |
21.1.1.1.26. .spec.collection.logs
21.1.1.1.26.1. Description
21.1.1.1.26.1.1. Type
- object
Property | Type | Description |
---|---|---|
fluentd | object | Specification of the Fluentd Log Collection component |
type | string | The type of Log Collection to configure |
21.1.1.1.27. .spec.collection.logs.fluentd
21.1.1.1.27.1. Description
CollectorSpec is spec to define scheduling and resources for a collector
21.1.1.1.27.1.1. Type
- object
Property | Type | Description |
---|---|---|
nodeSelector | object | (optional) Define which Nodes the Pods are scheduled on. |
resources | object | (optional) The resource requirements for the collector |
tolerations | array | (optional) Define the tolerations the Pods will accept |
21.1.1.1.28. .spec.collection.logs.fluentd.nodeSelector
21.1.1.1.28.1. Description
21.1.1.1.28.1.1. Type
- object
21.1.1.1.29. .spec.collection.logs.fluentd.resources
21.1.1.1.29.1. Description
21.1.1.1.29.1.1. Type
- object
Property | Type | Description |
---|---|---|
limits | object | (optional) Limits describes the maximum amount of compute resources allowed. |
requests | object | (optional) Requests describes the minimum amount of compute resources required. |
21.1.1.1.30. .spec.collection.logs.fluentd.resources.limits
21.1.1.1.30.1. Description
21.1.1.1.30.1.1. Type
- object
21.1.1.1.31. .spec.collection.logs.fluentd.resources.requests
21.1.1.1.31.1. Description
21.1.1.1.31.1.1. Type
- object
21.1.1.1.32. .spec.collection.logs.fluentd.tolerations[]
21.1.1.1.32.1. Description
21.1.1.1.32.1.1. Type
- array
Property | Type | Description |
---|---|---|
effect | string | (optional) Effect indicates the taint effect to match. Empty means match all taint effects. |
key | string | (optional) Key is the taint key that the toleration applies to. Empty means match all taint keys. |
operator | string | (optional) Operator represents a key's relationship to the value. |
tolerationSeconds | int | (optional) TolerationSeconds represents the period of time the toleration (which must be |
value | string | (optional) Value is the taint value the toleration matches to. |
21.1.1.1.33. .spec.collection.logs.fluentd.tolerations[].tolerationSeconds
21.1.1.1.33.1. Description
21.1.1.1.33.1.1. Type
- int
21.1.1.1.34. .spec.curation
21.1.1.1.34.1. Description
This is the struct that will contain information pertinent to Log curation (Curator)
21.1.1.1.34.1.1. Type
- object
Property | Type | Description |
---|---|---|
curator | object | The specification of curation to configure |
type | string | The kind of curation to configure |
21.1.1.1.35. .spec.curation.curator
21.1.1.1.35.1. Description
21.1.1.1.35.1.1. Type
- object
Property | Type | Description |
---|---|---|
nodeSelector | object | Define which Nodes the Pods are scheduled on. |
resources | object | (optional) The resource requirements for Curator |
schedule | string | The cron schedule that the Curator job is run. Defaults to "30 3 * * *" |
tolerations | array |
21.1.1.1.36. .spec.curation.curator.nodeSelector
21.1.1.1.36.1. Description
21.1.1.1.36.1.1. Type
- object
21.1.1.1.37. .spec.curation.curator.resources
21.1.1.1.37.1. Description
21.1.1.1.37.1.1. Type
- object
Property | Type | Description |
---|---|---|
limits | object | (optional) Limits describes the maximum amount of compute resources allowed. |
requests | object | (optional) Requests describes the minimum amount of compute resources required. |
21.1.1.1.38. .spec.curation.curator.resources.limits
21.1.1.1.38.1. Description
21.1.1.1.38.1.1. Type
- object
21.1.1.1.39. .spec.curation.curator.resources.requests
21.1.1.1.39.1. Description
21.1.1.1.39.1.1. Type
- object
21.1.1.1.40. .spec.curation.curator.tolerations[]
21.1.1.1.40.1. Description
21.1.1.1.40.1.1. Type
- array
Property | Type | Description |
---|---|---|
effect | string | (optional) Effect indicates the taint effect to match. Empty means match all taint effects. |
key | string | (optional) Key is the taint key that the toleration applies to. Empty means match all taint keys. |
operator | string | (optional) Operator represents a key's relationship to the value. |
tolerationSeconds | int | (optional) TolerationSeconds represents the period of time the toleration (which must be |
value | string | (optional) Value is the taint value the toleration matches to. |
21.1.1.1.41. .spec.curation.curator.tolerations[].tolerationSeconds
21.1.1.1.41.1. Description
21.1.1.1.41.1.1. Type
- int
21.1.1.1.42. .spec.forwarder
21.1.1.1.42.1. Description
ForwarderSpec contains global tuning parameters for specific forwarder implementations. This field is not required for general use, it allows performance tuning by users familiar with the underlying forwarder technology. Currently supported: fluentd
.
21.1.1.1.42.1.1. Type
- object
Property | Type | Description |
---|---|---|
fluentd | object |
21.1.1.1.43. .spec.forwarder.fluentd
21.1.1.1.43.1. Description
FluentdForwarderSpec represents the configuration for forwarders of type fluentd.
21.1.1.1.43.1.1. Type
- object
Property | Type | Description |
---|---|---|
buffer | object | |
inFile | object |
21.1.1.1.44. .spec.forwarder.fluentd.buffer
21.1.1.1.44.1. Description
FluentdBufferSpec represents a subset of fluentd buffer parameters to tune the buffer configuration for all fluentd outputs. It supports a subset of parameters to configure buffer and queue sizing, flush operations and retry flushing.
For general parameters refer to: https://docs.fluentd.org/configuration/buffer-section#buffering-parameters
For flush parameters refer to: https://docs.fluentd.org/configuration/buffer-section#flushing-parameters
For retry parameters refer to: https://docs.fluentd.org/configuration/buffer-section#retries-parameters
21.1.1.1.44.1.1. Type
- object
Property | Type | Description |
---|---|---|
chunkLimitSize | string | (optional) ChunkLimitSize represents the maximum size of each chunk. Events will be |
flushInterval | string | (optional) FlushInterval represents the time duration to wait between two consecutive flush |
flushMode | string | (optional) FlushMode represents the mode of the flushing thread to write chunks. The mode |
flushThreadCount | int | (optional) FlushThreadCount reprents the number of threads used by the fluentd buffer |
overflowAction | string | (optional) OverflowAction represents the action for the fluentd buffer plugin to |
retryMaxInterval | string | (optional) RetryMaxInterval represents the maximum time interval for exponential backoff |
retryTimeout | string | (optional) RetryTimeout represents the maximum time interval to attempt retries before giving up |
retryType | string | (optional) RetryType represents the type of retrying flush operations. Flush operations can |
retryWait | string | (optional) RetryWait represents the time duration between two consecutive retries to flush |
totalLimitSize | string | (optional) TotalLimitSize represents the threshold of node space allowed per fluentd |
21.1.1.1.45. .spec.forwarder.fluentd.inFile
21.1.1.1.45.1. Description
FluentdInFileSpec represents a subset of fluentd in-tail plugin parameters to tune the configuration for all fluentd in-tail inputs.
For general parameters refer to: https://docs.fluentd.org/input/tail#parameters
21.1.1.1.45.1.1. Type
- object
Property | Type | Description |
---|---|---|
readLinesLimit | int | (optional) ReadLinesLimit represents the number of lines to read with each I/O operation |
21.1.1.1.46. .spec.logStore
21.1.1.1.46.1. Description
The LogStoreSpec contains information about how logs are stored.
21.1.1.1.46.1.1. Type
- object
Property | Type | Description |
---|---|---|
elasticsearch | object | Specification of the Elasticsearch Log Store component |
lokistack | object | LokiStack contains information about which LokiStack to use for log storage if Type is set to LogStoreTypeLokiStack. |
retentionPolicy | object | (optional) Retention policy defines the maximum age for an index after which it should be deleted |
type | string | The Type of Log Storage to configure. The operator currently supports either using ElasticSearch |
21.1.1.1.47. .spec.logStore.elasticsearch
21.1.1.1.47.1. Description
21.1.1.1.47.1.1. Type
- object
Property | Type | Description |
---|---|---|
nodeCount | int | Number of nodes to deploy for Elasticsearch |
nodeSelector | object | Define which Nodes the Pods are scheduled on. |
proxy | object | Specification of the Elasticsearch Proxy component |
redundancyPolicy | string | (optional) |
resources | object | (optional) The resource requirements for Elasticsearch |
storage | object | (optional) The storage specification for Elasticsearch data nodes |
tolerations | array |
21.1.1.1.48. .spec.logStore.elasticsearch.nodeSelector
21.1.1.1.48.1. Description
21.1.1.1.48.1.1. Type
- object
21.1.1.1.49. .spec.logStore.elasticsearch.proxy
21.1.1.1.49.1. Description
21.1.1.1.49.1.1. Type
- object
Property | Type | Description |
---|---|---|
resources | object |
21.1.1.1.50. .spec.logStore.elasticsearch.proxy.resources
21.1.1.1.50.1. Description
21.1.1.1.50.1.1. Type
- object
Property | Type | Description |
---|---|---|
limits | object | (optional) Limits describes the maximum amount of compute resources allowed. |
requests | object | (optional) Requests describes the minimum amount of compute resources required. |
21.1.1.1.51. .spec.logStore.elasticsearch.proxy.resources.limits
21.1.1.1.51.1. Description
21.1.1.1.51.1.1. Type
- object
21.1.1.1.52. .spec.logStore.elasticsearch.proxy.resources.requests
21.1.1.1.52.1. Description
21.1.1.1.52.1.1. Type
- object
21.1.1.1.53. .spec.logStore.elasticsearch.resources
21.1.1.1.53.1. Description
21.1.1.1.53.1.1. Type
- object
Property | Type | Description |
---|---|---|
limits | object | (optional) Limits describes the maximum amount of compute resources allowed. |
requests | object | (optional) Requests describes the minimum amount of compute resources required. |
21.1.1.1.54. .spec.logStore.elasticsearch.resources.limits
21.1.1.1.54.1. Description
21.1.1.1.54.1.1. Type
- object
21.1.1.1.55. .spec.logStore.elasticsearch.resources.requests
21.1.1.1.55.1. Description
21.1.1.1.55.1.1. Type
- object
21.1.1.1.56. .spec.logStore.elasticsearch.storage
21.1.1.1.56.1. Description
21.1.1.1.56.1.1. Type
- object
Property | Type | Description |
---|---|---|
size | object | The max storage capacity for the node to provision. |
storageClassName | string | (optional) The name of the storage class to use with creating the node's PVC. |
21.1.1.1.57. .spec.logStore.elasticsearch.storage.size
21.1.1.1.57.1. Description
21.1.1.1.57.1.1. Type
- object
Property | Type | Description |
---|---|---|
Format | string | Change Format at will. See the comment for Canonicalize for |
d | object | d is the quantity in inf.Dec form if d.Dec != nil |
i | int | i is the quantity in int64 scaled form, if d.Dec == nil |
s | string | s is the generated value of this quantity to avoid recalculation |
21.1.1.1.58. .spec.logStore.elasticsearch.storage.size.d
21.1.1.1.58.1. Description
21.1.1.1.58.1.1. Type
- object
Property | Type | Description |
---|---|---|
Dec | object |
21.1.1.1.59. .spec.logStore.elasticsearch.storage.size.d.Dec
21.1.1.1.59.1. Description
21.1.1.1.59.1.1. Type
- object
Property | Type | Description |
---|---|---|
scale | int | |
unscaled | object |
21.1.1.1.60. .spec.logStore.elasticsearch.storage.size.d.Dec.unscaled
21.1.1.1.60.1. Description
21.1.1.1.60.1.1. Type
- object
Property | Type | Description |
---|---|---|
abs | Word | sign |
neg | bool |
21.1.1.1.61. .spec.logStore.elasticsearch.storage.size.d.Dec.unscaled.abs
21.1.1.1.61.1. Description
21.1.1.1.61.1.1. Type
- Word
21.1.1.1.62. .spec.logStore.elasticsearch.storage.size.i
21.1.1.1.62.1. Description
21.1.1.1.62.1.1. Type
- int
Property | Type | Description |
---|---|---|
scale | int | |
value | int |
21.1.1.1.63. .spec.logStore.elasticsearch.tolerations[]
21.1.1.1.63.1. Description
21.1.1.1.63.1.1. Type
- array
Property | Type | Description |
---|---|---|
effect | string | (optional) Effect indicates the taint effect to match. Empty means match all taint effects. |
key | string | (optional) Key is the taint key that the toleration applies to. Empty means match all taint keys. |
operator | string | (optional) Operator represents a key's relationship to the value. |
tolerationSeconds | int | (optional) TolerationSeconds represents the period of time the toleration (which must be |
value | string | (optional) Value is the taint value the toleration matches to. |
21.1.1.1.64. .spec.logStore.elasticsearch.tolerations[].tolerationSeconds
21.1.1.1.64.1. Description
21.1.1.1.64.1.1. Type
- int
21.1.1.1.65. .spec.logStore.lokistack
21.1.1.1.65.1. Description
LokiStackStoreSpec is used to set up cluster-logging to use a LokiStack as logging storage. It points to an existing LokiStack in the same namespace.
21.1.1.1.65.1.1. Type
- object
Property | Type | Description |
---|---|---|
name | string | Name of the LokiStack resource. |
21.1.1.1.66. .spec.logStore.retentionPolicy
21.1.1.1.66.1. Description
21.1.1.1.66.1.1. Type
- object
Property | Type | Description |
---|---|---|
application | object | |
audit | object | |
infra | object |
21.1.1.1.67. .spec.logStore.retentionPolicy.application
21.1.1.1.67.1. Description
21.1.1.1.67.1.1. Type
- object
Property | Type | Description |
---|---|---|
diskThresholdPercent | int | (optional) The threshold percentage of ES disk usage that when reached, old indices should be deleted (e.g. 75) |
maxAge | string | (optional) |
namespaceSpec | array | (optional) The per namespace specification to delete documents older than a given minimum age |
pruneNamespacesInterval | string | (optional) How often to run a new prune-namespaces job |
21.1.1.1.68. .spec.logStore.retentionPolicy.application.namespaceSpec[]
21.1.1.1.68.1. Description
21.1.1.1.68.1.1. Type
- array
Property | Type | Description |
---|---|---|
minAge | string | (optional) Delete the records matching the namespaces which are older than this MinAge (e.g. 1d) |
namespace | string | Target Namespace to delete logs older than MinAge (defaults to 7d) |
21.1.1.1.69. .spec.logStore.retentionPolicy.audit
21.1.1.1.69.1. Description
21.1.1.1.69.1.1. Type
- object
Property | Type | Description |
---|---|---|
diskThresholdPercent | int | (optional) The threshold percentage of ES disk usage that when reached, old indices should be deleted (e.g. 75) |
maxAge | string | (optional) |
namespaceSpec | array | (optional) The per namespace specification to delete documents older than a given minimum age |
pruneNamespacesInterval | string | (optional) How often to run a new prune-namespaces job |
21.1.1.1.70. .spec.logStore.retentionPolicy.audit.namespaceSpec[]
21.1.1.1.70.1. Description
21.1.1.1.70.1.1. Type
- array
Property | Type | Description |
---|---|---|
minAge | string | (optional) Delete the records matching the namespaces which are older than this MinAge (e.g. 1d) |
namespace | string | Target Namespace to delete logs older than MinAge (defaults to 7d) |
21.1.1.1.71. .spec.logStore.retentionPolicy.infra
21.1.1.1.71.1. Description
21.1.1.1.71.1.1. Type
- object
Property | Type | Description |
---|---|---|
diskThresholdPercent | int | (optional) The threshold percentage of ES disk usage that when reached, old indices should be deleted (e.g. 75) |
maxAge | string | (optional) |
namespaceSpec | array | (optional) The per namespace specification to delete documents older than a given minimum age |
pruneNamespacesInterval | string | (optional) How often to run a new prune-namespaces job |
21.1.1.1.72. .spec.logStore.retentionPolicy.infra.namespaceSpec[]
21.1.1.1.72.1. Description
21.1.1.1.72.1.1. Type
- array
Property | Type | Description |
---|---|---|
minAge | string | (optional) Delete the records matching the namespaces which are older than this MinAge (e.g. 1d) |
namespace | string | Target Namespace to delete logs older than MinAge (defaults to 7d) |
21.1.1.1.73. .spec.visualization
21.1.1.1.73.1. Description
This is the struct that will contain information pertinent to Log visualization (Kibana)
21.1.1.1.73.1.1. Type
- object
Property | Type | Description |
---|---|---|
kibana | object | Specification of the Kibana Visualization component |
type | string | The type of Visualization to configure |
21.1.1.1.74. .spec.visualization.kibana
21.1.1.1.74.1. Description
21.1.1.1.74.1.1. Type
- object
Property | Type | Description |
---|---|---|
nodeSelector | object | Define which Nodes the Pods are scheduled on. |
proxy | object | Specification of the Kibana Proxy component |
replicas | int | Number of instances to deploy for a Kibana deployment |
resources | object | (optional) The resource requirements for Kibana |
tolerations | array |
21.1.1.1.75. .spec.visualization.kibana.nodeSelector
21.1.1.1.75.1. Description
21.1.1.1.75.1.1. Type
- object
21.1.1.1.76. .spec.visualization.kibana.proxy
21.1.1.1.76.1. Description
21.1.1.1.76.1.1. Type
- object
Property | Type | Description |
---|---|---|
resources | object |
21.1.1.1.77. .spec.visualization.kibana.proxy.resources
21.1.1.1.77.1. Description
21.1.1.1.77.1.1. Type
- object
Property | Type | Description |
---|---|---|
limits | object | (optional) Limits describes the maximum amount of compute resources allowed. |
requests | object | (optional) Requests describes the minimum amount of compute resources required. |
21.1.1.1.78. .spec.visualization.kibana.proxy.resources.limits
21.1.1.1.78.1. Description
21.1.1.1.78.1.1. Type
- object
21.1.1.1.79. .spec.visualization.kibana.proxy.resources.requests
21.1.1.1.79.1. Description
21.1.1.1.79.1.1. Type
- object
21.1.1.1.80. .spec.visualization.kibana.replicas
21.1.1.1.80.1. Description
21.1.1.1.80.1.1. Type
- int
21.1.1.1.81. .spec.visualization.kibana.resources
21.1.1.1.81.1. Description
21.1.1.1.81.1.1. Type
- object
Property | Type | Description |
---|---|---|
limits | object | (optional) Limits describes the maximum amount of compute resources allowed. |
requests | object | (optional) Requests describes the minimum amount of compute resources required. |
21.1.1.1.82. .spec.visualization.kibana.resources.limits
21.1.1.1.82.1. Description
21.1.1.1.82.1.1. Type
- object
21.1.1.1.83. .spec.visualization.kibana.resources.requests
21.1.1.1.83.1. Description
21.1.1.1.83.1.1. Type
- object
21.1.1.1.84. .spec.visualization.kibana.tolerations[]
21.1.1.1.84.1. Description
21.1.1.1.84.1.1. Type
- array
Property | Type | Description |
---|---|---|
effect | string | (optional) Effect indicates the taint effect to match. Empty means match all taint effects. |
key | string | (optional) Key is the taint key that the toleration applies to. Empty means match all taint keys. |
operator | string | (optional) Operator represents a key's relationship to the value. |
tolerationSeconds | int | (optional) TolerationSeconds represents the period of time the toleration (which must be |
value | string | (optional) Value is the taint value the toleration matches to. |
21.1.1.1.85. .spec.visualization.kibana.tolerations[].tolerationSeconds
21.1.1.1.85.1. Description
21.1.1.1.85.1.1. Type
- int
21.1.1.1.86. .status
21.1.1.1.86.1. Description
ClusterLoggingStatus defines the observed state of ClusterLogging
21.1.1.1.86.1.1. Type
- object
Property | Type | Description |
---|---|---|
collection | object | (optional) |
conditions | object | (optional) |
curation | object | (optional) |
logStore | object | (optional) |
visualization | object | (optional) |
21.1.1.1.87. .status.collection
21.1.1.1.87.1. Description
21.1.1.1.87.1.1. Type
- object
Property | Type | Description |
---|---|---|
logs | object | (optional) |
21.1.1.1.88. .status.collection.logs
21.1.1.1.88.1. Description
21.1.1.1.88.1.1. Type
- object
Property | Type | Description |
---|---|---|
fluentdStatus | object | (optional) |
21.1.1.1.89. .status.collection.logs.fluentdStatus
21.1.1.1.89.1. Description
21.1.1.1.89.1.1. Type
- object
Property | Type | Description |
---|---|---|
clusterCondition | object | (optional) |
daemonSet | string | (optional) |
nodes | object | (optional) |
pods | string | (optional) |
21.1.1.1.90. .status.collection.logs.fluentdStatus.clusterCondition
21.1.1.1.90.1. Description
operator-sdk generate crds
does not allow map-of-slice, must use a named type.
21.1.1.1.90.1.1. Type
- object
21.1.1.1.91. .status.collection.logs.fluentdStatus.nodes
21.1.1.1.91.1. Description
21.1.1.1.91.1.1. Type
- object
21.1.1.1.92. .status.conditions
21.1.1.1.92.1. Description
21.1.1.1.92.1.1. Type
- object
21.1.1.1.93. .status.curation
21.1.1.1.93.1. Description
21.1.1.1.93.1.1. Type
- object
Property | Type | Description |
---|---|---|
curatorStatus | array | (optional) |
21.1.1.1.94. .status.curation.curatorStatus[]
21.1.1.1.94.1. Description
21.1.1.1.94.1.1. Type
- array
Property | Type | Description |
---|---|---|
clusterCondition | object | (optional) |
cronJobs | string | (optional) |
schedules | string | (optional) |
suspended | bool | (optional) |
21.1.1.1.95. .status.curation.curatorStatus[].clusterCondition
21.1.1.1.95.1. Description
operator-sdk generate crds
does not allow map-of-slice, must use a named type.
21.1.1.1.95.1.1. Type
- object
21.1.1.1.96. .status.logStore
21.1.1.1.96.1. Description
21.1.1.1.96.1.1. Type
- object
Property | Type | Description |
---|---|---|
elasticsearchStatus | array | (optional) |
21.1.1.1.97. .status.logStore.elasticsearchStatus[]
21.1.1.1.97.1. Description
21.1.1.1.97.1.1. Type
- array
Property | Type | Description |
---|---|---|
cluster | object | (optional) |
clusterConditions | object | (optional) |
clusterHealth | string | (optional) |
clusterName | string | (optional) |
deployments | array | (optional) |
nodeConditions | object | (optional) |
nodeCount | int | (optional) |
pods | object | (optional) |
replicaSets | array | (optional) |
shardAllocationEnabled | string | (optional) |
statefulSets | array | (optional) |
21.1.1.1.98. .status.logStore.elasticsearchStatus[].cluster
21.1.1.1.98.1. Description
21.1.1.1.98.1.1. Type
- object
Property | Type | Description |
---|---|---|
activePrimaryShards | int | The number of Active Primary Shards for the Elasticsearch Cluster |
activeShards | int | The number of Active Shards for the Elasticsearch Cluster |
initializingShards | int | The number of Initializing Shards for the Elasticsearch Cluster |
numDataNodes | int | The number of Data Nodes for the Elasticsearch Cluster |
numNodes | int | The number of Nodes for the Elasticsearch Cluster |
pendingTasks | int | |
relocatingShards | int | The number of Relocating Shards for the Elasticsearch Cluster |
status | string | The current Status of the Elasticsearch Cluster |
unassignedShards | int | The number of Unassigned Shards for the Elasticsearch Cluster |
21.1.1.1.99. .status.logStore.elasticsearchStatus[].clusterConditions
21.1.1.1.99.1. Description
21.1.1.1.99.1.1. Type
- object
21.1.1.1.100. .status.logStore.elasticsearchStatus[].deployments[]
21.1.1.1.100.1. Description
21.1.1.1.100.1.1. Type
- array
21.1.1.1.101. .status.logStore.elasticsearchStatus[].nodeConditions
21.1.1.1.101.1. Description
21.1.1.1.101.1.1. Type
- object
21.1.1.1.102. .status.logStore.elasticsearchStatus[].pods
21.1.1.1.102.1. Description
21.1.1.1.102.1.1. Type
- object
21.1.1.1.103. .status.logStore.elasticsearchStatus[].replicaSets[]
21.1.1.1.103.1. Description
21.1.1.1.103.1.1. Type
- array
21.1.1.1.104. .status.logStore.elasticsearchStatus[].statefulSets[]
21.1.1.1.104.1. Description
21.1.1.1.104.1.1. Type
- array
21.1.1.1.105. .status.visualization
21.1.1.1.105.1. Description
21.1.1.1.105.1.1. Type
- object
Property | Type | Description |
---|---|---|
kibanaStatus | array | (optional) |
21.1.1.1.106. .status.visualization.kibanaStatus[]
21.1.1.1.106.1. Description
21.1.1.1.106.1.1. Type
- array
Property | Type | Description |
---|---|---|
clusterCondition | object | (optional) |
deployment | string | (optional) |
pods | string | (optional) The status for each of the Kibana pods for the Visualization component |
replicaSets | array | (optional) |
replicas | int | (optional) |
21.1.1.1.107. .status.visualization.kibanaStatus[].clusterCondition
21.1.1.1.107.1. Description
21.1.1.1.107.1.1. Type
- object
21.1.1.1.108. .status.visualization.kibanaStatus[].replicaSets[]
21.1.1.1.108.1. Description
21.1.1.1.108.1.1. Type
- array