Skip to content

Commit

Permalink
Merge pull request #38997 from sergeyshevch/feature/topology-aware-hi…
Browse files Browse the repository at this point in the history
…nts-well-known-label

docs: service.kubernetes.io/topology-aware-hints
  • Loading branch information
k8s-ci-robot authored Aug 11, 2023
2 parents 4410c5f + ca5dc47 commit be0301a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions content/en/docs/reference/labels-annotations-taints/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,26 @@ Used on: Service

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

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

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

Used on: Service

This annotation was used for enabling _topology aware hints_ on Services. Topology aware
hints have since been renamed: the concept is now called
[topology aware routing](/docs/concepts/services-networking/topology-aware-routing/).
Setting the annotation to `Auto`, on a Service, configured the Kubernetes control plane to
add topology hints on EndpointSlices associated with that Service. You can also explicitly
set the annotation to `Disabled`.

If you are running a version of Kubernetes older than {{< skew currentVersion >}},
check the documentation for that Kubernetes version to see how topology aware routing
works in that release.

There are no other valid values for this annotation. If you don't want topology aware hints
for a Service, don't add this annotation.

### kubernetes.io/service-name {#kubernetesioservice-name}

Type: Label
Expand Down

0 comments on commit be0301a

Please sign in to comment.