2022-08-30 12:29:05 +00:00
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-07-27 07:50:17 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
2022-08-30 12:29:05 +00:00
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
2024-07-27 07:50:17 +00:00
app.kubernetes.io/version : '2.13.0'
2022-08-30 12:29:05 +00:00
name : agents.agent.k8s.elastic.co
spec :
group : agent.k8s.elastic.co
names :
categories :
- elastic
kind : Agent
listKind : AgentList
plural : agents
shortNames :
- agent
singular : agent
scope : Namespaced
versions :
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : available
type : integer
- description : Expected nodes
jsonPath : .status.expectedNodes
name : expected
type : integer
- description : Agent version
jsonPath : .status.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1alpha1
schema :
openAPIV3Schema :
description : Agent is the Schema for the Agents API.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : AgentSpec defines the desired state of the Agent
properties :
config :
description : Config holds the Agent configuration. At most one of [`Config`, `ConfigRef`] can be specified.
type : object
x-kubernetes-preserve-unknown-fields : true
configRef :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
daemonSet :
2024-07-27 07:50:17 +00:00
description : |-
DaemonSet specifies the Agent should be deployed as a DaemonSet, and allows providing its spec.
Cannot be used along with `deployment` or `statefulSet`.
2022-08-30 12:29:05 +00:00
properties :
podTemplate :
description : PodTemplateSpec describes the data a pod should have when created from a template
type : object
x-kubernetes-preserve-unknown-fields : true
updateStrategy :
description : DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
properties :
rollingUpdate :
2024-07-27 07:50:17 +00:00
description : |-
Rolling update config params. Present only if type = "RollingUpdate".
---
TODO : Update this to follow our convention for oneOf, whatever we decide it
to be. Same as Deployment `strategy.rollingUpdate`.
See https://github.com/kubernetes/kubernetes/issues/35345
2022-08-30 12:29:05 +00:00
properties :
maxSurge :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of nodes with an existing available DaemonSet pod that
can have an updated DaemonSet pod during during an update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex : 10 %).
This can not be 0 if MaxUnavailable is 0.
Absolute number is calculated from percentage by rounding up to a minimum of 1.
Default value is 0.
Example : when this is set to 30%, at most 30% of the total number of nodes
that should be running the daemon pod (i.e. status.desiredNumberScheduled)
can have their a new pod created before the old pod is marked as deleted.
The update starts by launching new pods on 30% of nodes. Once an updated
pod is available (Ready for at least minReadySeconds) the old DaemonSet pod
on that node is marked deleted. If the old pod becomes unavailable for any
reason (Ready transitions to false, is evicted, or is drained) an updated
pod is immediatedly created on that node without considering surge limits.
Allowing surge implies the possibility that the resources consumed by the
daemonset on any given node can double if the readiness check fails, and
so resource intensive daemonsets should take into account that they may
cause evictions during disruption.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
maxUnavailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of DaemonSet pods that can be unavailable during the
update. Value can be an absolute number (ex : 5 ) or a percentage of total
number of DaemonSet pods at the start of the update (ex : 10 %). Absolute
number is calculated from percentage by rounding up.
This cannot be 0 if MaxSurge is 0
Default value is 1.
Example : when this is set to 30%, at most 30% of the total number of nodes
that should be running the daemon pod (i.e. status.desiredNumberScheduled)
can have their pods stopped for an update at any given time. The update
starts by stopping at most 30% of those DaemonSet pods and then brings
up new DaemonSet pods in their place. Once the new pods are available,
it then proceeds onto other DaemonSet pods, thus ensuring that at least
70 % of original number of DaemonSet pods are available at all times during
the update.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
type : object
type :
description : Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
type : string
type : object
type : object
deployment :
2024-07-27 07:50:17 +00:00
description : |-
Deployment specifies the Agent should be deployed as a Deployment, and allows providing its spec.
Cannot be used along with `daemonSet` or `statefulSet`.
2022-08-30 12:29:05 +00:00
properties :
podTemplate :
description : PodTemplateSpec describes the data a pod should have when created from a template
type : object
x-kubernetes-preserve-unknown-fields : true
replicas :
format : int32
type : integer
strategy :
description : DeploymentStrategy describes how to replace existing pods with new ones.
properties :
rollingUpdate :
2024-07-27 07:50:17 +00:00
description : |-
Rolling update config params. Present only if DeploymentStrategyType =
RollingUpdate.
---
TODO : Update this to follow our convention for oneOf, whatever we decide it
to be.
2022-08-30 12:29:05 +00:00
properties :
maxSurge :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of pods that can be scheduled above the desired number of
pods.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex : 10 %).
This can not be 0 if MaxUnavailable is 0.
Absolute number is calculated from percentage by rounding up.
Defaults to 25%.
Example : when this is set to 30%, the new ReplicaSet can be scaled up immediately when
the rolling update starts, such that the total number of old and new pods do not exceed
130 % of desired pods. Once old pods have been killed,
new ReplicaSet can be scaled up further, ensuring that total number of pods running
at any time during the update is at most 130% of desired pods.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
maxUnavailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of pods that can be unavailable during the update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex : 10 %).
Absolute number is calculated from percentage by rounding down.
This can not be 0 if MaxSurge is 0.
Defaults to 25%.
Example : when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods
immediately when the rolling update starts. Once new pods are ready, old ReplicaSet
can be scaled down further, followed by scaling up the new ReplicaSet, ensuring
that the total number of pods available at all times during the update is at
least 70% of desired pods.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
type : object
type :
description : Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
type : string
type : object
type : object
elasticsearchRefs :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
outputName :
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : array
fleetServerEnabled :
description : FleetServerEnabled determines whether this Agent will launch Fleet Server. Don't set unless `mode` is set to `fleet`.
type : boolean
fleetServerRef :
2024-07-27 07:50:17 +00:00
description : |-
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`.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
http :
description : HTTP holds the HTTP layer configuration for the Agent in Fleet mode with Fleet Server enabled.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Agent Docker image to deploy. Version has to match the Agent in the image.
type : string
kibanaRef :
2024-07-27 07:50:17 +00:00
description : |-
KibanaRef is a reference to Kibana where Fleet should be set up and this Agent should be enrolled. Don't set
unless `mode` is set to `fleet`.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
mode :
2024-07-27 07:50:17 +00:00
description : |-
Mode specifies the source of configuration for the Agent. The configuration can be specified locally through
`config` or `configRef` (`standalone` mode), or come from Fleet during runtime (`fleet` mode).
Defaults to `standalone` mode.
2022-08-30 12:29:05 +00:00
enum :
- standalone
- fleet
type : string
2022-09-23 13:16:22 +00:00
policyID :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-09-23 13:16:22 +00:00
type : string
revisionHistoryLimit :
2024-07-27 07:50:17 +00:00
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying DaemonSet or Deployment or StatefulSet.
2022-09-23 13:16:22 +00:00
format : int32
type : integer
2022-08-30 12:29:05 +00:00
secureSettings :
2024-07-27 07:50:17 +00:00
description : |-
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 of
each SecureSetting.
2022-08-30 12:29:05 +00:00
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
2024-07-27 07:50:17 +00:00
statefulSet :
description : |-
StatefulSet specifies the Agent should be deployed as a StatefulSet, and allows providing its spec.
Cannot be used along with `daemonSet` or `deployment`.
properties :
podManagementPolicy :
default : Parallel
description : |-
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 scale
without waiting, and on scale down will delete all pods at once.
The alternative policy is `OrderedReady`, the default for vanilla kubernetes
StatefulSets, 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 before
continuing. When scaling down, the pods are removed in the opposite order.
enum :
- OrderedReady
- Parallel
type : string
podTemplate :
description : PodTemplateSpec describes the data a pod should have when created from a template
type : object
x-kubernetes-preserve-unknown-fields : true
replicas :
format : int32
type : integer
serviceName :
type : string
volumeClaimTemplates :
description : |-
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.
items :
description : PersistentVolumeClaim is a user's request for and claim to a persistent volume
properties :
apiVersion :
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type : string
kind :
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type : string
metadata :
description : |-
Standard object's metadata.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : |-
spec defines the desired characteristics of a volume requested by a pod author.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
properties :
accessModes :
description : |-
accessModes contains the desired access modes the volume should have.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
items :
type : string
type : array
dataSource :
description : |-
dataSource field can be used to specify either :
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
properties :
apiGroup :
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
required :
- kind
- name
type : object
x-kubernetes-map-type : atomic
dataSourceRef :
description : |-
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef :
* While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
properties :
apiGroup :
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
namespace :
description : |-
Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type : string
required :
- kind
- name
type : object
resources :
description : |-
resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
properties :
limits :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : |-
Limits describes the maximum amount of compute resources allowed.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type : object
requests :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type : object
type : object
selector :
description : selector is a label query over volumes to consider for binding.
properties :
matchExpressions :
description : matchExpressions is a list of label selector requirements. The requirements are ANDed.
items :
description : |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
properties :
key :
description : key is the label key that the selector applies to.
type : string
operator :
description : |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
type : string
values :
description : |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
type : object
type : object
x-kubernetes-map-type : atomic
storageClassName :
description : |-
storageClassName is the name of the StorageClass required by the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
type : string
volumeAttributesClassName :
description : |-
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
type : string
volumeMode :
description : |-
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
type : string
volumeName :
description : volumeName is the binding reference to the PersistentVolume backing this claim.
type : string
type : object
type : object
type : array
type : object
2022-08-30 12:29:05 +00:00
version :
description : Version of the Agent.
type : string
required :
- version
type : object
status :
description : AgentStatus defines the observed state of the Agent
properties :
availableNodes :
format : int32
type : integer
elasticsearchAssociationsStatus :
additionalProperties :
description : AssociationStatus is the status of an association resource.
type : string
2024-07-27 07:50:17 +00:00
description : |-
AssociationStatusMap is the map of association's namespaced name string to its AssociationStatus. For resources that
have a single Association of a given type (for ex. single ES reference), this map contains a single entry.
2022-08-30 12:29:05 +00:00
type : object
expectedNodes :
format : int32
type : integer
fleetServerAssociationStatus :
description : AssociationStatus is the status of an association resource.
type : string
health :
type : string
kibanaAssociationStatus :
description : AssociationStatus is the status of an association resource.
type : string
observedGeneration :
2024-07-27 07:50:17 +00:00
description : |-
ObservedGeneration is the most recent generation observed for this Elastic Agent.
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 Elastic
Agent controller has not yet processed the changes contained in the Elastic Agent specification.
2022-08-30 12:29:05 +00:00
format : int64
type : integer
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : true
subresources :
status : {}
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-07-27 07:50:17 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
2022-08-30 12:29:05 +00:00
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
2024-07-27 07:50:17 +00:00
app.kubernetes.io/version : '2.13.0'
2022-08-30 12:29:05 +00:00
name : apmservers.apm.k8s.elastic.co
spec :
group : apm.k8s.elastic.co
names :
categories :
- elastic
kind : ApmServer
listKind : ApmServerList
plural : apmservers
shortNames :
- apm
singular : apmserver
scope : Namespaced
versions :
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : APM version
jsonPath : .status.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1
schema :
openAPIV3Schema :
description : ApmServer represents an APM Server resource in a Kubernetes cluster.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : ApmServerSpec holds the specification of an APM Server.
properties :
config :
description: 'Config holds the APM Server configuration. See : https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html'
type : object
x-kubernetes-preserve-unknown-fields : true
count :
description : Count of APM Server instances to deploy.
format : int32
type : integer
elasticsearchRef :
description : ElasticsearchRef is a reference to the output Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
http :
description : HTTP holds the HTTP layer configuration for the APM Server resource.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the APM Server Docker image to deploy.
type : string
kibanaRef :
2024-07-27 07:50:17 +00:00
description : |-
KibanaRef is a reference to a Kibana instance running in the same Kubernetes cluster.
It allows APM agent central configuration management in Kibana.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
podTemplate :
description : PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the APM Server pods.
type : object
x-kubernetes-preserve-unknown-fields : true
2022-09-23 13:16:22 +00:00
revisionHistoryLimit :
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment.
format : int32
type : integer
2022-08-30 12:29:05 +00:00
secureSettings :
description : SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for APM Server.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
version :
description : Version of the APM Server.
type : string
required :
- version
type : object
status :
description : ApmServerStatus defines the observed state of ApmServer
properties :
availableNodes :
description : AvailableNodes is the number of available replicas in the deployment.
format : int32
type : integer
count :
description : Count corresponds to Scale.Status.Replicas, which is the actual number of observed instances of the scaled object.
format : int32
type : integer
elasticsearchAssociationStatus :
description : ElasticsearchAssociationStatus is the status of any auto-linking to Elasticsearch clusters.
type : string
health :
description : Health of the deployment.
type : string
kibanaAssociationStatus :
description : KibanaAssociationStatus is the status of any auto-linking to Kibana.
type : string
2022-09-23 13:16:22 +00:00
observedGeneration :
2024-07-27 07:50:17 +00:00
description : |-
ObservedGeneration represents the .metadata.generation that the status is based upon.
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 APM Server
controller has not yet processed the changes contained in the APM Server specification.
2022-09-23 13:16:22 +00:00
format : int64
type : integer
2022-08-30 12:29:05 +00:00
secretTokenSecret :
description : SecretTokenSecretName is the name of the Secret that contains the secret token
type : string
selector :
description : Selector is the label selector used to find all pods.
type : string
service :
description : ExternalService is the name of the service the agents should connect to.
type : string
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : true
subresources :
scale :
labelSelectorPath : .status.selector
specReplicasPath : .spec.count
statusReplicasPath : .status.count
status : {}
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : APM version
jsonPath : .spec.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1beta1
schema :
openAPIV3Schema :
description : ApmServer represents an APM Server resource in a Kubernetes cluster.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : ApmServerSpec holds the specification of an APM Server.
properties :
config :
description: 'Config holds the APM Server configuration. See : https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html'
type : object
x-kubernetes-preserve-unknown-fields : true
count :
description : Count of APM Server instances to deploy.
format : int32
type : integer
elasticsearchRef :
description : ElasticsearchRef is a reference to the output Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of the Kubernetes object.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
required :
- name
type : object
http :
description : HTTP holds the HTTP layer configuration for the APM Server resource.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the APM Server Docker image to deploy.
type : string
podTemplate :
description : PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the APM Server pods.
type : object
x-kubernetes-preserve-unknown-fields : true
secureSettings :
description : SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for APM Server.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
version :
description : Version of the APM Server.
type : string
type : object
status :
description : ApmServerStatus defines the observed state of ApmServer
properties :
associationStatus :
description : Association is the status of any auto-linking to Elasticsearch clusters.
type : string
availableNodes :
format : int32
type : integer
health :
description : ApmServerHealth expresses the status of the Apm Server instances.
type : string
secretTokenSecret :
description : SecretTokenSecretName is the name of the Secret that contains the secret token
type : string
service :
description : ExternalService is the name of the service the agents should connect to.
type : string
type : object
type : object
served : true
storage : false
subresources :
status : {}
- name : v1alpha1
schema :
openAPIV3Schema :
description : to not break compatibility when upgrading from previous versions of the CRD
type : object
served : false
storage : false
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-07-27 07:50:17 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
2022-08-30 12:29:05 +00:00
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
2024-07-27 07:50:17 +00:00
app.kubernetes.io/version : '2.13.0'
2022-08-30 12:29:05 +00:00
name : beats.beat.k8s.elastic.co
spec :
group : beat.k8s.elastic.co
names :
categories :
- elastic
kind : Beat
listKind : BeatList
plural : beats
shortNames :
- beat
singular : beat
scope : Namespaced
versions :
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : available
type : integer
- description : Expected nodes
jsonPath : .status.expectedNodes
name : expected
type : integer
- description : Beat type
jsonPath : .spec.type
name : type
type : string
- description : Beat version
jsonPath : .status.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1beta1
schema :
openAPIV3Schema :
description : Beat is the Schema for the Beats API.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : BeatSpec defines the desired state of a Beat.
properties :
config :
description : Config holds the Beat configuration. At most one of [`Config`, `ConfigRef`] can be specified.
type : object
x-kubernetes-preserve-unknown-fields : true
configRef :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
daemonSet :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
podTemplate :
description : PodTemplateSpec describes the data a pod should have when created from a template
type : object
x-kubernetes-preserve-unknown-fields : true
updateStrategy :
description : DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
properties :
rollingUpdate :
2024-07-27 07:50:17 +00:00
description : |-
Rolling update config params. Present only if type = "RollingUpdate".
---
TODO : Update this to follow our convention for oneOf, whatever we decide it
to be. Same as Deployment `strategy.rollingUpdate`.
See https://github.com/kubernetes/kubernetes/issues/35345
2022-08-30 12:29:05 +00:00
properties :
maxSurge :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of nodes with an existing available DaemonSet pod that
can have an updated DaemonSet pod during during an update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex : 10 %).
This can not be 0 if MaxUnavailable is 0.
Absolute number is calculated from percentage by rounding up to a minimum of 1.
Default value is 0.
Example : when this is set to 30%, at most 30% of the total number of nodes
that should be running the daemon pod (i.e. status.desiredNumberScheduled)
can have their a new pod created before the old pod is marked as deleted.
The update starts by launching new pods on 30% of nodes. Once an updated
pod is available (Ready for at least minReadySeconds) the old DaemonSet pod
on that node is marked deleted. If the old pod becomes unavailable for any
reason (Ready transitions to false, is evicted, or is drained) an updated
pod is immediatedly created on that node without considering surge limits.
Allowing surge implies the possibility that the resources consumed by the
daemonset on any given node can double if the readiness check fails, and
so resource intensive daemonsets should take into account that they may
cause evictions during disruption.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
maxUnavailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of DaemonSet pods that can be unavailable during the
update. Value can be an absolute number (ex : 5 ) or a percentage of total
number of DaemonSet pods at the start of the update (ex : 10 %). Absolute
number is calculated from percentage by rounding up.
This cannot be 0 if MaxSurge is 0
Default value is 1.
Example : when this is set to 30%, at most 30% of the total number of nodes
that should be running the daemon pod (i.e. status.desiredNumberScheduled)
can have their pods stopped for an update at any given time. The update
starts by stopping at most 30% of those DaemonSet pods and then brings
up new DaemonSet pods in their place. Once the new pods are available,
it then proceeds onto other DaemonSet pods, thus ensuring that at least
70 % of original number of DaemonSet pods are available at all times during
the update.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
type : object
type :
description : Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
type : string
type : object
type : object
deployment :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
podTemplate :
description : PodTemplateSpec describes the data a pod should have when created from a template
type : object
x-kubernetes-preserve-unknown-fields : true
replicas :
format : int32
type : integer
strategy :
description : DeploymentStrategy describes how to replace existing pods with new ones.
properties :
rollingUpdate :
2024-07-27 07:50:17 +00:00
description : |-
Rolling update config params. Present only if DeploymentStrategyType =
RollingUpdate.
---
TODO : Update this to follow our convention for oneOf, whatever we decide it
to be.
2022-08-30 12:29:05 +00:00
properties :
maxSurge :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of pods that can be scheduled above the desired number of
pods.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex : 10 %).
This can not be 0 if MaxUnavailable is 0.
Absolute number is calculated from percentage by rounding up.
Defaults to 25%.
Example : when this is set to 30%, the new ReplicaSet can be scaled up immediately when
the rolling update starts, such that the total number of old and new pods do not exceed
130 % of desired pods. Once old pods have been killed,
new ReplicaSet can be scaled up further, ensuring that total number of pods running
at any time during the update is at most 130% of desired pods.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
maxUnavailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
The maximum number of pods that can be unavailable during the update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex : 10 %).
Absolute number is calculated from percentage by rounding down.
This can not be 0 if MaxSurge is 0.
Defaults to 25%.
Example : when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods
immediately when the rolling update starts. Once new pods are ready, old ReplicaSet
can be scaled down further, followed by scaling up the new ReplicaSet, ensuring
that the total number of pods available at all times during the update is at
least 70% of desired pods.
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
type : object
type :
description : Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
type : string
type : object
type : object
elasticsearchRef :
description : ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
image :
description : Image is the Beat Docker image to deploy. Version and Type have to match the Beat in the image.
type : string
kibanaRef :
2024-07-27 07:50:17 +00:00
description : |-
KibanaRef is a reference to a Kibana instance running in the same Kubernetes cluster.
It allows automatic setup of dashboards and visualizations.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
2024-07-27 07:50:17 +00:00
monitoring :
description : |-
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 an
Elasticsearch monitoring cluster running in the same Kubernetes cluster.
properties :
logs :
description : Logs holds references to Elasticsearch clusters which receive log data from an associated resource.
properties :
elasticsearchRefs :
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.
items :
description : |-
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.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
description : |-
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 :
- `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.
type : string
serviceName :
description : |-
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.
type : string
type : object
type : array
type : object
metrics :
description : Metrics holds references to Elasticsearch clusters which receive monitoring data from this resource.
properties :
elasticsearchRefs :
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.
items :
description : |-
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.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
description : |-
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 :
- `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.
type : string
serviceName :
description : |-
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.
type : string
type : object
type : array
type : object
type : object
2022-09-23 13:16:22 +00:00
revisionHistoryLimit :
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying DaemonSet or Deployment.
format : int32
type : integer
2022-08-30 12:29:05 +00:00
secureSettings :
2024-07-27 07:50:17 +00:00
description : |-
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 of
each SecureSetting.
2022-08-30 12:29:05 +00:00
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type :
2024-07-27 07:50:17 +00:00
description : |-
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 appropriate
Elasticsearch roles created automatically. It also allows for dashboard setup when combined with a `KibanaRef`.
2022-08-30 12:29:05 +00:00
maxLength : 20
pattern : '[a-zA-Z0-9-]+'
type : string
version :
description : Version of the Beat.
type : string
required :
- type
- version
type : object
status :
description : BeatStatus defines the observed state of a Beat.
properties :
availableNodes :
format : int32
type : integer
elasticsearchAssociationStatus :
description : AssociationStatus is the status of an association resource.
type : string
expectedNodes :
format : int32
type : integer
health :
type : string
kibanaAssociationStatus :
description : AssociationStatus is the status of an association resource.
type : string
2024-07-27 07:50:17 +00:00
monitoringAssociationStatus :
additionalProperties :
description : AssociationStatus is the status of an association resource.
type : string
description : |-
AssociationStatusMap is the map of association's namespaced name string to its AssociationStatus. For resources that
have a single Association of a given type (for ex. single ES reference), this map contains a single entry.
type : object
2022-09-23 13:16:22 +00:00
observedGeneration :
2024-07-27 07:50:17 +00:00
description : |-
ObservedGeneration represents the .metadata.generation that the status is based upon.
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 Beats
controller has not yet processed the changes contained in the Beats specification.
2022-09-23 13:16:22 +00:00
format : int64
type : integer
2022-08-30 12:29:05 +00:00
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : true
subresources :
status : {}
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-07-27 07:50:17 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
2022-08-30 12:29:05 +00:00
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
2024-07-27 07:50:17 +00:00
app.kubernetes.io/version : '2.13.0'
2022-08-30 12:29:05 +00:00
name : elasticmapsservers.maps.k8s.elastic.co
spec :
group : maps.k8s.elastic.co
names :
categories :
- elastic
kind : ElasticMapsServer
listKind : ElasticMapsServerList
plural : elasticmapsservers
shortNames :
- ems
singular : elasticmapsserver
scope : Namespaced
versions :
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : ElasticMapsServer version
jsonPath : .status.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1alpha1
schema :
openAPIV3Schema :
description : ElasticMapsServer represents an Elastic Map Server resource in a Kubernetes cluster.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : MapsSpec holds the specification of an Elastic Maps Server instance.
properties :
config :
description: 'Config holds the ElasticMapsServer configuration. See : https://www.elastic.co/guide/en/kibana/current/maps-connect-to-ems.html#elastic-maps-server-configuration'
type : object
x-kubernetes-preserve-unknown-fields : true
configRef :
2024-07-27 07:50:17 +00:00
description : |-
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`.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
count :
description : Count of Elastic Maps Server instances to deploy.
format : int32
type : integer
elasticsearchRef :
description : ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
http :
description : HTTP holds the HTTP layer configuration for Elastic Maps Server.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Elastic Maps Server Docker image to deploy.
type : string
podTemplate :
description : PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Elastic Maps Server pods
type : object
x-kubernetes-preserve-unknown-fields : true
2022-09-23 13:16:22 +00:00
revisionHistoryLimit :
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment.
format : int32
type : integer
2022-08-30 12:29:05 +00:00
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
version :
description : Version of Elastic Maps Server.
type : string
required :
- version
type : object
status :
description : MapsStatus defines the observed state of Elastic Maps Server
properties :
associationStatus :
description : AssociationStatus is the status of an association resource.
type : string
availableNodes :
description : AvailableNodes is the number of available replicas in the deployment.
format : int32
type : integer
count :
description : Count corresponds to Scale.Status.Replicas, which is the actual number of observed instances of the scaled object.
format : int32
type : integer
health :
description : Health of the deployment.
type : string
2022-09-23 13:16:22 +00:00
observedGeneration :
2024-07-27 07:50:17 +00:00
description : |-
ObservedGeneration is the most recent generation observed for this Elastic Maps Server.
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 Elastic
Maps controller has not yet processed the changes contained in the Elastic Maps specification.
2022-09-23 13:16:22 +00:00
format : int64
type : integer
2022-08-30 12:29:05 +00:00
selector :
description : Selector is the label selector used to find all pods.
type : string
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : true
subresources :
scale :
labelSelectorPath : .status.selector
specReplicasPath : .spec.count
statusReplicasPath : .status.count
status : {}
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-07-27 07:50:17 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
2022-08-30 12:29:05 +00:00
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
2024-07-27 07:50:17 +00:00
app.kubernetes.io/version : '2.13.0'
name : elasticsearchautoscalers.autoscaling.k8s.elastic.co
2022-08-30 12:29:05 +00:00
spec :
2024-07-27 07:50:17 +00:00
group : autoscaling.k8s.elastic.co
2022-08-30 12:29:05 +00:00
names :
categories :
- elastic
2024-07-27 07:50:17 +00:00
kind : ElasticsearchAutoscaler
listKind : ElasticsearchAutoscalerList
plural : elasticsearchautoscalers
2022-08-30 12:29:05 +00:00
shortNames :
2024-07-27 07:50:17 +00:00
- esa
singular : elasticsearchautoscaler
2022-08-30 12:29:05 +00:00
scope : Namespaced
versions :
- additionalPrinterColumns :
2024-07-27 07:50:17 +00:00
- jsonPath : .spec.elasticsearchRef.name
name : Target
2022-08-30 12:29:05 +00:00
type : string
2024-07-27 07:50:17 +00:00
- jsonPath : .status.conditions[?(@.type=='Active')].status
name : Active
2022-08-30 12:29:05 +00:00
type : string
2024-07-27 07:50:17 +00:00
- jsonPath : .status.conditions[?(@.type=='Healthy')].status
name : Healthy
2022-08-30 12:29:05 +00:00
type : string
2024-07-27 07:50:17 +00:00
- jsonPath : .status.conditions[?(@.type=='Limited')].status
name : Limited
type : string
name : v1alpha1
2022-08-30 12:29:05 +00:00
schema :
openAPIV3Schema :
2024-07-27 07:50:17 +00:00
description : ElasticsearchAutoscaler represents an ElasticsearchAutoscaler resource in a Kubernetes cluster.
2022-08-30 12:29:05 +00:00
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
2024-07-27 07:50:17 +00:00
description : ElasticsearchAutoscalerSpec holds the specification of an Elasticsearch autoscaler resource.
2022-08-30 12:29:05 +00:00
properties :
2024-07-27 07:50:17 +00:00
elasticsearchRef :
description : ElasticsearchRef is a reference to an Elasticsearch cluster that exists in the same namespace.
2022-08-30 12:29:05 +00:00
properties :
2024-07-27 07:50:17 +00:00
name :
description : Name is the name of the Elasticsearch resource to scale automatically.
minLength : 1
type : string
type : object
policies :
items :
description : AutoscalingPolicySpec holds a named autoscaling policy and the associated resources limits (cpu, memory, storage).
properties :
deciders :
additionalProperties :
additionalProperties :
2022-08-30 12:29:05 +00:00
type : string
2024-07-27 07:50:17 +00:00
description : |-
DeciderSettings allow the user to tweak autoscaling deciders.
The map data structure complies with the <key,value> format expected by Elasticsearch.
type : object
description : Deciders allow the user to override default settings for autoscaling deciders.
2022-08-30 12:29:05 +00:00
type : object
2024-07-27 07:50:17 +00:00
name :
description : Name identifies the autoscaling policy in the autoscaling specification.
type : string
resources :
description : |-
AutoscalingResources model the limits, submitted by the user, for the supported resources in an autoscaling policy.
Only the node count range is mandatory. For other resources, a limit range is required only
if the Elasticsearch autoscaling capacity API returns a requirement for a given resource.
For example, the memory limit range is only required if the autoscaling API response contains a memory requirement.
If there is no limit range for a resource, and if that resource is not mandatory, then the resources in the NodeSets
managed by the autoscaling policy are left untouched.
2022-08-30 12:29:05 +00:00
properties :
2024-07-27 07:50:17 +00:00
cpu :
description : QuantityRange models a resource limit range for resources which can be expressed with resource.Quantity.
properties :
max :
anyOf :
- type : integer
- type : string
description : Max represents the upper limit for the resources managed by the autoscaler.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
min :
anyOf :
- type : integer
- type : string
description : Min represents the lower limit for the resources managed by the autoscaler.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
requestsToLimitsRatio :
anyOf :
- type : integer
- type : string
description : RequestsToLimitsRatio allows to customize Kubernetes resource Limit based on the Request.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
required :
- max
- min
type : object
memory :
description : QuantityRange models a resource limit range for resources which can be expressed with resource.Quantity.
properties :
max :
anyOf :
- type : integer
- type : string
description : Max represents the upper limit for the resources managed by the autoscaler.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
min :
anyOf :
- type : integer
- type : string
description : Min represents the lower limit for the resources managed by the autoscaler.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
requestsToLimitsRatio :
anyOf :
- type : integer
- type : string
description : RequestsToLimitsRatio allows to customize Kubernetes resource Limit based on the Request.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
required :
- max
- min
type : object
nodeCount :
description : NodeCountRange is used to model the minimum and the maximum number of nodes over all the NodeSets managed by the same autoscaling policy.
properties :
max :
description : Max represents the maximum number of nodes in a tier.
format : int32
type : integer
min :
description : Min represents the minimum number of nodes in a tier.
format : int32
type : integer
required :
- max
- min
type : object
storage :
description : QuantityRange models a resource limit range for resources which can be expressed with resource.Quantity.
properties :
max :
anyOf :
- type : integer
- type : string
description : Max represents the upper limit for the resources managed by the autoscaler.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
min :
anyOf :
- type : integer
- type : string
description : Min represents the lower limit for the resources managed by the autoscaler.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
requestsToLimitsRatio :
anyOf :
- type : integer
- type : string
description : RequestsToLimitsRatio allows to customize Kubernetes resource Limit based on the Request.
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
required :
- max
- min
type : object
required :
- nodeCount
2022-08-30 12:29:05 +00:00
type : object
2024-07-27 07:50:17 +00:00
roles :
description : An autoscaling policy must target a unique set of roles.
items :
type : string
type : array
required :
- resources
type : object
type : array
pollingPeriod :
description : PollingPeriod is the period at which to synchronize with the Elasticsearch autoscaling API.
type : string
required :
- policies
type : object
status :
properties :
conditions :
description : Conditions holds the current service state of the autoscaling controller.
items :
description : |-
Condition represents Elasticsearch resource's condition.
**This API is in technical preview and may be changed or removed in a future release.**
properties :
lastTransitionTime :
format : date-time
type : string
message :
type : string
status :
type : string
type :
description : ConditionType defines the condition of an Elasticsearch resource.
type : string
required :
- status
- type
type : object
type : array
observedGeneration :
description : ObservedGeneration is the last observed generation by the controller.
format : int64
type : integer
policies :
description : AutoscalingPolicyStatuses is used to expose state messages to user or external system.
items :
properties :
lastModificationTime :
description : LastModificationTime is the last time the resources have been updated, used by the cooldown algorithm.
format : date-time
type : string
name :
description : Name is the name of the autoscaling policy
type : string
nodeSets :
description : NodeSetNodeCount holds the number of nodes for each nodeSet.
items :
description : NodeSetNodeCount models the number of nodes expected in a given NodeSet.
properties :
name :
description : Name of the Nodeset.
type : string
nodeCount :
description : NodeCount is the number of nodes, as computed by the autoscaler, expected in this NodeSet.
format : int32
type : integer
required :
- name
- nodeCount
type : object
type : array
resources :
description : |-
ResourcesSpecification holds the resource values common to all the nodeSets managed by a same autoscaling policy.
Only the resources managed by the autoscaling controller are saved in the Status.
properties :
limits :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : ResourceList is a set of (resource name, quantity) pairs.
type : object
requests :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : ResourceList is a set of (resource name, quantity) pairs.
type : object
type : object
state :
description : PolicyStates may contain various messages regarding the current state of this autoscaling policy.
items :
properties :
messages :
items :
type : string
type : array
type :
type : string
required :
- messages
- type
type : object
type : array
required :
- name
type : object
type : array
type : object
type : object
served : true
storage : true
subresources :
status : {}
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
app.kubernetes.io/version : '2.13.0'
name : elasticsearches.elasticsearch.k8s.elastic.co
spec :
group : elasticsearch.k8s.elastic.co
names :
categories :
- elastic
kind : Elasticsearch
listKind : ElasticsearchList
plural : elasticsearches
shortNames :
- es
singular : elasticsearch
scope : Namespaced
versions :
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : Elasticsearch version
jsonPath : .status.version
name : version
type : string
- jsonPath : .status.phase
name : phase
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1
schema :
openAPIV3Schema :
description : Elasticsearch represents an Elasticsearch resource in a Kubernetes cluster.
properties :
apiVersion :
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type : string
kind :
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type : string
metadata :
type : object
spec :
description : ElasticsearchSpec holds the specification of an Elasticsearch cluster.
properties :
auth :
description : Auth contains user authentication and authorization security settings for Elasticsearch.
properties :
disableElasticUser :
description : DisableElasticUser disables the default elastic user that is created by ECK.
type : boolean
fileRealm :
description : FileRealm to propagate to the Elasticsearch cluster.
items :
description : FileRealmSource references users to create in the Elasticsearch cluster.
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
type : array
roles :
description : Roles to propagate to the Elasticsearch cluster.
items :
description : RoleSource references roles to create in the Elasticsearch cluster.
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
type : array
type : object
http :
description : HTTP holds HTTP layer settings for Elasticsearch.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
type : boolean
clusterIP :
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
type : string
clusterIPs :
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Elasticsearch Docker image to deploy.
type : string
monitoring :
2024-07-27 07:50:17 +00:00
description : |-
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.
Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one sends data to one or two different
Elasticsearch monitoring clusters running in the same Kubernetes cluster.
2022-08-30 12:29:05 +00:00
properties :
logs :
2024-07-27 07:50:17 +00:00
description : Logs holds references to Elasticsearch clusters which receive log data from an associated resource.
2022-08-30 12:29:05 +00:00
properties :
elasticsearchRefs :
2024-07-27 07:50:17 +00:00
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.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : array
type : object
metrics :
2024-07-27 07:50:17 +00:00
description : Metrics holds references to Elasticsearch clusters which receive monitoring data from this resource.
2022-08-30 12:29:05 +00:00
properties :
elasticsearchRefs :
2024-07-27 07:50:17 +00:00
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.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : array
type : object
type : object
nodeSets :
description : NodeSets allow specifying groups of Elasticsearch nodes sharing the same configuration and Pod templates.
items :
description : NodeSet is the specification for a group of Elasticsearch nodes sharing the same configuration and a Pod template.
properties :
config :
description : Config holds the Elasticsearch configuration.
type : object
x-kubernetes-preserve-unknown-fields : true
count :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
name :
description : Name of this set of nodes. Becomes a part of the Elasticsearch node.name setting.
maxLength : 23
pattern : '[a-zA-Z0-9-]+'
type : string
podTemplate :
description : PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Pods belonging to this NodeSet.
type : object
x-kubernetes-preserve-unknown-fields : true
volumeClaimTemplates :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : PersistentVolumeClaim is a user's request for and claim to a persistent volume
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
2024-07-27 07:50:17 +00:00
description : |-
Standard object's metadata.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
2024-07-27 07:50:17 +00:00
description : |-
spec defines the desired characteristics of a volume requested by a pod author.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
2022-08-30 12:29:05 +00:00
properties :
accessModes :
2024-07-27 07:50:17 +00:00
description : |-
accessModes contains the desired access modes the volume should have.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
dataSource :
2024-07-27 07:50:17 +00:00
description : |-
dataSource field can be used to specify either :
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
2022-08-30 12:29:05 +00:00
properties :
apiGroup :
2024-07-27 07:50:17 +00:00
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
2022-08-30 12:29:05 +00:00
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
required :
- kind
- name
type : object
2022-09-23 13:16:22 +00:00
x-kubernetes-map-type : atomic
2022-08-30 12:29:05 +00:00
dataSourceRef :
2024-07-27 07:50:17 +00:00
description : |-
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef :
* While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
2022-08-30 12:29:05 +00:00
properties :
apiGroup :
2024-07-27 07:50:17 +00:00
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
2022-08-30 12:29:05 +00:00
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
2024-07-27 07:50:17 +00:00
namespace :
description : |-
Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type : string
2022-08-30 12:29:05 +00:00
required :
- kind
- name
type : object
resources :
2024-07-27 07:50:17 +00:00
description : |-
resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
2022-08-30 12:29:05 +00:00
properties :
limits :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
2024-07-27 07:50:17 +00:00
description : |-
Limits describes the maximum amount of compute resources allowed.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
2022-08-30 12:29:05 +00:00
type : object
requests :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
2024-07-27 07:50:17 +00:00
description : |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
2022-08-30 12:29:05 +00:00
type : object
type : object
selector :
2022-09-23 13:16:22 +00:00
description : selector is a label query over volumes to consider for binding.
2022-08-30 12:29:05 +00:00
properties :
matchExpressions :
description : matchExpressions is a list of label selector requirements. The requirements are ANDed.
items :
2024-07-27 07:50:17 +00:00
description : |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
2022-08-30 12:29:05 +00:00
properties :
key :
description : key is the label key that the selector applies to.
type : string
operator :
2024-07-27 07:50:17 +00:00
description : |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
2022-08-30 12:29:05 +00:00
type : string
values :
2024-07-27 07:50:17 +00:00
description : |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
2022-08-30 12:29:05 +00:00
type : object
type : object
2022-09-23 13:16:22 +00:00
x-kubernetes-map-type : atomic
2022-08-30 12:29:05 +00:00
storageClassName :
2024-07-27 07:50:17 +00:00
description : |-
storageClassName is the name of the StorageClass required by the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
type : string
volumeAttributesClassName :
description : |-
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
2022-08-30 12:29:05 +00:00
type : string
volumeMode :
2024-07-27 07:50:17 +00:00
description : |-
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
2022-08-30 12:29:05 +00:00
type : string
volumeName :
2022-09-23 13:16:22 +00:00
description : volumeName is the binding reference to the PersistentVolume backing this claim.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
type : array
required :
- name
type : object
minItems : 1
type : array
podDisruptionBudget :
2024-07-27 07:50:17 +00:00
description : |-
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).
2022-08-30 12:29:05 +00:00
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the PDB.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the PDB.
properties :
maxUnavailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
An eviction is allowed if at most "maxUnavailable" pods selected by
"selector" are unavailable after the eviction, i.e. even in absence of
the evicted pod. For example, one can prevent all voluntary evictions
by specifying 0. This is a mutually exclusive setting with "minAvailable".
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
minAvailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
An eviction is allowed if at least "minAvailable" pods selected by
"selector" will still be available after the eviction, i.e. even in the
absence of the evicted pod. So for example you can prevent all voluntary
evictions by specifying "100%".
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
selector :
2024-07-27 07:50:17 +00:00
description : |-
Label query over pods whose evictions are managed by the disruption
budget.
A null selector will match no pods, while an empty ({}) selector will select
all pods within the namespace.
2022-08-30 12:29:05 +00:00
properties :
matchExpressions :
description : matchExpressions is a list of label selector requirements. The requirements are ANDed.
items :
2024-07-27 07:50:17 +00:00
description : |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
2022-08-30 12:29:05 +00:00
properties :
key :
description : key is the label key that the selector applies to.
type : string
operator :
2024-07-27 07:50:17 +00:00
description : |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
2022-08-30 12:29:05 +00:00
type : string
values :
2024-07-27 07:50:17 +00:00
description : |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
2022-08-30 12:29:05 +00:00
type : object
type : object
2022-09-23 13:16:22 +00:00
x-kubernetes-map-type : atomic
2024-07-27 07:50:17 +00:00
unhealthyPodEvictionPolicy :
description : |-
UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods
should be considered for eviction. Current implementation considers healthy pods,
as pods that have status.conditions item with type="Ready",status="True".
Valid policies are IfHealthyBudget and AlwaysAllow.
If no policy is specified, the default behavior will be used,
which corresponds to the IfHealthyBudget policy.
IfHealthyBudget policy means that running pods (status.phase="Running"),
but not yet healthy can be evicted only if the guarded application is not
disrupted (status.currentHealthy is at least equal to status.desiredHealthy).
Healthy pods will be subject to the PDB for eviction.
AlwaysAllow policy means that all running pods (status.phase="Running"),
but not yet healthy are considered disrupted and can be evicted regardless
of whether the criteria in a PDB is met. This means perspective running
pods of a disrupted application might not get a chance to become healthy.
Healthy pods will be subject to the PDB for eviction.
Additional policies may be added in the future.
Clients making eviction decisions should disallow eviction of unhealthy pods
if they encounter an unrecognized policy in this field.
This field is beta-level. The eviction API uses this field when
the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default).
type : string
2022-08-30 12:29:05 +00:00
type : object
type : object
remoteClusters :
description : RemoteClusters enables you to establish uni-directional connections to a remote Elasticsearch cluster.
items :
description : RemoteCluster declares a remote Elasticsearch cluster connection.
properties :
elasticsearchRef :
description : ElasticsearchRef is a reference to an Elasticsearch cluster running within the same k8s cluster.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
name :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
minLength : 1
type : string
required :
- name
type : object
type : array
2022-09-23 13:16:22 +00:00
revisionHistoryLimit :
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying StatefulSets.
format : int32
type : integer
2022-08-30 12:29:05 +00:00
secureSettings :
description : SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Elasticsearch.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
transport :
description : Transport holds transport layer settings for Elasticsearch.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
type : string
name :
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
type : string
nodePort :
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
format : int32
2022-08-30 12:29:05 +00:00
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS on the transport layer.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
Certificate is a reference to a Kubernetes secret that contains the CA certificate
and 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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
2024-07-27 07:50:17 +00:00
certificateAuthorities :
description : |-
CertificateAuthorities is a reference to a config map that contains one or more x509 certificates for
trusted authorities in PEM format. The certificates need to be in a file called `ca.crt`.
properties :
configMapName :
type : string
type : object
2022-08-30 12:29:05 +00:00
otherNameSuffix :
2024-07-27 07:50:17 +00:00
description : |-
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 Name
extension of each Elasticsearch node's transport TLS certificate.
Example : if set to "node.cluster.local", the generated certificate will have its otherName set to "<pod_name>.node.cluster.local".
2022-08-30 12:29:05 +00:00
type : string
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated node transport TLS certificates.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
updateStrategy :
description : UpdateStrategy specifies how updates to the cluster should be performed.
properties :
changeBudget :
description : ChangeBudget defines the constraints to consider when applying changes to the Elasticsearch cluster.
properties :
maxSurge :
2024-07-27 07:50:17 +00:00
description : |-
MaxSurge is the maximum number of new Pods that can be created exceeding the original number of Pods defined in
the specification. MaxSurge is only taken into consideration when scaling up. Setting a negative value will
disable the restriction. Defaults to unbounded if not specified.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
maxUnavailable :
2024-07-27 07:50:17 +00:00
description : |-
MaxUnavailable is the maximum number of Pods that can be unavailable (not ready) during the update due to
circumstances under the control of the operator. Setting a negative value will disable this restriction.
Defaults to 1 if not specified.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
version :
description : Version of Elasticsearch.
type : string
volumeClaimDeletePolicy :
2024-07-27 07:50:17 +00:00
description : |-
VolumeClaimDeletePolicy sets the policy for handling deletion of PersistentVolumeClaims for all NodeSets.
Possible values are DeleteOnScaledownOnly and DeleteOnScaledownAndClusterDeletion. Defaults to DeleteOnScaledownAndClusterDeletion.
2022-08-30 12:29:05 +00:00
enum :
- DeleteOnScaledownOnly
- DeleteOnScaledownAndClusterDeletion
type : string
required :
- nodeSets
- version
type : object
status :
description : ElasticsearchStatus represents the observed state of Elasticsearch.
properties :
availableNodes :
description : AvailableNodes is the number of available instances.
format : int32
type : integer
conditions :
2024-07-27 07:50:17 +00:00
description : |-
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.**
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
Condition represents Elasticsearch resource's condition.
**This API is in technical preview and may be changed or removed in a future release.**
2022-08-30 12:29:05 +00:00
properties :
lastTransitionTime :
format : date-time
type : string
message :
type : string
status :
type : string
type :
description : ConditionType defines the condition of an Elasticsearch resource.
type : string
required :
- status
- type
type : object
type : array
health :
description : ElasticsearchHealth is the health of the cluster as returned by the health API.
type : string
inProgressOperations :
2024-07-27 07:50:17 +00:00
description : |-
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.**
2022-08-30 12:29:05 +00:00
properties :
downscale :
2024-07-27 07:50:17 +00:00
description : |-
DownscaleOperation provides details about in progress downscale operations.
**This API is in technical preview and may be changed or removed in a future release.**
2022-08-30 12:29:05 +00:00
properties :
lastUpdatedTime :
format : date-time
type : string
nodes :
description : Nodes which are scheduled to be removed from the cluster.
items :
2024-07-27 07:50:17 +00:00
description : |-
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.**
2022-08-30 12:29:05 +00:00
properties :
explanation :
2024-07-27 07:50:17 +00:00
description : |-
Explanation provides details about an in progress node shutdown. It is only available for clusters managed with the
Elasticsearch shutdown API.
2022-08-30 12:29:05 +00:00
type : string
name :
description : Name of the Elasticsearch node that should be removed.
type : string
shutdownStatus :
2024-07-27 07:50:17 +00:00
description : |-
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 remaining
shards on the nodes, as observed by the operator.
2022-08-30 12:29:05 +00:00
type : string
required :
- name
- shutdownStatus
type : object
type : array
stalled :
2024-07-27 07:50:17 +00:00
description : |-
Stalled represents a state where no progress can be made.
It is only available for clusters managed with the Elasticsearch shutdown API.
2022-08-30 12:29:05 +00:00
type : boolean
type : object
upgrade :
2024-07-27 07:50:17 +00:00
description : |-
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.**
2022-08-30 12:29:05 +00:00
properties :
lastUpdatedTime :
format : date-time
type : string
nodes :
description : Nodes that must be restarted for upgrade.
items :
2024-07-27 07:50:17 +00:00
description : |-
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.**
2022-08-30 12:29:05 +00:00
properties :
message :
description : Optional message to explain why a node may not be immediately restarted for upgrade.
type : string
name :
description : Name of the Elasticsearch node that should be upgraded.
type : string
predicate :
description : Predicate is the name of the predicate currently preventing this node from being deleted for an upgrade.
type : string
status :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- name
- status
type : object
type : array
type : object
upscale :
2024-07-27 07:50:17 +00:00
description : |-
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.**
2022-08-30 12:29:05 +00:00
properties :
lastUpdatedTime :
format : date-time
type : string
nodes :
description : Nodes expected to be added by the operator.
items :
properties :
message :
description : Optional message to explain why a node may not be immediately added.
type : string
name :
description : Name of the Elasticsearch node that should be added to the cluster.
type : string
status :
description : NewNodeStatus states if a new node is being created, or if the upscale is delayed.
type : string
required :
- name
- status
type : object
type : array
type : object
required :
- downscale
- upgrade
- upscale
type : object
monitoringAssociationStatus :
additionalProperties :
description : AssociationStatus is the status of an association resource.
type : string
2024-07-27 07:50:17 +00:00
description : |-
AssociationStatusMap is the map of association's namespaced name string to its AssociationStatus. For resources that
have a single Association of a given type (for ex. single ES reference), this map contains a single entry.
2022-08-30 12:29:05 +00:00
type : object
observedGeneration :
2024-07-27 07:50:17 +00:00
description : |-
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 Elasticsearch
controller has not yet processed the changes contained in the Elasticsearch specification.
2022-08-30 12:29:05 +00:00
format : int64
type : integer
phase :
description : ElasticsearchOrchestrationPhase is the phase Elasticsearch is in from the controller point of view.
type : string
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : true
subresources :
status : {}
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : Elasticsearch version
jsonPath : .spec.version
name : version
type : string
- jsonPath : .status.phase
name : phase
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1beta1
schema :
openAPIV3Schema :
description : Elasticsearch represents an Elasticsearch resource in a Kubernetes cluster.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : ElasticsearchSpec holds the specification of an Elasticsearch cluster.
properties :
http :
description : HTTP holds HTTP layer settings for Elasticsearch.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Elasticsearch Docker image to deploy.
type : string
nodeSets :
description : NodeSets allow specifying groups of Elasticsearch nodes sharing the same configuration and Pod templates.
items :
description : NodeSet is the specification for a group of Elasticsearch nodes sharing the same configuration and a Pod template.
properties :
config :
description : Config holds the Elasticsearch configuration.
type : object
count :
description : Count of Elasticsearch nodes to deploy.
format : int32
minimum : 1
type : integer
name :
description : Name of this set of nodes. Becomes a part of the Elasticsearch node.name setting.
maxLength : 23
pattern : '[a-zA-Z0-9-]+'
type : string
podTemplate :
description : PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Pods belonging to this NodeSet.
type : object
volumeClaimTemplates :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : PersistentVolumeClaim is a user's request for and claim to a persistent volume
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
2024-07-27 07:50:17 +00:00
description : |-
Standard object's metadata.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
2024-07-27 07:50:17 +00:00
description : |-
spec defines the desired characteristics of a volume requested by a pod author.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
2022-08-30 12:29:05 +00:00
properties :
accessModes :
2024-07-27 07:50:17 +00:00
description : |-
accessModes contains the desired access modes the volume should have.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
dataSource :
2024-07-27 07:50:17 +00:00
description : |-
dataSource field can be used to specify either :
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
2022-08-30 12:29:05 +00:00
properties :
apiGroup :
2024-07-27 07:50:17 +00:00
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
2022-08-30 12:29:05 +00:00
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
required :
- kind
- name
type : object
2022-09-23 13:16:22 +00:00
x-kubernetes-map-type : atomic
2022-08-30 12:29:05 +00:00
dataSourceRef :
2024-07-27 07:50:17 +00:00
description : |-
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef :
* While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
2022-08-30 12:29:05 +00:00
properties :
apiGroup :
2024-07-27 07:50:17 +00:00
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
2022-08-30 12:29:05 +00:00
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
2024-07-27 07:50:17 +00:00
namespace :
description : |-
Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type : string
2022-08-30 12:29:05 +00:00
required :
- kind
- name
type : object
resources :
2024-07-27 07:50:17 +00:00
description : |-
resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
2022-08-30 12:29:05 +00:00
properties :
limits :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
2024-07-27 07:50:17 +00:00
description : |-
Limits describes the maximum amount of compute resources allowed.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
2022-08-30 12:29:05 +00:00
type : object
requests :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
2024-07-27 07:50:17 +00:00
description : |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
2022-08-30 12:29:05 +00:00
type : object
type : object
selector :
2022-09-23 13:16:22 +00:00
description : selector is a label query over volumes to consider for binding.
2022-08-30 12:29:05 +00:00
properties :
matchExpressions :
description : matchExpressions is a list of label selector requirements. The requirements are ANDed.
items :
2024-07-27 07:50:17 +00:00
description : |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
2022-08-30 12:29:05 +00:00
properties :
key :
description : key is the label key that the selector applies to.
type : string
operator :
2024-07-27 07:50:17 +00:00
description : |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
2022-08-30 12:29:05 +00:00
type : string
values :
2024-07-27 07:50:17 +00:00
description : |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
2022-08-30 12:29:05 +00:00
type : object
type : object
2022-09-23 13:16:22 +00:00
x-kubernetes-map-type : atomic
2022-08-30 12:29:05 +00:00
storageClassName :
2024-07-27 07:50:17 +00:00
description : |-
storageClassName is the name of the StorageClass required by the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
type : string
volumeAttributesClassName :
description : |-
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
2022-08-30 12:29:05 +00:00
type : string
volumeMode :
2024-07-27 07:50:17 +00:00
description : |-
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
2022-08-30 12:29:05 +00:00
type : string
volumeName :
2022-09-23 13:16:22 +00:00
description : volumeName is the binding reference to the PersistentVolume backing this claim.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
type : array
required :
- count
- name
type : object
minItems : 1
type : array
podDisruptionBudget :
2024-07-27 07:50:17 +00:00
description : |-
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).
2022-08-30 12:29:05 +00:00
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the PDB.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the PDB.
properties :
maxUnavailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
An eviction is allowed if at most "maxUnavailable" pods selected by
"selector" are unavailable after the eviction, i.e. even in absence of
the evicted pod. For example, one can prevent all voluntary evictions
by specifying 0. This is a mutually exclusive setting with "minAvailable".
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
minAvailable :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
An eviction is allowed if at least "minAvailable" pods selected by
"selector" will still be available after the eviction, i.e. even in the
absence of the evicted pod. So for example you can prevent all voluntary
evictions by specifying "100%".
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
selector :
2024-07-27 07:50:17 +00:00
description : |-
Label query over pods whose evictions are managed by the disruption
budget.
A null selector selects no pods.
An empty selector ({}) also selects no pods, which differs from standard behavior of selecting all pods.
In policy/v1, an empty selector will select all pods in the namespace.
2022-08-30 12:29:05 +00:00
properties :
matchExpressions :
description : matchExpressions is a list of label selector requirements. The requirements are ANDed.
items :
2024-07-27 07:50:17 +00:00
description : |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
2022-08-30 12:29:05 +00:00
properties :
key :
description : key is the label key that the selector applies to.
type : string
operator :
2024-07-27 07:50:17 +00:00
description : |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
2022-08-30 12:29:05 +00:00
type : string
values :
2024-07-27 07:50:17 +00:00
description : |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
2022-08-30 12:29:05 +00:00
type : object
type : object
2022-09-23 13:16:22 +00:00
x-kubernetes-map-type : atomic
2024-07-27 07:50:17 +00:00
unhealthyPodEvictionPolicy :
description : |-
UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods
should be considered for eviction. Current implementation considers healthy pods,
as pods that have status.conditions item with type="Ready",status="True".
Valid policies are IfHealthyBudget and AlwaysAllow.
If no policy is specified, the default behavior will be used,
which corresponds to the IfHealthyBudget policy.
IfHealthyBudget policy means that running pods (status.phase="Running"),
but not yet healthy can be evicted only if the guarded application is not
disrupted (status.currentHealthy is at least equal to status.desiredHealthy).
Healthy pods will be subject to the PDB for eviction.
AlwaysAllow policy means that all running pods (status.phase="Running"),
but not yet healthy are considered disrupted and can be evicted regardless
of whether the criteria in a PDB is met. This means perspective running
pods of a disrupted application might not get a chance to become healthy.
Healthy pods will be subject to the PDB for eviction.
Additional policies may be added in the future.
Clients making eviction decisions should disallow eviction of unhealthy pods
if they encounter an unrecognized policy in this field.
This field is beta-level. The eviction API uses this field when
the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default).
type : string
2022-08-30 12:29:05 +00:00
type : object
type : object
secureSettings :
description : SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Elasticsearch.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
updateStrategy :
description : UpdateStrategy specifies how updates to the cluster should be performed.
properties :
changeBudget :
description : ChangeBudget defines the constraints to consider when applying changes to the Elasticsearch cluster.
properties :
maxSurge :
2024-07-27 07:50:17 +00:00
description : |-
MaxSurge is the maximum number of new pods that can be created exceeding the original number of pods defined in
the specification. MaxSurge is only taken into consideration when scaling up. Setting a negative value will
disable the restriction. Defaults to unbounded if not specified.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
maxUnavailable :
2024-07-27 07:50:17 +00:00
description : |-
MaxUnavailable is the maximum number of pods that can be unavailable (not ready) during the update due to
circumstances under the control of the operator. Setting a negative value will disable this restriction.
Defaults to 1 if not specified.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
version :
description : Version of Elasticsearch.
type : string
required :
- nodeSets
type : object
status :
description : ElasticsearchStatus defines the observed state of Elasticsearch
properties :
availableNodes :
format : int32
type : integer
health :
description : ElasticsearchHealth is the health of the cluster as returned by the health API.
type : string
phase :
description : ElasticsearchOrchestrationPhase is the phase Elasticsearch is in from the controller point of view.
type : string
type : object
type : object
served : true
storage : false
subresources :
status : {}
- name : v1alpha1
schema :
openAPIV3Schema :
description : to not break compatibility when upgrading from previous versions of the CRD
type : object
served : false
storage : false
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-07-27 07:50:17 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
2022-08-30 12:29:05 +00:00
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
2024-07-27 07:50:17 +00:00
app.kubernetes.io/version : '2.13.0'
2022-08-30 12:29:05 +00:00
name : enterprisesearches.enterprisesearch.k8s.elastic.co
spec :
group : enterprisesearch.k8s.elastic.co
names :
categories :
- elastic
kind : EnterpriseSearch
listKind : EnterpriseSearchList
plural : enterprisesearches
shortNames :
- ent
singular : enterprisesearch
scope : Namespaced
versions :
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : Enterprise Search version
jsonPath : .status.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1
schema :
openAPIV3Schema :
description : EnterpriseSearch is a Kubernetes CRD to represent Enterprise Search.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : EnterpriseSearchSpec holds the specification of an Enterprise Search resource.
properties :
config :
description : Config holds the Enterprise Search configuration.
type : object
x-kubernetes-preserve-unknown-fields : true
configRef :
2024-07-27 07:50:17 +00:00
description : |-
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`.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
count :
description : Count of Enterprise Search instances to deploy.
format : int32
type : integer
elasticsearchRef :
description : ElasticsearchRef is a reference to the Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
http :
description : HTTP holds the HTTP layer configuration for Enterprise Search resource.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Enterprise Search Docker image to deploy.
type : string
podTemplate :
2024-07-27 07:50:17 +00:00
description : |-
PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on)
for the Enterprise Search pods.
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-preserve-unknown-fields : true
2022-09-23 13:16:22 +00:00
revisionHistoryLimit :
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment.
format : int32
type : integer
2022-08-30 12:29:05 +00:00
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
version :
description : Version of Enterprise Search.
type : string
type : object
status :
description : EnterpriseSearchStatus defines the observed state of EnterpriseSearch
properties :
associationStatus :
description : Association is the status of any auto-linking to Elasticsearch clusters.
type : string
availableNodes :
description : AvailableNodes is the number of available replicas in the deployment.
format : int32
type : integer
count :
description : Count corresponds to Scale.Status.Replicas, which is the actual number of observed instances of the scaled object.
format : int32
type : integer
health :
description : Health of the deployment.
type : string
2022-09-23 13:16:22 +00:00
observedGeneration :
2024-07-27 07:50:17 +00:00
description : |-
ObservedGeneration represents the .metadata.generation that the status is based upon.
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 Enterprise Search
controller has not yet processed the changes contained in the Enterprise Search specification.
2022-09-23 13:16:22 +00:00
format : int64
type : integer
2022-08-30 12:29:05 +00:00
selector :
description : Selector is the label selector used to find all pods.
type : string
service :
description : ExternalService is the name of the service associated to the Enterprise Search Pods.
type : string
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : true
subresources :
scale :
labelSelectorPath : .status.selector
specReplicasPath : .spec.count
statusReplicasPath : .status.count
status : {}
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : Enterprise Search version
jsonPath : .status.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1beta1
schema :
openAPIV3Schema :
description : EnterpriseSearch is a Kubernetes CRD to represent Enterprise Search.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : EnterpriseSearchSpec holds the specification of an Enterprise Search resource.
properties :
config :
description : Config holds the Enterprise Search configuration.
type : object
x-kubernetes-preserve-unknown-fields : true
configRef :
2024-07-27 07:50:17 +00:00
description : |-
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`.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
count :
description : Count of Enterprise Search instances to deploy.
format : int32
type : integer
elasticsearchRef :
description : ElasticsearchRef is a reference to the Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
http :
description : HTTP holds the HTTP layer configuration for Enterprise Search resource.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Enterprise Search Docker image to deploy.
type : string
podTemplate :
2024-07-27 07:50:17 +00:00
description : |-
PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on)
for the Enterprise Search pods.
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-preserve-unknown-fields : true
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
version :
description : Version of Enterprise Search.
type : string
type : object
status :
description : EnterpriseSearchStatus defines the observed state of EnterpriseSearch
properties :
associationStatus :
description : Association is the status of any auto-linking to Elasticsearch clusters.
type : string
availableNodes :
description : AvailableNodes is the number of available replicas in the deployment.
format : int32
type : integer
count :
description : Count corresponds to Scale.Status.Replicas, which is the actual number of observed instances of the scaled object.
format : int32
type : integer
health :
description : Health of the deployment.
type : string
selector :
description : Selector is the label selector used to find all pods.
type : string
service :
description : ExternalService is the name of the service associated to the Enterprise Search Pods.
type : string
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : false
subresources :
status : {}
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-07-27 07:50:17 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
2022-08-30 12:29:05 +00:00
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
2024-07-27 07:50:17 +00:00
app.kubernetes.io/version : '2.13.0'
2022-08-30 12:29:05 +00:00
name : kibanas.kibana.k8s.elastic.co
spec :
group : kibana.k8s.elastic.co
names :
categories :
- elastic
kind : Kibana
listKind : KibanaList
plural : kibanas
shortNames :
- kb
singular : kibana
scope : Namespaced
versions :
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : Kibana version
jsonPath : .status.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1
schema :
openAPIV3Schema :
description : Kibana represents a Kibana resource in a Kubernetes cluster.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : KibanaSpec holds the specification of a Kibana instance.
properties :
config :
description: 'Config holds the Kibana configuration. See : https://www.elastic.co/guide/en/kibana/current/settings.html'
type : object
x-kubernetes-preserve-unknown-fields : true
count :
description : Count of Kibana instances to deploy.
format : int32
type : integer
elasticsearchRef :
description : ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
enterpriseSearchRef :
2024-07-27 07:50:17 +00:00
description : |-
EnterpriseSearchRef is a reference to an EnterpriseSearch running in the same Kubernetes cluster.
Kibana provides the default Enterprise Search UI starting version 7.14.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
http :
description : HTTP holds the HTTP layer configuration for Kibana.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Kibana Docker image to deploy.
type : string
monitoring :
2024-07-27 07:50:17 +00:00
description : |-
Monitoring enables you to collect and ship log and monitoring data of this Kibana.
See https://www.elastic.co/guide/en/kibana/current/xpack-monitoring.html.
Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one sends data to one or two different
Elasticsearch monitoring clusters running in the same Kubernetes cluster.
2022-08-30 12:29:05 +00:00
properties :
logs :
2024-07-27 07:50:17 +00:00
description : Logs holds references to Elasticsearch clusters which receive log data from an associated resource.
2022-08-30 12:29:05 +00:00
properties :
elasticsearchRefs :
2024-07-27 07:50:17 +00:00
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.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : array
type : object
metrics :
2024-07-27 07:50:17 +00:00
description : Metrics holds references to Elasticsearch clusters which receive monitoring data from this resource.
2022-08-30 12:29:05 +00:00
properties :
elasticsearchRefs :
2024-07-27 07:50:17 +00:00
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.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
2024-07-27 07:50:17 +00:00
description : |-
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 :
- `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.
2022-08-30 12:29:05 +00:00
type : string
serviceName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : array
type : object
type : object
podTemplate :
description : PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Kibana pods
type : object
x-kubernetes-preserve-unknown-fields : true
2022-09-23 13:16:22 +00:00
revisionHistoryLimit :
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment.
format : int32
type : integer
2022-08-30 12:29:05 +00:00
secureSettings :
description : SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Kibana.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
serviceAccountName :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
version :
description : Version of Kibana.
type : string
required :
- version
type : object
status :
description : KibanaStatus defines the observed state of Kibana
properties :
associationStatus :
2024-07-27 07:50:17 +00:00
description : |-
AssociationStatus is the status of any auto-linking to Elasticsearch clusters.
This field is deprecated and will be removed in a future release. Use ElasticsearchAssociationStatus instead.
2022-08-30 12:29:05 +00:00
type : string
availableNodes :
description : AvailableNodes is the number of available replicas in the deployment.
format : int32
type : integer
count :
description : Count corresponds to Scale.Status.Replicas, which is the actual number of observed instances of the scaled object.
format : int32
type : integer
elasticsearchAssociationStatus :
description : ElasticsearchAssociationStatus is the status of any auto-linking to Elasticsearch clusters.
type : string
enterpriseSearchAssociationStatus :
description : EnterpriseSearchAssociationStatus is the status of any auto-linking to Enterprise Search.
type : string
health :
description : Health of the deployment.
type : string
monitoringAssociationStatus :
additionalProperties :
description : AssociationStatus is the status of an association resource.
type : string
description : MonitoringAssociationStatus is the status of any auto-linking to monitoring Elasticsearch clusters.
type : object
observedGeneration :
2024-07-27 07:50:17 +00:00
description : |-
ObservedGeneration is the most recent generation observed for this Kibana 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 Kibana
controller has not yet processed the changes contained in the Kibana specification.
2022-08-30 12:29:05 +00:00
format : int64
type : integer
selector :
description : Selector is the label selector used to find all pods.
type : string
version :
2024-07-27 07:50:17 +00:00
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
served : true
storage : true
subresources :
scale :
labelSelectorPath : .status.selector
specReplicasPath : .spec.count
statusReplicasPath : .status.count
status : {}
- additionalPrinterColumns :
- jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : nodes
type : integer
- description : Kibana version
jsonPath : .spec.version
name : version
type : string
- jsonPath : .metadata.creationTimestamp
name : age
type : date
name : v1beta1
schema :
openAPIV3Schema :
description : Kibana represents a Kibana resource in a Kubernetes cluster.
properties :
apiVersion :
2024-07-27 07:50:17 +00:00
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2022-08-30 12:29:05 +00:00
type : string
kind :
2024-07-27 07:50:17 +00:00
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2022-08-30 12:29:05 +00:00
type : string
metadata :
type : object
spec :
description : KibanaSpec holds the specification of a Kibana instance.
properties :
config :
description: 'Config holds the Kibana configuration. See : https://www.elastic.co/guide/en/kibana/current/settings.html'
type : object
x-kubernetes-preserve-unknown-fields : true
count :
description : Count of Kibana instances to deploy.
format : int32
type : integer
elasticsearchRef :
description : ElasticsearchRef is a reference to an Elasticsearch cluster running in the same Kubernetes cluster.
properties :
name :
description : Name of the Kubernetes object.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
required :
- name
type : object
http :
description : HTTP holds the HTTP layer configuration for Kibana.
properties :
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
2024-07-27 07:50:17 +00:00
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
2022-08-30 12:29:05 +00:00
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
2024-07-27 07:50:17 +00:00
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
2022-08-30 12:29:05 +00:00
type : boolean
clusterIP :
2024-07-27 07:50:17 +00:00
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
clusterIPs :
2024-07-27 07:50:17 +00:00
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
2024-07-27 07:50:17 +00:00
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
externalName :
2024-07-27 07:50:17 +00:00
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
2022-08-30 12:29:05 +00:00
type : string
externalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
2022-08-30 12:29:05 +00:00
type : string
healthCheckNodePort :
2024-07-27 07:50:17 +00:00
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
2022-08-30 12:29:05 +00:00
format : int32
type : integer
internalTrafficPolicy :
2024-07-27 07:50:17 +00:00
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
2022-08-30 12:29:05 +00:00
type : string
ipFamilies :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
2022-08-30 12:29:05 +00:00
items :
2024-07-27 07:50:17 +00:00
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
2022-08-30 12:29:05 +00:00
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
2024-07-27 07:50:17 +00:00
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerClass :
2024-07-27 07:50:17 +00:00
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerIP :
2024-07-27 07:50:17 +00:00
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
2022-08-30 12:29:05 +00:00
type : string
loadBalancerSourceRanges :
2024-07-27 07:50:17 +00:00
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
2022-08-30 12:29:05 +00:00
items :
type : string
type : array
ports :
2024-07-27 07:50:17 +00:00
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
2024-07-27 07:50:17 +00:00
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
2022-08-30 12:29:05 +00:00
type : string
name :
2024-07-27 07:50:17 +00:00
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
2022-08-30 12:29:05 +00:00
type : string
nodePort :
2024-07-27 07:50:17 +00:00
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
2022-08-30 12:29:05 +00:00
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
2024-07-27 07:50:17 +00:00
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
2022-08-30 12:29:05 +00:00
type : string
targetPort :
anyOf :
- type : integer
- type : string
2024-07-27 07:50:17 +00:00
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
2022-08-30 12:29:05 +00:00
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
2024-07-27 07:50:17 +00:00
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
2022-08-30 12:29:05 +00:00
type : boolean
selector :
additionalProperties :
type : string
2024-07-27 07:50:17 +00:00
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
2022-08-30 12:29:05 +00:00
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
2024-07-27 07:50:17 +00:00
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
2022-08-30 12:29:05 +00:00
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
2024-07-27 07:50:17 +00:00
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
2022-08-30 12:29:05 +00:00
format : int32
type : integer
type : object
type : object
type :
2024-07-27 07:50:17 +00:00
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
2022-08-30 12:29:05 +00:00
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
image :
description : Image is the Kibana Docker image to deploy.
type : string
podTemplate :
description : PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Kibana pods
type : object
x-kubernetes-preserve-unknown-fields : true
secureSettings :
description : SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for Kibana.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
2024-07-27 07:50:17 +00:00
description : |-
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.
2022-08-30 12:29:05 +00:00
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
version :
description : Version of Kibana.
type : string
type : object
status :
description : KibanaStatus defines the observed state of Kibana
properties :
associationStatus :
description : AssociationStatus is the status of an association resource.
type : string
availableNodes :
format : int32
type : integer
health :
description : KibanaHealth expresses the status of the Kibana instances.
type : string
type : object
type : object
served : true
storage : false
subresources :
status : {}
- name : v1alpha1
schema :
openAPIV3Schema :
description : to not break compatibility when upgrading from previous versions of the CRD
type : object
served : false
storage : false
2024-07-27 07:50:17 +00:00
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
app.kubernetes.io/version : '2.13.0'
name : logstashes.logstash.k8s.elastic.co
spec :
group : logstash.k8s.elastic.co
names :
categories :
- elastic
kind : Logstash
listKind : LogstashList
plural : logstashes
shortNames :
- ls
singular : logstash
scope : Namespaced
versions :
- additionalPrinterColumns :
- description : Health
jsonPath : .status.health
name : health
type : string
- description : Available nodes
jsonPath : .status.availableNodes
name : available
type : integer
- description : Expected nodes
jsonPath : .status.expectedNodes
name : expected
type : integer
- jsonPath : .metadata.creationTimestamp
name : age
type : date
- description : Logstash version
jsonPath : .status.version
name : version
type : string
name : v1alpha1
schema :
openAPIV3Schema :
description : Logstash is the Schema for the logstashes API
properties :
apiVersion :
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type : string
kind :
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type : string
metadata :
type : object
spec :
description : LogstashSpec defines the desired state of Logstash
properties :
config :
description : Config holds the Logstash configuration. At most one of [`Config`, `ConfigRef`] can be specified.
type : object
x-kubernetes-preserve-unknown-fields : true
configRef :
description : |-
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.
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
count :
format : int32
type : integer
elasticsearchRefs :
description : ElasticsearchRefs are references to Elasticsearch clusters running in the same Kubernetes cluster.
items :
description : ElasticsearchCluster is a named reference to an Elasticsearch cluster which can be used in a Logstash pipeline.
properties :
clusterName :
description : |-
ClusterName is an alias for the cluster to be used to refer to the Elasticsearch cluster in Logstash
configuration files, and will be used to identify "named clusters" in Logstash
minLength : 1
type : string
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
description : |-
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 :
- `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.
type : string
serviceName :
description : |-
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.
type : string
type : object
type : array
image :
description : Image is the Logstash Docker image to deploy. Version and Type have to match the Logstash in the image.
type : string
monitoring :
description : |-
Monitoring enables you to collect and ship log and monitoring data of this Logstash.
Metricbeat and Filebeat are deployed in the same Pod as sidecars and each one sends data to one or two different
Elasticsearch monitoring clusters running in the same Kubernetes cluster.
properties :
logs :
description : Logs holds references to Elasticsearch clusters which receive log data from an associated resource.
properties :
elasticsearchRefs :
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.
items :
description : |-
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.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
description : |-
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 :
- `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.
type : string
serviceName :
description : |-
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.
type : string
type : object
type : array
type : object
metrics :
description : Metrics holds references to Elasticsearch clusters which receive monitoring data from this resource.
properties :
elasticsearchRefs :
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.
items :
description : |-
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.
properties :
name :
description : Name of an existing Kubernetes object corresponding to an Elastic resource managed by ECK.
type : string
namespace :
description : Namespace of the Kubernetes object. If empty, defaults to the current namespace.
type : string
secretName :
description : |-
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 :
- `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.
type : string
serviceName :
description : |-
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.
type : string
type : object
type : array
type : object
type : object
pipelines :
description : Pipelines holds the Logstash Pipelines. At most one of [`Pipelines`, `PipelinesRef`] can be specified.
items :
type : object
type : array
x-kubernetes-preserve-unknown-fields : true
pipelinesRef :
description : |-
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.
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
podTemplate :
description : PodTemplate provides customisation options for the Logstash pods.
type : object
x-kubernetes-preserve-unknown-fields : true
revisionHistoryLimit :
description : RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying StatefulSet.
format : int32
type : integer
secureSettings :
description : |-
SecureSettings is a list of references to Kubernetes Secrets containing sensitive configuration options for the Logstash.
Secrets data can be then referenced in the Logstash config using the Secret's keys or as specified in `Entries` field of
each SecureSetting.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
description : |-
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.
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
description : |-
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.
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
serviceAccountName :
description : |-
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.
type : string
services :
description : |-
Services contains details of services that Logstash should expose - similar to the HTTP layer configuration for the
rest of the stack, but also applicable for more use cases than the metrics API, as logstash may need to
be opened up for other services : Beats, TCP, UDP, etc, inputs.
items :
properties :
name :
type : string
service :
description : Service defines the template for the associated Kubernetes Service object.
properties :
metadata :
description : |-
ObjectMeta is the metadata of the service.
The name and namespace provided here are managed by ECK and will be ignored.
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : Spec is the specification of the service.
properties :
allocateLoadBalancerNodePorts :
description : |-
allocateLoadBalancerNodePorts defines if NodePorts will be automatically
allocated for services with type LoadBalancer. Default is "true". It
may be set to "false" if the cluster load-balancer does not rely on
NodePorts. If the caller requests specific NodePorts (by specifying a
value), those requests will be respected, regardless of this field.
This field may only be set for services with type LoadBalancer and will
be cleared if the type is changed to any other type.
type : boolean
clusterIP :
description : |-
clusterIP is the IP address of the service and is usually assigned
randomly. If an address is specified manually, is in-range (as per
system configuration), and is not in use, it will be allocated to the
service; otherwise creation of the service will fail. This field may not
be changed through updates unless the type field is also being changed
to ExternalName (which requires this field to be blank) or the type
field is being changed from ExternalName (in which case this field may
optionally be specified, as describe above). Valid values are "None",
empty string (""), or a valid IP address. Setting this to "None" makes a
"headless service" (no virtual IP), which is useful when direct endpoint
connections are preferred and proxying is not required. Only applies to
types ClusterIP, NodePort, and LoadBalancer. If this field is specified
when creating a Service of type ExternalName, creation will fail. This
field will be wiped when updating a Service to type ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
type : string
clusterIPs :
description : |-
ClusterIPs is a list of IP addresses assigned to this service, and are
usually assigned randomly. If an address is specified manually, is
in-range (as per system configuration), and is not in use, it will be
allocated to the service; otherwise creation of the service will fail.
This field may not be changed through updates unless the type field is
also being changed to ExternalName (which requires this field to be
empty) or the type field is being changed from ExternalName (in which
case this field may optionally be specified, as describe above). Valid
values are "None", empty string (""), or a valid IP address. Setting
this to "None" makes a "headless service" (no virtual IP), which is
useful when direct endpoint connections are preferred and proxying is
not required. Only applies to types ClusterIP, NodePort, and
LoadBalancer. If this field is specified when creating a Service of type
ExternalName, creation will fail. This field will be wiped when updating
a Service to type ExternalName. If this field is not specified, it will
be initialized from the clusterIP field. If this field is specified,
clients must ensure that clusterIPs[0] and clusterIP have the same
value.
This field may hold a maximum of two entries (dual-stack IPs, in either order).
These IPs must correspond to the values of the ipFamilies field. Both
clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
items :
type : string
type : array
x-kubernetes-list-type : atomic
externalIPs :
description : |-
externalIPs is a list of IP addresses for which nodes in the cluster
will also accept traffic for this service. These IPs are not managed by
Kubernetes. The user is responsible for ensuring that traffic arrives
at a node with this IP. A common example is external load-balancers
that are not part of the Kubernetes system.
items :
type : string
type : array
externalName :
description : |-
externalName is the external reference that discovery mechanisms will
return as an alias for this service (e.g. a DNS CNAME record). No
proxying will be involved. Must be a lowercase RFC-1123 hostname
(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
type : string
externalTrafficPolicy :
description : |-
externalTrafficPolicy describes how nodes distribute service traffic they
receive on one of the Service's "externally-facing" addresses (NodePorts,
ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
the service in a way that assumes that external load balancers will take care
of balancing the service traffic between nodes, and so each node will deliver
traffic only to the node-local endpoints of the service, without masquerading
the client source IP. (Traffic mistakenly sent to a node with no endpoints will
be dropped.) The default value, "Cluster", uses the standard behavior of
routing to all endpoints evenly (possibly modified by topology and other
features). Note that traffic sent to an External IP or LoadBalancer IP from
within the cluster will always get "Cluster" semantics, but clients sending to
a NodePort from within the cluster may need to take traffic policy into account
when picking a node.
type : string
healthCheckNodePort :
description : |-
healthCheckNodePort specifies the healthcheck nodePort for the service.
This only applies when type is set to LoadBalancer and
externalTrafficPolicy is set to Local. If a value is specified, is
in-range, and is not in use, it will be used. If not specified, a value
will be automatically allocated. External systems (e.g. load-balancers)
can use this port to determine if a given node holds endpoints for this
service or not. If this field is specified when creating a Service
which does not need it, creation will fail. This field will be wiped
when updating a Service to no longer need it (e.g. changing type).
This field cannot be updated once set.
format : int32
type : integer
internalTrafficPolicy :
description : |-
InternalTrafficPolicy describes how nodes distribute service traffic they
receive on the ClusterIP. If set to "Local", the proxy will assume that pods
only want to talk to endpoints of the service on the same node as the pod,
dropping the traffic if there are no local endpoints. The default value,
"Cluster" , uses the standard behavior of routing to all endpoints evenly
(possibly modified by topology and other features).
type : string
ipFamilies :
description : |-
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
service. This field is usually assigned automatically based on cluster
configuration and the ipFamilyPolicy field. If this field is specified
manually, the requested family is available in the cluster,
and ipFamilyPolicy allows it, it will be used; otherwise creation of
the service will fail. This field is conditionally mutable : it allows
for adding or removing a secondary IP family, but it does not allow
changing the primary IP family of the Service. Valid values are "IPv4"
and "IPv6". This field only applies to Services of types ClusterIP,
NodePort, and LoadBalancer, and does apply to "headless" services.
This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in
either order). These families must correspond to the values of the
clusterIPs field, if specified. Both clusterIPs and ipFamilies are
governed by the ipFamilyPolicy field.
items :
description : |-
IPFamily represents the IP Family (IPv4 or IPv6). This type is used
to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
type : string
type : array
x-kubernetes-list-type : atomic
ipFamilyPolicy :
description : |-
IPFamilyPolicy represents the dual-stack-ness requested or required by
this Service. If there is no value provided, then this field will be set
to SingleStack. Services can be "SingleStack" (a single IP family),
"PreferDualStack" (two IP families on dual-stack configured clusters or
a single IP family on single-stack clusters), or "RequireDualStack"
(two IP families on dual-stack configured clusters, otherwise fail). The
ipFamilies and clusterIPs fields depend on the value of this field. This
field will be wiped when updating a service to type ExternalName.
type : string
loadBalancerClass :
description : |-
loadBalancerClass is the class of the load balancer implementation this Service belongs to.
If specified, the value of this field must be a label-style identifier, with an optional prefix,
e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
balancer implementation is used, today this is typically done through the cloud provider integration,
but should apply for any default implementation. If set, it is assumed that a load balancer
implementation is watching for Services with a matching class. Any default load balancer
implementation (e.g. cloud providers) should ignore Services that set this field.
This field can only be set when creating or updating a Service to type 'LoadBalancer'.
Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
type : string
loadBalancerIP :
description : |-
Only applies to Service Type : LoadBalancer.
This feature depends on whether the underlying cloud-provider supports specifying
the loadBalancerIP when a load balancer is created.
This field will be ignored if the cloud-provider does not support the feature.
Deprecated : This field was under-specified and its meaning varies across implementations.
Using it is non-portable and it may not support dual-stack.
Users are encouraged to use implementation-specific annotations when available.
type : string
loadBalancerSourceRanges :
description : |-
If specified and supported by the platform, this will restrict traffic through the cloud-provider
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature."
More info : https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
items :
type : string
type : array
ports :
description : |-
The list of ports that are exposed by this service.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
items :
description : ServicePort contains information on service's port.
properties :
appProtocol :
description : |-
The application protocol for this port.
This is used as a hint for implementations to offer richer behavior for protocols that they understand.
This field follows standard Kubernetes label syntax.
Valid values are either :
* Un-prefixed protocol names - reserved for IANA standard service names (as per
RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names :
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as
mycompany.com/my-custom-protocol.
type : string
name :
description : |-
The name of this port within the service. This must be a DNS_LABEL.
All ports within a ServiceSpec must have unique names. When considering
the endpoints for a Service, this must match the 'name' field in the
EndpointPort.
Optional if only one ServicePort is defined on this service.
type : string
nodePort :
description : |-
The port on each node on which this service is exposed when type is
NodePort or LoadBalancer. Usually assigned by the system. If a value is
specified, in-range, and not in use it will be used, otherwise the
operation will fail. If not specified, a port will be allocated if this
Service requires one. If this field is specified when creating a
Service which does not need it, creation will fail. This field will be
wiped when updating a Service to no longer need it (e.g. changing type
from NodePort to ClusterIP).
More info : https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
format : int32
type : integer
port :
description : The port that will be exposed by this service.
format : int32
type : integer
protocol :
default : TCP
description : |-
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
Default is TCP.
type : string
targetPort :
anyOf :
- type : integer
- type : string
description : |-
Number or name of the port to access on the pods targeted by the service.
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
If this is a string, it will be looked up as a named port in the
target Pod's container ports. If this is not specified, the value
of the 'port' field is used (an identity map).
This field is ignored for services with clusterIP=None, and should be
omitted or set equal to the 'port' field.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
x-kubernetes-int-or-string : true
required :
- port
type : object
type : array
x-kubernetes-list-map-keys :
- port
- protocol
x-kubernetes-list-type : map
publishNotReadyAddresses :
description : |-
publishNotReadyAddresses indicates that any agent which deals with endpoints for this
Service should disregard any indications of ready/not-ready.
The primary use case for setting this field is for a StatefulSet's Headless Service to
propagate SRV DNS records for its Pods for the purpose of peer discovery.
The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
Services interpret this to mean that all endpoints are considered "ready" even if the
Pods themselves are not. Agents which consume only Kubernetes generated endpoints
through the Endpoints or EndpointSlice resources can safely assume this behavior.
type : boolean
selector :
additionalProperties :
type : string
description : |-
Route service traffic to pods with label keys and values matching this
selector. If empty or not present, the service is assumed to have an
external process managing its endpoints, which Kubernetes will not
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
Ignored if type is ExternalName.
More info : https://kubernetes.io/docs/concepts/services-networking/service/
type : object
x-kubernetes-map-type : atomic
sessionAffinity :
description : |-
Supports "ClientIP" and "None". Used to maintain session affinity.
Enable client IP based session affinity.
Must be ClientIP or None.
Defaults to None.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
type : string
sessionAffinityConfig :
description : sessionAffinityConfig contains the configurations of session affinity.
properties :
clientIP :
description : clientIP contains the configurations of Client IP based session affinity.
properties :
timeoutSeconds :
description : |-
timeoutSeconds specifies the seconds of ClientIP type session sticky time.
The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
Default value is 10800(for 3 hours).
format : int32
type : integer
type : object
type : object
type :
description : |-
type determines how the Service is exposed. Defaults to ClusterIP. Valid
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
"ClusterIP" allocates a cluster-internal IP address for load-balancing
to endpoints. Endpoints are determined by the selector or if that is not
specified, by manual construction of an Endpoints object or
EndpointSlice objects. If clusterIP is "None", no virtual IP is
allocated and the endpoints are published as a set of endpoints rather
than a virtual IP.
"NodePort" builds on ClusterIP and allocates a port on every node which
routes to the same endpoints as the clusterIP.
"LoadBalancer" builds on NodePort and creates an external load-balancer
(if supported in the current cloud) which routes to the same endpoints
as the clusterIP.
"ExternalName" aliases this service to the specified externalName.
Several other fields do not apply to ExternalName services.
More info : https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
type : string
type : object
type : object
tls :
description : TLS defines options for configuring TLS for HTTP.
properties :
certificate :
description : |-
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.
properties :
secretName :
description : SecretName is the name of the secret.
type : string
type : object
selfSignedCertificate :
description : SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
properties :
disabled :
description : Disabled indicates that the provisioning of the self-signed certifcate should be disabled.
type : boolean
subjectAltNames :
description : SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
items :
description : SubjectAlternativeName represents a SAN entry in a x509 certificate.
properties :
dns :
description : DNS is the DNS name of the subject.
type : string
ip :
description : IP is the IP address of the subject.
type : string
type : object
type : array
type : object
type : object
type : object
type : array
updateStrategy :
description : UpdateStrategy is a StatefulSetUpdateStrategy. The default type is "RollingUpdate".
properties :
rollingUpdate :
description : RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
properties :
maxUnavailable :
anyOf :
- type : integer
- type : string
description : |-
The maximum number of pods that can be unavailable during the update.
Value can be an absolute number (ex: 5) or a percentage of desired pods (ex : 10 %).
Absolute number is calculated from percentage by rounding up. This can not be 0.
Defaults to 1. This field is alpha-level and is only honored by servers that enable the
MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to
Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it
will be counted towards MaxUnavailable.
x-kubernetes-int-or-string : true
partition :
description : |-
Partition indicates the ordinal at which the StatefulSet should be partitioned
for updates. During a rolling update, all pods from ordinal Replicas-1 to
Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched.
This is helpful in being able to do a canary based deployment. The default value is 0.
format : int32
type : integer
type : object
type :
description : |-
Type indicates the type of the StatefulSetUpdateStrategy.
Default is RollingUpdate.
type : string
type : object
version :
description : Version of the Logstash.
type : string
volumeClaimTemplates :
description : |-
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.
items :
description : PersistentVolumeClaim is a user's request for and claim to a persistent volume
properties :
apiVersion :
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type : string
kind :
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type : string
metadata :
description : |-
Standard object's metadata.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
properties :
annotations :
additionalProperties :
type : string
type : object
finalizers :
items :
type : string
type : array
labels :
additionalProperties :
type : string
type : object
name :
type : string
namespace :
type : string
type : object
spec :
description : |-
spec defines the desired characteristics of a volume requested by a pod author.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
properties :
accessModes :
description : |-
accessModes contains the desired access modes the volume should have.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
items :
type : string
type : array
dataSource :
description : |-
dataSource field can be used to specify either :
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
properties :
apiGroup :
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
required :
- kind
- name
type : object
x-kubernetes-map-type : atomic
dataSourceRef :
description : |-
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef :
* While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
properties :
apiGroup :
description : |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type : string
kind :
description : Kind is the type of resource being referenced
type : string
name :
description : Name is the name of resource being referenced
type : string
namespace :
description : |-
Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type : string
required :
- kind
- name
type : object
resources :
description : |-
resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
properties :
limits :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : |-
Limits describes the maximum amount of compute resources allowed.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type : object
requests :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : |-
Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info : https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
type : object
type : object
selector :
description : selector is a label query over volumes to consider for binding.
properties :
matchExpressions :
description : matchExpressions is a list of label selector requirements. The requirements are ANDed.
items :
description : |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
properties :
key :
description : key is the label key that the selector applies to.
type : string
operator :
description : |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
type : string
values :
description : |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
type : object
type : object
x-kubernetes-map-type : atomic
storageClassName :
description : |-
storageClassName is the name of the StorageClass required by the claim.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
type : string
volumeAttributesClassName :
description : |-
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
type : string
volumeMode :
description : |-
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
type : string
volumeName :
description : volumeName is the binding reference to the PersistentVolume backing this claim.
type : string
type : object
status :
description : |-
status represents the current information/status of a persistent volume claim.
Read-only.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
properties :
accessModes :
description : |-
accessModes contains the actual access modes the volume backing the PVC has.
More info : https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
items :
type : string
type : array
allocatedResourceStatuses :
additionalProperties :
description : |-
When a controller receives persistentvolume claim update with ClaimResourceStatus for a resource
that it does not recognizes, then it should ignore that update and let other controllers
handle it.
type : string
description : "allocatedResourceStatuses stores status of resource being resized for the given PVC.\nKey names follow standard Kubernetes label syntax. Valid values are either:\n\t* Un-prefixed keys:\n\t\t- storage - the capacity of the volume.\n\t* Custom resources must use implementation-defined prefixed names such as \"example.com/my-custom-resource\"\nApart from above values - keys that are unprefixed or have kubernetes.io prefix are considered\nreserved and hence may not be used.\n\n\nClaimResourceStatus can be in any of following states:\n\t- ControllerResizeInProgress:\n\t\tState set when resize controller starts resizing the volume in control-plane.\n\t- ControllerResizeFailed:\n\t\tState set when resize has failed in resize controller with a terminal error.\n\t- NodeResizePending:\n\t\tState set when resize controller has finished resizing the volume but further resizing of\n\t\tvolume is needed on the node.\n\t- NodeResizeInProgress:\n\t\tState set when kubelet starts resizing the volume.\n\t- NodeResizeFailed:\n\t\tState set when resizing has failed in kubelet with a terminal error. Transient errors don't set\n\t\tNodeResizeFailed.\nFor example: if expanding a PVC for more capacity - this field can be one of the following states:\n\t- pvc.status.allocatedResourceStatus['storage'] = \"ControllerResizeInProgress\"\n - pvc.status.allocatedResourceStatus['storage'] = \"ControllerResizeFailed\"\n - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizePending\"\n - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizeInProgress\"\n - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizeFailed\"\nWhen this field is not set, it means that no resize operation is in progress for the given PVC.\n\n\nA controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus\nshould ignore the update for the purpose it was designed. For example - a controller that\nonly is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid\nresources associated with PVC.\n\n\nThis is an alpha field and requires enabling RecoverVolumeExpansionFailure feature."
type : object
x-kubernetes-map-type : granular
allocatedResources :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : "allocatedResources tracks the resources allocated to a PVC including its capacity.\nKey names follow standard Kubernetes label syntax. Valid values are either:\n\t* Un-prefixed keys:\n\t\t- storage - the capacity of the volume.\n\t* Custom resources must use implementation-defined prefixed names such as \"example.com/my-custom-resource\"\nApart from above values - keys that are unprefixed or have kubernetes.io prefix are considered\nreserved and hence may not be used.\n\n\nCapacity reported here may be larger than the actual capacity when a volume expansion operation\nis requested.\nFor storage quota, the larger value from allocatedResources and PVC.spec.resources is used.\nIf allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.\nIf a volume expansion capacity request is lowered, allocatedResources is only\nlowered if there are no expansion operations in progress and if the actual volume capacity\nis equal or lower than the requested capacity.\n\n\nA controller that receives PVC update with previously unknown resourceName\nshould ignore the update for the purpose it was designed. For example - a controller that\nonly is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid\nresources associated with PVC.\n\n\nThis is an alpha field and requires enabling RecoverVolumeExpansionFailure feature."
type : object
capacity :
additionalProperties :
anyOf :
- type : integer
- type : string
pattern : ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string : true
description : capacity represents the actual resources of the underlying volume.
type : object
conditions :
description : |-
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'ResizeStarted'.
items :
description : PersistentVolumeClaimCondition contains details about state of pvc
properties :
lastProbeTime :
description : lastProbeTime is the time we probed the condition.
format : date-time
type : string
lastTransitionTime :
description : lastTransitionTime is the time the condition transitioned from one status to another.
format : date-time
type : string
message :
description : message is the human-readable message indicating details about last transition.
type : string
reason :
description : |-
reason is a unique, this should be a short, machine understandable string that gives the reason
for condition's last transition. If it reports "ResizeStarted" that means the underlying
persistent volume is being resized.
type : string
status :
type : string
type :
description : PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
type : string
required :
- status
- type
type : object
type : array
currentVolumeAttributesClassName :
description : |-
currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.
When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim
This is an alpha field and requires enabling VolumeAttributesClass feature.
type : string
modifyVolumeStatus :
description : |-
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
When this is unset, there is no ModifyVolume operation being attempted.
This is an alpha field and requires enabling VolumeAttributesClass feature.
properties :
status :
description : "status is the status of the ControllerModifyVolume operation. It can be in any of following states:\n - Pending\n Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as\n the specified VolumeAttributesClass not existing.\n - InProgress\n InProgress indicates that the volume is being modified.\n - Infeasible\n Infeasible indicates that the request has been rejected as invalid by the CSI driver. To\n\t resolve the error, a valid VolumeAttributesClass needs to be specified.\nNote: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately."
type : string
targetVolumeAttributesClassName :
description : targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
type : string
required :
- status
type : object
phase :
description : phase represents the current phase of PersistentVolumeClaim.
type : string
type : object
type : object
type : array
required :
- version
type : object
status :
description : LogstashStatus defines the observed state of Logstash
properties :
availableNodes :
format : int32
type : integer
elasticsearchAssociationsStatus :
additionalProperties :
description : AssociationStatus is the status of an association resource.
type : string
description : ElasticsearchAssociationStatus is the status of any auto-linking to Elasticsearch clusters.
type : object
expectedNodes :
format : int32
type : integer
health :
type : string
monitoringAssociationStatus :
additionalProperties :
description : AssociationStatus is the status of an association resource.
type : string
description : MonitoringAssociationStatus is the status of any auto-linking to monitoring Elasticsearch clusters.
type : object
observedGeneration :
description : |-
ObservedGeneration is the most recent generation observed for this Logstash instance.
It corresponds to the metadata generation, which is updated on mutation by the API Server.
If the generation observed in status diverges from the generation in metadata, the Logstash
controller has not yet processed the changes contained in the Logstash specification.
format : int64
type : integer
selector :
type : string
version :
description : |-
Version of the stack resource currently running. During version upgrades, multiple versions may run
in parallel : this value specifies the lowest version currently running.
type : string
required :
- selector
type : object
type : object
served : true
storage : true
subresources :
scale :
labelSelectorPath : .status.selector
specReplicasPath : .spec.count
statusReplicasPath : .status.expectedNodes
status : {}
---
# Source: eck-operator-crds/templates/all-crds.yaml
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
controller-gen.kubebuilder.io/version : v0.14.0
helm.sh/resource-policy : keep
labels :
app.kubernetes.io/instance : 'elastic-operator'
app.kubernetes.io/name : 'eck-operator-crds'
app.kubernetes.io/version : '2.13.0'
name : stackconfigpolicies.stackconfigpolicy.k8s.elastic.co
spec :
group : stackconfigpolicy.k8s.elastic.co
names :
categories :
- elastic
kind : StackConfigPolicy
listKind : StackConfigPolicyList
plural : stackconfigpolicies
shortNames :
- scp
singular : stackconfigpolicy
scope : Namespaced
versions :
- additionalPrinterColumns :
- description : Resources configured
jsonPath : .status.readyCount
name : Ready
type : string
- jsonPath : .status.phase
name : Phase
type : string
- jsonPath : .metadata.creationTimestamp
name : Age
type : date
name : v1alpha1
schema :
openAPIV3Schema :
description : StackConfigPolicy represents a StackConfigPolicy resource in a Kubernetes cluster.
properties :
apiVersion :
description : |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type : string
kind :
description : |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type : string
metadata :
type : object
spec :
properties :
elasticsearch :
properties :
clusterSettings :
description : ClusterSettings holds the Elasticsearch cluster settings (/_cluster/settings)
type : object
x-kubernetes-preserve-unknown-fields : true
config :
description : Config holds the settings that go into elasticsearch.yml.
type : object
x-kubernetes-preserve-unknown-fields : true
indexLifecyclePolicies :
description : IndexLifecyclePolicies holds the Index Lifecycle policies settings (/_ilm/policy)
type : object
x-kubernetes-preserve-unknown-fields : true
indexTemplates :
description : IndexTemplates holds the Index and Component Templates settings
properties :
componentTemplates :
description : ComponentTemplates holds the Component Templates settings (/_component_template)
type : object
x-kubernetes-preserve-unknown-fields : true
composableIndexTemplates :
description : ComposableIndexTemplates holds the Index Templates settings (/_index_template)
type : object
x-kubernetes-preserve-unknown-fields : true
type : object
x-kubernetes-preserve-unknown-fields : true
ingestPipelines :
description : IngestPipelines holds the Ingest Pipelines settings (/_ingest/pipeline)
type : object
x-kubernetes-preserve-unknown-fields : true
secretMounts :
description : SecretMounts are additional Secrets that need to be mounted into the Elasticsearch pods.
items :
description : SecretMount contains information about additional secrets to be mounted to the elasticsearch pods
properties :
mountPath :
description : MountPath denotes the path to which the secret should be mounted to inside the elasticsearch pod
type : string
secretName :
description : SecretName denotes the name of the secret that needs to be mounted to the elasticsearch pod
type : string
type : object
type : array
x-kubernetes-preserve-unknown-fields : true
secureSettings :
description : SecureSettings are additional Secrets that contain data to be configured to Elasticsearch's keystore.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
description : |-
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.
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
description : |-
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.
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
x-kubernetes-preserve-unknown-fields : true
securityRoleMappings :
description : SecurityRoleMappings holds the Role Mappings settings (/_security/role_mapping)
type : object
x-kubernetes-preserve-unknown-fields : true
snapshotLifecyclePolicies :
description : SnapshotLifecyclePolicies holds the Snapshot Lifecycle Policies settings (/_slm/policy)
type : object
x-kubernetes-preserve-unknown-fields : true
snapshotRepositories :
description : SnapshotRepositories holds the Snapshot Repositories settings (/_snapshot)
type : object
x-kubernetes-preserve-unknown-fields : true
type : object
kibana :
properties :
config :
description : Config holds the settings that go into kibana.yml.
type : object
x-kubernetes-preserve-unknown-fields : true
secureSettings :
description : SecureSettings are additional Secrets that contain data to be configured to Kibana's keystore.
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
description : |-
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.
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
description : |-
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.
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
x-kubernetes-preserve-unknown-fields : true
type : object
resourceSelector :
description : |-
A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects.
properties :
matchExpressions :
description : matchExpressions is a list of label selector requirements. The requirements are ANDed.
items :
description : |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
properties :
key :
description : key is the label key that the selector applies to.
type : string
operator :
description : |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
type : string
values :
description : |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
type : object
type : object
x-kubernetes-map-type : atomic
secureSettings :
description: 'Deprecated : SecureSettings only applies to Elasticsearch and is deprecated. It must be set per application instead.'
items :
description : SecretSource defines a data source based on a Kubernetes Secret.
properties :
entries :
description : |-
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.
items :
description : KeyToPath defines how to map a key in a Secret object to a filesystem path.
properties :
key :
description : Key is the key contained in the secret.
type : string
path :
description : |-
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.
type : string
required :
- key
type : object
type : array
secretName :
description : SecretName is the name of the secret.
type : string
required :
- secretName
type : object
type : array
type : object
status :
properties :
details :
additionalProperties :
additionalProperties :
description : ResourcePolicyStatus models the status of the policy for one resource to be configured.
properties :
currentVersion :
description : |-
CurrentVersion denotes the current version of filesettings applied to the Elasticsearch cluster
This field does not apply to Kibana resources
format : int64
type : integer
error :
properties :
message :
type : string
version :
format : int64
type : integer
type : object
expectedVersion :
description : |-
ExpectedVersion denotes the expected version of filesettings that should be applied to the Elasticsearch cluster
This field does not apply to Kibana resources
format : int64
type : integer
phase :
type : string
type : object
type : object
description : Details holds the status details for each resource to be configured.
type : object
errors :
description : Errors is the number of resources which have an incorrect configuration
type : integer
observedGeneration :
description : ObservedGeneration is the most recent generation observed for this StackConfigPolicy.
format : int64
type : integer
phase :
description : Phase is the phase of the StackConfigPolicy.
type : string
ready :
description : Ready is the number of resources successfully configured.
type : integer
readyCount :
description : ReadyCount is a human representation of the number of resources successfully configured.
type : string
resources :
description : Resources is the number of resources to be configured.
type : integer
resourcesStatuses :
additionalProperties :
description : ResourcePolicyStatus models the status of the policy for one resource to be configured.
properties :
currentVersion :
description : |-
CurrentVersion denotes the current version of filesettings applied to the Elasticsearch cluster
This field does not apply to Kibana resources
format : int64
type : integer
error :
properties :
message :
type : string
version :
format : int64
type : integer
type : object
expectedVersion :
description : |-
ExpectedVersion denotes the expected version of filesettings that should be applied to the Elasticsearch cluster
This field does not apply to Kibana resources
format : int64
type : integer
phase :
type : string
type : object
description : |-
ResourcesStatuses holds the status for each resource to be configured.
Deprecated : Details is used to store the status of resources from ECK 2.11
type : object
type : object
type : object
served : true
storage : true
subresources :
status : {}
2022-08-30 12:29:05 +00:00
