---
title: Elastic Cloud on Kubernetes API Reference for 3.1.0
description: agent.k8s.elastic.co/v1alpha1, apm.k8s.elastic.co/v1, apm.k8s.elastic.co/v1beta1, autoscaling.k8s.elastic.co/v1alpha1, beat.k8s.elastic.co/v1beta1, common.k8s.elastic.co/v1,...
url: https://www.elastic.co/elastic/docs-builder/docs/3028/reference/cloud-on-k8s/api-reference/3_1_0
products:
- Elastic Cloud on Kubernetes
applies_to:
- Elastic Cloud on Kubernetes: Generally available in 3.1
---
# Elastic Cloud on Kubernetes API Reference for 3.1.0
## Packages
- [agent.k8s.elastic.co/v1alpha1](#agentk8selasticcov1alpha1)
- [apm.k8s.elastic.co/v1](#apmk8selasticcov1)
- [apm.k8s.elastic.co/v1beta1](#apmk8selasticcov1beta1)
- [autoscaling.k8s.elastic.co/v1alpha1](#autoscalingk8selasticcov1alpha1)
- [beat.k8s.elastic.co/v1beta1](#beatk8selasticcov1beta1)
- [common.k8s.elastic.co/v1](#commonk8selasticcov1)
- [common.k8s.elastic.co/v1alpha1](#commonk8selasticcov1alpha1)
- [common.k8s.elastic.co/v1beta1](#commonk8selasticcov1beta1)
- [elasticsearch.k8s.elastic.co/v1](#elasticsearchk8selasticcov1)
- [elasticsearch.k8s.elastic.co/v1beta1](#elasticsearchk8selasticcov1beta1)
- [enterprisesearch.k8s.elastic.co/v1](#enterprisesearchk8selasticcov1)
- [enterprisesearch.k8s.elastic.co/v1beta1](#enterprisesearchk8selasticcov1beta1)
- [kibana.k8s.elastic.co/v1](#kibanak8selasticcov1)
- [kibana.k8s.elastic.co/v1beta1](#kibanak8selasticcov1beta1)
- [logstash.k8s.elastic.co/v1alpha1](#logstashk8selasticcov1alpha1)
- [maps.k8s.elastic.co/v1alpha1](#mapsk8selasticcov1alpha1)
- [stackconfigpolicy.k8s.elastic.co/v1alpha1](#stackconfigpolicyk8selasticcov1alpha1)
## agent.k8s.elastic.co/v1alpha1
Package v1alpha1 contains API Schema definitions for the agent v1alpha1 API group
### Resource Types
- [Agent](#agent)
### Agent
Agent is the Schema for the Agents API.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `agent.k8s.elastic.co/v1alpha1` |
| *`kind`* __string__ | `Agent` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[AgentSpec](#agentspec)__ | |
### AgentMode (string)
- [AgentSpec](#agentspec)
### AgentSpec
AgentSpec defines the desired state of the Agent
- [Agent](#agent)
| Field | Description |
|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of the Agent. |
| *`elasticsearchRefs`* __[Output](#output) array__ | ElasticsearchRefs is a reference to a list of Elasticsearch clusters running in the same Kubernetes cluster.Due to existing limitations, only a single ES cluster is currently supported. |
| *`image`* __string__ | Image is the Agent Docker image to deploy. Version has to match the Agent in the image. |
| *`config`* __[Config](#config)__ | Config holds the Agent configuration. At most one of [`Config`, `ConfigRef`] can be specified. |
| *`configRef`* __[ConfigSource](#configsource)__ | ConfigRef contains a reference to an existing Kubernetes Secret holding the Agent configuration.Agent settings must be specified as yaml, under a single "agent.yml" entry. At most one of [`Config`, `ConfigRef`]can be specified. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings is a list of references to Kubernetes Secrets containing sensitive configuration options for the Agent.Secrets data can be then referenced in the Agent config using the Secret's keys or as specified in `Entries` field ofeach SecureSetting. |
| *`serviceAccountName`* __string__ | ServiceAccountName is used to check access from the current resource to an Elasticsearch resource in a different namespace.Can only be used if ECK is enforcing RBAC on references. |
| *`daemonSet`* __[DaemonSetSpec](#daemonsetspec)__ | DaemonSet specifies the Agent should be deployed as a DaemonSet, and allows providing its spec.Cannot be used along with `deployment` or `statefulSet`. |
| *`deployment`* __[DeploymentSpec](#deploymentspec)__ | Deployment specifies the Agent should be deployed as a Deployment, and allows providing its spec.Cannot be used along with `daemonSet` or `statefulSet`. |
| *`statefulSet`* __[StatefulSetSpec](#statefulsetspec)__ | StatefulSet specifies the Agent should be deployed as a StatefulSet, and allows providing its spec.Cannot be used along with `daemonSet` or `deployment`. |
| *`revisionHistoryLimit`* __integer__ | RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying DaemonSet or Deployment or StatefulSet. |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for the Agent in Fleet mode with Fleet Server enabled. |
| *`mode`* __[AgentMode](#agentmode)__ | Mode specifies the runtime mode for the Agent. The configuration can be specified locally through`config` or `configRef` (`standalone` mode), or come from Fleet during runtime (`fleet` mode). Starting withversion 8.13.0 Fleet-managed agents support advanced configuration via a local configuration file.See [https://www.elastic.co/docs/reference/fleet/advanced-kubernetes-managed-by-fleet](https://www.elastic.co/docs/reference/fleet/advanced-kubernetes-managed-by-fleet)Defaults to `standalone` mode. |
| *`fleetServerEnabled`* __boolean__ | FleetServerEnabled determines whether this Agent will launch Fleet Server. Don't set unless `mode` is set to `fleet`. |
| *`policyID`* __string__ | PolicyID determines into which Agent Policy this Agent will be enrolled.This field will become mandatory in a future release, default policies are deprecated since 8.1.0. |
| *`kibanaRef`* __[ObjectSelector](#objectselector)__ | KibanaRef is a reference to Kibana where Fleet should be set up and this Agent should be enrolled. Don't setunless `mode` is set to `fleet`. |
| *`fleetServerRef`* __[ObjectSelector](#objectselector)__ | FleetServerRef is a reference to Fleet Server that this Agent should connect to to obtain it's configuration.Don't set unless `mode` is set to `fleet`. |
### DaemonSetSpec
- [AgentSpec](#agentspec)
| Field | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | |
| *`updateStrategy`* __[DaemonSetUpdateStrategy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#daemonsetupdatestrategy-v1-apps)__ | |
### DeploymentSpec
- [AgentSpec](#agentspec)
| Field | Description |
|----------------------------------------------------------------------------------------------------------------------------------------|-------------|
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | |
| *`replicas`* __integer__ | |
| *`strategy`* __[DeploymentStrategy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#deploymentstrategy-v1-apps)__ | |
### Output
- [AgentSpec](#agentspec)
| Field | Description |
|----------------------------------------------------------|-------------|
| *`ObjectSelector`* __[ObjectSelector](#objectselector)__ | |
| *`outputName`* __string__ | |
### StatefulSetSpec
- [AgentSpec](#agentspec)
| Field | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | |
| *`replicas`* __integer__ | |
| *`serviceName`* __string__ | |
| *`podManagementPolicy`* __[PodManagementPolicyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podmanagementpolicytype-v1-apps)__ | PodManagementPolicy controls how pods are created during initial scale up,when replacing pods on nodes, or when scaling down. The default policy is`Parallel`, where pods are created in parallel to match the desired scalewithout waiting, and on scale down will delete all pods at once.The alternative policy is `OrderedReady`, the default for vanilla kubernetesStatefulSets, where pods are created in increasing order in increasing order(pod-0, then pod-1, etc.) and the controller will wait until each pod is ready beforecontinuing. When scaling down, the pods are removed in the opposite order. |
| *`volumeClaimTemplates`* __[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#persistentvolumeclaim-v1-core) 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. |
## apm.k8s.elastic.co/v1
Package v1 contains API schema definitions for managing APM Server resources.
### Resource Types
- [ApmServer](#apmserver)
### ApmServer
ApmServer represents an APM Server resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `apm.k8s.elastic.co/v1` |
| *`kind`* __string__ | `ApmServer` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[ApmServerSpec](#apmserverspec)__ | |
### ApmServerSpec
ApmServerSpec holds the specification of an APM Server.
- [ApmServer](#apmserver)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of the APM Server. |
| *`image`* __string__ | Image is the APM Server Docker image to deploy. |
| *`count`* __integer__ | Count of APM Server instances to deploy. |
| *`config`* __[Config](#config)__ | Config holds the APM Server configuration. See: [https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html](https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html) |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for the APM Server resource. |
| *`elasticsearchRef`* __[ObjectSelector](#objectselector)__ | ElasticsearchRef is a reference to the output Elasticsearch cluster running in the same Kubernetes cluster. |
| *`kibanaRef`* __[ObjectSelector](#objectselector)__ | KibanaRef is a reference to a Kibana instance running in the same Kubernetes cluster.It allows APM agent central configuration management in Kibana. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the APM Server pods. |
| *`revisionHistoryLimit`* __integer__ | RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for APM Server. |
| *`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. |
## apm.k8s.elastic.co/v1beta1
Package v1beta1 contains API schema definitions for managing APM Server resources.
### Resource Types
- [ApmServer](#apmserver)
### ApmServer
ApmServer represents an APM Server resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `apm.k8s.elastic.co/v1beta1` |
| *`kind`* __string__ | `ApmServer` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[ApmServerSpec](#apmserverspec)__ | |
### ApmServerSpec
ApmServerSpec holds the specification of an APM Server.
- [ApmServer](#apmserver)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of the APM Server. |
| *`image`* __string__ | Image is the APM Server Docker image to deploy. |
| *`count`* __integer__ | Count of APM Server instances to deploy. |
| *`config`* __[Config](#config)__ | Config holds the APM Server configuration. See: [https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html](https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html) |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for the APM Server resource. |
| *`elasticsearchRef`* __[ObjectSelector](#objectselector)__ | ElasticsearchRef is a reference to the output Elasticsearch cluster running in the same Kubernetes cluster. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the APM Server pods. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for APM Server. |
## autoscaling.k8s.elastic.co/v1alpha1
Package v1alpha1 contains API schema definitions for managing ElasticsearchAutoscaler resources.
### Resource Types
- [ElasticsearchAutoscaler](#elasticsearchautoscaler)
### ElasticsearchAutoscaler
ElasticsearchAutoscaler represents an ElasticsearchAutoscaler resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `autoscaling.k8s.elastic.co/v1alpha1` |
| *`kind`* __string__ | `ElasticsearchAutoscaler` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[ElasticsearchAutoscalerSpec](#elasticsearchautoscalerspec)__ | |
### ElasticsearchAutoscalerSpec
ElasticsearchAutoscalerSpec holds the specification of an Elasticsearch autoscaler resource.
- [ElasticsearchAutoscaler](#elasticsearchautoscaler)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
| *`elasticsearchRef`* __[ElasticsearchRef](#elasticsearchref)__ | |
| *`pollingPeriod`* __[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#duration-v1-meta)__ | PollingPeriod is the period at which to synchronize with the Elasticsearch autoscaling API. |
### ElasticsearchRef
ElasticsearchRef is a reference to an Elasticsearch cluster that exists in the same namespace.
- [ElasticsearchAutoscalerSpec](#elasticsearchautoscalerspec)
| Field | Description |
|---------------------|------------------------------------------------------------------------|
| *`name`* __string__ | Name is the name of the Elasticsearch resource to scale automatically. |
## beat.k8s.elastic.co/v1beta1
Package v1beta1 contains API Schema definitions for the beat v1beta1 API group
### Resource Types
- [Beat](#beat)
### Beat
Beat is the Schema for the Beats API.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `beat.k8s.elastic.co/v1beta1` |
| *`kind`* __string__ | `Beat` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[BeatSpec](#beatspec)__ | |
### BeatSpec
BeatSpec defines the desired state of a Beat.
- [Beat](#beat)
| Field | Description |
|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`type`* __string__ | Type is the type of the Beat to deploy (filebeat, metricbeat, heartbeat, auditbeat, journalbeat, packetbeat, and so on).Any string can be used, but well-known types will have the image field defaulted and have the appropriateElasticsearch roles created automatically. It also allows for dashboard setup when combined with a `KibanaRef`. |
| *`version`* __string__ | Version of the Beat. |
| *`elasticsearchRef`* __[ObjectSelector](#objectselector)__ | ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster. |
| *`kibanaRef`* __[ObjectSelector](#objectselector)__ | KibanaRef is a reference to a Kibana instance running in the same Kubernetes cluster.It allows automatic setup of dashboards and visualizations. |
| *`image`* __string__ | Image is the Beat Docker image to deploy. Version and Type have to match the Beat in the image. |
| *`config`* __[Config](#config)__ | Config holds the Beat configuration. At most one of [`Config`, `ConfigRef`] can be specified. |
| *`configRef`* __[ConfigSource](#configsource)__ | ConfigRef contains a reference to an existing Kubernetes Secret holding the Beat configuration.Beat settings must be specified as yaml, under a single "beat.yml" entry. At most one of [`Config`, `ConfigRef`]can be specified. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings is a list of references to Kubernetes Secrets containing sensitive configuration options for the Beat.Secrets data can be then referenced in the Beat config using the Secret's keys or as specified in `Entries` field ofeach 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. |
| *`daemonSet`* __[DaemonSetSpec](#daemonsetspec)__ | DaemonSet specifies the Beat should be deployed as a DaemonSet, and allows providing its spec.Cannot be used along with `deployment`. If both are absent a default for the Type is used. |
| *`deployment`* __[DeploymentSpec](#deploymentspec)__ | Deployment specifies the Beat should be deployed as a Deployment, and allows providing its spec.Cannot be used along with `daemonSet`. If both are absent a default for the Type is used. |
| *`monitoring`* __[Monitoring](#monitoring)__ | Monitoring enables you to collect and ship logs and metrics for this Beat.Metricbeat and/or Filebeat sidecars are configured and send monitoring data to anElasticsearch monitoring cluster running in the same Kubernetes cluster. |
| *`revisionHistoryLimit`* __integer__ | RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying DaemonSet or Deployment. |
### DaemonSetSpec
- [BeatSpec](#beatspec)
| Field | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | |
| *`updateStrategy`* __[DaemonSetUpdateStrategy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#daemonsetupdatestrategy-v1-apps)__ | |
### DeploymentSpec
- [BeatSpec](#beatspec)
| Field | Description |
|----------------------------------------------------------------------------------------------------------------------------------------|-------------|
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | |
| *`replicas`* __integer__ | |
| *`strategy`* __[DeploymentStrategy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#deploymentstrategy-v1-apps)__ | |
## common.k8s.elastic.co/v1
Package v1 contains API schema definitions for common types used by all resources.
### Config
Config represents untyped YAML configuration.
- [AgentSpec](#agentspec)
- [ApmServerSpec](#apmserverspec)
- [BeatSpec](#beatspec)
- [ElasticsearchConfigPolicySpec](#elasticsearchconfigpolicyspec)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [IndexTemplates](#indextemplates)
- [KibanaConfigPolicySpec](#kibanaconfigpolicyspec)
- [KibanaSpec](#kibanaspec)
- [LogstashSpec](#logstashspec)
- [MapsSpec](#mapsspec)
- [NodeSet](#nodeset)
- [Search](#search)
### ConfigMapRef
ConfigMapRef is a reference to a config map that exists in the same namespace as the referring resource.
- [TransportTLSOptions](#transporttlsoptions)
| Field | Description |
|------------------------------|-------------|
| *`configMapName`* __string__ | |
### ConfigSource
ConfigSource references configuration settings.
- [AgentSpec](#agentspec)
- [BeatSpec](#beatspec)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [LogstashSpec](#logstashspec)
- [MapsSpec](#mapsspec)
| Field | Description |
|---------------------------|---------------------------------------|
| *`secretName`* __string__ | SecretName is the name of the secret. |
### HTTPConfig
HTTPConfig holds the HTTP layer configuration for resources.
- [AgentSpec](#agentspec)
- [ApmServerSpec](#apmserverspec)
- [ElasticsearchSpec](#elasticsearchspec)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [KibanaSpec](#kibanaspec)
- [MapsSpec](#mapsspec)
| Field | Description |
|-----------------------------------------------------|----------------------------------------------------------------------------|
| *`service`* __[ServiceTemplate](#servicetemplate)__ | Service defines the template for the associated Kubernetes Service object. |
| *`tls`* __[TLSOptions](#tlsoptions)__ | TLS defines options for configuring TLS for HTTP. |
### KeyToPath
KeyToPath defines how to map a key in a Secret object to a filesystem path.
- [SecretSource](#secretsource)
| Field | Description |
|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| *`key`* __string__ | Key is the key contained in the secret. |
| *`path`* __string__ | Path is the relative file path to map the key to.Path must not be an absolute file path and must not contain any ".." components. |
### LocalObjectSelector
LocalObjectSelector defines a reference to a Kubernetes object corresponding to an Elastic resource managed by the operator
- [RemoteCluster](#remotecluster)
| Field | Description |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`namespace`* __string__ | Namespace of the Kubernetes object. If empty, defaults to the current namespace. |
| *`name`* __string__ | Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK. |
| *`serviceName`* __string__ | ServiceName is the name of an existing Kubernetes service which is used to make requests to the referencedobject. It has to be in the same namespace as the referenced resource. If left empty, the default HTTP service ofthe referenced resource is used. |
### LogsMonitoring
LogsMonitoring holds a list of Elasticsearch clusters which receive logs data from
associated resources.
- [Monitoring](#monitoring)
| Field | Description |
|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`elasticsearchRefs`* __[ObjectSelector](#objectselector) array__ | 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
MetricsMonitoring holds a list of Elasticsearch clusters which receive monitoring data from
associated resources.
- [Monitoring](#monitoring)
| Field | Description |
|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`elasticsearchRefs`* __[ObjectSelector](#objectselector) array__ | 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
Monitoring holds references to both the metrics, and logs Elasticsearch clusters for
configuring stack monitoring.
- [BeatSpec](#beatspec)
- [ElasticsearchSpec](#elasticsearchspec)
- [KibanaSpec](#kibanaspec)
- [LogstashSpec](#logstashspec)
| Field | Description |
|---------------------------------------------------------|------------------------------------------------------------------------------------------------------|
| *`metrics`* __[MetricsMonitoring](#metricsmonitoring)__ | Metrics holds references to Elasticsearch clusters which receive monitoring data from this resource. |
| *`logs`* __[LogsMonitoring](#logsmonitoring)__ | Logs holds references to Elasticsearch clusters which receive log data from an associated resource. |
### ObjectSelector
ObjectSelector defines a reference to a Kubernetes object which can be an Elastic resource managed by the operator
or a Secret describing an external Elastic resource not managed by the operator.
- [AgentSpec](#agentspec)
- [ApmServerSpec](#apmserverspec)
- [BeatSpec](#beatspec)
- [ElasticsearchCluster](#elasticsearchcluster)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [EnterpriseSearchSpec](#enterprisesearchspec)
- [KibanaSpec](#kibanaspec)
- [LogsMonitoring](#logsmonitoring)
- [MapsSpec](#mapsspec)
- [MetricsMonitoring](#metricsmonitoring)
- [Output](#output)
| Field | Description |
|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`namespace`* __string__ | Namespace of the Kubernetes object. If empty, defaults to the current namespace. |
| *`name`* __string__ | Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK. |
| *`serviceName`* __string__ | ServiceName is the name of an existing Kubernetes service which is used to make requests to the referencedobject. It has to be in the same namespace as the referenced resource. If left empty, the default HTTP service ofthe referenced resource is used. |
| *`secretName`* __string__ | SecretName is the name of an existing Kubernetes secret that contains connection information for associating anElastic resource not managed by the operator. The referenced secret must contain the following:- `url`: the URL to reach the Elastic resource- `username`: the username of the user to be authenticated to the Elastic resource- `password`: the password of the user to be authenticated to the Elastic resource- `ca.crt`: the CA certificate in PEM format (optional)- `api-key`: the key to authenticate against the Elastic resource instead of a username and password (supported only for `elasticsearchRefs` in AgentSpec and in BeatSpec)This field cannot be used in combination with the other fields name, namespace or serviceName. |
### PodDisruptionBudgetTemplate
PodDisruptionBudgetTemplate defines the template for creating a PodDisruptionBudget.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[PodDisruptionBudgetSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#poddisruptionbudgetspec-v1-policy)__ | Spec is the specification of the PDB. |
### SecretRef
SecretRef is a reference to a secret that exists in the same namespace.
- [ConfigSource](#configsource)
- [FileRealmSource](#filerealmsource)
- [RoleSource](#rolesource)
- [TLSOptions](#tlsoptions)
- [TransportTLSOptions](#transporttlsoptions)
| Field | Description |
|---------------------------|---------------------------------------|
| *`secretName`* __string__ | SecretName is the name of the secret. |
### SecretSource
SecretSource defines a data source based on a Kubernetes Secret.
- [AgentSpec](#agentspec)
- [ApmServerSpec](#apmserverspec)
- [BeatSpec](#beatspec)
- [ElasticsearchConfigPolicySpec](#elasticsearchconfigpolicyspec)
- [ElasticsearchSpec](#elasticsearchspec)
- [KibanaConfigPolicySpec](#kibanaconfigpolicyspec)
- [KibanaSpec](#kibanaspec)
- [LogstashSpec](#logstashspec)
- [StackConfigPolicySpec](#stackconfigpolicyspec)
| Field | Description |
|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`secretName`* __string__ | SecretName is the name of the secret. |
| *`entries`* __[KeyToPath](#keytopath) array__ | Entries define how to project each key-value pair in the secret to filesystem paths.If not defined, all keys will be projected to similarly named paths in the filesystem.If defined, only the specified keys will be projected to the corresponding paths. |
### SelfSignedCertificate
SelfSignedCertificate holds configuration for the self-signed certificate generated by the operator.
- [TLSOptions](#tlsoptions)
| Field | Description |
|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
| *`subjectAltNames`* __[SubjectAlternativeName](#subjectalternativename) array__ | SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate. |
| *`disabled`* __boolean__ | Disabled indicates that the provisioning of the self-signed certifcate should be disabled. |
### ServiceTemplate
ServiceTemplate defines the template for a Kubernetes Service.
- [HTTPConfig](#httpconfig)
- [LogstashService](#logstashservice)
- [TransportConfig](#transportconfig)
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[ServiceSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#servicespec-v1-core)__ | Spec is the specification of the service. |
### SubjectAlternativeName
SubjectAlternativeName represents a SAN entry in a x509 certificate.
- [SelfSignedCertificate](#selfsignedcertificate)
- [TransportTLSOptions](#transporttlsoptions)
| Field | Description |
|--------------------|--------------------------------------|
| *`dns`* __string__ | DNS is the DNS name of the subject. |
| *`ip`* __string__ | IP is the IP address of the subject. |
### TLSOptions
TLSOptions holds TLS configuration options.
- [HTTPConfig](#httpconfig)
- [LogstashService](#logstashservice)
| Field | Description |
|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`selfSignedCertificate`* __[SelfSignedCertificate](#selfsignedcertificate)__ | SelfSignedCertificate allows configuring the self-signed certificate generated by the operator. |
| *`certificate`* __[SecretRef](#secretref)__ | Certificate is a reference to a Kubernetes secret that contains the certificate and private key for enabling TLS.The referenced secret should contain the following:- `ca.crt`: The certificate authority (optional).- `tls.crt`: The certificate (or a chain).- `tls.key`: The private key to the first certificate in the certificate chain. |
## common.k8s.elastic.co/v1alpha1
Package v1alpha1 contains API schema definitions for common types used by all resources.
### Condition
Condition represents Elasticsearch resource's condition.
**This API is in technical preview and may be changed or removed in a future release.**
- [Conditions](#conditions)
| Field | Description |
|--------------------------------------------------------------------------------------------------------------------------------|-------------|
| *`type`* __[ConditionType](#conditiontype)__ | |
| *`status`* __[ConditionStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#conditionstatus-v1-core)__ | |
| *`lastTransitionTime`* __[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)__ | |
| *`message`* __string__ | |
### ConditionType (string)
ConditionType defines the condition of an Elasticsearch resource.
- [Condition](#condition)
### Conditions ([Condition](#condition))
- [ElasticsearchStatus](#elasticsearchstatus)
| Field | Description |
|--------------------------------------------------------------------------------------------------------------------------------|-------------|
| *`type`* __[ConditionType](#conditiontype)__ | |
| *`status`* __[ConditionStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#conditionstatus-v1-core)__ | |
| *`lastTransitionTime`* __[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)__ | |
| *`message`* __string__ | |
## common.k8s.elastic.co/v1beta1
Package v1beta1 contains API schema definitions for common types used by all resources.
### Config
Config represents untyped YAML configuration.
- [ApmServerSpec](#apmserverspec)
- [KibanaSpec](#kibanaspec)
- [NodeSet](#nodeset)
### HTTPConfig
HTTPConfig holds the HTTP layer configuration for resources.
- [ApmServerSpec](#apmserverspec)
- [ElasticsearchSpec](#elasticsearchspec)
- [KibanaSpec](#kibanaspec)
| Field | Description |
|-----------------------------------------------------|----------------------------------------------------------------------------|
| *`service`* __[ServiceTemplate](#servicetemplate)__ | Service defines the template for the associated Kubernetes Service object. |
| *`tls`* __[TLSOptions](#tlsoptions)__ | TLS defines options for configuring TLS for HTTP. |
### KeyToPath
KeyToPath defines how to map a key in a Secret object to a filesystem path.
- [SecretSource](#secretsource)
| Field | Description |
|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| *`key`* __string__ | Key is the key contained in the secret. |
| *`path`* __string__ | Path is the relative file path to map the key to.Path must not be an absolute file path and must not contain any ".." components. |
### ObjectSelector
ObjectSelector defines a reference to a Kubernetes object.
- [ApmServerSpec](#apmserverspec)
- [KibanaSpec](#kibanaspec)
| Field | Description |
|--------------------------|----------------------------------------------------------------------------------|
| *`name`* __string__ | Name of the Kubernetes object. |
| *`namespace`* __string__ | Namespace of the Kubernetes object. If empty, defaults to the current namespace. |
### PodDisruptionBudgetTemplate
PodDisruptionBudgetTemplate defines the template for creating a PodDisruptionBudget.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[PodDisruptionBudgetSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#poddisruptionbudgetspec-v1beta1-policy)__ | Spec is the specification of the PDB. |
### SecretRef
SecretRef is a reference to a secret that exists in the same namespace.
- [TLSOptions](#tlsoptions)
| Field | Description |
|---------------------------|---------------------------------------|
| *`secretName`* __string__ | SecretName is the name of the secret. |
### SecretSource
SecretSource defines a data source based on a Kubernetes Secret.
- [ApmServerSpec](#apmserverspec)
- [ElasticsearchSpec](#elasticsearchspec)
- [KibanaSpec](#kibanaspec)
| Field | Description |
|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`secretName`* __string__ | SecretName is the name of the secret. |
| *`entries`* __[KeyToPath](#keytopath) array__ | Entries define how to project each key-value pair in the secret to filesystem paths.If not defined, all keys will be projected to similarly named paths in the filesystem.If defined, only the specified keys will be projected to the corresponding paths. |
### SelfSignedCertificate
SelfSignedCertificate holds configuration for the self-signed certificate generated by the operator.
- [TLSOptions](#tlsoptions)
| Field | Description |
|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
| *`subjectAltNames`* __[SubjectAlternativeName](#subjectalternativename) array__ | SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate. |
| *`disabled`* __boolean__ | Disabled indicates that the provisioning of the self-signed certifcate should be disabled. |
### ServiceTemplate
ServiceTemplate defines the template for a Kubernetes Service.
- [HTTPConfig](#httpconfig)
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[ServiceSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#servicespec-v1-core)__ | Spec is the specification of the service. |
### SubjectAlternativeName
SubjectAlternativeName represents a SAN entry in a x509 certificate.
- [SelfSignedCertificate](#selfsignedcertificate)
| Field | Description |
|--------------------|--------------------------------------|
| *`dns`* __string__ | DNS is the DNS name of the subject. |
| *`ip`* __string__ | IP is the IP address of the subject. |
### TLSOptions
TLSOptions holds TLS configuration options.
- [HTTPConfig](#httpconfig)
| Field | Description |
|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`selfSignedCertificate`* __[SelfSignedCertificate](#selfsignedcertificate)__ | SelfSignedCertificate allows configuring the self-signed certificate generated by the operator. |
| *`certificate`* __[SecretRef](#secretref)__ | Certificate is a reference to a Kubernetes secret that contains the certificate and private key for enabling TLS.The referenced secret should contain the following:- `ca.crt`: The certificate authority (optional).- `tls.crt`: The certificate (or a chain).- `tls.key`: The private key to the first certificate in the certificate chain. |
## elasticsearch.k8s.elastic.co/v1
Package v1 contains API schema definitions for managing Elasticsearch resources.
### Resource Types
- [Elasticsearch](#elasticsearch)
### Auth
Auth contains user authentication and authorization security settings for Elasticsearch.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|-------------------------------------------------------------|------------------------------------------------------------------------------|
| *`roles`* __[RoleSource](#rolesource) array__ | Roles to propagate to the Elasticsearch cluster. |
| *`fileRealm`* __[FileRealmSource](#filerealmsource) array__ | FileRealm to propagate to the Elasticsearch cluster. |
| *`disableElasticUser`* __boolean__ | DisableElasticUser disables the default elastic user that is created by ECK. |
### ChangeBudget
ChangeBudget defines the constraints to consider when applying changes to the Elasticsearch cluster.
- [UpdateStrategy](#updatestrategy)
| Field | Description |
|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`maxUnavailable`* __integer__ | MaxUnavailable is the maximum number of Pods that can be unavailable (not ready) during the update due tocircumstances under the control of the operator. Setting a negative value will disable this restriction.Defaults to 1 if not specified. |
| *`maxSurge`* __integer__ | MaxSurge is the maximum number of new Pods that can be created exceeding the original number of Pods defined inthe specification. MaxSurge is only taken into consideration when scaling up. Setting a negative value willdisable the restriction. Defaults to unbounded if not specified. |
### DownscaleOperation
DownscaleOperation provides details about in progress downscale operations.
**This API is in technical preview and may be changed or removed in a future release.**
- [InProgressOperations](#inprogressoperations)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| *`lastUpdatedTime`* __[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)__ | |
| *`nodes`* __[DownscaledNode](#downscalednode) array__ | Nodes which are scheduled to be removed from the cluster. |
| *`stalled`* __boolean__ | Stalled represents a state where no progress can be made.It is only available for clusters managed with the Elasticsearch shutdown API. |
### DownscaledNode
DownscaledNode provides an overview of in progress changes applied by the operator to remove Elasticsearch nodes from the cluster.
**This API is in technical preview and may be changed or removed in a future release.**
- [DownscaleOperation](#downscaleoperation)
| Field | Description |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`name`* __string__ | Name of the Elasticsearch node that should be removed. |
| *`shutdownStatus`* __string__ | Shutdown status as returned by the Elasticsearch shutdown API.If the Elasticsearch shutdown API is not available, the shutdown status is then inferred from the remainingshards on the nodes, as observed by the operator. |
| *`explanation`* __string__ | Explanation provides details about an in progress node shutdown. It is only available for clusters managed with theElasticsearch shutdown API. |
### Elasticsearch
Elasticsearch represents an Elasticsearch resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `elasticsearch.k8s.elastic.co/v1` |
| *`kind`* __string__ | `Elasticsearch` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[ElasticsearchSpec](#elasticsearchspec)__ | |
| *`status`* __[ElasticsearchStatus](#elasticsearchstatus)__ | |
### ElasticsearchHealth (string)
ElasticsearchHealth is the health of the cluster as returned by the health API.
- [ElasticsearchStatus](#elasticsearchstatus)
### ElasticsearchOrchestrationPhase (string)
ElasticsearchOrchestrationPhase is the phase Elasticsearch is in from the controller point of view.
- [ElasticsearchStatus](#elasticsearchstatus)
### ElasticsearchSpec
ElasticsearchSpec holds the specification of an Elasticsearch cluster.
- [Elasticsearch](#elasticsearch)
| Field | Description |
|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of Elasticsearch. |
| *`image`* __string__ | Image is the Elasticsearch Docker image to deploy. |
| *`remoteClusterServer`* __[RemoteClusterServer](#remoteclusterserver)__ | RemoteClusterServer specifies if the remote cluster server should be enabled.This must be enabled if this cluster is a remote cluster which is expected to be accessed using API key authentication. |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds HTTP layer settings for Elasticsearch. |
| *`transport`* __[TransportConfig](#transportconfig)__ | Transport holds transport layer settings for Elasticsearch. |
| *`nodeSets`* __[NodeSet](#nodeset) array__ | NodeSets allow specifying groups of Elasticsearch nodes sharing the same configuration and Pod templates. |
| *`updateStrategy`* __[UpdateStrategy](#updatestrategy)__ | UpdateStrategy specifies how updates to the cluster should be performed. |
| *`podDisruptionBudget`* __[PodDisruptionBudgetTemplate](#poddisruptionbudgettemplate)__ | PodDisruptionBudget provides access to the default Pod disruption budget for the Elasticsearch cluster.The default budget doesn't allow any Pod to be removed in case the cluster is not green or if there is only one node of type `data` or `master`.In all other cases the default PodDisruptionBudget sets `minUnavailable` equal to the total number of nodes minus 1.To disable, set `PodDisruptionBudget` to the empty value (`{}` in YAML). |
| *`auth`* __[Auth](#auth)__ | Auth contains user authentication and authorization security settings for Elasticsearch. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Elasticsearch. |
| *`serviceAccountName`* __string__ | ServiceAccountName is used to check access from the current resource to a resource (for ex. a remote Elasticsearch cluster) in a different namespace.Can only be used if ECK is enforcing RBAC on references. |
| *`remoteClusters`* __[RemoteCluster](#remotecluster) array__ | RemoteClusters enables you to establish uni-directional connections to a remote Elasticsearch cluster. |
| *`volumeClaimDeletePolicy`* __[VolumeClaimDeletePolicy](#volumeclaimdeletepolicy)__ | VolumeClaimDeletePolicy sets the policy for handling deletion of PersistentVolumeClaims for all NodeSets.Possible values are DeleteOnScaledownOnly and DeleteOnScaledownAndClusterDeletion. Defaults to DeleteOnScaledownAndClusterDeletion. |
| *`monitoring`* __[Monitoring](#monitoring)__ | Monitoring enables you to collect and ship log and monitoring data of this Elasticsearch cluster.See [https://www.elastic.co/guide/en/elasticsearch/reference/current/monitor-elasticsearch-cluster.html](https://www.elastic.co/guide/en/elasticsearch/reference/current/monitor-elasticsearch-cluster.html).Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one sends data to one or two differentElasticsearch monitoring clusters running in the same Kubernetes cluster. |
| *`revisionHistoryLimit`* __integer__ | RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying StatefulSets. |
### ElasticsearchStatus
ElasticsearchStatus represents the observed state of Elasticsearch.
- [Elasticsearch](#elasticsearch)
| Field | Description |
|-----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`availableNodes`* __integer__ | AvailableNodes is the number of available instances. |
| *`version`* __string__ | Version of the stack resource currently running. During version upgrades, multiple versions may runin parallel: this value specifies the lowest version currently running. |
| *`health`* __[ElasticsearchHealth](#elasticsearchhealth)__ | |
| *`phase`* __[ElasticsearchOrchestrationPhase](#elasticsearchorchestrationphase)__ | |
| *`conditions`* __[Conditions](#conditions)__ | Conditions holds the current service state of an Elasticsearch cluster.**This API is in technical preview and may be changed or removed in a future release.** |
| *`inProgressOperations`* __[InProgressOperations](#inprogressoperations)__ | InProgressOperations represents changes being applied by the operator to the Elasticsearch cluster.**This API is in technical preview and may be changed or removed in a future release.** |
| *`observedGeneration`* __integer__ | ObservedGeneration is the most recent generation observed for this Elasticsearch cluster.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 Elasticsearchcontroller has not yet processed the changes contained in the Elasticsearch specification. |
### FieldSecurity
- [Search](#search)
| Field | Description |
|-----------------------------|-------------|
| *`grant`* __string array__ | |
| *`except`* __string array__ | |
### FileRealmSource
FileRealmSource references users to create in the Elasticsearch cluster.
- [Auth](#auth)
| Field | Description |
|---------------------------|---------------------------------------|
| *`secretName`* __string__ | SecretName is the name of the secret. |
### InProgressOperations
InProgressOperations provides details about in progress changes applied by the operator on the Elasticsearch cluster.
**This API is in technical preview and may be changed or removed in a future release.**
- [ElasticsearchStatus](#elasticsearchstatus)
| Field | Description |
|-------------------------------------------------------------|-------------|
| *`downscale`* __[DownscaleOperation](#downscaleoperation)__ | |
| *`upgrade`* __[UpgradeOperation](#upgradeoperation)__ | |
| *`upscale`* __[UpscaleOperation](#upscaleoperation)__ | |
### NewNode
- [UpscaleOperation](#upscaleoperation)
| Field | Description |
|------------------------------------------------|------------------------------------------------------------------------------------|
| *`name`* __string__ | Name of the Elasticsearch node that should be added to the cluster. |
| *`status`* __[NewNodeStatus](#newnodestatus)__ | NewNodeStatus states if a new node is being created, or if the upscale is delayed. |
| *`message`* __string__ | Optional message to explain why a node may not be immediately added. |
### NewNodeStatus (string)
NewNodeStatus provides details about the status of nodes which are expected to be created and added to the Elasticsearch cluster.
**This API is in technical preview and may be changed or removed in a future release.**
- [NewNode](#newnode)
### NodeSet
NodeSet is the specification for a group of Elasticsearch nodes sharing the same configuration and a Pod template.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`name`* __string__ | Name of this set of nodes. Becomes a part of the Elasticsearch node.name setting. |
| *`config`* __[Config](#config)__ | Config holds the Elasticsearch configuration. |
| *`count`* __integer__ | Count of Elasticsearch nodes to deploy.If the node set is managed by an autoscaling policy the initial value is automatically set by the autoscaling controller. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Pods belonging to this NodeSet. |
| *`volumeClaimTemplates`* __[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#persistentvolumeclaim-v1-core) array__ | VolumeClaimTemplates is a list of persistent volume claims to be used by each Pod in this NodeSet.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. |
### RemoteCluster
RemoteCluster declares a remote Elasticsearch cluster connection.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`name`* __string__ | Name is the name of the remote cluster as it is set in the Elasticsearch settings.The name is expected to be unique for each remote clusters. |
| *`elasticsearchRef`* __[LocalObjectSelector](#localobjectselector)__ | ElasticsearchRef is a reference to an Elasticsearch cluster running within the same k8s cluster. |
| *`apiKey`* __[RemoteClusterAPIKey](#remoteclusterapikey)__ | APIKey can be used to enable remote cluster access using Cross-Cluster API keys: [https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html) |
### RemoteClusterAPIKey
RemoteClusterAPIKey defines a remote cluster API Key.
- [RemoteCluster](#remotecluster)
| Field | Description |
|------------------------------------------------------------|---------------------------------------------------------------------------------------|
| *`access`* __[RemoteClusterAccess](#remoteclusteraccess)__ | Access is the name of the API Key. It is automatically generated if not set or empty. |
### RemoteClusterAccess
RemoteClusterAccess models the API key specification as documented in [https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html)
- [RemoteClusterAPIKey](#remoteclusterapikey)
| Field | Description |
|-------------------------------------------------|-------------|
| *`search`* __[Search](#search)__ | |
| *`replication`* __[Replication](#replication)__ | |
### RemoteClusterServer
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|-------------------------|-------------|
| *`enabled`* __boolean__ | |
### Replication
- [RemoteClusterAccess](#remoteclusteraccess)
| Field | Description |
|----------------------------|-------------|
| *`names`* __string array__ | |
### RoleSource
RoleSource references roles to create in the Elasticsearch cluster.
- [Auth](#auth)
| Field | Description |
|---------------------------|---------------------------------------|
| *`secretName`* __string__ | SecretName is the name of the secret. |
### Search
- [RemoteClusterAccess](#remoteclusteraccess)
| Field | Description |
|--------------------------------------------------------|-------------|
| *`names`* __string array__ | |
| *`field_security`* __[FieldSecurity](#fieldsecurity)__ | |
| *`query`* __[Config](#config)__ | |
| *`allow_restricted_indices`* __boolean__ | |
### SelfSignedTransportCertificates
SelfSignedTransportCertificates holds configuration for the self-signed certificates generated by the operator.
- [TransportTLSOptions](#transporttlsoptions)
| Field | Description |
|--------------------------|------------------------------------------------------------------------------------------|
| *`disabled`* __boolean__ | Disabled indicates that provisioning of the self-signed certificates should be disabled. |
### TransportConfig
TransportConfig holds the transport layer settings for Elasticsearch.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|---------------------------------------------------------|----------------------------------------------------------------------------|
| *`service`* __[ServiceTemplate](#servicetemplate)__ | Service defines the template for the associated Kubernetes Service object. |
| *`tls`* __[TransportTLSOptions](#transporttlsoptions)__ | TLS defines options for configuring TLS on the transport layer. |
### TransportTLSOptions
- [TransportConfig](#transportconfig)
| Field | Description |
|----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`otherNameSuffix`* __string__ | OtherNameSuffix when defined will be prefixed with the Pod name and used as the common name,and the first DNSName, as well as an OtherName required by Elasticsearch in the Subject Alternative Nameextension of each Elasticsearch node's transport TLS certificate.Example: if set to "node.cluster.local", the generated certificate will have its otherName set to ".node.cluster.local". |
| *`subjectAltNames`* __[SubjectAlternativeName](#subjectalternativename) array__ | SubjectAlternativeNames is a list of SANs to include in the generated node transport TLS certificates. |
| *`certificate`* __[SecretRef](#secretref)__ | Certificate is a reference to a Kubernetes secret that contains the CA certificateand private key for generating node certificates.The referenced secret should contain the following:- `ca.crt`: The CA certificate in PEM format.- `ca.key`: The private key for the CA certificate in PEM format. |
| *`certificateAuthorities`* __[ConfigMapRef](#configmapref)__ | CertificateAuthorities is a reference to a config map that contains one or more x509 certificates fortrusted authorities in PEM format. The certificates need to be in a file called `ca.crt`. |
| *`selfSignedCertificates`* __[SelfSignedTransportCertificates](#selfsignedtransportcertificates)__ | SelfSignedCertificates allows configuring the self-signed certificate generated by the operator. |
### UpdateStrategy
UpdateStrategy specifies how updates to the cluster should be performed.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|----------------------------------------------------|------------------------------------------------------------------------------------------------------|
| *`changeBudget`* __[ChangeBudget](#changebudget)__ | ChangeBudget defines the constraints to consider when applying changes to the Elasticsearch cluster. |
### UpgradeOperation
UpgradeOperation provides an overview of the pending or in progress changes applied by the operator to update the Elasticsearch nodes in the cluster.
**This API is in technical preview and may be changed or removed in a future release.**
- [InProgressOperations](#inprogressoperations)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| *`lastUpdatedTime`* __[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)__ | |
| *`nodes`* __[UpgradedNode](#upgradednode) array__ | Nodes that must be restarted for upgrade. |
### UpgradedNode
UpgradedNode provides details about the status of nodes which are expected to be updated.
**This API is in technical preview and may be changed or removed in a future release.**
- [UpgradeOperation](#upgradeoperation)
| Field | Description |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`name`* __string__ | Name of the Elasticsearch node that should be upgraded. |
| *`status`* __string__ | Status states if the node is either in the process of being deleted for an upgrade,or blocked by a predicate or another condition stated in the message field. |
| *`message`* __string__ | Optional message to explain why a node may not be immediately restarted for upgrade. |
| *`predicate`* __string__ | Predicate is the name of the predicate currently preventing this node from being deleted for an upgrade. |
### UpscaleOperation
UpscaleOperation provides an overview of in progress changes applied by the operator to add Elasticsearch nodes to the cluster.
**This API is in technical preview and may be changed or removed in a future release.**
- [InProgressOperations](#inprogressoperations)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
| *`lastUpdatedTime`* __[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)__ | |
| *`nodes`* __[NewNode](#newnode) array__ | Nodes expected to be added by the operator. |
### VolumeClaimDeletePolicy (string)
VolumeClaimDeletePolicy describes the delete policy for handling PersistentVolumeClaims that hold Elasticsearch data.
Inspired by [https://github.com/kubernetes/enhancements/pull/2440](https://github.com/kubernetes/enhancements/pull/2440)
- [ElasticsearchSpec](#elasticsearchspec)
## elasticsearch.k8s.elastic.co/v1beta1
Package v1beta1 contains API schema definitions for managing Elasticsearch resources.
### Resource Types
- [Elasticsearch](#elasticsearch)
### ChangeBudget
ChangeBudget defines the constraints to consider when applying changes to the Elasticsearch cluster.
- [UpdateStrategy](#updatestrategy)
| Field | Description |
|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`maxUnavailable`* __integer__ | MaxUnavailable is the maximum number of pods that can be unavailable (not ready) during the update due tocircumstances under the control of the operator. Setting a negative value will disable this restriction.Defaults to 1 if not specified. |
| *`maxSurge`* __integer__ | MaxSurge is the maximum number of new pods that can be created exceeding the original number of pods defined inthe specification. MaxSurge is only taken into consideration when scaling up. Setting a negative value willdisable the restriction. Defaults to unbounded if not specified. |
### Elasticsearch
Elasticsearch represents an Elasticsearch resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `elasticsearch.k8s.elastic.co/v1beta1` |
| *`kind`* __string__ | `Elasticsearch` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[ElasticsearchSpec](#elasticsearchspec)__ | |
| *`status`* __[ElasticsearchStatus](#elasticsearchstatus)__ | |
### ElasticsearchHealth (string)
ElasticsearchHealth is the health of the cluster as returned by the health API.
- [ElasticsearchStatus](#elasticsearchstatus)
### ElasticsearchOrchestrationPhase (string)
ElasticsearchOrchestrationPhase is the phase Elasticsearch is in from the controller point of view.
- [ElasticsearchStatus](#elasticsearchstatus)
### ElasticsearchSpec
ElasticsearchSpec holds the specification of an Elasticsearch cluster.
- [Elasticsearch](#elasticsearch)
| Field | Description |
|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of Elasticsearch. |
| *`image`* __string__ | Image is the Elasticsearch Docker image to deploy. |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds HTTP layer settings for Elasticsearch. |
| *`nodeSets`* __[NodeSet](#nodeset) array__ | NodeSets allow specifying groups of Elasticsearch nodes sharing the same configuration and Pod templates. |
| *`updateStrategy`* __[UpdateStrategy](#updatestrategy)__ | UpdateStrategy specifies how updates to the cluster should be performed. |
| *`podDisruptionBudget`* __[PodDisruptionBudgetTemplate](#poddisruptionbudgettemplate)__ | PodDisruptionBudget provides access to the default pod disruption budget for the Elasticsearch cluster.The default budget selects all cluster pods and sets `maxUnavailable` to 1. To disable, set `PodDisruptionBudget`to the empty value (`{}` in YAML). |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Elasticsearch. |
### ElasticsearchStatus
ElasticsearchStatus defines the observed state of Elasticsearch
- [Elasticsearch](#elasticsearch)
| Field | Description |
|-----------------------------------------------------------------------------------|-------------|
| *`health`* __[ElasticsearchHealth](#elasticsearchhealth)__ | |
| *`phase`* __[ElasticsearchOrchestrationPhase](#elasticsearchorchestrationphase)__ | |
### NodeSet
NodeSet is the specification for a group of Elasticsearch nodes sharing the same configuration and a Pod template.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`name`* __string__ | Name of this set of nodes. Becomes a part of the Elasticsearch node.name setting. |
| *`config`* __[Config](#config)__ | Config holds the Elasticsearch configuration. |
| *`count`* __integer__ | Count of Elasticsearch nodes to deploy. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Pods belonging to this NodeSet. |
| *`volumeClaimTemplates`* __[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#persistentvolumeclaim-v1-core) array__ | VolumeClaimTemplates is a list of persistent volume claims to be used by each Pod in this NodeSet.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. |
### UpdateStrategy
UpdateStrategy specifies how updates to the cluster should be performed.
- [ElasticsearchSpec](#elasticsearchspec)
| Field | Description |
|----------------------------------------------------|------------------------------------------------------------------------------------------------------|
| *`changeBudget`* __[ChangeBudget](#changebudget)__ | ChangeBudget defines the constraints to consider when applying changes to the Elasticsearch cluster. |
## enterprisesearch.k8s.elastic.co/v1
Package v1beta1 contains API schema definitions for managing Enterprise Search resources.
### Resource Types
- [EnterpriseSearch](#enterprisesearch)
### EnterpriseSearch
EnterpriseSearch is a Kubernetes CRD to represent Enterprise Search.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `enterprisesearch.k8s.elastic.co/v1` |
| *`kind`* __string__ | `EnterpriseSearch` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[EnterpriseSearchSpec](#enterprisesearchspec)__ | |
### EnterpriseSearchSpec
EnterpriseSearchSpec holds the specification of an Enterprise Search resource.
- [EnterpriseSearch](#enterprisesearch)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of Enterprise Search. |
| *`image`* __string__ | Image is the Enterprise Search Docker image to deploy. |
| *`count`* __integer__ | Count of Enterprise Search instances to deploy. |
| *`config`* __[Config](#config)__ | Config holds the Enterprise Search configuration. |
| *`configRef`* __[ConfigSource](#configsource)__ | ConfigRef contains a reference to an existing Kubernetes Secret holding the Enterprise Search configuration.Configuration settings are merged and have precedence over settings specified in `config`. |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for Enterprise Search resource. |
| *`elasticsearchRef`* __[ObjectSelector](#objectselector)__ | ElasticsearchRef is a reference to the Elasticsearch cluster running in the same Kubernetes cluster. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on)for the Enterprise Search pods. |
| *`revisionHistoryLimit`* __integer__ | RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment. |
| *`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. |
## enterprisesearch.k8s.elastic.co/v1beta1
Package v1beta1 contains API schema definitions for managing Enterprise Search resources.
### Resource Types
- [EnterpriseSearch](#enterprisesearch)
### EnterpriseSearch
EnterpriseSearch is a Kubernetes CRD to represent Enterprise Search.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `enterprisesearch.k8s.elastic.co/v1beta1` |
| *`kind`* __string__ | `EnterpriseSearch` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[EnterpriseSearchSpec](#enterprisesearchspec)__ | |
### EnterpriseSearchSpec
EnterpriseSearchSpec holds the specification of an Enterprise Search resource.
- [EnterpriseSearch](#enterprisesearch)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of Enterprise Search. |
| *`image`* __string__ | Image is the Enterprise Search Docker image to deploy. |
| *`count`* __integer__ | Count of Enterprise Search instances to deploy. |
| *`config`* __[Config](#config)__ | Config holds the Enterprise Search configuration. |
| *`configRef`* __[ConfigSource](#configsource)__ | ConfigRef contains a reference to an existing Kubernetes Secret holding the Enterprise Search configuration.Configuration settings are merged and have precedence over settings specified in `config`. |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for Enterprise Search resource. |
| *`elasticsearchRef`* __[ObjectSelector](#objectselector)__ | ElasticsearchRef is a reference to the Elasticsearch cluster running in the same Kubernetes cluster. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on)for the Enterprise Search pods. |
| *`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. |
## kibana.k8s.elastic.co/v1
Package v1 contains API schema definitions for managing Kibana resources.
### Resource Types
- [Kibana](#kibana)
### Kibana
Kibana represents a Kibana resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `kibana.k8s.elastic.co/v1` |
| *`kind`* __string__ | `Kibana` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[KibanaSpec](#kibanaspec)__ | |
### KibanaSpec
KibanaSpec holds the specification of a Kibana instance.
- [Kibana](#kibana)
| 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](#objectselector)__ | ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster. |
| *`enterpriseSearchRef`* __[ObjectSelector](#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)__ | Config holds the Kibana configuration. See: [https://www.elastic.co/guide/en/kibana/current/settings.html](https://www.elastic.co/guide/en/kibana/current/settings.html) |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for Kibana. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Kibana pods |
| *`revisionHistoryLimit`* __integer__ | RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | 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)__ | 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](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 differentElasticsearch monitoring clusters running in the same Kubernetes cluster. |
## kibana.k8s.elastic.co/v1beta1
Package v1beta1 contains API schema definitions for managing Kibana resources.
### Resource Types
- [Kibana](#kibana)
### Kibana
Kibana represents a Kibana resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `kibana.k8s.elastic.co/v1beta1` |
| *`kind`* __string__ | `Kibana` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[KibanaSpec](#kibanaspec)__ | |
### KibanaSpec
KibanaSpec holds the specification of a Kibana instance.
- [Kibana](#kibana)
| 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](#objectselector)__ | ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster. |
| *`config`* __[Config](#config)__ | Config holds the Kibana configuration. See: [https://www.elastic.co/guide/en/kibana/current/settings.html](https://www.elastic.co/guide/en/kibana/current/settings.html) |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for Kibana. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Kibana pods |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Kibana. |
## logstash.k8s.elastic.co/v1alpha1
Package v1alpha1 contains API Schema definitions for the logstash v1alpha1 API group
### Resource Types
- [Logstash](#logstash)
### ElasticsearchCluster
ElasticsearchCluster is a named reference to an Elasticsearch cluster which can be used in a Logstash pipeline.
- [LogstashSpec](#logstashspec)
| Field | Description |
|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`ObjectSelector`* __[ObjectSelector](#objectselector)__ | |
| *`clusterName`* __string__ | ClusterName is an alias for the cluster to be used to refer to the Elasticsearch cluster in Logstashconfiguration files, and will be used to identify "named clusters" in Logstash |
### Logstash
Logstash is the Schema for the logstashes API
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `logstash.k8s.elastic.co/v1alpha1` |
| *`kind`* __string__ | `Logstash` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[LogstashSpec](#logstashspec)__ | |
| *`status`* __[LogstashStatus](#logstashstatus)__ | |
### LogstashHealth (string)
- [LogstashStatus](#logstashstatus)
### LogstashService
- [LogstashSpec](#logstashspec)
| Field | Description |
|-----------------------------------------------------|----------------------------------------------------------------------------|
| *`name`* __string__ | |
| *`service`* __[ServiceTemplate](#servicetemplate)__ | Service defines the template for the associated Kubernetes Service object. |
| *`tls`* __[TLSOptions](#tlsoptions)__ | TLS defines options for configuring TLS for HTTP. |
### LogstashSpec
LogstashSpec defines the desired state of Logstash
- [Logstash](#logstash)
| 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](#elasticsearchcluster) array__ | ElasticsearchRefs are references to Elasticsearch clusters running in the same Kubernetes cluster. |
| *`config`* __[Config](#config)__ | Config holds the Logstash configuration. At most one of [`Config`, `ConfigRef`] can be specified. |
| *`configRef`* __[ConfigSource](#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](#config) array__ | Pipelines holds the Logstash Pipelines. At most one of [`Pipelines`, `PipelinesRef`] can be specified. |
| *`pipelinesRef`* __[ConfigSource](#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](#logstashservice) array__ | Services contains details of services that Logstash should expose - similar to the HTTP layer configuration for therest of the stack, but also applicable for more use cases than the metrics API, as logstash may need tobe opened up for other services: Beats, TCP, UDP, etc, inputs. |
| *`monitoring`* __[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 differentElasticsearch monitoring clusters running in the same Kubernetes cluster. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | 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](#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 ofeach 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#statefulsetupdatestrategy-v1-apps)__ | UpdateStrategy is a StatefulSetUpdateStrategy. The default type is "RollingUpdate". |
| *`volumeClaimTemplates`* __[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#persistentvolumeclaim-v1-core) 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
LogstashStatus defines the observed state of Logstash
- [Logstash](#logstash)
| Field | Description |
|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of the stack resource currently running. During version upgrades, multiple versions may runin parallel: this value specifies the lowest version currently running. |
| *`expectedNodes`* __integer__ | |
| *`availableNodes`* __integer__ | |
| *`health`* __[LogstashHealth](#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 Logstashcontroller has not yet processed the changes contained in the Logstash specification. |
| *`selector`* __string__ | |
## maps.k8s.elastic.co/v1alpha1
Package v1alpha1 contains API schema definitions for managing Elastic Maps Server resources.
### Resource Types
- [ElasticMapsServer](#elasticmapsserver)
- [ElasticMapsServerList](#elasticmapsserverlist)
### ElasticMapsServer
ElasticMapsServer represents an Elastic Map Server resource in a Kubernetes cluster.
- [ElasticMapsServerList](#elasticmapsserverlist)
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `maps.k8s.elastic.co/v1alpha1` |
| *`kind`* __string__ | `ElasticMapsServer` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[MapsSpec](#mapsspec)__ | |
### ElasticMapsServerList
ElasticMapsServerList contains a list of ElasticMapsServer
| Field | Description |
|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `maps.k8s.elastic.co/v1alpha1` |
| *`kind`* __string__ | `ElasticMapsServerList` |
| *`metadata`* __[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#listmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`items`* __[ElasticMapsServer](#elasticmapsserver) array__ | |
### MapsSpec
MapsSpec holds the specification of an Elastic Maps Server instance.
- [ElasticMapsServer](#elasticmapsserver)
| Field | Description |
|-------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *`version`* __string__ | Version of Elastic Maps Server. |
| *`image`* __string__ | Image is the Elastic Maps Server Docker image to deploy. |
| *`count`* __integer__ | Count of Elastic Maps Server instances to deploy. |
| *`elasticsearchRef`* __[ObjectSelector](#objectselector)__ | ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster. |
| *`config`* __[Config](#config)__ | Config holds the ElasticMapsServer configuration. See: [https://www.elastic.co/guide/en/kibana/current/maps-connect-to-ems.html#elastic-maps-server-configuration](https://www.elastic.co/guide/en/kibana/current/maps-connect-to-ems.html#elastic-maps-server-configuration) |
| *`configRef`* __[ConfigSource](#configsource)__ | ConfigRef contains a reference to an existing Kubernetes Secret holding the Elastic Maps Server configuration.Configuration settings are merged and have precedence over settings specified in `config`. |
| *`http`* __[HTTPConfig](#httpconfig)__ | HTTP holds the HTTP layer configuration for Elastic Maps Server. |
| *`podTemplate`* __[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#podtemplatespec-v1-core)__ | PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Elastic Maps Server pods |
| *`revisionHistoryLimit`* __integer__ | RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment. |
| *`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. |
## stackconfigpolicy.k8s.elastic.co/v1alpha1
Package v1alpha1 contains API schema definitions for managing StackConfigPolicy resources.
### Resource Types
- [StackConfigPolicy](#stackconfigpolicy)
### ElasticsearchConfigPolicySpec
- [StackConfigPolicySpec](#stackconfigpolicyspec)
| Field | Description |
|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| *`clusterSettings`* __[Config](#config)__ | ClusterSettings holds the Elasticsearch cluster settings (/_cluster/settings) |
| *`snapshotRepositories`* __[Config](#config)__ | SnapshotRepositories holds the Snapshot Repositories settings (/_snapshot) |
| *`snapshotLifecyclePolicies`* __[Config](#config)__ | SnapshotLifecyclePolicies holds the Snapshot Lifecycle Policies settings (/_slm/policy) |
| *`securityRoleMappings`* __[Config](#config)__ | SecurityRoleMappings holds the Role Mappings settings (/_security/role_mapping) |
| *`indexLifecyclePolicies`* __[Config](#config)__ | IndexLifecyclePolicies holds the Index Lifecycle policies settings (/_ilm/policy) |
| *`ingestPipelines`* __[Config](#config)__ | IngestPipelines holds the Ingest Pipelines settings (/_ingest/pipeline) |
| *`indexTemplates`* __[IndexTemplates](#indextemplates)__ | IndexTemplates holds the Index and Component Templates settings |
| *`config`* __[Config](#config)__ | Config holds the settings that go into elasticsearch.yml. |
| *`secretMounts`* __[SecretMount](#secretmount) array__ | SecretMounts are additional Secrets that need to be mounted into the Elasticsearch pods. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings are additional Secrets that contain data to be configured to Elasticsearch's keystore. |
### IndexTemplates
- [ElasticsearchConfigPolicySpec](#elasticsearchconfigpolicyspec)
| Field | Description |
|----------------------------------------------------|----------------------------------------------------------------------------------|
| *`componentTemplates`* __[Config](#config)__ | ComponentTemplates holds the Component Templates settings (/_component_template) |
| *`composableIndexTemplates`* __[Config](#config)__ | ComposableIndexTemplates holds the Index Templates settings (/_index_template) |
### KibanaConfigPolicySpec
- [StackConfigPolicySpec](#stackconfigpolicyspec)
| Field | Description |
|------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| *`config`* __[Config](#config)__ | Config holds the settings that go into kibana.yml. |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | SecureSettings are additional Secrets that contain data to be configured to Kibana's keystore. |
### SecretMount
SecretMount contains information about additional secrets to be mounted to the elasticsearch pods
- [ElasticsearchConfigPolicySpec](#elasticsearchconfigpolicyspec)
| Field | Description |
|---------------------------|--------------------------------------------------------------------------------------------------|
| *`secretName`* __string__ | SecretName denotes the name of the secret that needs to be mounted to the elasticsearch pod |
| *`mountPath`* __string__ | MountPath denotes the path to which the secret should be mounted to inside the elasticsearch pod |
### StackConfigPolicy
StackConfigPolicy represents a StackConfigPolicy resource in a Kubernetes cluster.
| Field | Description |
|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| *`apiVersion`* __string__ | `stackconfigpolicy.k8s.elastic.co/v1alpha1` |
| *`kind`* __string__ | `StackConfigPolicy` |
| *`metadata`* __[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)__ | Refer to Kubernetes API documentation for fields of `metadata`. |
| *`spec`* __[StackConfigPolicySpec](#stackconfigpolicyspec)__ | |
### StackConfigPolicySpec
- [StackConfigPolicy](#stackconfigpolicy)
| Field | Description |
|--------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| *`resourceSelector`* __[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#labelselector-v1-meta)__ | |
| *`secureSettings`* __[SecretSource](#secretsource) array__ | Deprecated: SecureSettings only applies to Elasticsearch and is deprecated. It must be set per application instead. |
| *`elasticsearch`* __[ElasticsearchConfigPolicySpec](#elasticsearchconfigpolicyspec)__ | |
| *`kibana`* __[KibanaConfigPolicySpec](#kibanaconfigpolicyspec)__ | |