From 2474ff93aad946c158cec46477601963b2dcda26 Mon Sep 17 00:00:00 2001 From: Rob Scott Date: Wed, 17 Nov 2021 11:21:54 -0800 Subject: [PATCH] Updating Topology Aware Hints docs for 1.23 --- .../service-traffic-policy.md | 2 +- .../topology-aware-hints.md | 6 +-- .../feature-gates.md | 3 +- .../enabling-topology-aware-hints.md | 40 ------------------- 4 files changed, 5 insertions(+), 46 deletions(-) delete mode 100644 content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md diff --git a/content/en/docs/concepts/services-networking/service-traffic-policy.md b/content/en/docs/concepts/services-networking/service-traffic-policy.md index fb55a3d833e8a..0a62cb49348c7 100644 --- a/content/en/docs/concepts/services-networking/service-traffic-policy.md +++ b/content/en/docs/concepts/services-networking/service-traffic-policy.md @@ -68,6 +68,6 @@ When the [feature gate](/docs/reference/command-line-tools-reference/feature-gat ## {{% heading "whatsnext" %}} -* Read about [enabling Topology Aware Hints](/docs/tasks/administer-cluster/enabling-topology-aware-hints) +* Read about [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints) * Read about [Service External Traffic Policy](/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip) * Read [Connecting Applications with Services](/docs/concepts/services-networking/connect-applications-service/) diff --git a/content/en/docs/concepts/services-networking/topology-aware-hints.md b/content/en/docs/concepts/services-networking/topology-aware-hints.md index f471caff6b24d..d07a75d9234f2 100644 --- a/content/en/docs/concepts/services-networking/topology-aware-hints.md +++ b/content/en/docs/concepts/services-networking/topology-aware-hints.md @@ -9,7 +9,7 @@ weight: 45 -{{< feature-state for_k8s_version="v1.21" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} _Topology Aware Hints_ enable topology aware routing by including suggestions for how clients should consume endpoints. This approach adds metadata to enable @@ -35,8 +35,7 @@ can then consume those hints, and use them to influence how traffic to is routed ## Using Topology Aware Hints -If you have [enabled](/docs/tasks/administer-cluster/enabling-topology-aware-hints) the -overall feature, you can activate Topology Aware Hints for a Service by setting the +You can activate Topology Aware Hints for a Service by setting the `service.kubernetes.io/topology-aware-hints` annotation to `auto`. This tells the EndpointSlice controller to set topology hints if it is deemed safe. Importantly, this does not guarantee that hints will always be set. @@ -156,5 +155,4 @@ zone. ## {{% heading "whatsnext" %}} -* Read about [enabling Topology Aware Hints](/docs/tasks/administer-cluster/enabling-topology-aware-hints/) * Read [Connecting Applications with Services](/docs/concepts/services-networking/connect-applications-service/) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..67c1ac569c223 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -186,7 +186,8 @@ different Kubernetes components. | `StorageVersionHash` | `true` | Beta | 1.15 | | | `SuspendJob` | `false` | Alpha | 1.21 | 1.21 | | `SuspendJob` | `true` | Beta | 1.22 | | -| `TopologyAwareHints` | `false` | Alpha | 1.21 | | +| `TopologyAwareHints` | `false` | Alpha | 1.21 | 1.22 | +| `TopologyAwareHints` | `true` | Beta | 1.23 | | | `TopologyManager` | `false` | Alpha | 1.16 | 1.17 | | `TopologyManager` | `true` | Beta | 1.18 | | | `VolumeCapacityPriority` | `false` | Alpha | 1.21 | - | diff --git a/content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md b/content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md deleted file mode 100644 index dadc653f4e196..0000000000000 --- a/content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -reviewers: -- robscott -title: Enabling Topology Aware Hints -content_type: task -min-kubernetes-server-version: 1.21 ---- - - -{{< feature-state for_k8s_version="v1.21" state="alpha" >}} - -_Topology Aware Hints_ enable topology aware routing with topology hints -included in {{< glossary_tooltip text="EndpointSlices" term_id="endpoint-slice" >}}. -This approach tries to keep traffic close to where it originated from; -you might do this to reduce costs, or to improve network performance. - -## {{% heading "prerequisites" %}} - - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} - -The following prerequisite is needed in order to enable topology aware hints: - -* Configure the {{< glossary_tooltip text="kube-proxy" term_id="kube-proxy" >}} to run in - iptables mode or IPVS mode -* Ensure that you have not disabled EndpointSlices - -## Enable Topology Aware Hints - -To enable service topology hints, enable the `TopologyAwareHints` [feature -gate](/docs/reference/command-line-tools-reference/feature-gates/) for the -kube-apiserver, kube-controller-manager, and kube-proxy: - -``` ---feature-gates="TopologyAwareHints=true" -``` - -## {{% heading "whatsnext" %}} - -* Read about [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints) for Services -* Read [Connecting Applications with Services](/docs/concepts/services-networking/connect-applications-service/)