EndpointSubset

io.k8s.api.core.v1.EndpointSubset source ↗

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:

{ Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }

The resulting set of endpoints can be viewed as:

a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]

Deprecated: This API is deprecated in v1.33+.

addresses[]EndpointAddressIP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
hostnamestringThe Hostname of this endpoint
ipstring requiredThe IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
nodeNamestringOptional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
targetRefObjectReferenceReference to object providing the endpoint.
apiVersionstringAPI version of the referent.
fieldPathstringIf referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kindstringKind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespacestringNamespace of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersionstringSpecific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uidstringUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
notReadyAddresses[]EndpointAddressIP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
hostnamestringThe Hostname of this endpoint
ipstring requiredThe IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
nodeNamestringOptional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
targetRefObjectReferenceReference to object providing the endpoint.
apiVersionstringAPI version of the referent.
fieldPathstringIf referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kindstringKind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespacestringNamespace of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersionstringSpecific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uidstringUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
ports[]EndpointPortPort numbers available on the related IP addresses.
appProtocolstringThe application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
  • Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
namestringThe name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
portinteger (int32) requiredThe port number of the endpoint.
protocolstringThe IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.