website icon indicating copy to clipboard operation
website copied to clipboard

update Topology-Aware Routing docs

Open danwinship opened this issue 8 months ago • 5 comments

We need to update the docs for Topology-Aware Routing, especially content/en/docs/concepts/services-networking/topology-aware-routing.md. (I'm fixing a few smaller bits already...)

It's not clear to me if the right messaging is:

  • "Topology-Aware Routing is deprecated in favor of Traffic Distribution"
  • "Traffic Distribution, formerly known as Topology-Aware Routing ..."
  • "Topology-Aware Routing is a set of features including Traffic Distribution and the deprecated topology-mode annotation ..."
  • ... ?

/sig network /cc @gauravkghildiyal @robscott @thockin @aojea

danwinship avatar Mar 25 '25 12:03 danwinship

Firstly, thanks for helping with the docs updates @danwinship

I have a preference towards "Topology-Aware Routing is a set of features including Traffic Distribution and the deprecated topology-mode annotation ...", with "Topology-Aware Routing" conveying a general idea of what the feature is about, and the rest is just internal details of how it's supposed to be used -- through field, or the annotation

It is also along these lines that I've tried to convey it in our 1.33 Release Highlights

gauravkghildiyal avatar Mar 25 '25 21:03 gauravkghildiyal

/language en

sftim avatar Mar 26 '25 09:03 sftim

I like the idea of documenting as a concept how Kubernetes lets you account for topology when routing traffic, especially to Services.

sftim avatar Mar 26 '25 09:03 sftim

If there are tasks people want to achieve, eg ensuring or preferring zone-local routing, those should be separate task pages.

sftim avatar Mar 26 '25 09:03 sftim

/triage accepted /priority backlog

sftim avatar Mar 28 '25 09:03 sftim

/assign @Antraxmin

Antraxmin avatar May 07 '25 07:05 Antraxmin