Skip to content

buffer: add revision ring buffer#351

Open
yedou37 wants to merge 1 commit into
kubernetes:masterfrom
yedou37:feat-ringBuffer
Open

buffer: add revision ring buffer#351
yedou37 wants to merge 1 commit into
kubernetes:masterfrom
yedou37:feat-ringBuffer

Conversation

@yedou37
Copy link
Copy Markdown

@yedou37 yedou37 commented May 8, 2026

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR adds a shared revision-ordered ring buffer utility to k8s.io/utils/buffer.

The motivation comes from review feedback on kubernetes/kubernetes#138338, where the snapshot ring buffer implementation in apiserver was requested to align more closely with etcd's cache ring buffer so that the implementation can eventually be shared between Kubernetes and etcd.

The new utility:

  • keeps entries ordered by revision
  • supports binary-search-based iteration boundaries
  • supports removing entries older than a given revision
  • supports explicit capacity growth while preserving logical order
  • keeps the internal layout and iteration/search structure close to etcd's cache/ringbuffer.go

Why this is needed:

The existing k8s.io/utils/buffer utilities cover generic fixed-size and growing ring buffers, but they do not provide the revision-aware semantics needed by the Kubernetes snapshot storage use case, such as revision-ordered lookup and trimming by revision.

Which issue(s) this PR fixes:

N/A

Special notes for your reviewer:

This utility is extracted from the ring buffer work proposed in kubernetes/kubernetes#138338.

Related etcd context:

The implementation is intended to stay close in spirit to etcd's cache ring buffer while also covering the revision-aware operations currently needed by the Kubernetes snapshot storage use case.

Release note:

NONE

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label May 8, 2026
@k8s-ci-robot k8s-ci-robot requested review from aojea and deads2k May 8, 2026 07:51
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

Details 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

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @yedou37!

It looks like this is your first PR to kubernetes/utils 🎉. 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/utils 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 k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 8, 2026
@yedou37
Copy link
Copy Markdown
Author

yedou37 commented May 8, 2026

/cc @dims @serathius

@k8s-ci-robot k8s-ci-robot requested review from dims and serathius May 8, 2026 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants