Skip to content

Commit cad1368

Browse files
committed
KEP-1682: Move CSIVolumeSupportFSGroup to GA
1 parent 97da0f7 commit cad1368

File tree

3 files changed

+53
-21
lines changed

3 files changed

+53
-21
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
kep-number: 1682
2+
beta:
3+
approver: "@deads2k"
4+
stable:
5+
approver: "@deads2k"

keps/sig-storage/1682-csi-driver-skip-permission/README.md

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Items marked with (R) are required *prior to targeting to a milestone / release*
3232
- [x] (R) Design details are appropriately documented
3333
- [x] (R) Test plan is in place, giving consideration to SIG Architecture and SIG Testing input
3434
- [x] (R) Graduation criteria is in place
35-
- [ ] (R) Production readiness review completed
36-
- [ ] Production readiness review approved
37-
- [ ] "Implementation History" section is up-to-date for milestone
38-
- [ ] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
35+
- [x] (R) Production readiness review completed
36+
- [x] Production readiness review approved
37+
- [x] "Implementation History" section is up-to-date for milestone
38+
- [x] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
3939
- [ ] Supporting documentation e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
4040

4141
[kubernetes.io]: https://kubernetes.io/
@@ -140,15 +140,12 @@ A test plan will include the following tests:
140140

141141
* Alpha in 1.19 provided all tests are passing.
142142
* All functionality is guarded by a new alpha `CSIVolumeFSGroupPolicy` feature gate.
143-
144143
* Beta in 1.20 with design validated by at least two customer deployments
145144
(non-production), with discussions in SIG-Storage regarding success of
146145
deployments.
147146
* The `CSIVolumeFSGroupPolicy` feature gate will graduate to beta.
148147
* E2E tests
149-
150-
151-
* GA in 1.21, with E2E tests in place tagged with feature Storage.
148+
* GA in 1.23, with E2E tests in place tagged with feature Storage.
152149
* The `CSIVolumeFSGroupPolicy` feature gate will graduate to GA.
153150

154151
[issues]: https://github.com/kubernetes/enhancements/issues/1682
@@ -182,25 +179,54 @@ A test plan will include the following tests:
182179

183180
### Rollout, Upgrade and Rollback Planning
184181

185-
_This section must be completed when targeting beta graduation to a release._
186-
187182
* **How can a rollout fail? Can it impact already running workloads?**
188-
Try to be as paranoid as possible - e.g. what if some components will restart
189-
in the middle of rollout?
183+
No, a rollout should not impact running workloads, since the default behavior
184+
remains the same and using this feature requires a change to the CSIDriver.
190185

191186
* **What specific metrics should inform a rollback?**
187+
No known rollback criteria.
192188

193189
* **Were upgrade and rollback tested? Was upgrade->downgrade->upgrade path tested?**
194-
Describe manual testing that was done and the outcomes.
195-
Longer term, we may want to require automated upgrade/rollback tests, but we
196-
are missing a bunch of machinery and tooling and do that now.
190+
The upgrade->downgrade->upgrade path should work fine--if the new field is
191+
not present in the CSIDriver object, it defaults to current heuristic of
192+
looking at fstype and RWO volumes for applying fsgroups.
197193

198194
* **Is the rollout accompanied by any deprecations and/or removals of features,
199195
APIs, fields of API types, flags, etc.?**
200-
Even if applying deprecation policies, they may still surprise some users.
196+
No, this feature does not deprecate any existing functionality.
201197

202198
### Monitoring requirements
203199

200+
###### How can an operator determine if the feature is in use by workloads?
201+
202+
Check if `CSIDriver.Spec.FSGroupPolicy` is used on any CSIDriver objects.
203+
204+
###### How can someone using this feature know that it is working for their instance?
205+
206+
- [x] Other (treat as last resort)
207+
- Details:
208+
This is not an end user feature. Only cluster admins can configure `CSIDriver`
209+
objects. To verify the feature is functioning, they can review kubelet log
210+
messages from `mounter.SetupAt`.
211+
212+
###### What are the reasonable SLOs (Service Level Objectives) for the enhancement?
213+
214+
- No increased failure rates during mount operations.
215+
- Mount times should be expected to be less than or equal to the default behavior.
216+
217+
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
218+
219+
- [x] Metrics
220+
- Metric name: storage_operation_duration_seconds
221+
- [Optional] Aggregation method: filter by `operation_name = volume_mount`
222+
- Components exposing the metric: kubelet
223+
224+
There should be no change in `status: fail-unknown` once `CSIDriver.Spec.FSGroupPolicy` is set.
225+
226+
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
227+
228+
No additional metrics needed for this new API field.
229+
204230
### Dependencies
205231

206232
* **Does this feature depend on any specific services running in the cluster?**
@@ -238,4 +264,5 @@ There should be no noticeable increase to resource usage for any components.
238264

239265
- 2020-04-27 Initial KEP pull request submitted
240266
- 2020-05-12 Updated to use new KEP template
241-
- 2020-09-25 Moved E2E Tests for beta target
267+
- 2020-09-25 Moved E2E Tests for beta target
268+
- 2020-11-12 Feature moved to beta

keps/sig-storage/1682-csi-driver-skip-permission/kep.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ title: Skip Volume Ownership Change
22
kep-number: 1682
33
authors:
44
- "@huffmanca"
5+
- "@dobsonj"
56
owning-sig: sig-storage
67
participating-sigs:
78
- sig-storage
@@ -16,14 +17,13 @@ approvers:
1617
see-also:
1718
replaces:
1819

19-
stage: alpha
20-
21-
latest-milestone: "v1.19"
20+
stage: stable
21+
latest-milestone: "v1.23"
2222

2323
milestone:
2424
alpha: "v1.19"
2525
beta: "v1.20"
26-
stable: "v1.21"
26+
stable: "v1.23"
2727

2828
feature-gates:
2929
- name: CSIVolumeSupportFSGroup

0 commit comments

Comments
 (0)