common.k8s.elastic.co/v1
editcommon.k8s.elastic.co/v1
editPackage v1 contains API schema definitions for common types used by all resources.
Config
editConfig represents untyped YAML configuration.
ConfigMapRef
editConfigMapRef is a reference to a config map that exists in the same namespace as the referring resource.
Field | Description |
---|---|
|
ConfigSource
editConfigSource references configuration settings.
Field | Description |
---|---|
|
SecretName is the name of the secret. |
HTTPConfig
editHTTPConfig holds the HTTP layer configuration for resources.
Field | Description |
---|---|
|
Service defines the template for the associated Kubernetes Service object. |
|
TLS defines options for configuring TLS for HTTP. |
KeyToPath
editKeyToPath defines how to map a key in a Secret object to a filesystem path.
Field | Description |
---|---|
|
Key is the key contained in the secret. |
|
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
editLocalObjectSelector defines a reference to a Kubernetes object corresponding to an Elastic resource managed by the operator
Field | Description |
---|---|
|
Namespace of the Kubernetes object. If empty, defaults to the current namespace. |
|
Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK. |
|
ServiceName is the name of an existing Kubernetes service which is used to make requests to the referenced object. It has to be in the same namespace as the referenced resource. If left empty, the default HTTP service of the referenced resource is used. |
LogsMonitoring
editLogsMonitoring holds a list of Elasticsearch clusters which receive logs data from associated resources.
Field | Description |
---|---|
|
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
editMetricsMonitoring holds a list of Elasticsearch clusters which receive monitoring data from associated resources.
Field | Description |
---|---|
|
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
editMonitoring holds references to both the metrics, and logs Elasticsearch clusters for configuring stack monitoring.
Field | Description |
---|---|
|
Metrics holds references to Elasticsearch clusters which receive monitoring data from this resource. |
|
Logs holds references to Elasticsearch clusters which receive log data from an associated resource. |
ObjectSelector
editObjectSelector 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.
Field | Description |
---|---|
|
Namespace of the Kubernetes object. If empty, defaults to the current namespace. |
|
Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK. |
|
ServiceName is the name of an existing Kubernetes service which is used to make requests to the referenced object. It has to be in the same namespace as the referenced resource. If left empty, the default HTTP service of the referenced resource is used. |
|
SecretName is the name of an existing Kubernetes secret that contains connection information for associating an
Elastic resource not managed by the operator. The referenced secret must contain the following:
- |
PodDisruptionBudgetTemplate
editPodDisruptionBudgetTemplate defines the template for creating a PodDisruptionBudget.
Field | Description |
---|---|
|
Refer to Kubernetes API documentation for fields of |
Spec is the specification of the PDB. |
SecretRef
editSecretRef is a reference to a secret that exists in the same namespace.
Field | Description |
---|---|
|
SecretName is the name of the secret. |
SecretSource
editSecretSource defines a data source based on a Kubernetes Secret.
Field | Description |
---|---|
|
SecretName is the name of the secret. |
|
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
editSelfSignedCertificate holds configuration for the self-signed certificate generated by the operator.
Field | Description |
---|---|
|
SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate. |
|
Disabled indicates that the provisioning of the self-signed certifcate should be disabled. |
ServiceTemplate
editServiceTemplate defines the template for a Kubernetes Service.
Field | Description |
---|---|
|
Refer to Kubernetes API documentation for fields of |
|
Spec is the specification of the service. |
SubjectAlternativeName
editSubjectAlternativeName represents a SAN entry in a x509 certificate.
Field | Description |
---|---|
|
DNS is the DNS name of the subject. |
|
IP is the IP address of the subject. |
TLSOptions
editTLSOptions holds TLS configuration options.
Field | Description |
---|---|
|
SelfSignedCertificate allows configuring the self-signed certificate generated by the operator. |
|
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:
|