A newer version is available. For the latest information, see the current release documentation.

« apm.k8s.elastic.co/v1beta1 common.k8s.elastic.co/v1beta1 »

› ›

common.k8s.elastic.co/v1

edit

common.k8s.elastic.co/v1

edit

Package v1 contains API schema definitions for common types used by all resources.

Config

edit

Config represents untyped YAML configuration.

Field	Description
`Data` map[string]interface{}	Data holds the configuration keys and values. This field exists to work around https://github.com/kubernetes-sigs/kubebuilder/issues/528

HTTPConfig

edit

HTTPConfig holds the HTTP layer configuration for resources.

Field	Description
`service` ServiceTemplate	Service defines the template for the associated Kubernetes Service object.
`tls` TLSOptions	TLS defines options for configuring TLS for HTTP.

KeyToPath

edit

KeyToPath defines how to map a key in a Secret object to a filesystem path.

Field	Description
`key` string	Key is the key contained in the secret.
`path` string	Path is the relative file path to map the key to. Path must not be an absolute file path and must not contain any ".." components.

ObjectSelector

edit

ObjectSelector defines a reference to a Kubernetes object.

Field	Description
`name` string	Name of the Kubernetes object.
`namespace` string	Namespace of the Kubernetes object. If empty, defaults to the current namespace.

PodDisruptionBudgetTemplate

edit

PodDisruptionBudgetTemplate defines the template for creating a PodDisruptionBudget.

Field Description

Field	Description
`metadata` Kubernetes meta/v1.ObjectMeta	ObjectMeta is the metadata of the PDB. The name and namespace provided here are managed by ECK and will be ignored. Refer to the Kubernetes API documentation for the fields of the `metadata` field.
`spec` Kubernetes policy/v1beta1.PodDisruptionBudgetSpec	Spec is the specification of the PDB. `minAvailable` Kubernetes intstr.IntOrString (Optional) 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%". `selector` Kubernetes meta/v1.LabelSelector (Optional) Label query over pods whose evictions are managed by the disruption budget. `maxUnavailable` Kubernetes intstr.IntOrString (Optional) 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".

metadata
Kubernetes meta/v1.ObjectMeta

ObjectMeta is the metadata of the PDB. The name and namespace provided here are managed by ECK and will be ignored. Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Kubernetes policy/v1beta1.PodDisruptionBudgetSpec

Spec is the specification of the PDB.

minAvailable Kubernetes intstr.IntOrString: (Optional) 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%".
selector Kubernetes meta/v1.LabelSelector: (Optional) Label query over pods whose evictions are managed by the disruption budget.
maxUnavailable Kubernetes intstr.IntOrString: (Optional) 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".

SecretRef

edit

SecretRef is a reference to a secret that exists in the same namespace.

Field	Description
`secretName` string	SecretName is the name of the secret.

SecretSource

edit

SecretSource defines a data source based on a Kubernetes Secret.

Field	Description
`secretName` string	SecretName is the name of the secret.
`entries` []KeyToPath	Entries define how to project each key-value pair in the secret to filesystem paths. If not defined, all keys will be projected to similarly named paths in the filesystem. If defined, only the specified keys will be projected to the corresponding paths.

SelfSignedCertificate

edit

SelfSignedCertificate holds configuration for the self-signed certificate generated by the operator.

Field	Description
`subjectAltNames` []SubjectAlternativeName	SubjectAlternativeNames is a list of SANs to include in the generated HTTP TLS certificate.
`disabled` bool	Disabled indicates that the provisioning of the self-signed certifcate should be disabled.

ServiceTemplate

edit

ServiceTemplate defines the template for a Kubernetes Service.

Field Description

Field	Description
`metadata` Kubernetes meta/v1.ObjectMeta	ObjectMeta is the metadata of the service. The name and namespace provided here are managed by ECK and will be ignored. Refer to the Kubernetes API documentation for the fields of the `metadata` field.
`spec` Kubernetes core/v1.ServiceSpec	Spec is the specification of the service. `ports` []Kubernetes core/v1.ServicePort 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 `selector` map[string]string (Optional) 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/ `clusterIP` string (Optional) clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies `type` Kubernetes core/v1.ServiceType (Optional) type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "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. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types `externalIPs` []string (Optional) 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. `sessionAffinity` Kubernetes core/v1.ServiceAffinity (Optional) 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 `loadBalancerIP` string (Optional) Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. 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. `loadBalancerSourceRanges` []string (Optional) 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/configure-cloud-provider-firewall/ `externalName` string (Optional) externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName. `externalTrafficPolicy` Kubernetes core/v1.ServiceExternalTrafficPolicyType (Optional) 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. `healthCheckNodePort` int32 (Optional) healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local. `publishNotReadyAddresses` bool (Optional) publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet’s Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. `sessionAffinityConfig` Kubernetes core/v1.SessionAffinityConfig (Optional) sessionAffinityConfig contains the configurations of session affinity. `ipFamily` Kubernetes core/v1.IPFamily (Optional) ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is available in the cluster. If no IP family is requested, the cluster’s primary IP family will be used. Other IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which allocate external load-balancers should use the same IP family. Endpoints for this Service will be of this family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the cluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment.

metadata
Kubernetes meta/v1.ObjectMeta

ObjectMeta is the metadata of the service. The name and namespace provided here are managed by ECK and will be ignored. Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Kubernetes core/v1.ServiceSpec

Spec is the specification of the service.

ports []Kubernetes core/v1.ServicePort: 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
selector map[string]string: (Optional) 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/
clusterIP string: (Optional) clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
type Kubernetes core/v1.ServiceType: (Optional) type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "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. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
externalIPs []string: (Optional) 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.
sessionAffinity Kubernetes core/v1.ServiceAffinity: (Optional) 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
loadBalancerIP string: (Optional) Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. 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.
loadBalancerSourceRanges []string: (Optional) 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/configure-cloud-provider-firewall/
externalName string: (Optional) externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.
externalTrafficPolicy Kubernetes core/v1.ServiceExternalTrafficPolicyType: (Optional) 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.
healthCheckNodePort int32: (Optional) healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.
publishNotReadyAddresses bool: (Optional) publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet’s Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery.
sessionAffinityConfig Kubernetes core/v1.SessionAffinityConfig: (Optional) sessionAffinityConfig contains the configurations of session affinity.
ipFamily Kubernetes core/v1.IPFamily: (Optional) ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is available in the cluster. If no IP family is requested, the cluster’s primary IP family will be used. Other IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which allocate external load-balancers should use the same IP family. Endpoints for this Service will be of this family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the cluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment.

SubjectAlternativeName

edit

SubjectAlternativeName represents a SAN entry in a x509 certificate.

Field	Description
`dns` string	DNS is the DNS name of the subject.
`ip` string	IP is the IP address of the subject.

TLSOptions

edit

TLSOptions holds TLS configuration options.

Field	Description
`selfSignedCertificate` SelfSignedCertificate	SelfSignedCertificate allows configuring the self-signed certificate generated by the operator.
`certificate` SecretRef	Certificate is a reference to a Kubernetes secret that contains the certificate and private key for enabling TLS. The referenced secret should contain the following: `ca.crt`: The certificate authority (optional). `tls.crt`: The certificate (or a chain). `tls.key`: The private key to the first certificate in the certificate chain.

« apm.k8s.elastic.co/v1beta1 common.k8s.elastic.co/v1beta1 »