kibana.k8s.elastic.co/v1

edit

Package v1 contains API schema definitions for managing Kibana resources.

Resource Types

Kibana

edit

Kibana represents a Kibana resource in a Kubernetes cluster.

Field Description

apiVersion string

kibana.k8s.elastic.co/v1

kind string

Kibana

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec KibanaSpec

KibanaSpec

edit

KibanaSpec holds the specification of a Kibana instance.

Field Description

version string

Version of Kibana.

image string

Image is the Kibana Docker image to deploy.

count integer

Count of Kibana instances to deploy.

elasticsearchRef ObjectSelector

ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster.

enterpriseSearchRef ObjectSelector

EnterpriseSearchRef is a reference to an EnterpriseSearch running in the same Kubernetes cluster. Kibana provides the default Enterprise Search UI starting version 7.14.

config Config

Config holds the Kibana configuration. See: https://www.elastic.co/guide/en/kibana/current/settings.html

http HTTPConfig

HTTP holds the HTTP layer configuration for Kibana.

podTemplate PodTemplateSpec

PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Kibana pods

secureSettings SecretSource

SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Kibana.

serviceAccountName string

ServiceAccountName is used to check access from the current resource to a resource (for ex. Elasticsearch) in a different namespace. Can only be used if ECK is enforcing RBAC on references.

monitoring Monitoring

Monitoring enables you to collect and ship log and monitoring data of this Kibana. See https://www.elastic.co/guide/en/kibana/current/xpack-monitoring.html. 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.

LogsMonitoring

edit
Field Description

elasticsearchRefs ObjectSelector

ElasticsearchRefs is a reference to a list of monitoring Elasticsearch clusters running in the same Kubernetes cluster. Due to existing limitations, only a single Elasticsearch cluster is currently supported.

MetricsMonitoring

edit
Field Description

elasticsearchRefs ObjectSelector

ElasticsearchRefs is a reference to a list of monitoring Elasticsearch clusters running in the same Kubernetes cluster. Due to existing limitations, only a single Elasticsearch cluster is currently supported.

Monitoring

edit
Field Description

metrics MetricsMonitoring

Metrics holds references to Elasticsearch clusters which will receive monitoring data from this Kibana.

logs LogsMonitoring

Logs holds references to Elasticsearch clusters which will receive log data from this Kibana.