From c7a4fe6fafa99d5773cea6dc89ebf6bcb42726ef Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Thu, 19 Jan 2023 16:17:38 +0200 Subject: [PATCH 1/6] docs: service.kubernetes.io/topology-aware-hints --- .../en/docs/reference/labels-annotations-taints/_index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/en/docs/reference/labels-annotations-taints/_index.md b/content/en/docs/reference/labels-annotations-taints/_index.md index b2c0ec9aec086..2ec7f59b56473 100644 --- a/content/en/docs/reference/labels-annotations-taints/_index.md +++ b/content/en/docs/reference/labels-annotations-taints/_index.md @@ -883,6 +883,14 @@ 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 {#servicekubernetesiotopology-aware-hints} + +Example: `service.kubernetes.io/topology-aware-hints: "auto"` + +Used on: Service + +This annotation is used for enabling [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints/) for a service. This tells the EndpointSlice controller to set topology hints if it is deemed safe. + ### kubernetes.io/service-name {#kubernetesioservice-name} Type: Label From 2692020d98d960aeb0c208c894aa7312771b8618 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Fri, 20 Jan 2023 12:30:06 +0200 Subject: [PATCH 2/6] Update content/en/docs/reference/labels-annotations-taints/_index.md Co-authored-by: Tim Bannister --- .../en/docs/reference/labels-annotations-taints/_index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/labels-annotations-taints/_index.md b/content/en/docs/reference/labels-annotations-taints/_index.md index 2ec7f59b56473..1a459bd956f4f 100644 --- a/content/en/docs/reference/labels-annotations-taints/_index.md +++ b/content/en/docs/reference/labels-annotations-taints/_index.md @@ -889,7 +889,12 @@ Example: `service.kubernetes.io/topology-aware-hints: "auto"` Used on: Service -This annotation is used for enabling [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints/) for a service. This tells the EndpointSlice controller to set topology hints if it is deemed safe. +This annotation is used for enabling [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints/) for a Service. +If you set the annotation to `"auto"`, that instructs the EndpointSlice controller to set topology hints +(if the control plane considers that appropriate). + +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} From c9402a665c8d06d66ad6ee1c839eb9b98f249680 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Wed, 2 Aug 2023 16:40:21 +0300 Subject: [PATCH 3/6] Update content/en/docs/reference/labels-annotations-taints/_index.md Co-authored-by: Tim Bannister --- content/en/docs/reference/labels-annotations-taints/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/reference/labels-annotations-taints/_index.md b/content/en/docs/reference/labels-annotations-taints/_index.md index 1a459bd956f4f..c9dc587baeab2 100644 --- a/content/en/docs/reference/labels-annotations-taints/_index.md +++ b/content/en/docs/reference/labels-annotations-taints/_index.md @@ -883,7 +883,7 @@ 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 {#servicekubernetesiotopology-aware-hints} +### service.kubernetes.io/topology-aware-hints (deprecated) {#servicekubernetesiotopology-aware-hints} Example: `service.kubernetes.io/topology-aware-hints: "auto"` From 05b71986753bf7f325e5f6d12f186edda121a55d Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Wed, 2 Aug 2023 16:40:29 +0300 Subject: [PATCH 4/6] Update content/en/docs/reference/labels-annotations-taints/_index.md Co-authored-by: Tim Bannister --- content/en/docs/reference/labels-annotations-taints/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/reference/labels-annotations-taints/_index.md b/content/en/docs/reference/labels-annotations-taints/_index.md index c9dc587baeab2..6de8e7455c6e7 100644 --- a/content/en/docs/reference/labels-annotations-taints/_index.md +++ b/content/en/docs/reference/labels-annotations-taints/_index.md @@ -885,7 +885,7 @@ The control plane adds this label to an Endpoints object when the owning Service ### service.kubernetes.io/topology-aware-hints (deprecated) {#servicekubernetesiotopology-aware-hints} -Example: `service.kubernetes.io/topology-aware-hints: "auto"` +Example: `service.kubernetes.io/topology-aware-hints: "Auto"` Used on: Service From 02a2ce53587f6eda15377826ab6265045d2105bc Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Wed, 2 Aug 2023 16:40:39 +0300 Subject: [PATCH 5/6] Update content/en/docs/reference/labels-annotations-taints/_index.md Co-authored-by: Tim Bannister --- .../docs/reference/labels-annotations-taints/_index.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/content/en/docs/reference/labels-annotations-taints/_index.md b/content/en/docs/reference/labels-annotations-taints/_index.md index 6de8e7455c6e7..f4cfe0ecf991a 100644 --- a/content/en/docs/reference/labels-annotations-taints/_index.md +++ b/content/en/docs/reference/labels-annotations-taints/_index.md @@ -890,8 +890,13 @@ Example: `service.kubernetes.io/topology-aware-hints: "Auto"` Used on: Service This annotation is used for enabling [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints/) for a Service. -If you set the annotation to `"auto"`, that instructs the EndpointSlice controller to set topology hints -(if the control plane considers that appropriate). +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. From ca5dc47b299a477c73a61f54866632c9f751be84 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Wed, 2 Aug 2023 16:40:55 +0300 Subject: [PATCH 6/6] Update content/en/docs/reference/labels-annotations-taints/_index.md Co-authored-by: Tim Bannister --- content/en/docs/reference/labels-annotations-taints/_index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/labels-annotations-taints/_index.md b/content/en/docs/reference/labels-annotations-taints/_index.md index f4cfe0ecf991a..3557864d941d0 100644 --- a/content/en/docs/reference/labels-annotations-taints/_index.md +++ b/content/en/docs/reference/labels-annotations-taints/_index.md @@ -889,7 +889,9 @@ Example: `service.kubernetes.io/topology-aware-hints: "Auto"` Used on: Service -This annotation is used for enabling [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints/) for a 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`.