logstash.k8s.elastic.co/v1alpha1
ECK
Package v1alpha1 contains API Schema definitions for the logstash v1alpha1 API group
ElasticsearchCluster is a named reference to an Elasticsearch cluster which can be used in a Logstash pipeline.
Appears In:
| Field | Description |
|---|---|
ObjectSelector ObjectSelector |
|
clusterName string |
ClusterName is an alias for the cluster to be used to refer to the Elasticsearch cluster in Logstash configuration files, and will be used to identify "named clusters" in Logstash |
Logstash is the Schema for the logstashes API
| Field | Description |
|---|---|
apiVersion string |
logstash.k8s.elastic.co/v1alpha1 |
kind string |
Logstash |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec LogstashSpec |
|
status LogstashStatus |
Appears In:
Appears In:
| Field | Description |
|---|---|
name string |
|
service ServiceTemplate |
Service defines the template for the associated Kubernetes Service object. |
tls TLSOptions |
TLS defines options for configuring TLS for HTTP. |
LogstashSpec defines the desired state of Logstash
Appears In:
| Field | Description |
|---|---|
version string |
Version of the Logstash. |
count integer |
|
image string |
Image is the Logstash Docker image to deploy. Version and Type have to match the Logstash in the image. |
elasticsearchRefs ElasticsearchCluster array |
ElasticsearchRefs are references to Elasticsearch clusters running in the same Kubernetes cluster. |
config Config |
Config holds the Logstash configuration. At most one of [Config, ConfigRef] can be specified. |
configRef ConfigSource |
ConfigRef contains a reference to an existing Kubernetes Secret holding the Logstash configuration. Logstash settings must be specified as yaml, under a single "logstash.yml" entry. At most one of [Config, ConfigRef] can be specified. |
pipelines Config array |
Pipelines holds the Logstash Pipelines. At most one of [Pipelines, PipelinesRef] can be specified. |
pipelinesRef ConfigSource |
PipelinesRef contains a reference to an existing Kubernetes Secret holding the Logstash Pipelines. Logstash pipelines must be specified as yaml, under a single "pipelines.yml" entry. At most one of [Pipelines, PipelinesRef] can be specified. |
services LogstashService array |
Services contains details of services that Logstash should expose - similar to the HTTP layer configuration for the rest of the stack, but also applicable for more use cases than the metrics API, as logstash may need to be opened up for other services: Beats, TCP, UDP, etc, inputs. |
monitoring Monitoring |
Monitoring enables you to collect and ship log and monitoring data of this Logstash. Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one sends data to one or two different Elasticsearch monitoring clusters running in the same Kubernetes cluster. |
podTemplate PodTemplateSpec |
PodTemplate provides customisation options for the Logstash pods. |
revisionHistoryLimit integer |
RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying StatefulSet. |
secureSettings SecretSource array |
SecureSettings is a list of references to Kubernetes Secrets containing sensitive configuration options for the Logstash. Secrets data can be then referenced in the Logstash config using the Secret’s keys or as specified in Entries field of each SecureSetting. |
serviceAccountName string |
ServiceAccountName is used to check access from the current resource to Elasticsearch resource in a different namespace. Can only be used if ECK is enforcing RBAC on references. |
updateStrategy StatefulSetUpdateStrategy |
UpdateStrategy is a StatefulSetUpdateStrategy. The default type is "RollingUpdate". |
volumeClaimTemplates PersistentVolumeClaim array |
VolumeClaimTemplates is a list of persistent volume claims to be used by each Pod. Every claim in this list must have a matching volumeMount in one of the containers defined in the PodTemplate. Items defined here take precedence over any default claims added by the operator with the same name. |
LogstashStatus defines the observed state of Logstash
Appears In:
| Field | Description |
|---|---|
version string |
Version of the stack resource currently running. During version upgrades, multiple versions may run in parallel: this value specifies the lowest version currently running. |
expectedNodes integer |
|
availableNodes integer |
|
health LogstashHealth |
|
observedGeneration integer |
ObservedGeneration is the most recent generation observed for this Logstash instance. It corresponds to the metadata generation, which is updated on mutation by the API Server. If the generation observed in status diverges from the generation in metadata, the Logstash controller has not yet processed the changes contained in the Logstash specification. |
selector string |