com.coralogix.zio.k8s.model.discovery.v1beta1

Type members

Classlikes

case class Endpoint(addresses: Vector[String], conditions: Optional[EndpointConditions], hostname: Optional[String], nodeName: Optional[String], targetRef: Optional[ObjectReference], topology: Optional[Map[String, String]])

Endpoint represents a single logical "backend" implementing a service.

Endpoint represents a single logical "backend" implementing a service.

Value Params
addresses

addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.

hostname

hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.

nodeName

nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.

topology

topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/zone: the value indicates the zone where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/region: the value indicates the region where the endpoint is located. This should match the corresponding node label. This field is deprecated and will be removed in future api versions.

Companion
object
object Endpoint extends EndpointFields
Companion
class
case class EndpointConditions(ready: Optional[Boolean], serving: Optional[Boolean], terminating: Optional[Boolean])

EndpointConditions represents the current condition of an endpoint.

EndpointConditions represents the current condition of an endpoint.

Value Params
ready

ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints.

serving

serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

terminating

terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

Companion
object
class EndpointConditionsFields(_prefix: Chunk[String])
class EndpointFields(_prefix: Chunk[String])
case class EndpointPort(appProtocol: Optional[String], name: Optional[String], port: Optional[Int], protocol: Optional[String])

EndpointPort represents a Port used by an EndpointSlice

EndpointPort represents a Port used by an EndpointSlice

Value Params
appProtocol

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 http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.

name

The name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.

port

The port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.

protocol

The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

Companion
object
Companion
class
class EndpointPortFields(_prefix: Chunk[String])
case class EndpointSlice(addressType: String, endpoints: Vector[Endpoint], metadata: Optional[ObjectMeta], ports: Optional[Vector[EndpointPort]])

EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints.

EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints.

Value Params
addressType

addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.

endpoints

endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.

ports

ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.

Companion
object
Companion
class
class EndpointSliceFields(_prefix: Chunk[String])