Snapshottable API server cache

[serathius]

Enhancement Description

• One-line enhancement description (can be used as a release note): Improve apiserver watch cache to serve pagination.

• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/4988-snapshottable-api-server-cache/README.md

• Discussion Link: SIG api machinery August 21 meeting https://docs.google.com/document/d/1x9RNaaysyO0gXHIr1y50QFbiL1x8OWnk2v3XnrdkT5Y/edit?tab=t.0#heading=h.jnlasazf8f1g

• Primary contact (assignee): serathius@

• Responsible SIGs: api-machinery

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

  • Alpha release target (x.y): 1.33
  • Beta release target (x.y):
  • Stable release target (x.y):

• Alpha

  • KEP (k/enhancements) update PR(s): Snapshottable API server cache #5017
  • Code (k/k) update PR(s):
    • Test continuations and exact revision LISTs kubernetes#130242
    • Watchcache snapshot kubernetes#130279
    • Refactor TestList to allow testing continuations and exact kubernetes#130280
    • Remove limit support from btree store kubernetes#130443
    • Pass storage.ListOptions to WaitUntilFreshAndList kubernetes#130589
    • Test recursive in TestGetListCacheBypass and separate overrides kubernetes#130588
    • Serve LISTs with exact RV and continuations from cache kubernetes#130423
    • Implement consistency checking kubernetes#130475
  • Docs (k/website) update PR(s):
    • KEP-4988 documentation changes website#49941

• Beta

  • KEP (k/enhancements) update PR(s):
    • Consider introducing time based compaction for watch cache
  • Code (k/k) update PR(s):
    • Re-enable conformance test Disable ListFromCacheSnapshot in ci-kubernetes-network-kind-alpha-beta-features test-infra#34587
  • Docs (k/website) update(s):

[serathius]

/sig api-machinery

[fuweid]

Hi @serathius the discussion link is private?

[serathius]

No, it's api-machinery document, so requires you to be part of the apimachinery mailing list.

[jpbetz]

@serathius Is the intent to target alpha for 1.33 or is this future work? There's already a ton of work going on in the watch cache, so I'm perfectly happy to focus on the ongoing efforts for 1.33, but wanted to check to make sure I set milestones and lead-opt-in correctly.

[serathius]

My goal is to target v1.33, It might be hard to get review from @deads2k

[serathius]

/milestone v1.33

[pacoxu]

@jpbetz @dipesh-rawat this is target to v1.33 and the KEP was merged.
Should the lead-opted-in and tracked label be added and tracked by release team?

[dipesh-rawat]

@serathius @pacoxu Unfortunately, the enhancement freeze deadline has passed, and this KEP issue was not lead-opted-in, so it wasn’t added to the tracking board for the v1.33 release. Post-freeze, we've disabled the automated sync job for KEP issues to the tracking board.

To move forward, we’ll need a short exception request filed so the team can add the lead-opted-in label and manually include this in the tracking board.

If you still wish to progress this enhancement in v1.33, please file an exception request as soon as possible, within three days. If you have any questions, you can reach out in the #release-enhancements channel on Slack and we'll be happy to help. Thanks!

(cc v1.33 Release Lead @npolshakova)

[serathius]

Ups, @jpbetz is OOO. @deads2k can you take a look?

[serathius]

Sent https://groups.google.com/g/kubernetes-sig-release/c/CVYYVtjOa78

[dipesh-rawat]

@serathius Thanks for sending the exception request for this KEP. While validating the KEP files we have in the repo, I noticed that the KEP README is missing a few elements compared to latest template.

• Design Details section is missing.
• In the 'Implementation History' section, it would be helpful to mention that the KEP targets alpha in 1.33, as it's currently left blank.

These might need to be addressed for us to consider the KEP as complying with the latest template and be considered for the release. This may mean additional days are needed for the KEP to get merged

[serathius]

Sent #5175

[serathius]

Merged.

[dipesh-rawat]

Since the release team has APPROVED the exception request here. This will be considered to be added to the milestone for v1.33 release.

