Skip to content

Commit be0301a

Browse files
authored
Merge pull request #38997 from sergeyshevch/feature/topology-aware-hints-well-known-label
docs: service.kubernetes.io/topology-aware-hints
2 parents 4410c5f + ca5dc47 commit be0301a

File tree

1 file changed

+20
-0
lines changed
  • content/en/docs/reference/labels-annotations-taints

1 file changed

+20
-0
lines changed

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -883,6 +883,26 @@ Used on: Service
883883

884884
The control plane adds this label to an Endpoints object when the owning Service is headless.
885885

886+
### service.kubernetes.io/topology-aware-hints (deprecated) {#servicekubernetesiotopology-aware-hints}
887+
888+
Example: `service.kubernetes.io/topology-aware-hints: "Auto"`
889+
890+
Used on: Service
891+
892+
This annotation was used for enabling _topology aware hints_ on Services. Topology aware
893+
hints have since been renamed: the concept is now called
894+
[topology aware routing](/docs/concepts/services-networking/topology-aware-routing/).
895+
Setting the annotation to `Auto`, on a Service, configured the Kubernetes control plane to
896+
add topology hints on EndpointSlices associated with that Service. You can also explicitly
897+
set the annotation to `Disabled`.
898+
899+
If you are running a version of Kubernetes older than {{< skew currentVersion >}},
900+
check the documentation for that Kubernetes version to see how topology aware routing
901+
works in that release.
902+
903+
There are no other valid values for this annotation. If you don't want topology aware hints
904+
for a Service, don't add this annotation.
905+
886906
### kubernetes.io/service-name {#kubernetesioservice-name}
887907

888908
Type: Label

0 commit comments

Comments
 (0)