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.32
  • 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):
    • 1.30 KEP 3157 (watch-list): add a new beta criterion #4453
    • 1.32 Update KEP 3157 (watch-list) for milestone 1.32 #4836
  • Code (k/k) update PR(s):
    • 1.30 storage/cacher: ensure the cache is at the Most Recent ResourceVersion when streaming was requested kubernetes#122830
    • 1.31 cleanup: replace ENABLE_CLIENT_GO_WATCH_LIST_ALPHA with WatchListClient gate kubernetes#122791
    • 1.32:
      • client-go/rest/request: decodes initialEventsListBlueprint for watchlist requests kubernetes#127812
      • apiserver/handlers/watch: encode initialEventsListBlueprint with watchEncoder kubernetes#127587
      • cacher: prevents sending events with ResourceVersion < RequiredResourceVersion kubernetes#127500
      • metadata client: add support for API streaming  kubernetes#127388
      • apimachinery/meta/types.go: define InitialEventsListBlueprintAnnotationKey const kubernetes#127319
      • cacher: apply key for initial events only if the call is not recursive kubernetes#127265
      • adds watchListEndpointRestrictions for watchlist requests kubernetes#126996
      • Promote WatchList feature to Beta  kubernetes#128053
  • 1.34:
    • watchlist supports sending resources in Table format kubernetes#132817
    • reflector: detects unsupported meta.Table gvks for watchlist kubernetes#132928
    • client-go/reflector: stop exposing UseWatchList kubernetes#132453
    • apiserver/storage/cacher/listwatcher: error when the WatchList FG is disabled kubernetes#132497
    • apiserver/cacher: properly wire listwatch options to the listwatcher kubernetes#132479
    • e2e/watchlist: new test for checking metadata informer kubernetes#132417
    • cluster/gce: rm KUBE_LIST_FROM_CACHE_INCONSISTENCY_DETECTOR kubernetes#132369
    • client-go/util/consistencydetector: remove CheckListFromCacheDataConsistencyIfRequested kubernetes#132350
    • apimachinery/meta/types.go: remove InitialEventsListBlueprintAnnotationKey kubernetes#132349
    • apiserver/handlers/watch: stop encoding initialEventsListBlueprint kubernetes#132326
    • client-go/rest/request: decodes initialEventsListBlueprint for watchlist requests kubernetes#127812
    • rest client: remove support for API streaming  kubernetes#132285
    • typed client: remove support for API streaming  kubernetes#132257
    • dynamic client: remove support for API streaming kubernetes#132229
    • metadata client: remove support for API streaming kubernetes#132149
    • storage/etcd: skip SendInitialEvents if the request is backward compatible kubernetes#117862
    • cacher: do not simply popExpiredWatchers when the cacher hasn't dispatched any event kubernetes#117014
    • Promote WatchList feature to Beta kubernetes#132704
  • 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
    • Add feature gate WatchListClient for v1.30 website#47261
    • Document KEP 3157 (watch-list) for milestone 1.32 website#48512
    • Blog post: Enhancing Kubernetes API Server Efficiency with API Streaming website#48513

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.