Skip to content

Commit c60bb21

Browse files
authored
Promote KEP-4292 custom profiling in kubectl debug to GA (#4824)
* Promote KEP-4292 custom profiling in kubectl debug to GA * Apply review suggestions * Fix the feature gate removal release
1 parent 362f7b3 commit c60bb21

File tree

3 files changed

+23
-6
lines changed

3 files changed

+23
-6
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ alpha:
66
approver: "@johnbelamaric"
77
beta:
88
approver: "@johnbelamaric"
9+
stable:
10+
approver: "@johnbelamaric"

keps/sig-cli/4292-kubectl-debug-custom-profile/README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,8 @@ Items marked with (R) are required *prior to targeting to a milestone / release*
145145
- [x] (R) Production readiness review completed
146146
- [x] (R) Production readiness review approved
147147
- [X] "Implementation History" section is up-to-date for milestone
148-
- [ ] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
149-
- [ ] Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
148+
- [X] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
149+
- [X] Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
150150

151151
<!--
152152
**Note:** This checklist is iterative and should be reviewed and updated every time this enhancement is being considered for a milestone.
@@ -399,6 +399,8 @@ New unit test cases will be added for the following scenarios:
399399
- During the copying pod, custom profile is set and `--profile` is `general` and the output is expected
400400
- During the node debugging, custom profile is set and `--profile` is `general` and the output is expected
401401

402+
- `k8s.io/kubernetes/vendor/k8s.io/kubectl/pkg/cmd/debug`: `30-09-2024` - `67.3%`
403+
402404
##### Integration tests
403405

404406
<!--
@@ -425,6 +427,10 @@ this value is in the pod spec.
425427
- Send invalid custom profile json(not in corev1.Container type or completely invalid json) and assure that
426428
the error message is correct.
427429

430+
integration tests (defined in https://k8s.io/kubernetes/test/cmd/debug.sh#L571-L661) are running in
431+
https://storage.googleapis.com/k8s-triage/index.html?pr=1&job=pull-kubernetes-integration
432+
433+
428434
##### e2e tests
429435

430436
<!--
@@ -518,7 +524,7 @@ in back-to-back releases.
518524

519525
#### GA
520526

521-
- Environment variable is removed altogether and feature is enabled and can not be disabled.
527+
- Feature gate (i.e. `KUBECTL_DEBUG_CUSTOM_PROFILE`) is locked to true and will be removed in 1.34.
522528
- e2e tests are implemented and enabled.
523529

524530
### Upgrade / Downgrade Strategy
@@ -941,8 +947,16 @@ For each of them, fill in the following information by copying the below templat
941947
- Testing: Are there any tests for failure mode? If not, describe why.
942948
-->
943949

950+
- invalid debug pod after invalid custom profiling
951+
- Detection: Debug pod is not in running state or not having required privileges to debug smoothly
952+
- Mitigations: Pod can be deleted and re-run after modifying the custom profile
953+
- Diagnostics: Pod can't be attached or in not running state
954+
- Testing: There are several unit tests are implemented in https://github.com/kubernetes/kubectl/blob/master/pkg/cmd/debug/debug_test.go
955+
944956
###### What steps should be taken if SLOs are not being met to determine the problem?
945957

958+
Not applicable
959+
946960
## Implementation History
947961

948962
<!--
@@ -957,6 +971,7 @@ Major milestones might include:
957971
-->
958972
- 2023-10-13: Kep is proposed as alpha feature
959973
- 2024-06-04: Kep is promoted to beta
974+
- 2024-09-05: Kep is promoted to stable
960975

961976
## Drawbacks
962977

keps/sig-cli/4292-kubectl-debug-custom-profile/kep.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ see-also:
1818
- "/keps/sig-cli/1441-kubectl-debug"
1919

2020
# The target maturity stage in the current dev cycle for this KEP.
21-
stage: alpha
21+
stage: stable
2222

2323
# The most recent milestone for which work toward delivery of this KEP has been
2424
# done. This can be the current (upcoming) milestone, if it is being actively
2525
# worked on.
26-
latest-milestone: "v1.31"
26+
latest-milestone: "v1.32"
2727

2828
# The milestone at which this feature was, or is targeted to be, at each stage.
2929
milestone:
3030
alpha: "v1.30"
3131
beta: "v1.31"
32-
stable: "TBD"
32+
stable: "1.32"
3333

3434
# The following PRR answers are required at alpha release
3535
# List the feature gate name and the components for which it must be enabled

0 commit comments

Comments
 (0)