List available endpoints for kube-apiserver #132581

itssimrank · 2025-06-27T17:19:56Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR makes useful links available for kube-apiserver

Which issue(s) this PR is related to: #132538

Special notes for your reviewer:

Does this PR introduce a user-facing change?


Adds useful endpoints for kube-apiserver

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

linux-foundation-easycla · 2025-06-27T17:20:00Z

The committers listed above are authorized under a signed CLA.

✅ login: itssimrank / name: Simran Kaur (d9beeeb, 8f9219a, 8b9b260, 221f617, 003d5a5, fb8c387, 0df189e, 6467089)

k8s-ci-robot · 2025-06-27T17:20:05Z

Welcome @itssimrank!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-06-27T17:20:05Z

Hi @itssimrank. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

yongruilin

/ok-to-test
/triage accepted
/cc @richabanker

staging/src/k8s.io/component-base/zpages/statusz/statusz.go

yongruilin · 2025-07-01T16:57:13Z

/lgtm
/label tide/merge-method-squash

k8s-ci-robot · 2025-07-01T16:57:21Z

LGTM label has been added.

Git tree hash: 0719ce28b8caf8f51ad0b9d88d786d47cc9b65fb

k8s-ci-robot · 2025-07-01T21:18:05Z

New changes are detected. LGTM label has been removed.

k8s-ci-robot · 2025-07-01T21:18:20Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: itssimrank
Once this PR has been reviewed and has the lgtm label, please assign deads2k, rexagod for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

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

richabanker · 2025-07-01T21:47:58Z

staging/src/k8s.io/component-base/zpages/statusz/statusz.go

@@ -83,14 +91,19 @@ func populateStatuszData(reg statuszRegistry) (string, error) {
 	if reg.emulationVersion() != nil {
 		emulationVersion = fmt.Sprintf(`Emulation version%s %s`, delim, html.EscapeString(reg.emulationVersion().String()))
 	}
+	var apiserverLinks string
+	if componentName == "kube-apiserver" {
+		apiserverLinks = fmt.Sprintf(`Useful Endpoints%s %s`, delim, html.EscapeString(aggregatePaths(reg.paths())))


should we only add the Useful Endpoints if aggregatePaths() returns non-nil/non-empty value?

Also if someone changes the componentName to something other than kube-apiserver here that would make the Useful links not work for apiserver...

To avoid that, could we do the sanitization of the links before we pass it on during statusz initialization, i.e. in pkg/controlplane/apiserver/server.go?

richabanker · 2025-07-01T21:48:25Z

staging/src/k8s.io/component-base/zpages/statusz/statusz_test.go

@@ -36,6 +36,7 @@ Up: %s
 Go version: %s
 Binary version: %v
 Emulation version: %v
+


why empty line?

k8s-ci-robot · 2025-07-02T21:05:44Z

@itssimrank: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-kubernetes-unit	`0df189e`	link	true	`/test pull-kubernetes-unit`
pull-kubernetes-e2e-gce	`0df189e`	link	true	`/test pull-kubernetes-e2e-gce`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

List available endpoints for kube-apiserver

8f9219a

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 27, 2025

k8s-ci-robot requested review from dgrisonnet and serathius June 27, 2025 17:20

itssimrank marked this pull request as draft June 27, 2025 17:20

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 27, 2025

itssimrank marked this pull request as ready for review June 27, 2025 17:38

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 27, 2025

k8s-ci-robot requested a review from logicalhan June 27, 2025 17:38

yongruilin reviewed Jun 27, 2025

View reviewed changes

staging/src/k8s.io/component-base/zpages/statusz/statusz.go Outdated Show resolved Hide resolved

k8s-ci-robot requested a review from richabanker June 27, 2025 17:47

Fix maps import

8b9b260

k8s-ci-robot added area/kube-proxy sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/network Categorizes an issue or PR as relevant to SIG Network. labels Jun 30, 2025

Update dependencies

6467089

k8s-ci-robot added area/kubelet sig/node Categorizes an issue or PR as relevant to SIG Node. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. labels Jun 30, 2025

github-project-automation bot added this to SIG Node: code and documentation PRs Jun 30, 2025

github-project-automation bot moved this to Triage in SIG Node: code and documentation PRs Jun 30, 2025

Fix lint

fb8c387

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jul 1, 2025

k8s-ci-robot assigned yongruilin Jul 1, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 1, 2025

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jul 1, 2025

Peac36 mentioned this pull request Jul 1, 2025

add useful endpoints section in statusz endpoint #132606

Open

Add option to pass listedpaths

003d5a5

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Jul 1, 2025

k8s-ci-robot requested a review from yongruilin July 1, 2025 21:18

richabanker reviewed Jul 1, 2025

View reviewed changes

Remove apiserver component check

0df189e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

List available endpoints for kube-apiserver #132581

List available endpoints for kube-apiserver #132581

itssimrank commented Jun 27, 2025 •

edited

Loading

Uh oh!

linux-foundation-easycla bot commented Jun 27, 2025 •

edited

Loading

Uh oh!

k8s-ci-robot commented Jun 27, 2025

Uh oh!

k8s-ci-robot commented Jun 27, 2025

Uh oh!

yongruilin left a comment

Uh oh!

Uh oh!

yongruilin commented Jul 1, 2025

Uh oh!

k8s-ci-robot commented Jul 1, 2025

Uh oh!

k8s-ci-robot commented Jul 1, 2025

Uh oh!

k8s-ci-robot commented Jul 1, 2025

Uh oh!

richabanker Jul 1, 2025 •

edited

Loading

Uh oh!

richabanker Jul 1, 2025

Uh oh!

richabanker Jul 1, 2025

Uh oh!

k8s-ci-robot commented Jul 2, 2025

Uh oh!

Uh oh!

List available endpoints for kube-apiserver #132581

Are you sure you want to change the base?

List available endpoints for kube-apiserver #132581

Conversation

itssimrank commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR is related to: #132538

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

Uh oh!

linux-foundation-easycla bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Jun 27, 2025

Uh oh!

k8s-ci-robot commented Jun 27, 2025

Uh oh!

yongruilin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yongruilin commented Jul 1, 2025

Uh oh!

k8s-ci-robot commented Jul 1, 2025

Uh oh!

k8s-ci-robot commented Jul 1, 2025

Uh oh!

k8s-ci-robot commented Jul 1, 2025

Uh oh!

richabanker Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richabanker Jul 1, 2025

Choose a reason for hiding this comment

Uh oh!

richabanker Jul 1, 2025

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Jul 2, 2025

Uh oh!

Uh oh!

itssimrank commented Jun 27, 2025 •

edited

Loading

linux-foundation-easycla bot commented Jun 27, 2025 •

edited

Loading

richabanker Jul 1, 2025 •

edited

Loading