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.

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

Bug in page https://k8s.io/docs/concepts/services-networking/topology-aware-routing/ #50017

Open
manshshriva opened this issue Mar 5, 2025 · 4 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done.

Comments

@manshshriva
Copy link

In documentation annotation value for service.kubernetes.io/topology-mode should be "auto" not "Auto"
Make below changes

  1. "service.kubernetes.io/topology-mode annotation to Auto" to "service.kubernetes.io/topology-mode annotation to auto".
  2. The "Auto" heuristic attempts to proportionally allocate a number of endpoints to each zone. to "The "auto" heuristic attempts to proportionally allocate a number of endpoints to each zone.
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Mar 5, 2025
@dipesh-rawat
Copy link
Member

Page reported in issue (based on the initial title): https://kubernetes.io/docs/concepts/services-networking/topology-aware-routing
/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Mar 5, 2025
@dipesh-rawat
Copy link
Member

The upstream codebase in k/k includes the following information in the annotation:

	// AnnotationTopologyMode can be used to enable or disable Topology Aware
	// Routing for a Service. Well known values are "Auto" and "Disabled".
	// Implementations may choose to develop new topology approaches, exposing
	// them with domain-prefixed values. For example, "example.com/lowest-rtt"
	// could be a valid implementation-specific value for this annotation. These
	// heuristics will often populate topology hints on EndpointSlices, but that
	// is not a requirement.
	AnnotationTopologyMode = "service.kubernetes.io/topology-mode"

Code reference here

@sftim
Copy link
Contributor

sftim commented Mar 6, 2025

/priority awaiting-more-evidence

Are you sure that the issue is right, @manshshriva ?

/retitle Bug in page https://k8s.io/docs/concepts/services-networking/topology-aware-routing/

/kind bug

@k8s-ci-robot k8s-ci-robot changed the title Improvement for k8s.io/docs/concepts/services-networking/topology-aware-routing/ Bug in page https://k8s.io/docs/concepts/services-networking/topology-aware-routing/ Mar 6, 2025
@k8s-ci-robot k8s-ci-robot added priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. kind/bug Categorizes issue or PR as related to a bug. labels Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done.
Projects
None yet
Development

No branches or pull requests

4 participants