Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: service.kubernetes.io/topology-aware-hints #38997

Merged
merged 6 commits into from
Aug 11, 2023
Merged

docs: service.kubernetes.io/topology-aware-hints #38997

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c7a4fe6
docs: service.kubernetes.io/topology-aware-hints
sergeyshevch Jan 19, 2023
2692020
Update content/en/docs/reference/labels-annotations-taints/_index.md
sergeyshevch Jan 20, 2023
c9402a6
Update content/en/docs/reference/labels-annotations-taints/_index.md
sergeyshevch Aug 2, 2023
05b7198
Update content/en/docs/reference/labels-annotations-taints/_index.md
sergeyshevch Aug 2, 2023
02a2ce5
Update content/en/docs/reference/labels-annotations-taints/_index.md
sergeyshevch Aug 2, 2023
ca5dc47
Update content/en/docs/reference/labels-annotations-taints/_index.md
sergeyshevch Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/en/docs/reference/labels-annotations-taints/_index.md
View file
Open in desktop
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