Custom profile in kubectl debug

[ardaguclu]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add custom profiling support in kubectl debug
• Kubernetes Enhancement Proposal: KEP 4292
• Discussion Link: Discussed in multiple issues but first one is Not possible to load an ephemeral container in a POD with runAsNonRoot:true kubernetes#113006 (comment)
• Primary contact (assignee): @ardaguclu
• Responsible SIGs: sig-cli
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.30
  • Beta release target (x.y): 1.31
  • Stable release target (x.y): 1.32
• Alpha
  • KEP (k/enhancements) update PR(s): KEP-4292: Add custom profiling in kubectl debug #4293
  • Code (k/k) update PR(s): kubectl debug: Add custom debug profiles on top of static profiles kubernetes#120346
  • Docs (k/website) update PR(s): KEP-4292: Custom profile in kubectl debug website#45223
• Beta
  • KEP (k/enhancements) update PR(s): KEP-4292: Update to promote it to beta #4689
  • Code (k/k) update PR(s): KEP-4292: Preparations to promote custom profiling in kubectl debug kubernetes#125333
  • Docs (k/website) update(s): Custom profiling in kubectl debug feature blog website#46909
• Stable
  • KEP (k/enhancements) update PR(s): Promote KEP-4292 custom profiling in kubectl debug to GA #4824
  • Code (k/k) update PR(s): KEP-4292: Add e2e test for custom profile in kubectl debug kubernetes#127187
  • Docs (k/website) update(s): KEP-4292: Remove custom profiling env var as it is GA now website#47805

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

[ardaguclu]

/sig cli

[soltysh]

/label lead-opted-in
/milestone v1.30

[soltysh]

/stage alpha

[soltysh]

/assign @ardaguclu

[tjons]

Hello @ardaguclu 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on Friday, February 9th, 2024 at 02:00 UTC.

This enhancement is targeting for stage alpha for 1.30 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: 1.30. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

For this KEP, we would just need to complete the following:

• Add graduation criteria to the KEP readme.
• Merge the KEP readme into k/enhancements.
• Complete the PRR review process and merge it into k/enhancements.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[ardaguclu]

@tjons thanks for checking the KEP. But I have added graduation criteria as you can see in https://github.com/kubernetes/enhancements/pull/4293/files#diff-708a3d9c4718ca7f3da37b08c6cbee5ff7fc7df4f496783dd213b7abf0f2c216R98, do you mean adding somewhere else?.

[tjons]

@ardaguclu whoops, missed that in the diff! thanks for updating me. I've updated my commend accordingly.

[tjons]

With all the requirements fulfilled this enhancement is now marked as tracked for the upcoming enhancements freeze 🚀

[natalisucks]

Hi @ardaguclu,

👋 from the v1.30 Communications Team! We'd love for you to opt in to write a feature blog about your enhancement!

We encourage blogs for features including, but not limited to: breaking changes, features and changes important to our users, and features that have been in progress for a long time and are graduating.

To opt in, you need to open a Feature Blog placeholder PR against the website repository.
The placeholder PR deadline is 27th February, 2024.

Here's the 1.30 Release Calendar

[Vyom-Yadav]

Hello @ardaguclu 👋, v1.30 Docs Shadow here.

Does this enhancement work planned for v1.30 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.30 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday, February 22nd, 2024 18:00 PDT

Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.

Thank you!

---

Does this enhancement work planned for v1.30 require any new docs or modification to existing docs?

Going through the changes this PR entails, we'll need a docs PR. Marking this as Need Docs. Thanks for this cool feature!

[tjons]

Hey again @ardaguclu 👋 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 6th March 2024 .

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, it looks like the following PRs are open and need to be merged before code freeze:

• kubectl debug: Add custom debug profiles on top of static profiles kubernetes#120346

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[tjons]

Hello @ardaguclu 👋, Enhancements team here.

With all the implementation(code related) PRs merged as per the issue description:

• kubectl debug: Add custom debug profiles on top of static profiles kubernetes#120346

This enhancement is now marked as tracked for code freeze for the 1.30 Code Freeze!

[Starttoaster]

This feature makes the kubectl debug command actually useful to me, so thank you for it. My team has always been somewhat turned-off from building their applications in shell-less base images because it was really annoying and difficult to runtime debug those containers, so being able to mount data volumes and such in the debug container will be a huge security win for us, I think. Couple of suggestions but I can't overstate how I'm already happy with the current state of it:

• It'd be nice if the file pointed to with the --custom flag could also be yaml (I'm somewhat assuming it can't be based on the docs specifying json.)

• It also might be nice if I could just put raw json into the flag, rather than making a local file for it. But I can work around this with a small bash wrapper function I think that just makes the file and cleans it up afterward. I have a habit of leaving random files around my home directory that I have to clean up later.

Since both of those feature suggestions kind of clash in usage, it might make more sense to consider doing one (if not neither) of them. The raw json in the flag idea is mostly just how I imagined the flag worked before I tried it. The yaml idea might be more generally useful to other people.

