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

sergeyshevch · 2023-01-19T14:18:50Z

netlify · 2023-01-19T14:32:35Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`4b2fe55`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/63c9514c70d4770009337e3c
😎 Deploy Preview	https://deploy-preview-38997--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify · 2023-01-19T14:36:54Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`ca5dc47`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/64d4e6e6d074e90008a12147
😎 Deploy Preview	https://deploy-preview-38997--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

content/en/docs/reference/labels-annotations-taints/_index.md

kbhawkey · 2023-02-26T02:56:25Z

@kubernetes/sig-network-misc , Do you have time to review the changes?

reylejano · 2023-04-04T06:44:45Z

If this PR is open after the 1.27 release is out (scheduled for April 11, one week from the time of this comment), this annotation needs confirmation from SIG Network as there is a name change from Topology Aware Hints to Topology Aware Routing in 1.27

sergeyshevch · 2023-04-06T12:37:48Z

@reylejano For now we waiting for SIG Network review. If it will be available after 1.27 freeze, I will change naming

k8s-triage-robot · 2023-07-19T19:15:02Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

sergeyshevch · 2023-07-24T11:25:35Z

@sftim Can we review it in any way?

robscott

Thanks @sergeyshevch! Left some recommended changes to capture the latest updates to the KEP.

robscott · 2023-08-01T22:51:01Z

content/en/docs/reference/labels-annotations-taints/_index.md

@@ -395,6 +395,19 @@ 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}


Please use the updated terminology throughout:

The annotation should be service.kubernetes.io/topology-mode

The hints annotation is deprecated

The value should be "Auto" (note the capitalization)

Links should go to https://kubernetes.io/docs/concepts/services-networking/topology-aware-routing/

Domain-prefixed values are supported for custom/implementation-specific values per https://github.com/kubernetes/kubernetes/blob/99190634ab252604a4496882912ac328542d649d/staging/src/k8s.io/api/core/v1/annotation_key_constants.go#L154-L161

In this PR, we're documenting service.kubernetes.io/topology-aware-hints @robscott, as a fix for #36830.
Please review this as a PR to belatedly register and document service.kubernetes.io/topology-aware-hints.

PRs to document service.kubernetes.io/topology-mode are also welcome; I know that this is undocumented as of right now. Anyone is welcome to open a PR that documents the new annotation.

service.kubernetes.io/topology-aware-hints was replaced by service.kubernetes.io/topology-mode, any reason we should document the old annotation? For reference, any use of the hints annotation will return a warning pointing to the new annotation: https://github.com/kubernetes/kubernetes/blob/99190634ab252604a4496882912ac328542d649d/pkg/api/service/warnings.go#L34

We register (and document) all the annotations that we've ever used in official released code. Even if using them returns a warning, they should still be registered.

