Skip to content

Commit d5b2be7

Browse files
committed
use the correct flag name
1 parent ba451d6 commit d5b2be7

File tree

1 file changed

+19
-35
lines changed
  • keps/sig-node/5573-cgroup-v1-unsupported

1 file changed

+19
-35
lines changed

keps/sig-node/5573-cgroup-v1-unsupported/README.md

Lines changed: 19 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ By formally moving cgroup v1 to unsupported status, Kubernetes provides a clear
9191

9292
### Goals
9393

94-
1. **Disable cgroup v1 support by default**: Set the kubelet flag `--disable-cgroupv1-support` to `true` by default, effectively making cgroup v1 unsupported unless explicitly enabled.
94+
1. **Disable cgroup v1 support by default**: Set the kubelet flag `FailCgroupV1` to `true` by default, effectively making cgroup v1 unsupported unless explicitly enabled.
9595

9696
2. **Clear messaging**: Update warning messages and events to reflect that cgroup v1 is now unsupported rather than in maintenance mode.
9797

@@ -119,7 +119,7 @@ The primary risks involve potential disruptions for users who have not yet migra
119119

120120
1. **Existing clusters running cgroup v1**: Users running Kubernetes on hosts with cgroup v1 will need to either:
121121
- Migrate their hosts to cgroup v2 (recommended)
122-
- Explicitly set `--disable-cgroupv1-support=false` to continue using cgroup v1 (not recommended)
122+
- Explicitly set `FailCgroupV1=false` to continue using cgroup v1 (not recommended)
123123

124124
2. **Workload compatibility**: Users depending on technologies that require specific versions for cgroup v2 support:
125125
- OpenJDK / HotSpot: jdk8u372, 11.0.16, 15 and later
@@ -130,7 +130,7 @@ The primary risks involve potential disruptions for users who have not yet migra
130130

131131
**Mitigations**:
132132
- Provide comprehensive migration documentation and guidance
133-
- Maintain the ability to override the default behavior with `--disable-cgroupv1-support=false`
133+
- Change the KubeletConfig field FailCgroupV1 to false.
134134
- Clear warning messages when cgroup v1 is detected
135135
- Community support through migration period
136136
- Advance notice through multiple release cycles
@@ -139,20 +139,20 @@ The primary risks involve potential disruptions for users who have not yet migra
139139

140140
This enhancement primarily involves configuration changes and messaging updates, building on the infrastructure already implemented in KEP-4569.
141141

142-
### Enable fail-cgroup-v1 by default
142+
### Enable FailCgroupV1 by default
143143

144-
The key technical change is to modify the default value of the kubelet flag `--disable-cgroupv1-support` from `false` to `true`. This change will be implemented in the kubelet configuration types.
144+
The key technical change is to modify the default value of the kubelet config api `FailCgroupV1` from `false` to `true`. This change will be implemented in the kubelet configuration types.
145145

146146
Current behavior:
147147
```go
148148
// Default: false (cgroup v1 support enabled by default)
149-
DisableCgroupV1Support: false,
149+
FailCgroupV1: false,
150150
```
151151

152152
Proposed behavior:
153153
```go
154154
// Default: true (cgroup v1 support disabled by default)
155-
DisableCgroupV1Support: true,
155+
FailCgroupV1: true,
156156
```
157157

158158
### Update warning messages and events
@@ -204,8 +204,7 @@ implementing this enhancement to ensure the enhancements have also solid foundat
204204

205205
All existing cgroup v2 test jobs must continue to pass. Tests should verify that:
206206
1. The default behavior correctly disables cgroup v1 support
207-
2. The override flag `--disable-cgroupv1-support=false` continues to work
208-
3. Appropriate warning messages are displayed when cgroup v1 is detected
207+
2. Appropriate warning messages are displayed when cgroup v1 is detected
209208

210209
##### Unit tests
211210

@@ -246,31 +245,16 @@ We expect no non-infra related flakes in the last month as a GA graduation crite
246245
1. Continue monitoring cgroup v2 CI jobs to ensure stability
247246
2. Add specific tests for the new default behavior
248247
3. Ensure all new tests use cgroup v2 hosts
249-
4. Maintain minimal testing for override scenarios where cgroup v1 is explicitly enabled
248+
4. Remove all cgroup v1 test lanes.
250249