This is actually my first time replying to a KEP issue here so let me know if there is anything else I can provide to the team here.

[sreeram-venkitesh]

Hi @ardaguclu 👋, 1.31 Enhancements Lead here.

If you wish to progress this enhancement in v1.31, please have the SIG lead opt-in your enhancement by adding the lead-opted-in label and set the milestone to v1.31 before the Production Readiness Review Freeze.

/remove-label lead-opted-in

[ardaguclu]

@eddiezane could you please add the lead-opted-in label to track the work in 1.31?. Thanks.

[eddiezane]

/label lead-opted-in

[soltysh]

/milestone v1.31

[tjons]

Hey again @ardaguclu - 👋 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 24th July 2024 / 19:00 PDT Tuesday 23rd July 2024. .

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, it looks like the following PRs are open and need to be merged before code freeze:

• KEP-4292: Preparations to promote custom profiling in kubectl debug kubernetes#125333

If you anticipate missing code freeze, you can file an exception request in advance.

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[tjons]

With all PRs to k/k merged, this enhancement is now tracked for code freeze!

[tjons]

Hi, enhancements lead here - I inadvertently added this to the 1.32 tracking board 😀. Please readd it if you wish to progress this enhancement in 1.32.

/remove-label lead-opted-in

[ardaguclu]

/sig cli
/milestone v1.32
/stage stable
/label lead-opted-in

[ardaguclu]

/milestone v1.32

[dipesh-rawat]

Hello @ardaguclu 👋, v1.32 Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 11th October 2024 / 19:00 PDT Thursday 10th October 2024.

This enhancement is targeting for stage stable for v1.32 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.32.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here). If your production readiness review is not completed yet, please make sure to fill the production readiness questionnaire in your KEP by the PRR Freeze deadline on Thursday 3rd October 2024 so that the PRR team has enough time to review your KEP.

For this KEP, we would just need to update the following:

• Update kep.yaml to mention latest-milestone: v1.32 and stable: "v1.32"
• Complete the PRR review process for stable stage and merge it into k/enhancements.

It looks like #4824 will address most of these issues.

• Get Promote KEP-4292 custom profiling in kubectl debug to GA #4824 merged before the enhancements freeze.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well.

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[dipesh-rawat]

Hello @ardaguclu 👋, v1.32 Enhancements team here,

Now that PR #4824 has been merged, all the KEP requirements are in place and merged into k/enhancements.

The status of this enhancement is now marked as tracked for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[edithturn]

Hello @ardaguclu , 👋🏼 this is Edith from the v1.32 Communications Team!

We’d love for you to consider writing a feature blog about your enhancement! ✍
Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024. For more information about writing a blog, see the blog contribution guidelines.

Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

[rdalbuquerque]

Hello @ardaguclu 👋, 1.32 Docs Shadow here.
Does this enhancement work planned for 1.32 require any new docs or modification to existing docs?
If so, please follows the steps here to open a PR against dev-1.32 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday October 24th 2024 18:00 PDT.
Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.
Thank you!

[dipesh-rawat]

Hey again @ardaguclu 👋 v1.32 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Friday 8th November 2024 / 19:00 PDT Thursday 7th November 2024 .

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, it looks like the following PRs are open and need to be merged before code freeze (and we need to update the Issue description to include all the related PRs of this KEP):

• KEP-4292: Add e2e test for custom profile in kubectl debug kubernetes#127187

Additionally, please let me know if there are any other PRs in k/k not listed in the description or linked with this GitHub issue that we should track for this KEP, so that we can maintain accurate status.

The status of this enhancement is marked as at risk for code freeze.

If you anticipate missing code freeze, you can file an exception request in advance. Thank you!

[dipesh-rawat]

Hi @ardaguclu 👋 v1.32 Enhancements team here,

I see that PR kubernetes/kubernetes#127187 has been merged, adding E2E test related to this KEP-4292. Are there any additional code/test changes planned for this KEP needed to progress towards a stable release in v1.32? If there are, could you update the issue description so we can track them and ensure accurate status? And if no further changes are expected, please let me know as well. Once I have your update, I’ll adjust the status of this KEP accordingly.

The current status of this enhancement is marked as at risk for code freeze.

[ardaguclu]

@dipesh-rawat There is no pending PRs other than website changes kubernetes/website#47805. I think, this KEP is almost completed.

[edithturn]

Hello @ardaguclu ! 🙂 👋

This is a reminder to author your feature blog post!

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024. For more information about writing a blog see the blog contribution guidelines.

Please feel free to reach out if you have any questions!

Thank you very much!
Edith from the v1.32 Shadow Communications Team

[dipesh-rawat]

@ardaguclu Thanks for the confirmation (here).

With all the implementation(code related) PRs merged as per the issue description:

• KEP-4292: Add e2e test for custom profile in kubectl debug kubernetes#127187

This enhancement is now marked as tracked for code freeze for the v1.32 Code Freeze!