(if we don't do that, we won't resolve issue #36830)

content/en/docs/reference/labels-annotations-taints/_index.md

sftim

Based on feedback so far on the PR.

/lgtm

k8s-ci-robot · 2023-08-02T13:46:30Z

LGTM label has been added.

Git tree hash: 1cc0fe5e5c9acac597bc026a2342daf6f2804ab5

divya-mohan0209 · 2023-08-08T04:42:32Z

/remove-lifecycle stale

divya-mohan0209 · 2023-08-08T04:43:39Z

@robscott : Please would you be able to provide feedback from a technical POV and see if this is all okay to merge?

natalisucks · 2023-08-09T20:39:14Z

@sergeyshevch While we wait for another tech review to make sure we can move forward, would you mind pushing an empty commit due to the checks failing? This should help kickstart them so we can eventually merge – thanks!

sergeyshevch · 2023-08-09T21:43:54Z

@natalisucks Sure. Will make it tomorrow

robscott · 2023-08-09T21:45:51Z

As I commented above, I'd personally rather document the current annotation instead of (or at least before) the deprecated annotation since I think this could lead to confusion. This does look like correct documentation for the deprecated annotation, so LGTM for sig-network.

sftim · 2023-08-09T21:58:23Z

As I commented above, I'd personally rather document the current annotation instead of (or at least before) the deprecated annotation since I think this could lead to confusion.

The best time to document annotations is before / as we start to use them. The second best time - in my view - is now. Please do feel free to document the missing newer annotation. PRs to fix gaps like that are always welcome.

@sergeyshevch please try rebasing this against main from upstream. Your base branch is fairly stale (and Netlify doesn't automate testing against a simulated merge).

Co-authored-by: Tim Bannister <[email protected]>

sergeyshevch · 2023-08-10T13:33:12Z

Rebased on actual main

sftim

Thanks

/lgtm
/approve

k8s-ci-robot · 2023-08-11T07:55:21Z

LGTM label has been added.

Git tree hash: 4549763100282e1d410633d5c9bfe5c5af097719

k8s-ci-robot · 2023-08-11T07:55:22Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [sftim]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 19, 2023

k8s-ci-robot requested review from nate-double-u and tengqm January 19, 2023 14:19

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jan 19, 2023

sergeyshevch force-pushed the feature/topology-aware-hints-well-known-label branch 2 times, most recently from dcb356d to 09b19ba Compare January 19, 2023 14:19

sftim reviewed Jan 19, 2023

View reviewed changes

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 20, 2023

sftim reviewed Jan 20, 2023

View reviewed changes

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved

k8s-ci-robot added the sig/network Categorizes an issue or PR as relevant to SIG Network. label Feb 26, 2023

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 19, 2023

robscott reviewed Aug 1, 2023

View reviewed changes

sftim reviewed Aug 1, 2023

View reviewed changes

sftim reviewed Aug 2, 2023

View reviewed changes

k8s-ci-robot assigned sftim Aug 2, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 2, 2023

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 8, 2023

sergeyshevch and others added 6 commits August 10, 2023 16:31

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

c7a4fe6

Update content/en/docs/reference/labels-annotations-taints/_index.md

2692020

Co-authored-by: Tim Bannister <[email protected]>

Update content/en/docs/reference/labels-annotations-taints/_index.md

c9402a6

Co-authored-by: Tim Bannister <[email protected]>

Update content/en/docs/reference/labels-annotations-taints/_index.md

05b7198

Co-authored-by: Tim Bannister <[email protected]>

Update content/en/docs/reference/labels-annotations-taints/_index.md

02a2ce5

Co-authored-by: Tim Bannister <[email protected]>

Update content/en/docs/reference/labels-annotations-taints/_index.md

ca5dc47

Co-authored-by: Tim Bannister <[email protected]>

sergeyshevch force-pushed the feature/topology-aware-hints-well-known-label branch from 87f4d88 to ca5dc47 Compare August 10, 2023 13:32

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 10, 2023

k8s-ci-robot requested a review from sftim August 10, 2023 13:32

sftim reviewed Aug 11, 2023

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 11, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 11, 2023

k8s-ci-robot merged commit be0301a into kubernetes:main Aug 11, 2023

sergeyshevch mentioned this pull request Apr 1, 2024

REQUEST: New membership for sergeyshevch kubernetes/org#4857

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

sergeyshevch commented Jan 19, 2023

netlify bot commented Jan 19, 2023

netlify bot commented Jan 19, 2023 •

edited

Loading

kbhawkey commented Feb 26, 2023

reylejano commented Apr 4, 2023 •

edited

Loading

sergeyshevch commented Apr 6, 2023

k8s-triage-robot commented Jul 19, 2023

sergeyshevch commented Jul 24, 2023

robscott left a comment

robscott Aug 1, 2023

sftim Aug 1, 2023

robscott Aug 1, 2023

sftim Aug 1, 2023

sftim Aug 1, 2023

sftim left a comment

k8s-ci-robot commented Aug 2, 2023

divya-mohan0209 commented Aug 8, 2023

divya-mohan0209 commented Aug 8, 2023

natalisucks commented Aug 9, 2023

sergeyshevch commented Aug 9, 2023

robscott commented Aug 9, 2023

sftim commented Aug 9, 2023

sergeyshevch commented Aug 10, 2023

sftim left a comment

k8s-ci-robot commented Aug 11, 2023

k8s-ci-robot commented Aug 11, 2023

		@@ -395,6 +395,19 @@ 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}

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

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

Conversation

sergeyshevch commented Jan 19, 2023

netlify bot commented Jan 19, 2023

✅ Pull request preview available for checking

netlify bot commented Jan 19, 2023 • edited Loading

✅ Pull request preview available for checking

kbhawkey commented Feb 26, 2023

reylejano commented Apr 4, 2023 • edited Loading

sergeyshevch commented Apr 6, 2023

k8s-triage-robot commented Jul 19, 2023

sergeyshevch commented Jul 24, 2023

robscott left a comment

Choose a reason for hiding this comment

robscott Aug 1, 2023

Choose a reason for hiding this comment

sftim Aug 1, 2023

Choose a reason for hiding this comment

robscott Aug 1, 2023

Choose a reason for hiding this comment

sftim Aug 1, 2023

Choose a reason for hiding this comment

sftim Aug 1, 2023

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 2, 2023

divya-mohan0209 commented Aug 8, 2023

divya-mohan0209 commented Aug 8, 2023

natalisucks commented Aug 9, 2023

sergeyshevch commented Aug 9, 2023

robscott commented Aug 9, 2023

sftim commented Aug 9, 2023

sergeyshevch commented Aug 10, 2023

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 11, 2023

k8s-ci-robot commented Aug 11, 2023

netlify bot commented Jan 19, 2023 •

edited

Loading

reylejano commented Apr 4, 2023 •

edited

Loading