openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Code Issues Releases Activity
Files
6900a504e45fae2b69959ecd195db7742aa0d586
openshift-docs/modules/logging-5.6-api-ref.adoc
Kathryn Alexander 90d985a0bb [enterprise-4.14] changing content type attribute
2023-10-30 10:13:25 -04:00

1361 lines
35 KiB
Plaintext
Raw Blame History

// Module included in the following assemblies:
//
// Note: This content is automatically generated from source, do not edit.
:_mod-docs-content-type: REFERENCE
[id="logging-5-6-api-ref"]
= Logging 5.6 API reference
:toc:
:toclevels: 4
== 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.
[options="header"]
|======================
|Property|Type|Description
|spec|object| Specification of the desired behavior of ClusterLogForwarder
|status|object| Status of the ClusterLogForwarder
|======================
=== .spec
==== Description
ClusterLogForwarderSpec defines how logs should be forwarded to remote targets.
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.inputs[]
==== Description
InputSpec defines a selector of log messages.
===== Type
* array
[options="header"]
|======================
|Property|Type|Description
|application|object| *(optional)* Application, if present, enables named set of `application` logs that
|name|string| Name used to refer to the input of a `pipeline`.
|======================
=== .spec.inputs[].application
==== Description
Application log selector.
All conditions in the selector must be satisfied (logical AND) to select logs.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|namespaces|array| *(optional)* Namespaces from which to collect application logs.
|selector|object| *(optional)* Selector for logs from pods with matching labels.
|======================
=== .spec.inputs[].application.namespaces[]
==== Description
===== Type
* array
=== .spec.inputs[].application.selector
==== Description
A label selector is a label query over a set of resources.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|matchLabels|object| *(optional)* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
|======================
=== .spec.inputs[].application.selector.matchLabels
==== Description
===== Type
* object
=== .spec.outputDefaults
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|elasticsearch|object| *(optional)* Elasticsearch OutputSpec default values
|======================
=== .spec.outputDefaults.elasticsearch
==== Description
ElasticsearchStructuredSpec is spec related to structured log changes to determine the elasticsearch index
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.outputs[]
==== Description
Output defines a destination for log messages.
===== Type
* array
[options="header"]
|======================
|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 `pipeline`.
|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.
|======================
=== .spec.outputs[].secret
==== Description
OutputSecretSpec is a secret reference containing name only, no namespace.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|name|string| Name of a secret in the namespace configured for log forwarder secrets.
|======================
=== .spec.outputs[].tls
==== Description
OutputTLSSpec contains options for TLS connections that are agnostic to the output type.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|insecureSkipVerify|bool| If InsecureSkipVerify is true, then the TLS client will be configured to ignore errors with certificates.
|======================
=== .spec.pipelines[]
==== Description
PipelinesSpec link a set of inputs to a set of outputs.
===== Type
* array
[options="header"]
|======================
|Property|Type|Description
|detectMultilineErrors|bool| *(optional)* DetectMultilineErrors enables multiline error detection of container logs
|inputRefs|array| InputRefs lists the names (`input.name`) of inputs to this pipeline.
|labels|object| *(optional)* Labels applied to log records passing through this pipeline.
|name|string| *(optional)* Name is optional, but must be unique in the `pipelines` list if provided.
|outputRefs|array| OutputRefs lists the names (`output.name`) of outputs from this pipeline.
|parse|string| *(optional)* Parse enables parsing of log entries into structured logs
|======================
=== .spec.pipelines[].inputRefs[]
==== Description
===== Type
* array
=== .spec.pipelines[].labels
==== Description
===== Type
* object
=== .spec.pipelines[].outputRefs[]
==== Description
===== Type
* array
=== .status
==== Description
ClusterLogForwarderStatus defines the observed state of ClusterLogForwarder
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .status.conditions
==== Description
===== Type
* object
=== .status.inputs
==== Description
===== Type
* Conditions
=== .status.outputs
==== Description
===== Type
* Conditions
=== .status.pipelines
==== Description
===== Type
* Conditions== ClusterLogging
A Red Hat OpenShift Logging instance. ClusterLogging is the Schema for the clusterloggings API
[options="header"]
|======================
|Property|Type|Description
|spec|object| Specification of the desired behavior of ClusterLogging
|status|object| Status defines the observed state of ClusterLogging
|======================
=== .spec
==== Description
ClusterLoggingSpec defines the desired state of ClusterLogging
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.collection
==== Description
This is the struct that will contain information pertinent to Log and event collection
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.collection.fluentd
==== Description
FluentdForwarderSpec represents the configuration for forwarders of type fluentd.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|buffer|object|
|inFile|object|
|======================
=== .spec.collection.fluentd.buffer
==== 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
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.collection.fluentd.inFile
==== 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
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|readLinesLimit|int| *(optional)* ReadLinesLimit represents the number of lines to read with each I/O operation
|======================
=== .spec.collection.logs
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|fluentd|object| Specification of the Fluentd Log Collection component
|type|string| The type of Log Collection to configure
|======================
=== .spec.collection.logs.fluentd
==== Description
CollectorSpec is spec to define scheduling and resources for a collector
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.collection.logs.fluentd.nodeSelector
==== Description
===== Type
* object
=== .spec.collection.logs.fluentd.resources
==== Description
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.collection.logs.fluentd.resources.limits
==== Description
===== Type
* object
=== .spec.collection.logs.fluentd.resources.requests
==== Description
===== Type
* object
=== .spec.collection.logs.fluentd.tolerations[]
==== Description
===== Type
* array
[options="header"]
|======================
|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.
|======================
=== .spec.collection.logs.fluentd.tolerations[].tolerationSeconds
==== Description
===== Type
* int
=== .spec.curation
==== Description
This is the struct that will contain information pertinent to Log curation (Curator)
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|curator|object| The specification of curation to configure
|type|string| The kind of curation to configure
|======================
=== .spec.curation.curator
==== Description
===== Type
* object
[options="header"]
|======================
|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|
|======================
=== .spec.curation.curator.nodeSelector
==== Description
===== Type
* object
=== .spec.curation.curator.resources
==== Description
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.curation.curator.resources.limits
==== Description
===== Type
* object
=== .spec.curation.curator.resources.requests
==== Description
===== Type
* object
=== .spec.curation.curator.tolerations[]
==== Description
===== Type
* array
[options="header"]
|======================
|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.
|======================
=== .spec.curation.curator.tolerations[].tolerationSeconds
==== Description
===== Type
* int
=== .spec.forwarder
==== 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`.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|fluentd|object|
|======================
=== .spec.forwarder.fluentd
==== Description
FluentdForwarderSpec represents the configuration for forwarders of type fluentd.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|buffer|object|
|inFile|object|
|======================
=== .spec.forwarder.fluentd.buffer
==== 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
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.forwarder.fluentd.inFile
==== 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
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|readLinesLimit|int| *(optional)* ReadLinesLimit represents the number of lines to read with each I/O operation
|======================
=== .spec.logStore
==== Description
The LogStoreSpec contains information about how logs are stored.
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.logStore.elasticsearch
==== Description
===== Type
* object
[options="header"]
|======================
|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|
|======================
=== .spec.logStore.elasticsearch.nodeSelector
==== Description
===== Type
* object
=== .spec.logStore.elasticsearch.proxy
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|resources|object|
|======================
=== .spec.logStore.elasticsearch.proxy.resources
==== Description
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.logStore.elasticsearch.proxy.resources.limits
==== Description
===== Type
* object
=== .spec.logStore.elasticsearch.proxy.resources.requests
==== Description
===== Type
* object
=== .spec.logStore.elasticsearch.resources
==== Description
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.logStore.elasticsearch.resources.limits
==== Description
===== Type
* object
=== .spec.logStore.elasticsearch.resources.requests
==== Description
===== Type
* object
=== .spec.logStore.elasticsearch.storage
==== Description
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.logStore.elasticsearch.storage.size
==== Description
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.logStore.elasticsearch.storage.size.d
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|Dec|object|
|======================
=== .spec.logStore.elasticsearch.storage.size.d.Dec
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|scale|int|
|unscaled|object|
|======================
=== .spec.logStore.elasticsearch.storage.size.d.Dec.unscaled
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|abs|Word| sign
|neg|bool|
|======================
=== .spec.logStore.elasticsearch.storage.size.d.Dec.unscaled.abs
==== Description
===== Type
* Word
=== .spec.logStore.elasticsearch.storage.size.i
==== Description
===== Type
* int
[options="header"]
|======================
|Property|Type|Description
|scale|int|
|value|int|
|======================
=== .spec.logStore.elasticsearch.tolerations[]
==== Description
===== Type
* array
[options="header"]
|======================
|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.
|======================
=== .spec.logStore.elasticsearch.tolerations[].tolerationSeconds
==== Description
===== Type
* int
=== .spec.logStore.lokistack
==== 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.
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|name|string| Name of the LokiStack resource.
|======================
=== .spec.logStore.retentionPolicy
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|application|object|
|audit|object|
|infra|object|
|======================
=== .spec.logStore.retentionPolicy.application
==== Description
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.logStore.retentionPolicy.application.namespaceSpec[]
==== Description
===== Type
* array
[options="header"]
|======================
|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)
|======================
=== .spec.logStore.retentionPolicy.audit
==== Description
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.logStore.retentionPolicy.audit.namespaceSpec[]
==== Description
===== Type
* array
[options="header"]
|======================
|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)
|======================
=== .spec.logStore.retentionPolicy.infra
==== Description
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .spec.logStore.retentionPolicy.infra.namespaceSpec[]
==== Description
===== Type
* array
[options="header"]
|======================
|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)
|======================
=== .spec.visualization
==== Description
This is the struct that will contain information pertinent to Log visualization (Kibana)
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|kibana|object| Specification of the Kibana Visualization component
|type|string| The type of Visualization to configure
|======================
=== .spec.visualization.kibana
==== Description
===== Type
* object
[options="header"]
|======================
|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|
|======================
=== .spec.visualization.kibana.nodeSelector
==== Description
===== Type
* object
=== .spec.visualization.kibana.proxy
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|resources|object|
|======================
=== .spec.visualization.kibana.proxy.resources
==== Description
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.visualization.kibana.proxy.resources.limits
==== Description
===== Type
* object
=== .spec.visualization.kibana.proxy.resources.requests
==== Description
===== Type
* object
=== .spec.visualization.kibana.replicas
==== Description
===== Type
* int
=== .spec.visualization.kibana.resources
==== Description
===== Type
* object
[options="header"]
|======================
|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.
|======================
=== .spec.visualization.kibana.resources.limits
==== Description
===== Type
* object
=== .spec.visualization.kibana.resources.requests
==== Description
===== Type
* object
=== .spec.visualization.kibana.tolerations[]
==== Description
===== Type
* array
[options="header"]
|======================
|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.
|======================
=== .spec.visualization.kibana.tolerations[].tolerationSeconds
==== Description
===== Type
* int
=== .status
==== Description
ClusterLoggingStatus defines the observed state of ClusterLogging
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|collection|object| *(optional)*
|conditions|object| *(optional)*
|curation|object| *(optional)*
|logStore|object| *(optional)*
|visualization|object| *(optional)*
|======================
=== .status.collection
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|logs|object| *(optional)*
|======================
=== .status.collection.logs
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|fluentdStatus|object| *(optional)*
|======================
=== .status.collection.logs.fluentdStatus
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|clusterCondition|object| *(optional)*
|daemonSet|string| *(optional)*
|nodes|object| *(optional)*
|pods|string| *(optional)*
|======================
=== .status.collection.logs.fluentdStatus.clusterCondition
==== Description
`operator-sdk generate crds` does not allow map-of-slice, must use a named type.
===== Type
* object
=== .status.collection.logs.fluentdStatus.nodes
==== Description
===== Type
* object
=== .status.conditions
==== Description
===== Type
* object
=== .status.curation
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|curatorStatus|array| *(optional)*
|======================
=== .status.curation.curatorStatus[]
==== Description
===== Type
* array
[options="header"]
|======================
|Property|Type|Description
|clusterCondition|object| *(optional)*
|cronJobs|string| *(optional)*
|schedules|string| *(optional)*
|suspended|bool| *(optional)*
|======================
=== .status.curation.curatorStatus[].clusterCondition
==== Description
`operator-sdk generate crds` does not allow map-of-slice, must use a named type.
===== Type
* object
=== .status.logStore
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|elasticsearchStatus|array| *(optional)*
|======================
=== .status.logStore.elasticsearchStatus[]
==== Description
===== Type
* array
[options="header"]
|======================
|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)*
|======================
=== .status.logStore.elasticsearchStatus[].cluster
==== Description
===== Type
* object
[options="header"]
|======================
|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
|======================
=== .status.logStore.elasticsearchStatus[].clusterConditions
==== Description
===== Type
* object
=== .status.logStore.elasticsearchStatus[].deployments[]
==== Description
===== Type
* array
=== .status.logStore.elasticsearchStatus[].nodeConditions
==== Description
===== Type
* object
=== .status.logStore.elasticsearchStatus[].pods
==== Description
===== Type
* object
=== .status.logStore.elasticsearchStatus[].replicaSets[]
==== Description
===== Type
* array
=== .status.logStore.elasticsearchStatus[].statefulSets[]
==== Description
===== Type
* array
=== .status.visualization
==== Description
===== Type
* object
[options="header"]
|======================
|Property|Type|Description
|kibanaStatus|array| *(optional)*
|======================
=== .status.visualization.kibanaStatus[]
==== Description
===== Type
* array
[options="header"]
|======================
|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)*
|======================
=== .status.visualization.kibanaStatus[].clusterCondition
==== Description
===== Type
* object
=== .status.visualization.kibanaStatus[].replicaSets[]
==== Description
===== Type
* array
View Git Blame Copy Permalink