Statusz for Kubernetes Components

[richabanker]

Enhancement Description

• Introduces a statusz page for all core components.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-instrumentation/4827-component-statusz/README.md
• Discussion Link: link
• Primary contact (assignee): @richabanker
• Responsible SIGs: sig-instrumentation
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.32
  • Beta release target (x.y): 1.33
  • Stable release target (x.y): 1.34
• Alpha
  • KEP (k/enhancements) update PR(s): KEP for statusz page for Kubernetes Components #4830
  • Code (k/k) update PR(s):
    • add OWNERS and README for zpages under component-base kubernetes#127206
    • Move k8s.io/apiserver/pkg/util/version to component-base kubernetes#128196
    • Add statusz endpoint for apiserver kubernetes#125577
  • Docs (k/website) update PR(s):
    • Add docs for zpages website#48760
    • Add blog for zpages website#48369

[richabanker]

/assign

[richabanker]

/sig instrumentation

[aojea]

logistic question for sig-instrumentation folks, don't you prefer to consolidate all statusz, flagz and featurez in a single kep to avoid the overhead?
or is that there is risk for something to not be graduated at the same time?

[logicalhan]

logistic question for sig-instrumentation folks, don't you prefer to consolidate all statusz, flagz and featurez in a single kep to avoid the overhead? or is that there is risk for something to not be graduated at the same time?

No, some pages may be more contentious than the others. Centralizing z-pages itself has been agreed to be of general benefit to the community (rather than one offs in the kubelet).

[impact-maker]

Hello @richabanker 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 11th October 2024 / 19:00 PDT Thursday 10th October 2024.

This enhancement is targeting for stage alpha for v1.32 (correct me, if otherwise).

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.32.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here). If your production readiness review is not completed yet, please make sure to fill the production readiness questionnaire in your KEP by the PRR Freeze deadline on Thursday, October 3rd, 2024 so that the PRR team has enough time to review your KEP.

For this KEP, we would just need to update the following:

• KEP has a production readiness review that has been completed and merged into k/enhancements.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well.

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[pacoxu]

/milestone v1.32

[edithturn]

Hello @richabanker , 👋🏼 this is Edith from the v1.32 Communications Team!

We’d love for you to consider writing a feature blog about your enhancement! ✍
Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024 🗓 . For more information about writing a blog, see the blog contribution guidelines.

Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

[rdalbuquerque]

Hello @richabanker 👋, 1.32 Docs Shadow here.
Does this enhancement work planned for 1.32 require any new docs or modification to existing docs?
If so, please follows the steps here to open a PR against dev-1.32 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday October 24th 2024 18:00 PDT.
Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.
Thank you!

[richabanker]

@rdalbuquerque Created a docs PR here kubernetes/website#48368, thanks!

[richabanker]

@edithturn Created a blog PR here kubernetes/website#48369, thanks!

[tjons]

Hey again @richabanker 👋 v1.32 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Friday 8th November 2024 / 19:00 PDT Thursday 7th November 2024 .

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, it looks like the following PRs are open and need to be merged before code freeze (and we need to update the Issue description to include all the related PRs of this KEP):

• Add statusz endpoint for apiserver kubernetes#125577

Additionally, please let me know if there are any other PRs in k/k not listed in the description or not linked with this GitHub issue that we should track for this KEP, so that we can maintain accurate status.

The status of this enhancement is marked as at risk for code freeze.

If you anticipate missing code freeze, you can file an exception request in advance. Thank you!

[tjons]

Hello @richabanker 👋, Enhancements team here.

With all the implementation(code related) PRs merged as per the issue description:

• add OWNERS and README for zpages under component-base kubernetes#127206
• Move k8s.io/apiserver/pkg/util/version to component-base kubernetes#128196
• Add statusz endpoint for apiserver kubernetes#125577

This enhancement is now marked as tracked for code freeze for the 1.32 Code Freeze!

Please note that KEPs targeting stable need to have the status field marked as implemented in the kep.yaml file after code PRs are merged and the feature gates are removed.

[rashansmith]

Hello @richabanker 👋, v1.32 Comms team here,

Thank you for creating a placeholder PR for a feature blog!

The deadline for completing blog content to be Ready for Review is Monday 25th November 2024 . For more information about writing a blog see the blog contribution guidelines.

Please feel free to reach out if you have any questions!

[rdalbuquerque]

Hi @richabanker !
Can you please update the docs PR link in the issue description?

Thanks!

[richabanker]

@rdalbuquerque done. Thanks for noticing that!