Skip to content

Commit 0441fe7

Browse files
rikatzRicardo Katz
authored andcommitted
review comments and do some cleanup
1 parent 8bcdaaa commit 0441fe7

File tree

2 files changed

+16
-49
lines changed

2 files changed

+16
-49
lines changed

keps/sig-cli/2551-return-code-normalization/README.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# KEP-2551: kubectl exit code standardization
2-
2+
π
33
<!-- toc -->
44
- [Release Signoff Checklist](#release-signoff-checklist)
55
- [Summary](#summary)
@@ -95,6 +95,7 @@ to this specific problem.
9595
### Non-Goals
9696

9797
* Define a different return for each internal kubectl step or each APIServer condition/return
98+
* Define a return code pattern for kubectl plugins or other external calls (we will recommend, but this is not a goal)
9899

99100
## Proposal
100101

@@ -106,7 +107,7 @@ to this specific problem.
106107
* Exit codes generated by kubectl itself should be distinct, so as not to be confused with codes from external/subcommands
107108
* Implement a common way so commands can delegate the exit code normalization to a different function
108109

109-
### User Stories (Optional)
110+
### User Stories
110111

111112
#### Story 1
112113
Joice, the SRE of a big company is automating the deployment of the infrastructure with a lot of kubectl commands.
@@ -370,35 +371,17 @@ This section must be completed when targeting alpha to a release.
370371

371372
###### How can this feature be enabled / disabled in a live cluster?
372373

373-
<!--
374-
Pick one of these and delete the rest.
375-
-->
376-
377-
- [ ] Feature gate (also fill in values in `kep.yaml`)
378-
- Feature gate name:
379-
- Components depending on the feature gate:
380-
- [ ] Other
381-
- Describe the mechanism:
382-
- Will enabling / disabling the feature require downtime of the control
383-
plane?
384-
- Will enabling / disabling the feature require downtime or reprovisioning
385-
of a node? (Do not assume `Dynamic Kubelet Config` feature is enabled).
386374

375+
- [X] Feature gate (also fill in values in `kep.yaml`)
376+
- Feature gate name: ENV VAR `KUBECTL_ERROR_CODES`
377+
387378
###### Does enabling the feature change any default behavior?
388379

389-
<!--
390-
Any change of default behavior may be surprising to users or break existing
391-
automations, so be extremely careful here.
392-
-->
380+
Yes, kubectl exit codes numbers will change after the FG is enabled
393381

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

396-
<!--
397-
Describe the consequences on existing workloads (e.g., if this is a runtime
398-
feature, can it break the existing applications?).
399-
400-
NOTE: Also set `disable-supported` to `true` or `false` in `kep.yaml`.
401-
-->
384+
Yes, just remove the Env Var.
402385

403386
###### What happens if we reenable the feature if it was previously rolled back?
404387

keps/sig-cli/2551-return-code-normalization/kep.yaml

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,23 @@ owning-sig: sig-cli
77
status: provisional
88
creation-date: 2021-03-16
99
reviewers:
10-
- TBD
10+
- "@soltysh"
11+
- "@sftim"
12+
- "@rikatz"
13+
- "@deejross"
1114
approvers:
12-
- TBD
13-
prr-approvers:
14-
- TBD
15-
see-also:
16-
- "/keps/sig-aaa/1234-we-heard-you-like-keps"
17-
- "/keps/sig-bbb/2345-everyone-gets-a-kep"
18-
replaces:
19-
- "/keps/sig-ccc/3456-replaced-kep"
15+
- "@soltysh"
16+
2017

2118
# The target maturity stage in the current dev cycle for this KEP.
2219
stage: alpha
2320

2421
# The most recent milestone for which work toward delivery of this KEP has been
2522
# done. This can be the current (upcoming) milestone, if it is being actively
2623
# worked on.
27-
latest-milestone: "v1.22"
24+
latest-milestone: "v1.24"
2825

2926
# The milestone at which this feature was, or is targeted to be, at each stage.
3027
milestone:
31-
alpha: "v1.22"
32-
beta: "v1.23"
33-
stable: "v1.24"
34-
35-
# The following PRR answers are required at alpha release
36-
# List the feature gate name and the components for which it must be enabled
37-
feature-gates:
38-
- name: MyFeature
39-
components:
40-
- kubectl
41-
disable-supported: true
28+
alpha: "v1.24"
4229

43-
# The following PRR answers are required at beta release
44-
metrics:
45-
- my_feature_metric

0 commit comments

Comments
 (0)