description:Agent is the Schema for the Agents 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: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:
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.
properties:
secretName:
description:SecretName is the name of the secret.
type:string
type:object
daemonSet:
description:DaemonSet specifies the Agent should be deployed as a DaemonSet, and allows providing its spec. Cannot be used along with `deployment`.
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:
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'
properties:
maxSurge:
anyOf:
- type:integer
- type:string
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. This is beta field and enabled/disabled by DaemonSetUpdateSurge feature gate.'
x-kubernetes-int-or-string:true
maxUnavailable:
anyOf:
- type:integer
- type:string
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.'
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:
description:Deployment specifies the Agent should be deployed as a Deployment, and allows providing its spec. Cannot be used along with `daemonSet`.
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:
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.'
properties:
maxSurge:
anyOf:
- type:integer
- type:string
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.'
x-kubernetes-int-or-string:true
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 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.'
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:
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.
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:
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). 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
fleetServerEnabled:
description:FleetServerEnabled determines whether this Agent will launch Fleet Server. Don't set unless `mode` is set to `fleet`.
type:boolean
fleetServerRef:
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`.
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). 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
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
image:
description:Image is the Agent Docker image to deploy. Version has to match the Agent in the image.
type:string
kibanaRef:
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`.
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). 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
mode:
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.
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.
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 an Elasticsearch resource in a different namespace. Can only be used if ECK is enforcing RBAC on references.
type:string
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
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
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:
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.
format:int64
type:integer
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.'
description:ApmServer represents an APM Server 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: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:
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). 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
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
image:
description:Image is the APM Server Docker image to deploy.
type:string
kibanaRef:
description:KibanaRef is a reference to a Kibana instance running in the same Kubernetes cluster. It allows APM agent central configuration management in Kibana.
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). 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
podTemplate:
description:PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the APM Server pods.
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:
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 a resource (for ex. Elasticsearch) in a different namespace. Can only be used if ECK is enforcing RBAC on references.
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.
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.
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:
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
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:
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: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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
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:
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
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
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: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:
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.
properties:
secretName:
description:SecretName is the name of the secret.
type:string
type:object
daemonSet:
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.
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:
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'
properties:
maxSurge:
anyOf:
- type:integer
- type:string
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. This is beta field and enabled/disabled by DaemonSetUpdateSurge feature gate.'
x-kubernetes-int-or-string:true
maxUnavailable:
anyOf:
- type:integer
- type:string
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.'
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:
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.
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:
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.'
properties:
maxSurge:
anyOf:
- type:integer
- type:string
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.'
x-kubernetes-int-or-string:true
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 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.'
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:
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). 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
image:
description:Image is the Beat Docker image to deploy. Version and Type have to match the Beat in the image.
type:string
kibanaRef:
description:KibanaRef is a reference to a Kibana instance running in the same Kubernetes cluster. It allows automatic setup of dashboards and visualizations.
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). 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.
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.
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
type:
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`.
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.
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.
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.'
description:ElasticMapsServer represents an Elastic Map Server 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: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:
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`.
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:
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). 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
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
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
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.
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.
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.
description:Selector is the label selector used to find all pods.
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.'
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
image:
description:Image is the Elasticsearch Docker image to deploy.
type:string
monitoring:
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.
properties:
logs:
description:Logs holds references to Elasticsearch clusters which receive log data from this Elasticsearch cluster.
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). 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 Elasticsearch cluster.
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). 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
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:
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.
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:
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.
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'
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'
description: 'accessModes contains the desired access modes the volume should have. More info:https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
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. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.'
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
description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local 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, 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. There are two 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. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.'
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
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'
description: 'Limits describes the maximum amount of compute resources allowed. More info:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
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. More info:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
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.
description: 'storageClassName is the name of the StorageClass required by the claim. More info:https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
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'
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'
description:allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
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'.
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.
description:resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
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).
properties:
metadata:
description:ObjectMeta is the metadata of the PDB. 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 PDB.
properties:
maxUnavailable:
anyOf:
- type:integer
- type:string
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".
x-kubernetes-int-or-string:true
minAvailable:
anyOf:
- type:integer
- type:string
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%".
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.
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.
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:
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
name:
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.
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:
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 a resource (for ex. a remote Elasticsearch cluster) in a different namespace. Can only be used if ECK is enforcing RBAC on references.
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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 on the transport layer.
properties:
certificate:
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: \n - `ca.crt`: The CA certificate in PEM format. - `ca.key`: The private key for the CA certificate in PEM format."
properties:
secretName:
description:SecretName is the name of the secret.
type:string
type:object
otherNameSuffix:
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".'
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:
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.
format:int32
type:integer
maxUnavailable:
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.
format:int32
type:integer
type:object
type:object
version:
description:Version of Elasticsearch.
type:string
volumeClaimDeletePolicy:
description:VolumeClaimDeletePolicy sets the policy for handling deletion of PersistentVolumeClaims for all NodeSets. Possible values are DeleteOnScaledownOnly and DeleteOnScaledownAndClusterDeletion. Defaults to DeleteOnScaledownAndClusterDeletion.
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:
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.**
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
health:
description:ElasticsearchHealth is the health of the cluster as returned by the health API.
type:string
inProgressOperations:
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.**
properties:
downscale:
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.**
properties:
lastUpdatedTime:
format:date-time
type:string
nodes:
description:Nodes which are scheduled to be removed from the cluster.
items:
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.**
properties:
explanation:
description:Explanation provides details about an in progress node shutdown. It is only available for clusters managed with the Elasticsearch shutdown API.
type:string
name:
description:Name of the Elasticsearch node that should be removed.
type:string
shutdownStatus:
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.
type:string
required:
- name
- shutdownStatus
type:object
type:array
stalled:
description:Stalled represents a state where no progress can be made. It is only available for clusters managed with the Elasticsearch shutdown API.
type:boolean
type:object
upgrade:
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.**
properties:
lastUpdatedTime:
format:date-time
type:string
nodes:
description:Nodes that must be restarted for upgrade.
items:
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.**
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:
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.
type:string
required:
- name
- status
type:object
type:array
type:object
upscale:
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.**
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
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
observedGeneration:
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.
format:int64
type:integer
phase:
description:ElasticsearchOrchestrationPhase is the phase Elasticsearch is in from the controller point of view.
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
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:
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
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:
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.
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'
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'
description: 'accessModes contains the desired access modes the volume should have. More info:https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
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. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.'
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
description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local 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, 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. There are two 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. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.'
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
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'
description: 'Limits describes the maximum amount of compute resources allowed. More info:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
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. More info:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
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.
description: 'storageClassName is the name of the StorageClass required by the claim. More info:https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
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'
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'
description:allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
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'.
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.
description:resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
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).
properties:
metadata:
description:ObjectMeta is the metadata of the PDB. 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 PDB.
properties:
maxUnavailable:
anyOf:
- type:integer
- type:string
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".
x-kubernetes-int-or-string:true
minAvailable:
anyOf:
- type:integer
- type:string
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%".
x-kubernetes-int-or-string:true
selector:
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.
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.
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:
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
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:
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.
format:int32
type:integer
maxUnavailable:
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.
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
description:EnterpriseSearch is a Kubernetes CRD to represent Enterprise Search.
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: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:
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`.
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:
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). 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
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
image:
description:Image is the Enterprise Search Docker image to deploy.
type:string
podTemplate:
description:PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Enterprise Search pods.
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.
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.
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.
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:
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
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:
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: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:
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`.
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:
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). 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
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
image:
description:Image is the Enterprise Search Docker image to deploy.
type:string
podTemplate:
description:PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Enterprise Search pods.
type:object
x-kubernetes-preserve-unknown-fields:true
serviceAccountName:
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.
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:
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.'
description:Kibana represents a Kibana 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: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:
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). 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
enterpriseSearchRef:
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.
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). 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
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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
image:
description:Image is the Kibana Docker image to deploy.
type:string
monitoring:
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.
properties:
logs:
description:Logs holds references to Elasticsearch clusters which will receive log data from this Kibana.
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). 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 will receive monitoring data from this Kibana.
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). 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
podTemplate:
description:PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the Kibana pods
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:
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 a resource (for ex. Elasticsearch) in a different namespace. Can only be used if ECK is enforcing RBAC on references.
type:string
version:
description:Version of Kibana.
type:string
required:
- version
type:object
status:
description:KibanaStatus defines the observed state of Kibana
properties:
associationStatus:
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.
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:
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.
format:int64
type:integer
selector:
description:Selector is the label selector used to find all pods.
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
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:
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: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:
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.
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.
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. \n 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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
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).
format:int32
type:integer
internalTrafficPolicy:
description:InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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. \n 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.
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, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version.'
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.
description:The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
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: \n - `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
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:
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
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
