Skip to content

Commit d51c5c2

Browse files
author
Ricardo Katz
committed
Fix PRR review comments
1 parent 71cbf14 commit d51c5c2

File tree

3 files changed

+23
-31
lines changed

3 files changed

+23
-31
lines changed

keps/prod-readiness/sig-cli/2551.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
kep-number: 2551
22
alpha:
3-
approver: "@johnbelamaric"
3+
approver: "@johnbelamaric"

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

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
- [Story 1](#story-1)
1212
- [Story 2](#story-2)
1313
- [Story 3](#story-3)
14-
- [Notes/Constraints/Caveats (Optional)](#notesconstraintscaveats-optional)
1514
- [Risks and Mitigations](#risks-and-mitigations)
1615
- [Feature Gating](#feature-gating)
1716
- [Design Details](#design-details)
@@ -36,7 +35,6 @@
3635
- [Implementation History](#implementation-history)
3736
- [Drawbacks](#drawbacks)
3837
- [Alternatives](#alternatives)
39-
- [Infrastructure Needed (Optional)](#infrastructure-needed-optional)
4038
<!-- /toc -->
4139

4240
## Release Signoff Checklist
@@ -135,15 +133,6 @@ was due to something on the client side (like a missing flag, an invalid yaml fi
135133
is due to some invalid operation on the server side.
136134

137135

138-
### Notes/Constraints/Caveats (Optional)
139-
140-
<!--
141-
What are the caveats to the proposal?
142-
What are some important details that didn't come across above?
143-
Go in to as much detail as necessary here.
144-
This might be a good place to talk about core concepts and how they relate.
145-
-->
146-
147136
### Risks and Mitigations
148137

149138
* Users already relying on specific error codes might face migration problems / false positives or negatives
@@ -292,24 +281,28 @@ Not applicable, as this is just a kubectl change
292281
###### How can this feature be enabled / disabled in a live cluster?
293282

294283

295-
- [X] Feature gate (also fill in values in `kep.yaml`)
296-
- Feature gate name: ENV VAR `KUBECTL_ERROR_CODES`
297-
284+
- [X] Other
285+
- Describe the mechanism: Environment Variable `KUBECTL_ERROR_CODES`
286+
- Will enabling / disabling the feature require downtime of the control plane?
287+
No
288+
- Will enabling / disabling the feature require downtime or reprovisioning of a node?
289+
No
298290
###### Does enabling the feature change any default behavior?
299291

300-
Yes, kubectl exit codes numbers will change after the FG is enabled
292+
Yes, kubectl exit codes numbers will change after the Environment variable is set
301293

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

304-
Yes, just remove the Env Var.
296+
Yes, just remove the Environment Variable.
305297

306298
###### What happens if we reenable the feature if it was previously rolled back?
307299

308300
kubectl will start issuing different and standardized exit codes again when errors occurs.
309301

310302
###### Are there any tests for feature enablement/disablement?
311303

312-
No.
304+
A test simulating an error can be created, and check a return code
305+
so we can assert if the enablement is working.
313306

314307
### Rollout, Upgrade and Rollback Planning
315308

@@ -336,11 +329,15 @@ No
336329

337330
Not applicable
338331

339-
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
332+
###### How can someone using this feature know that it is working for their instance?
333+
- [X] Other
334+
- Details: There are some situations today were exit codes are not returned correctly. Knowing this situations, someone can test whether the expected exit code was returned given a well known situation.
335+
336+
###### What are the reasonable SLOs (Service Level Objectives) for the enhancement?
340337

341338
Not applicable
342339

343-
###### What are the reasonable SLOs (Service Level Objectives) for the above SLIs?
340+
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
344341

345342
Not applicable
346343

@@ -400,9 +397,7 @@ Not applicable
400397

401398
## Drawbacks
402399

403-
<!--
404-
Why should this KEP _not_ be implemented?
405-
-->
400+
N/A
406401

407402
## Alternatives
408403

@@ -411,11 +406,3 @@ What other approaches did you consider, and why did you rule them out? These do
411406
not need to be as detailed as the proposal, but should include enough
412407
information to express the idea and why it was not acceptable.
413408
-->
414-
415-
## Infrastructure Needed (Optional)
416-
417-
<!--
418-
Use this section if you need things from the project/SIG. Examples include a
419-
new subproject, repos requested, or GitHub details. Listing these here allows a
420-
SIG to get the process for these resources started right away.
421-
-->

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,8 @@ latest-milestone: "v1.24"
2727
milestone:
2828
alpha: "v1.24"
2929

30+
feature-gates:
31+
- name: KUBECTL_ERROR_CODES
32+
components:
33+
- kubectl
34+
disable-supported: true

0 commit comments

Comments
 (0)