[dipesh-rawat]

Hello @serathius 👋, v1.33 Enhancements team here.

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

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.33. 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 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 6th February 2025 so that the PRR team has enough time to review your KEP.

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

Could we ensure that this issue has an assignee please.

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

/milestone v1.33
/label tracked/yes

[dipesh-rawat]

@serathius I've manually added this KEP to the tracking board and marked it as tracked for enhancements freeze🚀

We would need one of the SIG leads to add the lead-opted-in label to this one too. Would you be able to request this from the leads whenever you get a chance? Thanks!

[deads2k]

/label lead-opted-in
/milestone v1.33

[rayandas]

Hello @serathius 👋, v1.33 Docs Lead here.

Does this enhancement work planned for v1.33 require any new docs or modification to existing docs?

If so, please follow the steps here to open a PR against dev-1.33 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday 27th February 2025 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!

[xigang]

cc

[aibarbetta]

Hi @serathius 👋 -- this is Agustina (@aibarbetta) from the 1.33 Communications Team!

For the 1.33 release, we are currently in the process of collecting and curating a list of potential feature blogs, and we'd love for you to consider writing one for your enhancement!

As you may be aware, feature blogs are a great way to communicate to users about features which fall into (but not limited to) the following categories:

• This introduces some breaking change(s)
• This has significant impacts and/or implications to users
• ...Or this is a long-awaited feature, which would go a long way to cover the journey more in detail 🎉

To opt in to write a feature blog, could you please let us know and open a "Feature Blog placeholder PR" (which can be only a skeleton at first) against the website repository by Wednesday, 5th March, 2025? For more information about writing a blog, please find the blog contribution guidelines 📚

Tip

Some timeline to keep in mind:

• 02:00 UTC Wednesday, 5th March, 2025: Feature blog PR freeze
• Monday, 7th April, 2025: Feature blogs ready for review
• You can find more in the release document

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.

[aibarbetta]

Hi @serathius 👋, 1.33 Communications Team here again!

This is a gentle reminder for the feature blog deadline mentioned above, which is 02:00 UTC Wednesday, 5th March, 2025. To opt in, please let us know and open a Feature Blog placeholder PR against k/website by the deadline. If you have any questions, please feel free to reach out to us!

Tip

Some timeline to keep in mind:

• 02:00 UTC Wednesday, 5th March, 2025: Feature blog PR freeze
• Monday, 7th April, 2025: Feature blogs ready for review
• You can find more in the release document

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.

[bianbbc87]

Hey again @serathius 👋, v1.33 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Friday 21st March 2025 / 19:00 PDT Thursday 20th March 2025.

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 PRs 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 need to be merged before code freeze (and we need to update the Issue description to include all the related PRs of this KEP):

• Test continuations and exact revision LISTs kubernetes#130242
• Watchcache snapshot kubernetes#130279
• Refactor TestList to allow testing continuations and exact kubernetes#130280
• Remove limit support from btree store kubernetes#130443
• Pass storage.ListOptions to WaitUntilFreshAndList kubernetes#130589
• Test recursive in TestGetListCacheBypass and separate overrides kubernetes#130588
• Serve LISTs with exact RV and continuations from cache kubernetes#130423
• Implement consistency checking kubernetes#130475

Additionally, please let me know if there are any other PRs in k/k not listed above that we should track for this KEP, so that we can maintain accurate status.

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

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

As always, we are here to help if any questions come up. Thanks!

[dipesh-rawat]

Hi @serathius 👋, v1.33 Enhancements team here,

Just a quick friendly reminder as we approach the code freeze later this week, at 02:00 UTC Friday 21st March 2025 / 19:00 PDT Thursday 20th March 2025.

The current status of this enhancement is marked as At risk for code freeze. There are a few requirements mentioned in the comment #4988 (comment) that still need to be completed.

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

[serathius]

Done, coding is done!

[dipesh-rawat]

@serathius Thanks, for the update and clarifying the required changes needed for this KEP are merged. We can mark now this as tracked since all required PRs are merged.

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