Allow informers for getting a stream of data instead of chunking

[p0lyn0mial]

Enhancement Description

• One-line enhancement description (can be used as a release note): informers can get a stream of data to prime the caches

• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/3157-watch-list/README.md

• Discussion Link:

• Primary contact (assignee): @p0lyn0mial

• Responsible SIGs: sig-apimachinery, sig-scalability

• Enhancement target (which target equals to which milestone):

  • Alpha release target (x.y): 1.27
  • Beta release target (x.y): 1.31
  • Stable release target (x.y): TBD

• Alpha

  • KEP (k/enhancements) update PR(s):
    • KEP-3157: allow informers for getting a stream of data instead of chunking #3142
    • Update KEP 3157 for milestone 1.27 #3822
  • Code (k/k) update PR(s):
    • WIP: POC introduce API streaming kubernetes#106477
    • e2e/apimachinery: Add an e2e test for the API Streaming feature kubernetes#117277
    • cacher avoid double locking kubernetes#117410
  • Docs (k/website) update PR(s):
    • Streaming lists documentation website#39993

• Beta

  • KEP (k/enhancements) update PR(s): KEP 3157 (watch-list): add a new beta criterion #4453
  • Code (k/k) update PR(s):
    • storage/cacher: ensure the cache is at the Most Recent ResourceVersion when streaming was requested kubernetes#122830
    • cleanup: replace ENABLE_CLIENT_GO_WATCH_LIST_ALPHA with WatchListClient gate kubernetes#122791
  • Docs (k/website) update(s):
    • WIP: Document KEP 3157 (watch-list) for milestone 1.30 website#45283
    • WIP: Add a blog post about using the API streaming (KEP 3157) website#45285
    • WIP: Add a blog post introducing feature gates for client-go website#45286

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

/sig api-machinery
/sig scalability

[gracenng]

Hi @p0lyn0mial ! 1.24 Enhancements team here. Just checking in as we approach enhancements freeze on 18:00pm PT on Thursday Feb 3rd. This enhancements is targeting alpha for 1.24
Here’s where this enhancement currently stands:

• Updated KEP file using the latest template has been merged into the k/enhancements repo. KEP-3157: allow informers for getting a stream of data instead of chunking #3142
• KEP status is marked as implementable for this release with latest-milestone: 1.24
• KEP has a test plan section filled out.
  - [ ] KEP has up to date graduation criteria. -- not needed for alpha
• KEP has a production readiness review that has been completed and merged into k/enhancements -- PRR not found

The status of this enhancement is track as at risk
Thanks!

[p0lyn0mial]

Hi @gracenng! Many thanks for the heads-up. Could you please double-check the last point? The KEP has the Production Readiness Review Questionnaire. In addition to that, I have filled the required bits for the alpha version - it just hasn't been reviewed yet.

[gracenng]

Hi @p0lyn0mial,
Thanks for the reply. Your PRR Questionaire in the KEP needs to be approved by the PRR team, which will result in a file in
https://github.com/kubernetes/enhancements/tree/master/keps/prod-readiness/
Your sig has not made a folder there yet, please check out the format.

Regarding your second point, I am tracking your KEP files and the first bullet will be checked when the PR is merged. Does that answer your question?

[gracenng]

Hi @p0lyn0mial , 1.24 Enhancements Team here.

Reaching out as we're less than a week away from Enhancement Freeze on Thursday, February 3rd.
There's no update for this enhancement since last checkin, let me know if I missed anything.
Current status is at risk

[p0lyn0mial]

Hi @gracenng, it looks like it won't make it to 1.24. Please leave me some instructions on how to update the KEP so it won't show up on your query.

[gracenng]

No worries I’ll take care of it

…

On Mon, Jan 31, 2022 at 12:42 AM Lukasz Szaszkiewicz < ***@***.***> wrote: Hi @gracenng <https://github.com/gracenng>, it looks like it won't make it to 1.24. Please leave me some instructions on how to update the KEP so it won't show up on your query. — Reply to this email directly, view it on GitHub <#3157 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKCRLOZTCK54ONCDRDEXZCTUYZDP3ANCNFSM5MHDCLRQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[Dingshujie]

@p0lyn0mial how is feature going? we met a lot of server overloading scene(kube-apiserver oom or master oom), looking forward to this feature. if you need help，you can assign some tasks to me.

