Prevent unauthorised volume mode conversion during volume restore

[RaunakShah]

Enhancement Description

• One-line enhancement description (can be used as a release note): Prevent unauthorised volume mode conversion during volume restore.

• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/3141-prevent-volume-mode-conversion

• Primary contact (assignee): @RaunakShah @xing-yang

• Responsible SIGs: SIG-Storage

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

  • Alpha release target (x.y): 1.24
  • Beta release target (x.y): 1.27
  • Stable release target (x.y): 1.30

• Alpha

  • KEP (k/enhancements) update PR(s):
    • https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/3141-prevent-volume-mode-conversion
  • Code (k/k) update PR(s):
    • Update generated code for SourceVolumeMode field in VolumeSnapshotContents kubernetes-csi/external-snapshotter#665
    • Update snapshotter and client modules kubernetes-csi/external-snapshotter#670
  • Docs (k/website) update PR(s):
    • Add docs for preventing volume mode conversion website#32673

• Beta

  • KEP (k/enhancements) update PR(s):
    • KEP-3141: Graduate "Prevent unauthorised volume mode conversion" to Beta  #3556
  • Code (k/k) update PR(s):
    • Add tests for volume mode conversion feature kubernetes-csi/external-provisioner#867
    • Add and enable sidecar e2e test to enable volume mode conversion kubernetes-csi/external-provisioner#832
    • Fix string pointer comparison for source volume mode conversion kubernetes-csi/external-provisioner#793
    • Register metrics exposed by sig-storage-lib kubernetes-csi/external-provisioner#792
    • Change annotation name to allow volume mode change kubernetes-csi/external-provisioner#791
    • Add dataSource label to pvcs created kubernetes-sigs/sig-storage-lib-external-provisioner#128
    • Add optional canary job to all CSI sidecar repos test-infra#28307
  • Docs (k/website) update(s):
    • Update volume mode change annotation in documentation website#39367

• Stable

  • KEP (k/enhancements) update PR(s): KEP-3141: Graduate "Prevent unauthorised volume mode conversion" to Stable #4459, KEP-3141: Add no known failure modes to README #4497

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

[RaunakShah]

/sig storage

[gracenng]

Hi @RaunakShah ! 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, is that correct?.
Here’s where this enhancement currently stands:

• Updated KEP file using the latest template has been merged into the k/enhancements repo.
• 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.
• KEP has a production readiness review that has been completed and merged into k/enhancements.

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

[xing-yang]

/milestone v1.24

[xing-yang]

@gracenng Yes, this is targeting Alpha in 1.24.

[gracenng]

Hi @RaunakShah , 1.24 Enhancements Team here.

Reaching out as we're less than a week away from Enhancement Freeze on Thursday, February 3rd.
Updated some points on the check list above, let me know if I missed anything.
I'm monitoring #3151 and current status is at risk

[gracenng]

All good for 1.24 Enhancements Freeze

[xing-yang]

@gracenng Should this have a Tracked/Yes label?

[didicodes]

Hi @xing-yang & @RaunakShah, 1.24 Docs shadow here. 👋

This enhancement is marked as Needs Docs for the 1.24 release.

Please follow the steps detailed in the documentation to open a PR against the dev-1.24 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday 31st March 2022, 18:00 PDT.

Also, if needed take a look at Documenting for a release to familiarize yourself with the docs requirement for the release.

Thank you! 🙌

[gracenng]

Hi @RaunakShah 1.24 Enhancements Team here,

With Code Freeze approaching on 18:00 PDT Tuesday March 29th 2022, the enhancement status is at risk as there is no linked k/k PR. Kindly list them in this issue. Thanks!

[xing-yang]

PRs are submitted here:
kubernetes-csi/external-snapshotter#665
kubernetes-csi/external-snapshotter#670

[xing-yang]

@gracenng It might be better to label this feature as "tracked/out-of-tree" as all the code changes are out-of-tree.

[gracenng]

All good for Code Freeze!

[nate-double-u]

Hi @RaunakShah, reminder that tomorrow (April 5th) is the deadline for 1.24 Docs Ready for Review.

Please open a PR (and link it back here), push your docs content for this enhancement, and remove the work-in-progress label when ready for review.

We have a tight turnaround to getting docs reviewed and approved for the release, and we’re hoping to have all docs in for review by tomorrow. Thank you!

[xing-yang]

Here's the doc PR: kubernetes/website#32673