251250
### Graduation Criteria
252251

253-
#### Alpha
252+
#### GA
254253

255-
- Default value for `--disable-cgroupv1-support` changed to `true`
254+
- Default value for `FailCgroupV1` changed to `true`
256255
- Updated warning messages and events for unsupported status
257256
- Documentation updates in kubernetes/enhancements repository
258-
- Basic test coverage for new default behavior
259-
260-
#### Beta
261-
262-
- Comprehensive testing across multiple scenarios
263-
- Updated documentation in kubernetes/website
264-
- Community feedback incorporated
265-
- Stable behavior across different environments
266-
267-
#### GA
268-
269-
- All tests passing consistently
270-
- Complete documentation coverage
271-
- Community migration guidance available
272-
- Blog post announcing the change
273-
- Preparation for future removal KEP
257+
- All e2e testing removed for cgroup v1.
274258

275259
### Upgrade / Downgrade Strategy
276260

@@ -287,7 +271,7 @@ enhancement:
287271
-->
288272

289273
**Upgrade considerations**:
290-
- Clusters upgrading to Kubernetes v1.35+ on cgroup v1 hosts will fail to start kubelet unless `--disable-cgroupv1-support=false` is explicitly set
274+
- Clusters upgrading to Kubernetes v1.35+ on cgroup v1 hosts will fail to start kubelet unless `FailCgroupV1` is set to false
291275
- Administrators should migrate to cgroup v2 before upgrading or explicitly set the override flag
292276
- Clear documentation and communication about this breaking change
293277

@@ -339,17 +323,17 @@ you need any help or guidance.
339323

340324
###### How can this feature be enabled / disabled in a live cluster?
341325

342-
This is a default configuration change. The feature can be controlled via the kubelet flag:
343-
- To disable cgroup v1 support (default): `--disable-cgroupv1-support=true`
344-
- To enable cgroup v1 support (override): `--disable-cgroupv1-support=false`
326+
This is a default configuration change. The feature can be controlled via the kubelet config:
327+
- To disable cgroup v1 support (default): `FailCgroupV1=true`
328+
- To enable cgroup v1 support (override): `FailCgroupV1=false`
345329

346330
###### Does enabling the feature change any default behavior?
347331

348332
Yes, this change modifies the default behavior. Previously, cgroup v1 support was enabled by default. After this change, cgroup v1 support will be disabled by default.
349333

350334
###### Can the feature be disabled once it has been enabled (i.e. can we roll back the enablement)?
351335

352-
Yes, users can set `--disable-cgroupv1-support=false` to re-enable cgroup v1 support.
336+
Yes, users can set `FailCgroupV1=false` to re-enable cgroup v1 support.
353337

354338
###### What happens if we reenable the feature if it was previously rolled back?
355339

@@ -386,7 +370,7 @@ Testing will include:
386370

387371
###### Is the rollout accompanied by any deprecations and/or removals of features, APIs, fields of API types, flags, etc.?
388372

389-
This change moves cgroup v1 from maintenance mode to unsupported status but does not remove any APIs or flags. The `--disable-cgroupv1-support` flag remains available for override purposes.
373+
This change moves cgroup v1 from maintenance mode to unsupported status but does not remove any APIs or flags. The `FailCgroupV1` flag remains available for override purposes.
390374

391375
### Monitoring Requirements
392376

@@ -463,7 +447,7 @@ This feature operates at the kubelet level and does not depend on API server or
463447

464448
**Failure mode**: Kubelet fails to start on cgroup v1 hosts
465449
- **Detection**: Kubelet startup logs and node status
466-
- **Mitigation**: Set `--disable-cgroupv1-support=false` or migrate to cgroup v2
450+
- **Mitigation**: Set `FailCgroupV1=false` or migrate to cgroup v2
467451
- **Diagnostics**: Kubelet logs will clearly indicate cgroup v1 detection and unsupported status
468452
- **Testing**: Covered in unit and integration tests
469453

0 commit comments

Comments
 (0)