[JohnRusk]

@Dingshujie BTW, if you have more than a few hundred nodes, then this fix will probably help to reduce API server load kubernetes/kubernetes#109381 . (If you have more than a few thousand nodes it will definitely help). It solves a bug where the kubelets would keep doing the same listing calls over and over again (typically immediately after a restart of the API server). Obvoiusly, other list issues are possible too, so that fix won't solve them all for you. But it might help.

[Dingshujie]

@Dingshujie BTW, if you have more than a few hundred nodes, then this fix will probably help to reduce API server load kubernetes/kubernetes#109381 . (If you have more than a few thousand nodes it will definitely help). It solves a bug where the kubelets would keep doing the same listing calls over and over again (typically immediately after a restart of the API server). Obvoiusly, other list issues are possible too, so that fix won't solve them all for you. But it might help.

@JohnRusk thanks, i already cherry-pick this to 1.23 branch. but this fixs can't slove the situation that custom-defined operator list issues.
and finally expect all list from watch cache

[k8s-triage-robot]

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

This bot triages issues and 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 issue is closed

You can:

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

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

/lifecycle stale

[k8s-triage-robot]

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

This bot triages issues and 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 issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

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

/lifecycle rotten

[wojtek-t]

/remove-lifecycle rotten

[p0lyn0mial]

/milestone v1.26

[deads2k]

/milestone v1.31

[tjons]

Hello @p0lyn0mial 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th June 2024 / 19:00 PDT Thursday 13th June 2024.

This enhancement is targeting for stage beta for 1.31 (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: { 1.31 }. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria.
• KEP has submitted a production readiness review request for approval and has a reviewer assigned.
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

With all the KEP requirements in place and merged into k/enhancements, this enhancement is all good for the upcoming enhancements freeze. 🚀

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

[wojtek-t]

/milestone v1.31

[chanieljdan]

Hi @p0lyn0mial 👋, 1.31 Docs Shadow here.

Does this enhancement work planned for 1.31 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.31 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday June 27, 2024 18:00 PDT.

Also, take a look at Documenting for a release to get yourself familiarized with the docs requirement for the release.

Thank you!

Daniel

[hailkomputer]

Hi @p0lyn0mial

👋 from the v1.31 Communications Team! We'd love for you to opt in to write 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 3rd July, 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.

[chanieljdan]

Hi @p0lyn0mial 👋, 1.31 Docs Shadow here.

Does this enhancement work planned for 1.31 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.31 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday June 27, 2024 18:00 PDT.

Also, take a look at Documenting for a release to get yourself familiarized with the docs requirement for the release.

Thank you!

Daniel

Hi @jpbetz 👋,

Just a reminder to open a placeholder PR against dev-1.31 branch in the k/website repo for this (steps available here). The deadline for this is a week away at Thursday June 27, 2024 18:00 PDT.

Thanks,

Daniel

[jpbetz]

@p0lyn0mial Would you open the placeholder docs PR for this one?

[p0lyn0mial]

done, kubernetes/website#46985
sorry for the delay.

[hailkomputer]

@p0lyn0mial , friendly reminder about the upcoming blog opt-in and placeholder deadline on July 3rd. Please open a blog placeholder PR if you are interested in contributing a blog.

[p0lyn0mial]

I'm, thanks for the reminder, opened kubernetes/website#47018

[tjons]

Hey again @p0lyn0mial 👋 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 24th July 2024 / 19:00 PDT Tuesday 23rd July 2024 .

I found two PRs for this KEP in 1.31:

• storage/cacher: ensure the cache is at the Most Recent ResourceVersion when streaming was requested kubernetes#122830
• cleanup: replace ENABLE_CLIENT_GO_WATCH_LIST_ALPHA with WatchListClient gate kubernetes#122791

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.

With the above criteria met, this enhancement is now tracked for code freeze!

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[p0lyn0mial]

Unfortunately, a bug was found in the dynamic client, and we have to revert the graduation of the feature.
It looks like this feature is going to miss the 1.31 release :(

[dipesh-rawat]

Hey @p0lyn0mial 👋 Enhancements team here,

Thank you for confirming that this enhancement will now be targeted for a future release. I will mark this as Deferred on the tracking board for the current v1.31 release.

[deads2k]

/milestone v1.32