[RaunakShah]

@nate-double-u @xing-yang I've removed the WIP label from the doc PR.

[sftim]

This enhancement proposal mentions the annotation snapshot.storage.kubernetes.io/allowVolumeModeChange. Would it be possible to deprecate that in favor of a more conventional snapshot.storage.kubernetes.io/allow-volume-mode-change?

[xing-yang]

This enhancement proposal mentions the annotation snapshot.storage.kubernetes.io/allowVolumeModeChange. Would it be possible to deprecate that in favor of a more conventional snapshot.storage.kubernetes.io/allow-volume-mode-change?

We could do that in 1.25.

[nate-double-u]

A note for when this KEP goes to beta (targeting v1.25): the documentation that was added in v1.24 needs to be updated.

[Priyankasaggu11929]

/milestone clear

[xing-yang]

@pnbrown The KEP PR is merged. Please let us know if anything is missing. Thanks!
cc @RaunakShah

[pnbrown]

@xing-yang Thank you. I've marked that complete.

There is still one question on the readiness survey that is not answered:

https://github.com/kubernetes/enhancements/blob/42fe9143b211db01ed7e6e636a4e73ac2f77ae0a/keps/sig-storage/3141-prevent-volume-mode-conversion/README.md#what-are-other-known-failure-modes

[pnbrown]

With all the requirements fulfilled this enhancement is now marked as tracked for the upcoming enhancements freeze 🚀

[Princesso]

Hello @RaunakShah, 👋 1.30 Docs Shadow here.
Does this enhancement work planned for 1.30 require any new docs or modifications to existing docs?
If so, please follow the steps here to open a PR against the dev-1.30 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday, February 22nd, 2024 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!

[a-mccarthy]

Hi @RaunakShah ,

👋 from the v1.30 Communications Team! We'd love for you to opt in to write a feature blog about your enhancement!

We encourage blogs for features including, but not limited to: breaking changes, features and changes important to our users, and features that have been in progress for a long time and are graduating.

To opt in, you need to open a Feature Blog placeholder PR against the website repository.
The placeholder PR deadline is 27th February, 2024.
Here's the 1.30 Release Calendar

[RaunakShah]

@Princesso Here is the placeholder PR for the doc updates - kubernetes/website#45262
@a-mccarthy Here is the placeholder PR for the blog - kubernetes/website#45261

[pnbrown]

Hey again @RaunakShah 👋 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 6th March 2024 .

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.

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!

[pnbrown]

@RaunakShah, Enhancements team here!
As this enhancement is targeting stable for this release, may you please update the status field in the kep.yaml file to implemented as the code PRs are merged and the feature gates are removed.

https://github.com/kubernetes/enhancements/blob/master/keps/sig-storage/3141-prevent-volume-mode-conversion/kep.yaml

[RaunakShah]

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.

Hi @pnbrown, the only tickets remaining for this KEP are documentation and blog related. There are no other code changes that need to go in.

As this enhancement is targeting stable for this release, may you please update the status field in the kep.yaml file to implemented as the code PRs are merged and the feature gates are removed.

Sure will do!

[a-mccarthy]

@RaunakShah, looks like the links for the blog and docs placeholder PRs got reversed in your comment above. The correct links are below:

@Princesso Here is the placeholder PR for the doc updates - kubernetes/website#45261
@a-mccarthy Here is the placeholder PR for the blog - kubernetes/website#45262

Please note some important deadlines for comms and docs

• from @Princesso here: Hello @RaunakShah 👋 please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday March 12th 2024 18:00 PST. Thank you!
• Blog ready for review deadline is March 22, 2024

Please reach out if you have any questions!

[sreeram-venkitesh]

Hi @RaunakShah 👋, 1.31 Enhancements Lead here.

Since this KEP has been graduated to GA in v1.30, please make sure to update the status field in the kep.yaml to implemented here, after which we can close this issue.

/remove-label lead-opted-in

[k8s-triage-robot]

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

This bot triages un-triaged issues 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 as fresh with /remove-lifecycle stale
• Close this issue 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.

This bot triages un-triaged issues 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 as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

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

/lifecycle rotten

[xing-yang]

/remove-lifecycle rotten

[RaunakShah]

hi @sreeram-venkitesh can this issue be closed now?

[sreeram-venkitesh]

@RaunakShah Yes, now that we've marked the KEP as implemented, we are good to close this issue!

CC: @tjons