Skip to content

Commit

Permalink
Change reference of feature gate to feature flag
Browse files Browse the repository at this point in the history
  • Loading branch information
RaunakShah committed Jan 25, 2022
1 parent 6ef2f18 commit e957dd6
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions keps/sig-storage/3141-prevent-volume-mode-conversion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,26 @@
To get started with this template:
- [ ] **Pick a hosting SIG.**
- [x] **Pick a hosting SIG.**
Make sure that the problem space is something the SIG is interested in taking
up. KEPs should not be checked in without a sponsoring SIG.
- [ ] **Create an issue in kubernetes/enhancements**
- [x] **Create an issue in kubernetes/enhancements**
When filing an enhancement tracking issue, please make sure to complete all
fields in that template. One of the fields asks for a link to the KEP. You
can leave that blank until this KEP is filed, and then go back to the
enhancement and add the link.
- [ ] **Make a copy of this template directory.**
- [x] **Make a copy of this template directory.**
Copy this template into the owning SIG's directory and name it
`NNNN-short-descriptive-title`, where `NNNN` is the issue number (with no
leading-zero padding) assigned to your enhancement above.
- [ ] **Fill out as much of the kep.yaml file as you can.**
- [x] **Fill out as much of the kep.yaml file as you can.**
At minimum, you should fill in the "Title", "Authors", "Owning-sig",
"Status", and date-related fields.
- [ ] **Fill out this file as best you can.**
- [x] **Fill out this file as best you can.**
At minimum, you should fill in the "Summary" and "Motivation" sections.
These should be easy if you've preflighted the idea of the KEP with the
appropriate SIG(s).
- [ ] **Create a PR for this KEP.**
- [x] **Create a PR for this KEP.**
Assign it to people in the SIG who are sponsoring this process.
- [ ] **Merge early and iterate.**
Avoid getting hung up on specific details and instead aim to get the goals of
Expand Down Expand Up @@ -256,8 +256,9 @@ Consider including folks who also work outside the SIG or subproject.

## Design Details

A new out-of-tree flag named `PreventVolumeModeConversion` will be introduced on `external-snapshotter`
and `external-provisioner`. Both of these components are out-of-tree so this proposal will not require any in-tree feature gates.
A new out-of-tree flag named `PreventVolumeModeConversion` will be introduced on
`external-snapshotter` and `external-provisioner`. Both of these components are
out-of-tree so this proposal will not require any in-tree feature gates.

### Changes to VolumeSnapshotContent API

Expand Down Expand Up @@ -334,10 +335,10 @@ and without requisite privileges.
#### Unit tests
- With feature gate disabled:
- With feature flag disabled:
- attempt to convert volume mode when creating a `PVC`
from a `VolumeSnapshot`.
- With feature gate enabled, attempt to convert volume mode when creating a `PVC`
- With feature flag enabled, attempt to convert volume mode when creating a `PVC`
from a `VolumeSnapshot`:
- With `Spec.SourceVolumeMode` populated and `snapshot.storage.kubernetes.io/allowVolumeModeChange: true`
annotation present.
Expand All @@ -347,7 +348,7 @@ from a `VolumeSnapshot`:
#### E2E tests
- Attempt to convert volume mode when creating a `PVC`from a `VolumeSnapshot`:
- Attempt to convert volume mode when creating a `PVC` from a `VolumeSnapshot`:
- With `Spec.SourceVolumeMode` populated and `snapshot.storage.kubernetes.io/allowVolumeModeChange: true`
annotation present.
- With `Spec.SourceVolumeMode` populated but no `snapshot.storage.kubernetes.io/allowVolumeModeChange: true`
Expand All @@ -368,7 +369,7 @@ from a `VolumeSnapshot`:
#### Beta -> GA
- Deployed in production in use by backup vendors.
- Deployed in production and in use by backup software.
- Gone through one kubernetes upgrade.
### Upgrade / Downgrade Strategy
Expand Down Expand Up @@ -430,8 +431,8 @@ was disabled will not have the new capabilities.
###### Are there any tests for feature enablement/disablement?
We will add unit tests with and without the feature gate enabled. The expectation
is for new fields in `VolumeSnapshotContent` to be dropped when the feature gate
We will add unit tests with and without the feature flag enabled. The expectation
is for new fields in `VolumeSnapshotContent` to be dropped when the feature flag
is disabled.
### Rollout, Upgrade and Rollback Planning
Expand Down

0 comments on commit e957dd6

Please sign in to comment.