CSI Differential Snapshot for Block Volumes

[phuongatemc]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add Differential Snapshot to CSI to provide a common method get differential snapshots of two arbitrary CSI VolumeSnapshots for PersistentVolumes that are backed by Block volumes in the backend storage.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-storage/3314-csi-changed-block-tracking/README.md
  CSI spec PR: Added the SnapshotMetadata service. container-storage-interface/spec#551
• Discussion Link: https://hackmd.io/VN_TBl3NSLaeiD8BLeeCfw?view
• Primary contact (assignee): @ihcsim @Braganza @PrasadG193
• Responsible SIGs: SIG-Storage
• 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): KEP-3314: CSI Changed Block Tracking #4082, KEP-3314: Update alpha target and latest-milestone for 1.32 #4909, KEP-3314: Update alpha target and latest-milestone for 1.33 #5133
  • Code (k/k) update PR(s):
  • Docs (k/website) update PR(s): Blog: WIP: Blog post for changed block tracking feature website#48456

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

[xing-yang]

/sig storage

[xing-yang]

/wg data-protection

[xing-yang]

/milestone v1.25

[jasonbraganza]

Hello @phuongatemc 👋, 1.25 Enhancements team here.

Just checking in as we approach enhancements freeze on 18:00 PST on Thursday June 16, 2022.

For note, This enhancement is targeting for stage alpha for 1.25 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP file using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable
• KEP has a updated detailed test plan section filled out
• KEP has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

Looks like for this one, we would need to update the following:

• Have a KEP with all the above checkpoints included and a completed PRR, merged in kubernetes/enhancements repo

Open KEP PR #3367

For note, the status of this enhancement is marked as at risk. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[jasonbraganza]

Hello @phuongatemc, @ihcsim 👋, just a quick check-in again, as we approach the 1.25 enhancements freeze.

Please plan to get the above done before enhancements freeze on Thursday, June 16, 2022 at 18:00 PM PT.

For note, the current status of the enhancement is atat-risk. Thank you!

[phuongatemc]

@jasonbraganza I have updated the issue description with the PR #3367
This is still an work in progress so we don't have the code ready yet but here is our repository https://github.com/phuongatemc/diffsnapcontroller/

[jasonbraganza]

Thank you so much for the updates, @phuongatemc 🙂

Could you please, make the following updates in you open PR #3367

1. Update the status from provisional to implementable in the kep.yaml file.
2. Please update the test plan section, to add the test information in the requested format, as described in the template

Please plan to have the PR merged, before the updated enhancements freeze date on Thursday, June 23, 2022.

[ihcsim]

@jasonbraganza thanks - we added the test plan section yesterday. I thought the KEP must be approved before we can update it to implementable.

[jasonbraganza]

Hello @ihcsim. Just checking in, as we are four days away from the enhancements freeze on Thursday, June 23, 2022 at 18:00 PM PT.

I thought the KEP must be approved before we can update it to implementable.

For a KEP to be tracked in release cycle, it should be marked as implementable.

Kindly plan to have the PR merged by the freeze date.

Please note: the current status of the enhancement is at-risk.
Thank you.

[Priyankasaggu11929]

Hello, 1.25 Enhancements Lead here 👋. With Enhancements Freeze now in effect, this enhancement has not met the criteria for the freeze and has been removed from the milestone.

As a reminder, the criteria for enhancements freeze is:

• KEP file using the latest template has been merged into the k/enhancements repo, with up to date latest milestone and stage
• KEP status is marked as implementable
• KEP has an updated detailed test plan section filled out
• KEP has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

Feel free to file an exception to add this back to the release. If you plan to do so, please file this as early as possible.

Thanks!
/milestone clear

[xing-yang]

/milestone v1.26

[PrasadG193]

Hey @tjons ,
We would like to address the following issues before the release -

• Add E2E tests kubernetes-csi/external-snapshot-metadata#13
• CSI driver developer support  kubernetes-csi/external-snapshot-metadata#17
• Add example of csi hostpath driver kubernetes-csi/external-snapshot-metadata#62

[tjons]

Hello @PrasadG193 👋 Enhancements team here,

Unfortunately, the implementation (code related) PR(s) associated with this enhancement is not in the merge-ready state by code-freeze and hence this enhancement is now removed from the 1.32 milestone. I am basing this off of the three issues still open without PRs that you linked above.

If you still wish to progress this enhancement in 1.32, 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!

/milestone clear

[dipesh-rawat]

Hello @PrasadG193 👋, 1.33 Enhancements Lead here.

If you'd like to work on this enhancement in v1.33, please have the SIG lead opt-in by adding the lead-opted-in label, which ensures it gets added to the tracking board. Also, please set the milestone to v1.33 using /milestone v1.33.
Thanks!

/remove-label lead-opted-in

[PrasadG193]

/lead-opted-in

[PrasadG193]

@dipesh-rawat Yes, we would like to continue working on this enhancement. Do we need to ask the sig-storage lead to add the labels? Also, this feature is out-of-tree to K8s and can be released independently from the K8s release cycle.

[xing-yang]

@dipesh-rawat The labels are added. Let us know if anything else is missing. Thanks!

[dipesh-rawat]

Hello @PrasadG193 @xing-yang 👋, v1.33 Enhancements team here.

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

This enhancement is targeting stage alpha for v1.33 (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.33.
• 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. 🚀

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!

/label tracked/yes

[rayandas]

Hello @PrasadG193 @xing-yang 👋, 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!

[Rakshith-R]

Hello @PrasadG193 @xing-yang 👋, 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!

Hey @rayandas ,

As mentioned here #3314 (comment)

We expect the documentation to be out-of-tree in the https://github.com/kubernetes-csi/docs repo - they will become visible in (https://kubernetes-csi.github.io/docs. This will be done after the sidecar is developed.

The documentation pr is already merged kubernetes-csi/docs#605 and is live here https://kubernetes-csi.github.io/docs/external-snapshot-metadata.html .

Please let us know if anything else is needed to be done.

Thanks

cc @PrasadG193 @carlbraganza

[PrasadG193]

Hey @rayandas, this is an out-of-tree feature. We have recently made the first alpha release and documentation is also published on https://kubernetes-csi.github.io/docs/external-snapshot-metadata.html. Please let us know if anything else is needed.

[rayandas]

Alright @Rakshith-R and @PrasadG193, thanks for the update. I think that should be good.

[dipesh-rawat]

Hey again @PrasadG193 @xing-yang 👋, 1.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 KEP, we would need to do the following:

• Ensure all PRs to the Kubernetes repo related to your enhancement are linked in the above issue description (for tracking purposes).
• Ensure all PRs are prepared for merging (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

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.

[aakankshabhende]

Hi @ihcsim @Braganza @PrasadG193 👋 -- this is Aakanksha (@aakankshabhende ) 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.