Skip to content

Commit d08777d

Browse files
authored
Merge pull request #53219 from danwinship/endpoints-labels
Misc updates to endpoint-related annotation/label docs
2 parents c409ea1 + c678228 commit d08777d

File tree

1 file changed

+36
-28
lines changed
  • content/en/docs/reference/labels-annotations-taints

1 file changed

+36
-28
lines changed

content/en/docs/reference/labels-annotations-taints/_index.md

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -749,13 +749,13 @@ There are two possible values:
749749

750750
Type: Annotation
751751

752-
Used on: StatefulSet
752+
Used on: Service
753753

754-
This annotation on a Service denotes if the Endpoints controller should go ahead and create
755-
Endpoints for unready Pods. Endpoints of these Services retain their DNS records and continue
756-
receiving traffic for the Service from the moment the kubelet starts all containers in the pod
757-
and marks it _Running_, til the kubelet stops all containers and deletes the pod from
758-
the API server.
754+
This annotation was formerly used to indicate that the Endpoints controller
755+
should create Endpoints for unready Pods. Since Kubernetes 1.11, the preferred
756+
API for this feature has been the `.publishNotReadyAddresses` field on the
757+
{{< glossary_tooltip term_id="service" >}}. This annotation has no effect in
758+
Kubernetes {{< skew currentVersion >}}.
759759

760760
### autoscaling.alpha.kubernetes.io/behavior (deprecated) {#autoscaling-alpha-kubernetes-io-behavior}
761761

@@ -1230,30 +1230,24 @@ Type: Label
12301230
12311231
Example: `service.kubernetes.io/headless: ""`
12321232

1233-
Used on: Endpoints
1233+
Used on: EndpointSlice, Endpoints
12341234

1235-
The control plane adds this label to an Endpoints object when the owning Service is headless.
1236-
To learn more, read [Headless Services](/docs/concepts/services-networking/service/#headless-services).
1235+
The {{< glossary_tooltip term_id="control-plane" text="control plane" >}} adds
1236+
this {{< glossary_tooltip term_id="label" text="label" >}} to EndpointSlice and
1237+
Endpoints objects when the owning {{< glossary_tooltip term_id="service" >}} is
1238+
headless (as a hint to the service proxy that it can ignore these endpoints). To
1239+
learn more, read [Headless
1240+
Services](/docs/concepts/services-networking/service/#headless-services).
12371241

12381242
### service.kubernetes.io/topology-aware-hints (deprecated) {#servicekubernetesiotopology-aware-hints}
12391243

12401244
Example: `service.kubernetes.io/topology-aware-hints: "Auto"`
12411245

12421246
Used on: Service
12431247

1244-
This annotation was used for enabling _topology aware hints_ on Services. Topology aware
1245-
hints have since been renamed: the concept is now called
1246-
[topology aware routing](/docs/concepts/services-networking/topology-aware-routing/).
1247-
Setting the annotation to `Auto`, on a Service, configured the Kubernetes control plane to
1248-
add topology hints on EndpointSlices associated with that Service. You can also explicitly
1249-
set the annotation to `Disabled`.
1250-
1251-
If you are running a version of Kubernetes older than {{< skew currentVersion >}},
1252-
check the documentation for that Kubernetes version to see how topology aware routing
1253-
works in that release.
1254-
1255-
There are no other valid values for this annotation. If you don't want topology aware hints
1256-
for a Service, don't add this annotation.
1248+
This is a deprecated alias for the
1249+
[`service.kubernetes.io/topology-mode`](#service-kubernetes-io-topology-mode)
1250+
annotation, which has the same functionality.
12571251

12581252
### service.kubernetes.io/topology-mode
12591253

@@ -1578,11 +1572,11 @@ a separate change could have been made since the last manually triggered rollout
15781572
If you manually set this annotation on a Pod, nothing happens. The restarting side effect comes from
15791573
how workload management and Pod templating works.
15801574

1581-
### endpoints.kubernetes.io/over-capacity
1575+
### endpoints.kubernetes.io/over-capacity (deprecated) {#endpoints-kubernetes-io-over-capacity}
15821576

15831577
Type: Annotation
15841578

1585-
Example: `endpoints.kubernetes.io/over-capacity:truncated`
1579+
Example: `endpoints.kubernetes.io/over-capacity: truncated`
15861580

15871581
Used on: Endpoints
15881582

@@ -1594,7 +1588,14 @@ has been truncated to 1000.
15941588

15951589
If the number of backend endpoints falls below 1000, the control plane removes this annotation.
15961590

1597-
### endpoints.kubernetes.io/last-change-trigger-time
1591+
{{< note >}}
1592+
The [Endpoints](/docs/reference/kubernetes-api/service-resources/endpoints-v1/)
1593+
API is deprecated in favor of
1594+
[EndpointSlice](/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1/).
1595+
A Service can have multiple EndpointSlice objects. As a result, EndpointSlices do not require truncation.
1596+
{{< /note >}}
1597+
1598+
### endpoints.kubernetes.io/last-change-trigger-time (deprecated) {#endpoints-kubernetes-io-last-change-trigger-time}
15981599

15991600
Type: Annotation
16001601

@@ -1606,6 +1607,12 @@ This annotation set to an [Endpoints](/docs/concepts/services-networking/service
16061607
represents the timestamp (The timestamp is stored in RFC 3339 date-time string format. For example, '2018-10-22T19:32:52.1Z'). This is timestamp
16071608
of the last change in some Pod or Service object, that triggered the change to the Endpoints object.
16081609

1610+
{{< note >}}
1611+
The [Endpoints](/docs/reference/kubernetes-api/service-resources/endpoints-v1/)
1612+
API is deprecated in favor of
1613+
[EndpointSlice](/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1/).
1614+
{{< /note >}}
1615+
16091616
### control-plane.alpha.kubernetes.io/leader (deprecated) {#control-plane-alpha-kubernetes-io-leader}
16101617

16111618
Type: Annotation
@@ -1614,9 +1621,10 @@ Example: `control-plane.alpha.kubernetes.io/leader={"holderIdentity":"controller
16141621

16151622
Used on: Endpoints
16161623

1617-
The {{< glossary_tooltip text="control plane" term_id="control-plane" >}} previously set annotation on
1618-
an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object. This annotation provided
1619-
the following detail:
1624+
The {{< glossary_tooltip text="control plane" term_id="control-plane" >}} previously used
1625+
an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object to
1626+
coordinate leader assignment for the Kubernetes control plane. This Endpoints
1627+
object included an annotation with the following detail:
16201628

16211629
- Who is the current leader.
16221630
- The time when the current leadership was acquired.

0 commit comments

Comments
 (0)