package v1
- Alphabetic
- Public
- All
Type Members
-
case class
Endpoint(addresses: Vector[String], conditions: Optional[EndpointConditions] = Optional.Absent, deprecatedTopology: Optional[Map[String, String]] = Optional.Absent, hints: Optional[EndpointHints] = Optional.Absent, hostname: Optional[String] = Optional.Absent, nodeName: Optional[String] = Optional.Absent, targetRef: Optional[ObjectReference] = Optional.Absent, zone: Optional[String] = Optional.Absent) extends Product with Serializable
Endpoint represents a single logical "backend" implementing a service.
Endpoint represents a single logical "backend" implementing a service.
- 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.
- deprecatedTopology
deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.
- 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.
- zone
zone is the name of the Zone this endpoint exists in.
-
case class
EndpointConditions(ready: Optional[Boolean] = Optional.Absent, serving: Optional[Boolean] = Optional.Absent, terminating: Optional[Boolean] = Optional.Absent) extends Product with Serializable
EndpointConditions represents the current condition of an endpoint.
EndpointConditions represents the current condition of an endpoint.
- 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.
- class EndpointConditionsFields extends AnyRef
- class EndpointFields extends AnyRef
-
case class
EndpointHints(forZones: Optional[Vector[ForZone]] = Optional.Absent) extends Product with Serializable
EndpointHints provides hints describing how an endpoint should be consumed.
EndpointHints provides hints describing how an endpoint should be consumed.
- forZones
forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.
- class EndpointHintsFields extends AnyRef
-
case class
EndpointPort(appProtocol: Optional[String] = Optional.Absent, name: Optional[String] = Optional.Absent, port: Optional[Int] = Optional.Absent, protocol: Optional[String] = Optional.Absent) extends Product with Serializable
EndpointPort represents a Port used by an EndpointSlice
EndpointPort represents a Port used by an EndpointSlice
- 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.
- class EndpointPortFields extends AnyRef
-
case class
EndpointSlice(addressType: String, endpoints: Vector[Endpoint], metadata: Optional[ObjectMeta] = Optional.Absent, ports: Optional[Vector[EndpointPort]] = Optional.Absent) extends Product with Serializable
EndpointSlice represents a subset of the endpoints that implement a service.
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.
- 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.
- class EndpointSliceFields extends AnyRef
-
case class
ForZone(name: String) extends Product with Serializable
ForZone provides information about which zones should consume this endpoint.
ForZone provides information about which zones should consume this endpoint.
- name
name represents the name of the zone.
- class ForZoneFields extends AnyRef
Value Members
- object Endpoint extends EndpointFields with Serializable
- object EndpointConditions extends EndpointConditionsFields with Serializable
- object EndpointHints extends EndpointHintsFields with Serializable
- object EndpointPort extends EndpointPortFields with Serializable
- object EndpointSlice extends EndpointSliceFields with Serializable
- object ForZone extends ForZoneFields with Serializable